@solana/rpc-api 6.3.1 → 6.3.2-canary-20260313112147

package/src/getSlot.ts

@@ -0,0 +1,29 @@
+import type { Commitment, Slot } from '@solana/rpc-types';
+
+type GetSlotApiResponse = Slot;
+
+export type GetSlotApi = {
+    /**
+     * Returns the slot that has reached the given or default commitment level.
+     *
+     * @see https://solana.com/docs/rpc/http/getslot
+     */
+    getSlot(
+        config?: Readonly<{
+            /**
+             * Fetch 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;
+            /**
+             * Prevents accessing stale data by enforcing that the RPC node has processed
+             * transactions up to this slot
+             */
+            minContextSlot?: Slot;
+        }>,
+    ): GetSlotApiResponse;
+};

package/src/getSlotLeader.ts

@@ -0,0 +1,32 @@
+import type { Address } from '@solana/addresses';
+import type { Commitment, Slot } from '@solana/rpc-types';
+
+type GetSlotLeaderApiResponse = Address;
+
+export type GetSlotLeaderApi = {
+    /**
+     * Returns the current slot leader.
+     *
+     * @returns The address of the validator that has been granted the opportunity to create the
+     * block for the current slot.
+     * @see https://solana.com/docs/rpc/http/getslotleader
+     */
+    getSlotLeader(
+        config?: Readonly<{
+            /**
+             * Fetch the leader 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;
+            /**
+             * Prevents accessing stale data by enforcing that the RPC node has processed
+             * transactions up to this slot
+             */
+            minContextSlot?: Slot;
+        }>,
+    ): GetSlotLeaderApiResponse;
+};

package/src/getSlotLeaders.ts

@@ -0,0 +1,21 @@
+import type { Address } from '@solana/addresses';
+import type { Slot } from '@solana/rpc-types';
+
+/** array of Node identity public keys as base-58 encoded strings */
+type GetSlotLeadersApiResponse = Address[];
+
+export type GetSlotLeadersApi = {
+    /**
+     * Returns the slot leaders for a given slot range.
+     *
+     * @returns The addresses of the validators that have been granted the opportunity to create the
+     * blocks for each slot in the range provided
+     * @see https://solana.com/docs/rpc/http/getslotleaders
+     */
+    getSlotLeaders(
+        /** Start slot, as u64 integer */
+        startSlotInclusive: Slot,
+        /** Limit (between 1 and 5000) */
+        limit: number,
+    ): GetSlotLeadersApiResponse;
+};

package/src/getStakeMinimumDelegation.ts

