Interface PdaNode<TSeeds>

A program-derived address: its name, optional program ID override, and the seeds used to derive it.

interface PdaNode<TSeeds extends PdaSeedNode[] = PdaSeedNode[]> {
    docs?: Docs;
    kind: "pdaNode";
    name: CamelCaseString;
    programId?: string;
    seeds: TSeeds;
}

Type Parameters

TSeeds extends PdaSeedNode[] = PdaSeedNode[]

Index

Properties

docs? kind name programId? seeds

Properties

`Optional` `Readonly`docs

docs?: Docs

Markdown documentation for the PDA.

`Readonly`kind

kind: "pdaNode"

`Readonly`name

name: CamelCaseString

The name of the PDA.

`Optional` `Readonly`programId

programId?: string

The base58-encoded program ID used to derive the PDA. When omitted, the surrounding program is assumed.

`Readonly`seeds

seeds: TSeeds

The seeds used to derive the PDA, in order.