Coda by Ian Macalinao
    Preparing search index...

    Interface InstructionAccountNode<TDefaultValue, TAccountLink, TDisplay>

    An account participating in an instruction, with its name, signing/writability flags, and an optional default value.

    interface InstructionAccountNode<
        TDefaultValue extends
            InstructionInputValueNode
            | undefined = InstructionInputValueNode | undefined,
        TAccountLink extends
            AccountLinkNode
            | undefined = AccountLinkNode | undefined,
        TDisplay extends
            InstructionAccountDisplayNode
            | undefined = InstructionAccountDisplayNode | undefined,
    > {
        accountLink?: TAccountLink;
        defaultValue?: TDefaultValue;
        display?: TDisplay;
        docs?: Docs;
        isOptional?: boolean;
        isSigner: boolean
        | "either";
        isWritable: boolean;
        kind: "instructionAccountNode";
        name: CamelCaseString;
    }

    Type Parameters

    Index
    accountLink? defaultValue? display? docs? isOptional? isSigner isWritable kind name
    accountLink?: TAccountLink

    A reference to the account's data layout. Required for consumers (e.g. accountFieldValueNode) to read fields from the account. The link's optional program allows cross-program references via the root's additionalPrograms.

    defaultValue?: TDefaultValue

    A default value used to fill the slot when the caller does not provide one.

    display?: TDisplay

    Display metadata describing how the account is presented.

    docs?: Docs

    Markdown documentation for the account slot.

    isOptional?: boolean

    Whether the account slot may be omitted by callers.

    isSigner: boolean | "either"

    Whether the account must sign the transaction. The literal "either" indicates a slot that may or may not sign depending on context.

    isWritable: boolean

    Whether the instruction may write to the account.

    kind: "instructionAccountNode"
    name: CamelCaseString

    The name of the account.

    Settings
    Member Visibility

    On This Page
    Properties