@@ -0,0 +1,26 @@
+import type { Commitment, Lamports, SolanaRpcResponse } from '@solana/rpc-types';
+
+type GetStakeMinimumDelegationApiResponse = Lamports;
+
+export type GetStakeMinimumDelegationApi = {
+    /**
+     * Returns the minimum amount of stake that can be delegated to a validator, in
+     * {@link Lamports}.
+     *
+     * @see https://solana.com/docs/rpc/http/getstakeminimumdelegation
+     */
+    getStakeMinimumDelegation(
+        config?: Readonly<{
+            /**
+             * Fetch the minimum delegation 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<GetStakeMinimumDelegationApiResponse>;
+};

package/src/getSupply.ts

@@ -0,0 +1,66 @@
+import type { Address } from '@solana/addresses';
+import type { Commitment, Lamports, SolanaRpcResponse } from '@solana/rpc-types';
+
+type GetSupplyConfig = Readonly<{
+    /**
+     * Fetch the supply 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;
+    excludeNonCirculatingAccountsList?: boolean;
+}>;
+
+type GetSupplyApiResponseBase = Readonly<{
+    /** Circulating supply in {@link Lamports} */
+    circulating: Lamports;
+    /** Non-circulating supply in {@link Lamports} */
+    nonCirculating: Lamports;
+    /** Total supply in {@link Lamports} */
+    total: Lamports;
+}>;
+
+type GetSupplyApiResponseWithNonCirculatingAccounts = GetSupplyApiResponseBase &
+    Readonly<{
+        /** Addresses of non-circulating accounts */
+        nonCirculatingAccounts: Address[];
+    }>;
+
+type GetSupplyApiResponseWithoutNonCirculatingAccounts = GetSupplyApiResponseBase &
+    Readonly<{
+        /**
+         * An empty array, since the `excludeNonCirculatingAccountsList` argument was not set to
+         * `true`.
+         */
+        nonCirculatingAccounts: never[];
+    }>;
+
+export type GetSupplyApi = {
+    /**
+     * Returns information about the current supply, excluding the list of non-circulating accounts.
+     *
+     * {@label exclude-non-circulating-accounts}
+     * @see https://solana.com/docs/rpc/http/getsupply
+     */
+    getSupply(
+        config: GetSupplyConfig &
+            Readonly<{
+                excludeNonCirculatingAccountsList: true;
+            }>,
+    ): SolanaRpcResponse<GetSupplyApiResponseWithoutNonCirculatingAccounts>;
+    /**
+     * Returns information about the current supply.
+     *
+     * {@label default}
+     * @see https://solana.com/docs/rpc/http/getsupply
+     */
+    getSupply(
+        config?: GetSupplyConfig &
+            Readonly<{
+                excludeNonCirculatingAccountsList?: false;
+            }>,
+    ): SolanaRpcResponse<GetSupplyApiResponseWithNonCirculatingAccounts>;
+};

package/src/getTokenAccountBalance.ts

@@ -0,0 +1,26 @@
+import type { Address } from '@solana/addresses';
+import type { Commitment, SolanaRpcResponse, TokenAmount } from '@solana/rpc-types';
+
+type GetTokenAccountBalanceApiResponse = TokenAmount;
+
+export type GetTokenAccountBalanceApi = {
+    /**
+     * Returns the balance of an SPL Token account.
+     *
+     * @see https://solana.com/docs/rpc/http/gettokenaccountbalance
+     */
+    getTokenAccountBalance(
+        address: Address,
+        config?: Readonly<{
+            /**
+             * Fetch the balance 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<GetTokenAccountBalanceApiResponse>;
+};

package/src/getTokenAccountsByDelegate.ts

@@ -0,0 +1,196 @@
+import type { Address } from '@solana/addresses';
+import type { JsonParsedTokenAccount } from '@solana/rpc-parsed-types';
+import type {
+    AccountInfoBase,
+    AccountInfoWithBase58Bytes,
+    AccountInfoWithBase58EncodedData,
+    AccountInfoWithBase64EncodedData,
+    AccountInfoWithBase64EncodedZStdCompressedData,
+    AccountInfoWithPubkey,
+    Commitment,
+    DataSlice,
+    Slot,
+    SolanaRpcResponse,
+} from '@solana/rpc-types';
+
+type TokenAccountInfoWithJsonData = Readonly<{
+    data: Readonly<{
+        parsed: {
+            info: JsonParsedTokenAccount;
+            type: 'account';
+        };
+        /** Name of the program that owns this account. */
+        program: Address;
+        space: bigint;
+    }>;
+}>;
+
+type GetTokenAccountsByDelegateResponse<T> = readonly AccountInfoWithPubkey<AccountInfoBase & T>[];
+
+type MintFilter = Readonly<{
+    /** This filter matches when the token account's mint is equal to the address supplied. */
+    mint: Address;
+}>;
+
+type ProgramIdFilter = Readonly<{
+    /**
+     * This filter matches when the token account's token program address is equal to the address
+     * supplied.
+     */
+    programId: Address;
+}>;
+
+type AccountsFilter = MintFilter | ProgramIdFilter;
+
+type GetTokenAccountsByDelegateApiCommonConfig = Readonly<{
+    /**
+     * Fetch the details of the 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;
+    /**
+     * Determines how the accounts' data should be encoded in the response.
+     *
+     * - `'base58'` returns a tuple whose first element is the data as a base58-encoded string. If
+     *   the account contains more than 129 bytes of data, an error will be raised.
+     * - `'base64'` returns a tuple whose first element is the data as a base64-encoded string.
+     * - `'base64+zstd'` returns a tuple whose first element is the
+     *   [ZStandard](https://facebook.github.io/zstd/)-compressed data as a base64-encoded string.
+     * - `'jsonParsed'` will cause the server to attempt to process the data using a parser specific
+     *   to each account's owning program. If successful, the parsed data will be returned in the
+     *   response as JSON. Otherwise, the raw account data will be returned in the response as a
+     *   tuple whose first element is a base64-encoded string.
+     */
+    encoding?: 'base58' | 'base64' | 'base64+zstd' | 'jsonParsed';
+    /**
+     * Prevents accessing stale data by enforcing that the RPC node has processed transactions up to
+     * this slot
+     */
+    minContextSlot?: Slot;
+}>;
+
+type GetTokenAccountsByDelegateApiSliceableCommonConfig = Readonly<{
+    /**
+     * Define which slice of the accounts' data you want the RPC to return.
+     *
+     * Use this to save network bandwidth and encoding time when you do not need the entire buffer.
+     *
+     * Data slicing is only available for `"base58"`, `"base64"`, and `"base64+zstd"` encodings.
+     */
+    dataSlice?: DataSlice;
+}>;
+
+export type GetTokenAccountsByDelegateApi = {
+    /**
+     * Returns all SPL Token accounts for which transfer authority over some quantity of tokens has
+     * been delegated to the supplied address.
+     *
+     * The accounts' data will be returned in the response as a tuple whose first element is a
+     * base64-encoded string.
+     *
+     * @param filter Limits the results to either token accounts associated with a particular mint,
+     * or token accounts owned by a certain token program.
+     *
+     * {@label base64}
+     * @see https://solana.com/docs/rpc/http/gettokenaccountsbydelegate
+     */
+    getTokenAccountsByDelegate(
+        delegate: Address,
+        filter: AccountsFilter,
+        config: GetTokenAccountsByDelegateApiCommonConfig &
+            GetTokenAccountsByDelegateApiSliceableCommonConfig &
+            Readonly<{
+                encoding: 'base64';
+            }>,
+    ): SolanaRpcResponse<GetTokenAccountsByDelegateResponse<AccountInfoWithBase64EncodedData>>;
+    /**
+     * Returns all SPL Token accounts for which transfer authority over some quantity of tokens has
+     * been delegated to the supplied address.
+     *
+     * The accounts' data will first be compressed using
+     * [ZStandard](https://facebook.github.io/zstd/) and the result will be returned in the response
+     * as a tuple whose first element is a base64-encoded string.
+     *
+     * @param filter Limits the results to either token accounts associated with a particular mint,
+     * or token accounts owned by a certain token program.
+     *
+     * {@label base64-zstd-compressed}
+     * @see https://solana.com/docs/rpc/http/gettokenaccountsbydelegate
+     */
+    getTokenAccountsByDelegate(
+        delegate: Address,
+        filter: AccountsFilter,
+        config: GetTokenAccountsByDelegateApiCommonConfig &
+            GetTokenAccountsByDelegateApiSliceableCommonConfig &
+            Readonly<{
+                encoding: 'base64+zstd';
+            }>,
+    ): SolanaRpcResponse<GetTokenAccountsByDelegateResponse<AccountInfoWithBase64EncodedZStdCompressedData>>;
+    /**
+     * Returns all SPL Token accounts for which transfer authority over some quantity of tokens has
+     * been delegated to the supplied address.
+     *
+     * The server will attempt to process the accounts' data using a parser specific to each
+     * account's owning token program.
+     *
+     * @param filter Limits the results to either token accounts associated with a particular mint,
+     * or token accounts owned by a certain token program.
+     *
+     * {@label parsed}
+     * @see https://solana.com/docs/rpc/http/gettokenaccountsbydelegate
+     */
+    getTokenAccountsByDelegate(
+        delegate: Address,
+        filter: AccountsFilter,
+        config: GetTokenAccountsByDelegateApiCommonConfig &
+            Readonly<{
+                encoding: 'jsonParsed';
+            }>,
+    ): SolanaRpcResponse<GetTokenAccountsByDelegateResponse<TokenAccountInfoWithJsonData>>;
+    /**
+     * Returns all SPL Token accounts for which transfer authority over some quantity of tokens has
+     * been delegated to the supplied address.
+     *
+     * The accounts' data will be returned in the response as a tuple whose first element is a
+     * base58-encoded string. If any account contains more than 129 bytes of data, this method will
+     * raise an error.
+     *
+     * @param filter Limits the results to either token accounts associated with a particular mint,
+     * or token accounts owned by a certain token program.
+     *
+     * {@label base58}
+     * @see https://solana.com/docs/rpc/http/gettokenaccountsbydelegate
+     */
+    getTokenAccountsByDelegate(
+        delegate: Address,
+        filter: AccountsFilter,
+        config: GetTokenAccountsByDelegateApiCommonConfig &
+            GetTokenAccountsByDelegateApiSliceableCommonConfig &
+            Readonly<{
+                encoding: 'base58';
+            }>,
+    ): SolanaRpcResponse<GetTokenAccountsByDelegateResponse<AccountInfoWithBase58EncodedData>>;
+    /**
+     * Returns all SPL Token accounts for which transfer authority over some quantity of tokens has
+     * been delegated to the supplied address.
+     *
+     * The accounts' data will be returned in the response as a base58-encoded string. If any
+     * account contains more than 129 bytes of data, this method will raise an error.
+     *
+     * @param filter Limits the results to either token accounts associated with a particular mint,
+     * or token accounts owned by a certain token program.
+     *
+     * {@label base58-legacy}
+     * @see https://solana.com/docs/rpc/http/gettokenaccountsbydelegate
+     */
+    getTokenAccountsByDelegate(
+        delegate: Address,
+        filter: AccountsFilter,
+        config?: GetTokenAccountsByDelegateApiCommonConfig & GetTokenAccountsByDelegateApiSliceableCommonConfig,
+    ): SolanaRpcResponse<GetTokenAccountsByDelegateResponse<AccountInfoWithBase58Bytes>>;
+};

package/src/getTokenAccountsByOwner.ts

@@ -0,0 +1,190 @@
+import type { Address } from '@solana/addresses';
+import type { JsonParsedTokenAccount } from '@solana/rpc-parsed-types';
+import type {
+    AccountInfoBase,
+    AccountInfoWithBase58Bytes,
+    AccountInfoWithBase58EncodedData,
+    AccountInfoWithBase64EncodedData,
+    AccountInfoWithBase64EncodedZStdCompressedData,
+    AccountInfoWithPubkey,
+    Commitment,
+    DataSlice,
+    Slot,
+    SolanaRpcResponse,
+} from '@solana/rpc-types';
+
+type TokenAccountInfoWithJsonData = Readonly<{
+    data: Readonly<{
+        parsed: {
+            info: JsonParsedTokenAccount;
+            type: 'account';
+        };
+        /** Name of the program that owns this account. */
+        program: Address;
+        space: bigint;
+    }>;
+}>;
+
+type GetTokenAccountsByOwnerResponse<T> = readonly AccountInfoWithPubkey<AccountInfoBase & T>[];
+
+type MintFilter = Readonly<{
+    /** This filter matches when the token account's mint is equal to the address supplied. */
+    mint: Address;
+}>;
+
+type ProgramIdFilter = Readonly<{
+    /**
+     * This filter matches when the token account's token program address is equal to the address
+     * supplied.
+     */
+    programId: Address;
+}>;
+
+type AccountsFilter = MintFilter | ProgramIdFilter;
+
+type GetTokenAccountsByOwnerApiCommonConfig = Readonly<{
+    /**
+     * Fetch the details of the 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;
+    /**
+     * Determines how the accounts' data should be encoded in the response.
+     *
+     * - `'base58'` returns a tuple whose first element is the data as a base58-encoded string. If
+     *   the account contains more than 129 bytes of data, an error will be raised.
+     * - `'base64'` returns a tuple whose first element is the data as a base64-encoded string.
+     * - `'base64+zstd'` returns a tuple whose first element is the
+     *   [ZStandard](https://facebook.github.io/zstd/)-compressed data as a base64-encoded string.
+     * - `'jsonParsed'` will cause the server to attempt to process the data using a parser specific
+     *   to each account's owning program. If successful, the parsed data will be returned in the
+     *   response as JSON. Otherwise, the raw account data will be returned in the response as a
+     *   tuple whose first element is a base64-encoded string.
+     */
+    encoding?: 'base58' | 'base64' | 'base64+zstd' | 'jsonParsed';
+    /**
+     * Prevents accessing stale data by enforcing that the RPC node has processed transactions up to
+     * this slot
+     */
+    minContextSlot?: Slot;
+}>;
+
+type GetTokenAccountsByOwnerApiSliceableCommonConfig = Readonly<{
+    /**
+     * Define which slice of the accounts' data you want the RPC to return.
+     *
+     * Use this to save network bandwidth and encoding time when you do not need the entire buffer.
+     *
+     * Data slicing is only available for `"base58"`, `"base64"`, and `"base64+zstd"` encodings.
+     */
+    dataSlice?: DataSlice;
+}>;
+export type GetTokenAccountsByOwnerApi = {
+    /**
+     * Returns all SPL Token accounts owned by the supplied address.
+     *
+     * The accounts' data will be returned in the response as a tuple whose first element is a
+     * base64-encoded string.
+     *
+     * @param filter Limits the results to either token accounts associated with a particular mint,
+     * or token accounts owned by a certain token program.
+     *
+     * {@label base64}
+     * @see https://solana.com/docs/rpc/http/gettokenaccountsbyowner
+     */
+    getTokenAccountsByOwner(
+        owner: Address,
+        filter: AccountsFilter,
+        config: GetTokenAccountsByOwnerApiCommonConfig &
+            GetTokenAccountsByOwnerApiSliceableCommonConfig &
+            Readonly<{
+                encoding: 'base64';
+            }>,
+    ): SolanaRpcResponse<GetTokenAccountsByOwnerResponse<AccountInfoWithBase64EncodedData>>;
+    /**
+     * Returns all SPL Token accounts owned by the supplied address.
+     *
+     * The accounts' data will first be compressed using
+     * [ZStandard](https://facebook.github.io/zstd/) and the result will be returned in the response
+     * as a tuple whose first element is a base64-encoded string.
+     *
+     * @param filter Limits the results to either token accounts associated with a particular mint,
+     * or token accounts owned by a certain token program.
+     *
+     * {@label base64-zstd-compressed}
+     * @see https://solana.com/docs/rpc/http/gettokenaccountsbyowner
+     */
+    getTokenAccountsByOwner(
+        owner: Address,
+        filter: AccountsFilter,
+        config: GetTokenAccountsByOwnerApiCommonConfig &
+            GetTokenAccountsByOwnerApiSliceableCommonConfig &
+            Readonly<{
+                encoding: 'base64+zstd';
+            }>,
+    ): SolanaRpcResponse<GetTokenAccountsByOwnerResponse<AccountInfoWithBase64EncodedZStdCompressedData>>;
+    /**
+     * Returns all SPL Token accounts owned by the supplied address.
+     *
+     * The server will attempt to process the accounts' data using a parser specific to each
+     * account's owning token program.
+     *
+     * @param filter Limits the results to either token accounts associated with a particular mint,
+     * or token accounts owned by a certain token program.
+     *
+     * {@label parsed}
+     * @see https://solana.com/docs/rpc/http/gettokenaccountsbyowner
+     */
+    getTokenAccountsByOwner(
+        owner: Address,
+        filter: AccountsFilter,
+        config: GetTokenAccountsByOwnerApiCommonConfig &
+            Readonly<{
+                encoding: 'jsonParsed';
+            }>,
+    ): SolanaRpcResponse<GetTokenAccountsByOwnerResponse<TokenAccountInfoWithJsonData>>;
+    /**
+     * Returns all SPL Token accounts owned by the supplied address.
+     *
+     * The accounts' data will be returned in the response as a tuple whose first element is a
+     * base58-encoded string. If any account contains more than 129 bytes of data, this method will
+     * raise an error.
+     *
+     * @param filter Limits the results to either token accounts associated with a particular mint,
+     * or token accounts owned by a certain token program.
+     *
+     * {@label base58}
+     * @see https://solana.com/docs/rpc/http/gettokenaccountsbyowner
+     */
+    getTokenAccountsByOwner(
+        owner: Address,
+        filter: AccountsFilter,
+        config: GetTokenAccountsByOwnerApiCommonConfig &
+            GetTokenAccountsByOwnerApiSliceableCommonConfig &
+            Readonly<{
+                encoding: 'base58';
+            }>,
+    ): SolanaRpcResponse<GetTokenAccountsByOwnerResponse<AccountInfoWithBase58EncodedData>>;
+    /**
+     * Returns all SPL Token accounts owned by the supplied address.
+     *
+     * The accounts' data will be returned in the response as a base58-encoded string. If any
+     * account contains more than 129 bytes of data, this method will raise an error.
+     *
+     * @param filter Limits the results to either token accounts associated with a particular mint,
+     * or token accounts owned by a certain token program.
+     *
+     * {@label base58-legacy}
+     * @see https://solana.com/docs/rpc/http/gettokenaccountsbyowner
+     */
+    getTokenAccountsByOwner(
+        owner: Address,
+        filter: AccountsFilter,
+        config?: GetTokenAccountsByOwnerApiCommonConfig & GetTokenAccountsByOwnerApiSliceableCommonConfig,
+    ): SolanaRpcResponse<GetTokenAccountsByOwnerResponse<AccountInfoWithBase58Bytes>>;
+};

package/src/getTokenLargestAccounts.ts

@@ -0,0 +1,29 @@
+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>;
+};

package/src/getTokenSupply.ts

@@ -0,0 +1,26 @@
+import type { Address } from '@solana/addresses';
+import type { Commitment, SolanaRpcResponse, TokenAmount } from '@solana/rpc-types';
+
+type GetTokenSupplyApiResponse = TokenAmount;
+
+export type GetTokenSupplyApi = {
+    /**
+     * Returns the total supply of the token mint supplied.
+     *
+     * @see https://solana.com/docs/rpc/http/gettokensupply
+     */
+    getTokenSupply(
+        tokenMint: Address,
+        config?: Readonly<{
+            /**
+             * Fetch the supply 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<GetTokenSupplyApiResponse>;
+};