PackSet | @metaplex-foundation/mpl-nft-packs

Holds the data for the PackSet Account and provides de/serialization functionality for that data

Hierarchy

PackSet

Implements

PackSetArgs

Properties

Readonly accountType

accountType: AccountType

Readonly allowedAmountToRedeem

allowedAmountToRedeem: number

Readonly authority

authority: PublicKey

Readonly description

description: string

Readonly distributionType

distributionType: PackDistributionType

Readonly mutable

mutable: boolean

Readonly name

name: number[]

Readonly packCards

packCards: number

Readonly packState

packState: PackSetState

Readonly packVouchers

packVouchers: number

Readonly redeemEndDate

redeemEndDate: bignum

Readonly redeemStartDate

redeemStartDate: bignum

Readonly store

store: PublicKey

Readonly totalEditions

totalEditions: bignum

Readonly totalWeight

totalWeight: bignum

Readonly uri

uri: string

Methods

pretty

pretty(): { accountType: string; allowedAmountToRedeem: number; authority: string; description: string; distributionType: string; mutable: boolean; name: number[]; packCards: number; packState: string; packVouchers: number; redeemEndDate: bignum; redeemStartDate: number | { toNumber: any }; store: string; totalEditions: number | { toNumber: any }; totalWeight: number | { toNumber: any }; uri: string }

- Defined in dev/mp/metaplex/metaplex-foundation/mpl/nft-packs/js/src/generated/accounts/PackSet.ts:174
Returns a readable version of PackSet properties and can be used to convert to JSON and/or logging

Returns { accountType: string; allowedAmountToRedeem: number; authority: string; description: string; distributionType: string; mutable: boolean; name: number[]; packCards: number; packState: string; packVouchers: number; redeemEndDate: bignum; redeemStartDate: number | { toNumber: any }; store: string; totalEditions: number | { toNumber: any }; totalWeight: number | { toNumber: any }; uri: string }
- accountType: string
- allowedAmountToRedeem: number
- authority: string
- description: string
- distributionType: string
- mutable: boolean
- name: number[]
- packCards: number
- packState: string
- packVouchers: number
- redeemEndDate: bignum
- redeemStartDate: number | { toNumber: any }
- store: string
- totalEditions: number | { toNumber: any }
- totalWeight: number | { toNumber: any }
- uri: string

serialize

serialize(): [Buffer, number]

- Defined in dev/mp/metaplex/metaplex-foundation/mpl/nft-packs/js/src/generated/accounts/PackSet.ts:138
Serializes the PackSet 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 byteSize

byteSize(args: PackSetArgs): number

- Defined in dev/mp/metaplex/metaplex-foundation/mpl/nft-packs/js/src/generated/accounts/PackSet.ts:149
Returns the byteSize of a {@link Buffer} holding the serialized data of PackSet for the provided args.

Parameters
- args: PackSetArgs
  
  need to be provided since the byte size for this account depends on them
Returns number

Static deserialize

deserialize(buf: Buffer, offset?: number): [PackSet, number]

- Defined in dev/mp/metaplex/metaplex-foundation/mpl/nft-packs/js/src/generated/accounts/PackSet.ts:130
Deserializes the PackSet from the provided data Buffer.

Parameters
- buf: Buffer
- offset: number = 0
Returns [PackSet, number]
a tuple of the account data and the offset up to which the buffer was read to obtain it.

Static fromAccountAddress

fromAccountAddress(connection: Connection, address: PublicKey): Promise<PackSet>

- Defined in dev/mp/metaplex/metaplex-foundation/mpl/nft-packs/js/src/generated/accounts/PackSet.ts:103
Retrieves the account info from the provided address and deserializes the PackSet from its data.

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

Parameters
- connection: Connection
- address: PublicKey
Returns Promise<PackSet>

Static fromAccountInfo

fromAccountInfo(accountInfo: AccountInfo<Buffer>, offset?: number): [PackSet, number]

- Defined in dev/mp/metaplex/metaplex-foundation/mpl/nft-packs/js/src/generated/accounts/PackSet.ts:93
Deserializes the PackSet from the data of the provided {@link web3.AccountInfo}.

Parameters
- accountInfo: AccountInfo<Buffer>
- offset: number = 0
Returns [PackSet, number]
a tuple of the account data and the offset up to which the buffer was read to obtain it.

Static fromArgs

fromArgs(args: PackSetArgs): PackSet

- Defined in dev/mp/metaplex/metaplex-foundation/mpl/nft-packs/js/src/generated/accounts/PackSet.ts:68
Creates a PackSet instance from the provided args.

Parameters
- args: PackSetArgs
Returns PackSet

Static getMinimumBalanceForRentExemption

getMinimumBalanceForRentExemption(args: PackSetArgs, connection: Connection, commitment?: Commitment): Promise<number>

- Defined in dev/mp/metaplex/metaplex-foundation/mpl/nft-packs/js/src/generated/accounts/PackSet.ts:162
Fetches the minimum balance needed to exempt an account holding PackSet data from rent

Parameters
- args: PackSetArgs
  
  need to be provided since the byte size for this account depends on them
- connection: Connection
  
  used to retrieve the rent exemption information
- Optional commitment: Commitment
Returns Promise<number>

Static gpaBuilder

gpaBuilder(programId?: PublicKey): GpaBuilder<Object>

- Defined in dev/mp/metaplex/metaplex-foundation/mpl/nft-packs/js/src/generated/accounts/PackSet.ts:120
Provides a {@link web3.Connection.getProgramAccounts} config builder, to fetch accounts matching filters that can be specified via that builder.

Parameters
- programId: PublicKey = ...
  
  the program that owns the accounts we are filtering
Returns GpaBuilder<Object>

Hierarchy

Implements

Index

Properties

Methods

Properties

Readonly accountType

Readonly allowedAmountToRedeem

Readonly authority

Readonly description

Readonly distributionType

Readonly mutable

Readonly name

Readonly packCards

Readonly packState

Readonly packVouchers

Readonly redeemEndDate

Readonly redeemStartDate

Readonly store

Readonly totalEditions

Readonly totalWeight

Readonly uri

Methods

pretty

accountType: string

allowedAmountToRedeem: number

authority: string

description: string

distributionType: string

mutable: boolean

name: number[]

packCards: number

packState: string

packVouchers: number

redeemEndDate: bignum

redeemStartDate: number | { toNumber: any }

store: string

totalEditions: number | { toNumber: any }

totalWeight: number | { toNumber: any }

uri: string

serialize

Returns [Buffer, number]

Static byteSize

Parameters

args: PackSetArgs

Returns number

Static deserialize

Parameters

buf: Buffer

offset: number = 0

Returns [PackSet, number]

Static fromAccountAddress

Parameters

connection: Connection

address: PublicKey

Returns Promise<PackSet>

Static fromAccountInfo

Parameters

accountInfo: AccountInfo<Buffer>

offset: number = 0

Returns [PackSet, number]

Static fromArgs

Parameters

args: PackSetArgs

Returns PackSet

Static getMinimumBalanceForRentExemption

Parameters

args: PackSetArgs

connection: Connection

Optional commitment: Commitment

Returns Promise<number>

Static gpaBuilder

Parameters

programId: PublicKey = ...

Returns GpaBuilder<Object>