Interface DelegationOptions<C>

A UCANOptions instance that include options for delegating capabilities.

Type Parameters

Hierarchy

Properties

attachedBlocks? audience capabilities expiration? facts? issuer lifetimeInSeconds? nonce? notBefore? proofs?

Properties

Optional attachedBlocks

attachedBlocks?: BlockStore<unknown>

audience

audience: Principal<`did:${string}:${string}`>

The audience for a Delegation is the party being delegated to, or the Principal which will invoke the delegated Capabilities on behalf of the issuer.

capabilities

capabilities: C

The set of Capabilities being delegated.

Optional expiration

expiration?: number

Optional facts

facts?: Fact[]

issuer

issuer: UCAN.Signer<`did:${string}:${string}`, SigAlg>

The issuer of a Delegation is the delegating party, or the Principal that has some capabilities that they wish to delegate the audience Principal.

Optional lifetimeInSeconds

lifetimeInSeconds?: number

Optional nonce

nonce?: string

Optional notBefore

notBefore?: number

Optional proofs

proofs?: Proof<Capabilities>[]

If the issuer of this Delegation is not the resource owner / service provider, for the delegated capabilities, the proofs array must contain valid Proofs containing delegations to the issuer.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc