@rainfi/sdk
Version:
This package is used to interact with Rain.fi protocol on Solana
169 lines (168 loc) • 6.18 kB
TypeScript
/**
* This code was GENERATED using the solita package.
* Please DO NOT EDIT THIS FILE, instead rerun solita to update it or write a wrapper to add functionality.
*
* See: https://github.com/metaplex-foundation/solita
*/
/// <reference types="node" />
import * as web3 from '@solana/web3.js';
import * as beet from '@metaplex-foundation/beet';
import * as beetSolana from '@metaplex-foundation/beet-solana';
import { WhitelistType } from '../types/WhitelistType';
/**
* Arguments used to create {@link CollectionGlobalOffer}
* @category Accounts
* @category generated
*/
export type CollectionGlobalOfferArgs = {
name: number[];
authority: web3.PublicKey;
creator: web3.PublicKey;
collection: web3.PublicKey;
collectionId: number;
activeBid: beet.bignum;
volumeActiveBid: beet.bignum;
totalWhitelisted: beet.bignum;
totalVolume: beet.bignum;
totalAccepted: beet.bignum;
whitelistType: WhitelistType;
isAttributeFilteringEnabled: boolean;
createdAt: beet.bignum;
updatedAt: beet.bignum;
padding: beet.bignum[];
};
export declare const collectionGlobalOfferDiscriminator: number[];
/**
* Holds the data for the {@link CollectionGlobalOffer} Account and provides de/serialization
* functionality for that data
*
* @category Accounts
* @category generated
*/
export declare class CollectionGlobalOffer implements CollectionGlobalOfferArgs {
readonly name: number[];
readonly authority: web3.PublicKey;
readonly creator: web3.PublicKey;
readonly collection: web3.PublicKey;
readonly collectionId: number;
readonly activeBid: beet.bignum;
readonly volumeActiveBid: beet.bignum;
readonly totalWhitelisted: beet.bignum;
readonly totalVolume: beet.bignum;
readonly totalAccepted: beet.bignum;
readonly whitelistType: WhitelistType;
readonly isAttributeFilteringEnabled: boolean;
readonly createdAt: beet.bignum;
readonly updatedAt: beet.bignum;
readonly padding: beet.bignum[];
private constructor();
/**
* Creates a {@link CollectionGlobalOffer} instance from the provided args.
*/
static fromArgs(args: CollectionGlobalOfferArgs): CollectionGlobalOffer;
/**
* Deserializes the {@link CollectionGlobalOffer} 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): [CollectionGlobalOffer, number];
/**
* Retrieves the account info from the provided address and deserializes
* the {@link CollectionGlobalOffer} 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<CollectionGlobalOffer>;
/**
* 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): beetSolana.GpaBuilder<{
accountDiscriminator: any;
createdAt: any;
padding: any;
updatedAt: any;
collectionId: any;
name: any;
creator: any;
collection: any;
authority: any;
activeBid: any;
volumeActiveBid: any;
totalWhitelisted: any;
totalVolume: any;
totalAccepted: any;
whitelistType: any;
isAttributeFilteringEnabled: any;
}>;
/**
* Deserializes the {@link CollectionGlobalOffer} 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): [CollectionGlobalOffer, number];
/**
* Serializes the {@link CollectionGlobalOffer} 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 CollectionGlobalOffer}
*/
static get byteSize(): number;
/**
* Fetches the minimum balance needed to exempt an account holding
* {@link CollectionGlobalOffer} data from rent
*
* @param connection used to retrieve the rent exemption information
*/
static getMinimumBalanceForRentExemption(connection: web3.Connection, commitment?: web3.Commitment): Promise<number>;
/**
* Determines if the provided {@link Buffer} has the correct byte size to
* hold {@link CollectionGlobalOffer} data.
*/
static hasCorrectByteSize(buf: Buffer, offset?: number): boolean;
/**
* Returns a readable version of {@link CollectionGlobalOffer} properties
* and can be used to convert to JSON and/or logging
*/
pretty(): {
name: number[];
authority: string;
creator: string;
collection: string;
collectionId: number;
activeBid: number | {
toNumber: () => number;
};
volumeActiveBid: number | {
toNumber: () => number;
};
totalWhitelisted: number | {
toNumber: () => number;
};
totalVolume: number | {
toNumber: () => number;
};
totalAccepted: number | {
toNumber: () => number;
};
whitelistType: string;
isAttributeFilteringEnabled: boolean;
createdAt: number | {
toNumber: () => number;
};
updatedAt: number | {
toNumber: () => number;
};
padding: beet.bignum[];
};
}
/**
* @category Accounts
* @category generated
*/
export declare const collectionGlobalOfferBeet: beet.BeetStruct<CollectionGlobalOffer, CollectionGlobalOfferArgs & {
accountDiscriminator: number[];
}>;