Class DelegationNode

Delegation nodes are used within the KILT protocol to construct the trust hierarchy.

Starting from the root node, entities can delegate the right to issue attestations to Claimers for a certain CTYPE and also delegate the right to attest and to delegate further nodes.

A delegation object is stored on-chain, and can be revoked.

A delegation can and may restrict permissions.

Permissions:

Delegate.
Attest.

Hierarchy

DelegationNode

Implements

IDelegationNode

Index

Constructors

constructor

new DelegationNode(__namedParameters: IDelegationNode): DelegationNode
Creates a new [DelegationNode] from an [IDelegationNode].
Parameters
- __namedParameters: IDelegationNode
Returns DelegationNode
- Defined in packages/core/src/delegation/DelegationNode.ts:71

Properties

`Readonly` account

account: DidUri

`Readonly` hierarchyId

hierarchyId: string

`Readonly` id

id: string

`Optional` `Readonly` parentId

parentId?: string

`Readonly` permissions

permissions: number[]

`Readonly` revoked

revoked: boolean

Accessors

childrenIds

get childrenIds(): string[]
Returns string[]
Implementation of IDelegationNode.childrenIds
- Defined in packages/core/src/delegation/DelegationNode.ts:90

Methods

delegateSign

delegateSign(delegateDid: DidDocument, sign: SignCallback): Promise<EncodedVerificationKey>
Signs the delegation hash from the delegations' property values.

This is required to anchor the delegation node on chain in order to enforce the delegate's consent.

Returns
The DID signature over the delegation as a hex string.
Parameters
- delegateDid: DidDocument
  
  The DID of the delegate.
- sign: SignCallback
  
  The callback to sign the delegation creation details for the delegate.
Returns Promise<EncodedVerificationKey>
- Defined in packages/core/src/delegation/DelegationNode.ts:265

findAncestorOwnedBy

findAncestorOwnedBy(dids: DidUri | DidUri[]): Promise<{
node: null | DelegationNode;
steps: number;
}>
Checks on chain whether an identity with the given DID is delegating to the current node.

Returns
An object containing a node owned by the identity if it is delegating, plus the number of steps traversed. steps is 0 if the DID is owner of the current node.
Parameters
- dids: DidUri | DidUri[]
  
  A DID or an array of DIDs to search for.
Returns Promise<{
node: null | DelegationNode;
steps: number;
}>
- Defined in packages/core/src/delegation/DelegationNode.ts:348

generateHash

generateHash(): Uint8Array
Generates the delegation hash from the delegations' property values.

This hash is signed by the delegate and later stored along with the delegation to make sure delegation data (such as permissions) has not been tampered with.

Returns
The hash representation of this delegation as a byte array.

Returns Uint8Array
- Defined in packages/core/src/delegation/DelegationNode.ts:244

getAttestationHashes

getAttestationHashes(): Promise<`0x${string}`[]>
Fetches all hashes of attestations attested with this delegation node.

Returns
Promise containing all attestation hashes attested with this node.

Returns Promise<`0x${string}`[]>
- Defined in packages/core/src/delegation/DelegationNode.ts:229

getAttestations

getAttestations(): Promise<IAttestation[]>
Fetches and resolves all attestations attested with this delegation node.

Returns
Promise containing all resolved attestations attested with this node.

Returns Promise<IAttestation[]>
- Defined in packages/core/src/delegation/DelegationNode.ts:209

getCTypeHash

getCTypeHash(): Promise<`0x${string}`>
Lazily fetches the details of the hierarchy the node is part of and return its CType.

Returns
The CType hash associated with the delegation hierarchy.

Returns Promise<`0x${string}`>
- Defined in packages/core/src/delegation/DelegationNode.ts:158

getChildren

getChildren(): Promise<DelegationNode[]>
Fetches the children nodes of this delegation node.

Returns
Promise containing the children as an array of DelegationNode, which is empty if there are no children.

Returns Promise<DelegationNode[]>
- Defined in packages/core/src/delegation/DelegationNode.ts:194

getHierarchyDetails

getHierarchyDetails(): Promise<IDelegationHierarchyDetails>
Fetches the details of the hierarchy this delegation node belongs to.

Returns
Promise containing the IDelegationHierarchyDetails of this delegation node.

Returns Promise<IDelegationHierarchyDetails>
- Defined in packages/core/src/delegation/DelegationNode.ts:168

getLatestState

getLatestState(): Promise<DelegationNode>
Synchronise the delegation node state with the latest state as stored on the blockchain.

Returns
An updated instance of the same [DelegationNode] containing the up-to-date state fetched from the chain.

Returns Promise<DelegationNode>
- Defined in packages/core/src/delegation/DelegationNode.ts:297

getParent

getParent(): Promise<null | DelegationNode>
Fetches the parent node of this delegation node.

Returns
Promise containing the parent as DelegationNode or [null].

Returns Promise<null | DelegationNode>
- Defined in packages/core/src/delegation/DelegationNode.ts:180

getReclaimDepositTx

getReclaimDepositTx(): Promise<SubmittableExtrinsic>
Reclaims the deposit of a delegation and removes the delegation and all its children.

This call can only be successfully executed if the submitter of the transaction is the original payer of the delegation deposit.

