Class Delegation<C>

constructor

• new Delegation<C>(root, blocks?): Delegation.Delegation<C>

• Type Parameters

  • C extends Capabilities

  Parameters

  • root: UCANBlock<C, MulticodecCode<number, string>, SigAlg>

  • Optional blocks: BlockStore<unknown>

  Returns Delegation.Delegation<C>

blocks

root

asCID

• get asCID(): Link<UCAN.UCAN<C>, MulticodecCode<number, string>, SigAlg, 1>

• Returns Link<UCAN.UCAN<C>, MulticodecCode<number, string>, SigAlg, 1>

attachedLinks

• get attachedLinks(): AttachedLinkSet

• Returns AttachedLinkSet

audience

• get audience(): Principal<`did:${string}:${string}`>

• Returns Principal<`did:${string}:${string}`>

bytes

• get bytes(): ByteView<UCAN.UCAN<C>>

• Returns ByteView<UCAN.UCAN<C>>

capabilities

• get capabilities(): C

• Returns C

cid

• get cid(): Link<UCAN.UCAN<C>, MulticodecCode<number, string>, SigAlg, 1>

• Returns Link<UCAN.UCAN<C>, MulticodecCode<number, string>, SigAlg, 1>

data

• get data(): UCAN.View<C>

• Returns UCAN.View<C>

expiration

• get expiration(): number

• Returns number

facts

• get facts(): Fact[]

• Returns Fact[]

issuer

• get issuer(): Principal<`did:${string}:${string}`>

• Returns Principal<`did:${string}:${string}`>

nonce

• get nonce(): undefined | string

• Returns undefined | string

notBefore

• get notBefore(): undefined | number

• Returns undefined | number

proofs

• get proofs(): Proof<Capabilities>[]

• Returns Proof<Capabilities>[]

signature

• get signature(): SignatureView<unknown, SigAlg>

• Returns SignatureView<unknown, SigAlg>

version

• get version(): `${number}.${number}.${number}`

• Returns `${number}.${number}.${number}`

archive

• archive(): Await<Schema.Result<Uint8Array, Error>>

• Returns Await<Schema.Result<Uint8Array, Error>>

attach

• attach(block): void

• Attach a block to the delegation DAG so it would be included in the block iterator. ⚠️ You can only attach blocks that are referenced from the capabilities or facts.

  Parameters

  • block: Transport.Block<unknown, number, number, 1>

  Returns void

buildIPLDView

• buildIPLDView(): Delegation.Delegation<C>

• Encodes all the blocks and creates a new IPLDView instance over them. Can be passed a multihasher to specify a preferred hashing algorithm. Note that there is no guarantee that preferred hasher will be used, it is only a hint of preference and not a requirement.

  Returns Delegation.Delegation<C>

delegate

• delegate(): Delegation.Delegation<C>

• Returns Delegation.Delegation<C>

export

• export(): IterableIterator<Transport.Block<any, number, number, 1>>

• Returns IterableIterator<Transport.Block<any, number, number, 1>>

iterate

• iterate(): IterableIterator<Delegation<Capabilities>>

• Iterate over the proofs

  Returns IterableIterator<Delegation<Capabilities>>

iterateIPLDBlocks

• iterateIPLDBlocks(): IterableIterator<Transport.Block<any, number, number, 1>>

• Returns an iterable of all the IPLD blocks that are included in this view. It is RECOMMENDED that implementations return blocks in bottom up order (i.e. leaf blocks first, root block last).

  Iterator MUST include the root block otherwise it will lead to encoders into omitting it when encoding the view into a CAR archive.

  Note that we would like to rename this method to blocks but that would be a breaking change on the Delegate API so we defer it for now.

  Returns IterableIterator<Transport.Block<any, number, number, 1>>

link

• link(): Link<UCAN.UCAN<C>, MulticodecCode<number, string>, SigAlg, 1>

• Returns Link<UCAN.UCAN<C>, MulticodecCode<number, string>, SigAlg, 1>

toJSON

• toJSON(): DelegationJSON<Delegation.Delegation<C>>

• Returns DelegationJSON<Delegation.Delegation<C>>