Skip to content

Define Coordinator and Client #306

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Define Coordinator and Client #306

Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
a27dbe3
Define Coordinator and Client
marcoscaceres Jun 30, 2025
774e687
Merge branch 'main' into corrdinator
marcoscaceres Jul 1, 2025
f1a4286
Set interaction state default
marcoscaceres Jul 2, 2025
edbea34
Merge branch 'main' into corrdinator
marcoscaceres Jul 2, 2025
60c425d
Update index.html
marcoscaceres Jul 2, 2025
964c2ce
Update index.html
marcoscaceres Jul 7, 2025
9d8e72a
Update index.html
marcoscaceres Jul 7, 2025
5377bc8
Update index.html
marcoscaceres Jul 7, 2025
be4b2b3
Update index.html
marcoscaceres Jul 7, 2025
58ff6c4
Update index.html
marcoscaceres Jul 7, 2025
9795095
Update index.html
marcoscaceres Jul 7, 2025
3ab6775
Merge branch 'main' into corrdinator
marcoscaceres Jul 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 95 additions & 0 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,101 @@ <h2>
identifier=]. See also section [[[#protocol-registry]]].
</dd>
</dl>
<h3>
Credential Request Coordinator
</h3>
<p>
The <dfn>credential request coordinator</dfn> is a user-agent-defined
component responsible for mediating [=digital credential=] interactions
within a given [=top-level traversable=].
</p>
<p>
Each [=top-level traversable=] has a single associated [=credential
request coordinator=].
</p>
<p>
The [=credential request coordinator=]:
</p>
<ul>
<li>Ensures that only one [=digital credential=] interaction is active at
any time. This includes via both the:
<ul>
<li>{{DigitalCredential/[[DiscoverFromExternalSource]](origin,
options, sameOriginWithAncestors)}} internal method.
</li>
<li>{{DigitalCredential/[[Create]](origin, options,
sameOriginWithAncestors)}} internal method.
</li>
</ul>
</li>
<li>Handles state transitions across the following <dfn data-for=
"credential request coordinator" data-local-lt="state">interaction
states</dfn>:
<ul>
<li>
<dfn data-dfn-for="credential request coordinator">Idle</dfn>: No
credential interaction is currently in progress.
</li>
<li>
<dfn data-dfn-for=
"credential request coordinator">Ongoing</dfn>: A credential
interaction is currently in progress and the user interface is
being shown to the user.
</li>
<li>
<dfn data-dfn-for="credential request coordinator">Aborting</dfn>:
A credential interaction is being canceled. The coordinator is in
the process of cleaning up the interaction.
</li>
</ul>
</li>
<li>Manages the lifecycle of the current interaction's promise, including
its resolution or rejection.
</li>
<li>Integrates with an {{AbortSignal}} to allow user-initiated or
programmatic cancellation.
</li>
</ul>
<p>
The [=credential request coordinator=] is initialized in the [=credential
request coordinator/idle=] [=interaction state=].
</p>
<h3>
Digital Credential Client
</h3>
<p>
A <dfn>digital credential client</dfn> is a user-agent-defined component
responsible managing the credential presentation or issuance flow, which
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
responsible managing the credential presentation or issuance flow, which
responsible for managing the credential presentation or issuance flow, which

includes allowing a user to select from available [=holders=] and coordinating the request.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
includes allowing a user to select from available [=holders=] and coordinating the request.
includes allowing the user to select from available [=holders=] and coordinating the request.

</p>
<p>
Each [=credential request coordinator=] uses a single associated
[=digital credential client=] to fulfill credential presentation and issuance
operations.
</p>
<p>
The [=digital credential client=]:
</p>
<ul>
<li>Validates and transforms digital credential presentation or issuance
inputs.
</li>
<li>Interprets each individual request in the input list as targeting a
specific [=holder=], and prepares holder options accordingly.
</li>
<li>Presents the available [=holders=] to the user for selection.
</li>
<li>Returns the result — a selected credential or a cancellation — to the
[=credential request coordinator=].
</li>
</ul>
<aside class="note">
<p>
Although the [=digital credential client=] coordinates the credential
interaction, it is the selected [=holder=] that typically acts as the
[=credential chooser=].
</p>
</aside>
<h2>
Scope
</h2>
Expand Down