Returns
A promise containing the unsigned SubmittableExtrinsic (submittable transaction).

Returns Promise<SubmittableExtrinsic>
- Defined in packages/core/src/delegation/DelegationNode.ts:436

getRemoveTx

getRemoveTx(): Promise<SubmittableExtrinsic>
Removes the delegation node from the chain.

Returns
Promise containing an unsigned SubmittableExtrinsic.

Returns Promise<SubmittableExtrinsic>
- Defined in packages/core/src/delegation/DelegationNode.ts:422

getRevokeTx

getRevokeTx(did: DidUri): Promise<SubmittableExtrinsic>
Revokes the delegation node on chain.

Returns
Promise containing an unsigned SubmittableExtrinsic.
Parameters
- did: DidUri
  
  The address of the identity used to revoke the delegation.
Returns Promise<SubmittableExtrinsic>
- Defined in packages/core/src/delegation/DelegationNode.ts:402

getStoreTx

getStoreTx(signature?: EncodedVerificationKey): Promise<SubmittableExtrinsic>
Stores the delegation node on chain.

Returns
Promise containing an unsigned SubmittableExtrinsic.
Parameters
- Optional signature: EncodedVerificationKey
  
  Signature of the delegate to ensure it is done under the delegate's permission.
Returns Promise<SubmittableExtrinsic>
- Defined in packages/core/src/delegation/DelegationNode.ts:307

isRoot

isRoot(): boolean
Returns boolean
- Defined in packages/core/src/delegation/DelegationNode.ts:327

subtreeNodeCount

subtreeNodeCount(): Promise<number>
Recursively counts all nodes that descend from the current node (excluding the current node). It is important to first refresh the state of the node from the chain.

Returns
Promise resolving to the node count.

Returns Promise<number>
- Defined in packages/core/src/delegation/DelegationNode.ts:382

verify

verify(): Promise<void>
Verifies the delegation node by fetching it from chain and checking its revocation status.

Returns Promise<void>
- Defined in packages/core/src/delegation/DelegationNode.ts:334

`Static` fetch

fetch(delegationId: string): Promise<DelegationNode>
Queries the delegation node with its [delegationId].

Returns
Promise containing the DelegationNode.
Parameters
- delegationId: string
  
  The unique identifier of the desired delegation.
Returns Promise<DelegationNode>
- Defined in packages/core/src/delegation/DelegationNode.ts:451

`Static` newNode

newNode(input: Required<Pick<IDelegationNode, "account" | "permissions" | "hierarchyId" | "parentId">>): DelegationNode
Builds a new [DelegationNode] representing a regular delegation node ready to be submitted to the chain for creation.

Returns
A new [DelegationNode] with a randomly generated id.
Parameters
- input: Required<Pick<IDelegationNode, "account" | "permissions" | "hierarchyId" | "parentId">>
  
  An partial [IDelegationNode] input object.
Returns DelegationNode
- Defined in packages/core/src/delegation/DelegationNode.ts:104

`Static` newRoot

newRoot(input: NewDelegationRootInput): DelegationNode
Builds a new [DelegationNode] representing a root delegation node ready to be submitted to the chain for creation.

Returns
A new [DelegationNode] with a randomly generated id.
Parameters
- input: NewDelegationRootInput
  
  An input object.
Returns DelegationNode
- Defined in packages/core/src/delegation/DelegationNode.ts:130

Class DelegationNode

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: IDelegationNode

Returns DelegationNode

Properties

Readonly account

Readonly hierarchyId

Readonly id

Optional Readonly parentId

Readonly permissions

Readonly revoked

Accessors

childrenIds

Returns string[]

Methods

delegateSign

Returns

Parameters

delegateDid: DidDocument

sign: SignCallback

Returns Promise<EncodedVerificationKey>

findAncestorOwnedBy

Returns

Parameters

dids: DidUri | DidUri[]

Returns Promise<{ node: null | DelegationNode; steps: number; }>

generateHash

Returns

Returns Uint8Array

getAttestationHashes

Returns

Returns Promise<`0x${string}`[]>

getAttestations

Returns

Returns Promise<IAttestation[]>

getCTypeHash

Returns

Returns Promise<`0x${string}`>

getChildren

Returns

Returns Promise<DelegationNode[]>

getHierarchyDetails

Returns

Returns Promise<IDelegationHierarchyDetails>

getLatestState

Returns

Returns Promise<DelegationNode>

getParent

Returns

Returns Promise<null | DelegationNode>

getReclaimDepositTx

Returns

Returns Promise<SubmittableExtrinsic>

getRemoveTx

Returns

Returns Promise<SubmittableExtrinsic>

getRevokeTx

Returns

Parameters

did: DidUri

Returns Promise<SubmittableExtrinsic>

getStoreTx

Returns

Parameters

Optional signature: EncodedVerificationKey

Returns Promise<SubmittableExtrinsic>

isRoot

Returns boolean

subtreeNodeCount

Returns

Returns Promise<number>

`Readonly` account

`Readonly` hierarchyId

`Readonly` id

`Optional` `Readonly` parentId

`Readonly` permissions

`Readonly` revoked

Returns Promise<{
node: null | DelegationNode;
steps: number;
}>

`Optional` signature: EncodedVerificationKey

`Static` fetch

`Static` newNode

`Static` newRoot