@bbachain/spl-token-metadata
Version:
116 lines • 4.49 kB
TypeScript
/// <reference types="node" />
/// <reference types="node" />
import * as beet from '@bbachain/beet';
import * as beetBBA from '@bbachain/beet-bbachain';
import * as web3 from '@bbachain/web3.js';
import { Collection, CollectionDetails, Data, Key, TokenStandard, Uses } from '../types';
/**
* Arguments used to create {@link Metadata}
* @category Accounts
*/
export type MetadataArgs = {
key: Key;
updateAuthority: web3.PublicKey;
mint: web3.PublicKey;
data: Data;
primarySaleHappened: boolean;
isMutable: boolean;
tokenStandard: beet.COption<TokenStandard>;
collection: beet.COption<Collection>;
collectionDetails: beet.COption<CollectionDetails>;
uses: beet.COption<Uses>;
};
/**
* Holds the data for the {@link Metadata} Account and provides de/serialization
* functionality for that data
*
* @category Accounts
*/
export declare class Metadata implements MetadataArgs {
readonly key: Key;
readonly updateAuthority: web3.PublicKey;
readonly mint: web3.PublicKey;
readonly data: Data;
readonly primarySaleHappened: boolean;
readonly isMutable: boolean;
readonly tokenStandard: beet.COption<TokenStandard>;
readonly collection: beet.COption<Collection>;
readonly collectionDetails: beet.COption<CollectionDetails>;
readonly uses: beet.COption<Uses>;
private constructor();
/**
* Creates a {@link Metadata} instance from the provided args.
*/
static fromArgs(args: MetadataArgs): Metadata;
/**
* Deserializes the {@link Metadata} from the data of the provided {@link web3.AccountInfo}.
* @returns a tuple of the account data and the offset up to which the buffer was read to obtain it.
*/
static fromAccountInfo(accountInfo: web3.AccountInfo<Buffer>, offset?: number): [Metadata, number];
/**
* Retrieves the account info from the provided address and deserializes
* the {@link Metadata} from its data.
*
* @throws Error if no account info is found at the address or if deserialization fails
*/
static fromAccountAddress(connection: web3.Connection, address: web3.PublicKey, commitmentOrConfig?: web3.Commitment | web3.GetAccountInfoConfig): Promise<Metadata>;
/**
* Provides a {@link web3.Connection.getProgramAccounts} config builder,
* to fetch accounts matching filters that can be specified via that builder.
*
* @param programId - the program that owns the accounts we are filtering
*/
static gpaBuilder(programId?: web3.PublicKey): beetBBA.GpaBuilder<MetadataArgs>;
/**
* Deserializes the {@link Metadata} from the provided data Buffer.
* @returns a tuple of the account data and the offset up to which the buffer was read to obtain it.
*/
static deserialize(buf: Buffer, offset?: number): [Metadata, number];
/**
* Serializes the {@link Metadata} into a Buffer.
* @returns a tuple of the created Buffer and the offset up to which the buffer was written to store it.
*/
serialize(): [Buffer, number];
/**
* Returns the byteSize of a {@link Buffer} holding the serialized data of
* {@link Metadata} for the provided args.
*
* @param args need to be provided since the byte size for this account
* depends on them
*/
static byteSize(args: MetadataArgs): number;
/**
* Fetches the minimum balance needed to exempt an account holding
* {@link Metadata} data from rent
*
* @param args need to be provided since the byte size for this account
* depends on them
* @param connection used to retrieve the rent exemption information
*/
static getMinimumBalanceForRentExemption(args: MetadataArgs, connection: web3.Connection, commitment?: web3.Commitment): Promise<number>;
/**
* Returns a readable version of {@link Metadata} properties
* and can be used to convert to JSON and/or logging
*/
pretty(): {
key: string;
updateAuthority: string;
mint: string;
data: Data;
primarySaleHappened: boolean;
isMutable: boolean;
tokenStandard: TokenStandard;
collection: Collection;
collectionDetails: {
__kind: "V1";
} & Omit<{
size: beet.bignum;
}, "void">;
uses: Uses;
};
}
/**
* @category Accounts
*/
export declare const metadataBeet: beet.FixableBeetStruct<Metadata, MetadataArgs>;
//# sourceMappingURL=Metadata.d.ts.map