Class NftPdasClient

This client allows you to build PDAs related to the NFT module.

See

NftClient

Hierarchy

NftPdasClient

Index

Constructors

constructor

new NftPdasClient(metaplex: Metaplex): NftPdasClient
Parameters
- metaplex: Metaplex
Returns NftPdasClient
- Defined in packages/js/src/plugins/nftModule/NftPdasClient.ts:16

Properties

`Protected` `Readonly` metaplex

metaplex: Metaplex

Methods

metadata

metadata(__namedParameters: MintAddressPdaInput): Pda
Finds the Metadata PDA of a given mint address.
Parameters
- __namedParameters: MintAddressPdaInput
Returns Pda
- Defined in packages/js/src/plugins/nftModule/NftPdasClient.ts:19

masterEdition

masterEdition(__namedParameters: MintAddressPdaInput): Pda
Finds the Master Edition PDA of a given mint address.
Parameters
- __namedParameters: MintAddressPdaInput
Returns Pda
- Defined in packages/js/src/plugins/nftModule/NftPdasClient.ts:29

edition

edition(input: MintAddressPdaInput): Pda
Finds the Edition PDA of a given mint address.
Parameters
- input: MintAddressPdaInput
Returns Pda
- Defined in packages/js/src/plugins/nftModule/NftPdasClient.ts:40

editionMarker

editionMarker(__namedParameters: {
    mint: PublicKey;
    edition: BigNumber;
    programs?: Program[];
}): Pda
Finds the Edition Marker PDA of a given edition number.
Parameters
- __namedParameters: {
      mint: PublicKey;
      edition: BigNumber;
      programs?: Program[];
  }
  - mint: PublicKey
    
    The address of the mint account of the edition NFT.
  - edition: BigNumber
    
    The edition number of the NFT.
  - Optional programs?: Program[]
    
    An optional set of programs that override the registered ones.
Returns Pda
- Defined in packages/js/src/plugins/nftModule/NftPdasClient.ts:45

collectionAuthorityRecord

collectionAuthorityRecord(__namedParameters: {
    mint: PublicKey;
    collectionAuthority: PublicKey;
    programs?: Program[];
}): Pda
Finds the collection authority PDA for a given NFT and authority.
Parameters
- __namedParameters: {
      mint: PublicKey;
      collectionAuthority: PublicKey;
      programs?: Program[];
  }
  - mint: PublicKey
    
    The address of the NFT's mint account.
  - collectionAuthority: PublicKey
    
    The address of the collection authority.
  - Optional programs?: Program[]
    
    An optional set of programs that override the registered ones.
Returns Pda
- Defined in packages/js/src/plugins/nftModule/NftPdasClient.ts:68

useAuthorityRecord

useAuthorityRecord(__namedParameters: {
    mint: PublicKey;
    useAuthority: PublicKey;
    programs?: Program[];
}): Pda
Finds the use authority PDA for a given NFT and user.
Parameters
- __namedParameters: {
      mint: PublicKey;
      useAuthority: PublicKey;
      programs?: Program[];
  }
  - mint: PublicKey
    
    The address of the NFT's mint account.
  - useAuthority: PublicKey
    
    The address of the use authority.
  - Optional programs?: Program[]
    
    An optional set of programs that override the registered ones.
Returns Pda
- Defined in packages/js/src/plugins/nftModule/NftPdasClient.ts:91

burner

burner(__namedParameters: {
programs?: Program[];
}): Pda
Finds the burner PDA of the Token Metadata program.
Parameters
- __namedParameters: {
  programs?: Program[];
  }
  - Optional programs?: Program[]
    
    An optional set of programs that override the registered ones.
Returns Pda
- Defined in packages/js/src/plugins/nftModule/NftPdasClient.ts:114

tokenRecord

tokenRecord(input: {
    mint: PublicKey;
    token: PublicKey;
    programs?: Program[];
}): Pda
Finds the record PDA for a given NFT and delegate authority.
Parameters
- input: {
      mint: PublicKey;
      token: PublicKey;
      programs?: Program[];
  }
  - mint: PublicKey
    
    The address of the NFT's mint account.
  - token: PublicKey
    
    The address of the token account
  - Optional programs?: Program[]
    
    An optional set of programs that override the registered ones.
