Documentation
    Preparing search index...

    Interface InvocationPayload

    https://github.com/ucan-wg/invocation#invocation-payload

    interface InvocationPayload {
        args: Record<string, unknown>;
        aud?: DID;
        cause?: CID<unknown, number, number, Version>;
        cmd: string;
        exp: null | number;
        iat?: number;
        iss: DIDURL;
        meta?: Record<string, unknown>;
        nbf?: number;
        nonce: Uint8Array<ArrayBuffer>;
        prf: CID<unknown, number, number, Version>[];
        sub: DID;
    }

    Hierarchy (View Summary)

    Index

    Properties

    args aud? cause? cmd exp iat? iss meta? nbf? nonce prf sub

    Properties

    args: Record<string, unknown>

    Any [Arguments] that MUST be present in the Invocation

    aud?: DID

    Optional if equal to subject

    cause?: CID<unknown, number, number, Version>

    An OPTIONAL CID of the Receipt that enqueued the Task

    cmd: string

    The Command to eventually invoke

    https://github.com/ucan-wg/spec#command

    exp: null | number

    Expiration UTC Unix Timestamp in seconds (valid until)

    iat?: number

    Issued at time

    iss: DIDURL

    Issuer DID (sender)

    meta?: Record<string, unknown>

    Meta (asserted, signed data) — is not delegated authority

    nbf?: number

    "Not before" UTC Unix Timestamp in seconds (valid from)

    nonce: Uint8Array<ArrayBuffer>

    The nonce of the UCAN

    https://github.com/ucan-wg/spec#nonce

    prf: CID<unknown, number, number, Version>[]

    Delegations that prove the chain of authority

    sub: DID

    Principal that the chain is about (the [Subject])

    Settings

    Member Visibility

    On This Page

    Properties