@solana/rpc-api
Version:
Defines all default Solana RPC methods as types
27 lines • 1.27 kB
TypeScript
import type { Address } from '@solana/addresses';
import type { Commitment, SolanaRpcResponse, TokenAmount } from '@solana/rpc-types';
type TokenLargestAccount = Readonly<{
address: Address;
}> & TokenAmount;
type GetTokenLargestAccountsApiResponse = readonly TokenLargestAccount[];
export type GetTokenLargestAccountsApi = {
/**
* Returns the 20 largest token accounts whose mint is equal to the address supplied.
*
* @see https://solana.com/docs/rpc/http/gettokenlargestaccounts
*/
getTokenLargestAccounts(tokenMint: Address, config?: Readonly<{
/**
* Fetch the largest accounts as of the highest slot that has reached this level of
* commitment.
*
* @defaultValue Whichever default is applied by the underlying {@link RpcApi} in use.
* For example, when using an API created by a `createSolanaRpc*()` helper, the default
* commitment is `"confirmed"` unless configured otherwise. Unmitigated by an API layer
* on the client, the default commitment applied by the server is `"finalized"`.
*/
commitment?: Commitment;
}>): SolanaRpcResponse<GetTokenLargestAccountsApiResponse>;
};
export {};
//# sourceMappingURL=getTokenLargestAccounts.d.ts.map