Returns Pda
- Defined in packages/js/src/plugins/nftModule/NftPdasClient.ts:129

metadataDelegateRecord

metadataDelegateRecord(input: {
    mint: PublicKey;
    type: MetadataDelegateType;
    updateAuthority: PublicKey;
    delegate: PublicKey;
    programs?: Program[];
}): Pda
Finds the record PDA for a given NFT and delegate authority.
Parameters
- input: {
      mint: PublicKey;
      type: MetadataDelegateType;
      updateAuthority: PublicKey;
      delegate: PublicKey;
      programs?: Program[];
  }
  - mint: PublicKey
    
    The address of the NFT's mint account.
  - type: MetadataDelegateType
    
    The role of the delegate authority.
  - updateAuthority: PublicKey
    
    The address of the metadata's update authority.
  - delegate: PublicKey
    
    The address of delegate authority.
  - Optional programs?: Program[]
    
    An optional set of programs that override the registered ones.
Returns Pda
- Defined in packages/js/src/plugins/nftModule/NftPdasClient.ts:148

`Private` programId

programId(programs?: Program[]): PublicKey
Parameters
- Optional programs: Program[]
Returns PublicKey
- Defined in packages/js/src/plugins/nftModule/NftPdasClient.ts:171

Class NftPdasClient

See

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

metaplex: Metaplex

Returns NftPdasClient

Properties

Protected Readonly metaplex

Methods

metadata

Parameters

__namedParameters: MintAddressPdaInput

Returns Pda

masterEdition

Parameters

__namedParameters: MintAddressPdaInput

Returns Pda

edition

Parameters

input: MintAddressPdaInput

Returns Pda

editionMarker

Parameters

__namedParameters: { mint: PublicKey; edition: BigNumber; programs?: Program[]; }

mint: PublicKey

edition: BigNumber

Optional programs?: Program[]

Returns Pda

collectionAuthorityRecord

Parameters

__namedParameters: { mint: PublicKey; collectionAuthority: PublicKey; programs?: Program[]; }

mint: PublicKey

collectionAuthority: PublicKey

Optional programs?: Program[]

Returns Pda

useAuthorityRecord

Parameters

__namedParameters: { mint: PublicKey; useAuthority: PublicKey; programs?: Program[]; }

mint: PublicKey

useAuthority: PublicKey

Optional programs?: Program[]

Returns Pda

burner

Parameters

__namedParameters: { programs?: Program[]; }

Optional programs?: Program[]

Returns Pda

tokenRecord

Parameters

input: { mint: PublicKey; token: PublicKey; programs?: Program[]; }

mint: PublicKey

token: PublicKey

Optional programs?: Program[]

Returns Pda

metadataDelegateRecord

Parameters

input: { mint: PublicKey; type: MetadataDelegateType; updateAuthority: PublicKey; delegate: PublicKey; programs?: Program[]; }

mint: PublicKey

type: MetadataDelegateType

updateAuthority: PublicKey

delegate: PublicKey

Optional programs?: Program[]

Returns Pda

Private programId

Parameters

Optional programs: Program[]

Returns PublicKey

Settings

Member Visibility

Theme

`Protected` `Readonly` metaplex

__namedParameters: {
mint: PublicKey;
edition: BigNumber;
programs?: Program[];
}

`Optional` programs?: Program[]

__namedParameters: {
mint: PublicKey;
collectionAuthority: PublicKey;
programs?: Program[];
}

`Optional` programs?: Program[]

__namedParameters: {
mint: PublicKey;
useAuthority: PublicKey;
programs?: Program[];
}

`Optional` programs?: Program[]

__namedParameters: {
programs?: Program[];
}

`Optional` programs?: Program[]

input: {
mint: PublicKey;
token: PublicKey;
programs?: Program[];
}

`Optional` programs?: Program[]

input: {
mint: PublicKey;
type: MetadataDelegateType;
updateAuthority: PublicKey;
delegate: PublicKey;
programs?: Program[];
}

`Optional` programs?: Program[]

`Private` programId

`Optional` programs: Program[]