Class NFT

Readonly bump

Readonly collection

Readonly creator

Readonly lastClaim

Readonly lastStakedAt

Readonly lastUnstakedAt

Readonly mint

Readonly stakedAt

Readonly staker

Readonly stakingPool

Static byteSize

• get byteSize(): number

• Returns the byteSize of a Buffer holding the serialized data of NFT

  Returns number

pretty

• pretty(): {
      bump: number;
      collection: string;
      creator: string;
      lastClaim: number | {
          toNumber: (() => number);
      };
      lastStakedAt: number | {
          toNumber: (() => number);
      };
      lastUnstakedAt: number | {
          toNumber: (() => number);
      };
      mint: string;
      stakedAt: number | {
          toNumber: (() => number);
      };
      staker: string;
      stakingPool: string;
  }

• Returns a readable version of NFT properties and can be used to convert to JSON and/or logging

  Returns {
      bump: number;
      collection: string;
      creator: string;
      lastClaim: number | {
          toNumber: (() => number);
      };
      lastStakedAt: number | {
          toNumber: (() => number);
      };
      lastUnstakedAt: number | {
          toNumber: (() => number);
      };
      mint: string;
      stakedAt: number | {
          toNumber: (() => number);
      };
      staker: string;
      stakingPool: string;
  }

  • bump: number

  • collection: string

  • creator: string

  • lastClaim: number | {
        toNumber: (() => number);
    }

  • lastStakedAt: number | {
        toNumber: (() => number);
    }

  • lastUnstakedAt: number | {
        toNumber: (() => number);
    }

  • mint: string

  • stakedAt: number | {
        toNumber: (() => number);
    }

  • staker: string

  • stakingPool: string

serialize

• serialize(): [Buffer, number]

• Serializes the NFT into a Buffer.

  Returns [Buffer, number]

  a tuple of the created Buffer and the offset up to which the buffer was written to store it.

Static deserialize

• deserialize(buf, offset?): [NFT, number]

• Deserializes the NFT from the provided data Buffer.

  Parameters

  • buf: Buffer

  • Optional offset: number

  Returns [NFT, number]

  a tuple of the account data and the offset up to which the buffer was read to obtain it.

Static fromAccountAddress

• fromAccountAddress(connection, address, commitmentOrConfig?): Promise<NFT>

• Retrieves the account info from the provided address and deserializes the NFT from its data.

  Parameters

  • connection: Connection

  • address: PublicKey

  • Optional commitmentOrConfig: Commitment | GetAccountInfoConfig

  Returns Promise<NFT>

  Throws

  Error if no account info is found at the address or if deserialization fails

Static fromAccountInfo

• fromAccountInfo(accountInfo, offset?): [NFT, number]

• Deserializes the NFT from the data of the provided web3.AccountInfo.

  Parameters

  • accountInfo: AccountInfo<Buffer>

  • Optional offset: number

  Returns [NFT, number]

  a tuple of the account data and the offset up to which the buffer was read to obtain it.

Static fromArgs

• fromArgs(args): NFT

• Creates a NFT instance from the provided args.

  Parameters

  • args: NFTArgs

  Returns NFT

Static getMinimumBalanceForRentExemption

• getMinimumBalanceForRentExemption(connection, commitment?): Promise<number>

• Fetches the minimum balance needed to exempt an account holding NFT data from rent

  Parameters

  • connection: Connection

    used to retrieve the rent exemption information

  • Optional commitment: Commitment

  Returns Promise<number>

Static gpaBuilder

• gpaBuilder(programId?): GpaBuilder<{
      accountDiscriminator: any;
      bump: any;
      collection: any;
      creator: any;
      lastClaim: any;
      lastStakedAt: any;
      lastUnstakedAt: any;
      mint: any;
      stakedAt: any;
      staker: any;
      stakingPool: any;
  }>

• Provides a web3.Connection.getProgramAccounts config builder, to fetch accounts matching filters that can be specified via that builder.

  Parameters

  • Optional programId: PublicKey

    the program that owns the accounts we are filtering

  Returns GpaBuilder<{
      accountDiscriminator: any;
      bump: any;
      collection: any;
      creator: any;
      lastClaim: any;
      lastStakedAt: any;
      lastUnstakedAt: any;
      mint: any;
      stakedAt: any;
      staker: any;
      stakingPool: any;
  }>

Static hasCorrectByteSize

• hasCorrectByteSize(buf, offset?): boolean

• Determines if the provided Buffer has the correct byte size to hold NFT data.

  Parameters

  • buf: Buffer

  • Optional offset: number

  Returns boolean