@coinbase/cdp-sdk 1.24.0 → 1.26.0

package/client/solana/solana.types.ts

@@ -1,5 +1,9 @@
 import { Account, SolanaAccount } from "../../accounts/solana/types.js";
-import { OpenApiSolanaMethods, UpdateSolanaAccountBody } from "../../openapi-client/index.js";
+import {
+  ListSolanaTokenBalancesNetwork,
+  OpenApiSolanaMethods,
+  UpdateSolanaAccountBody,
+} from "../../openapi-client/index.js";
 
 /**
  * The SolanaClient type, where all OpenApiSolanaMethods methods are wrapped.
@@ -18,6 +22,7 @@ export type SolanaClientInterface = Omit<
   | "exportSolanaAccount" // mapped to exportAccount
   | "exportSolanaAccountByName" // mapped to exportAccount
   | "importSolanaAccount" // mapped to importAccount
+  | "listSolanaTokenBalances" // mapped to listTokenBalances
 > & {
   createAccount: (options: CreateAccountOptions) => Promise<Account>;
   exportAccount: (options: ExportAccountOptions) => Promise<string>;
@@ -29,6 +34,7 @@ export type SolanaClientInterface = Omit<
   requestFaucet: (options: RequestFaucetOptions) => Promise<SignatureResult>;
   signMessage: (options: SignMessageOptions) => Promise<SignatureResult>;
   signTransaction: (options: SignTransactionOptions) => Promise<SignatureResult>;
+  listTokenBalances: (options: ListTokenBalancesOptions) => Promise<ListTokenBalancesResult>;
 };
 
 /**
@@ -164,3 +170,56 @@ export interface ImportAccountOptions {
   /** The private key of the account - can be a base58 encoded string or raw bytes. */
   privateKey: string | Uint8Array;
 }
+
+/**
+ * Options for listing Solana token balances.
+ */
+export interface ListTokenBalancesOptions {
+  /** The address of the account. */
+  address: string;
+  /** The network to list token balances for. */
+  network?: ListSolanaTokenBalancesNetwork;
+  /** The page size. */
+  pageSize?: number;
+  /** The page token. */
+  pageToken?: string;
+}
+
+export interface SolanaTokenAmount {
+  /** The amount of the token. */
+  amount: bigint;
+  /** The number of decimals in the token. */
+  decimals: number;
+}
+
+export interface SolanaToken {
+  /** The token address. */
+  mintAddress: string;
+  /** The token name. */
+  name?: string;
+  /** The token symbol. */
+  symbol?: string;
+}
+
+/**
+ * A Solana token balance.
+ */
+export interface SolanaTokenBalance {
+  /** The amount of the token. */
+  amount: SolanaTokenAmount;
+  /** The token. */
+  token: SolanaToken;
+}
+
+/**
+ * The result of listing Solana token balances.
+ */
+export interface ListTokenBalancesResult {
+  /** The token balances. */
+  balances: SolanaTokenBalance[];
+  /**
+   * The next page token to paginate through the token balances.
+   * If undefined, there are no more token balances to paginate through.
+   */
+  nextPageToken?: string;
+}

package/openapi-client/generated/coinbaseDeveloperPlatformAPIs.schemas.ts

@@ -1432,6 +1432,59 @@ Account names are guaranteed to be unique across all Solana accounts in the deve
   updatedAt?: string;
 }
 
+/**
+ * The name of the supported Solana networks in human-readable format.
+ */
+export type ListSolanaTokenBalancesNetwork =
+  (typeof ListSolanaTokenBalancesNetwork)[keyof typeof ListSolanaTokenBalancesNetwork];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const ListSolanaTokenBalancesNetwork = {
+  solana: "solana",
+  "solana-devnet": "solana-devnet",
+} as const;
+
+/**
+ * Amount of a given Solana token.
+ */
+export interface SolanaTokenAmount {
+  /**
+   * The amount is denominated in the smallest indivisible unit of the token. For SOL, the smallest indivisible unit is lamports (10^-9 SOL). For SPL tokens, the smallest unit is defined by the token's decimals configuration.
+   * @pattern ^[0-9]+$
+   */
+  amount: string;
+  /** 'decimals' is the exponential value N that satisfies the equation `amount * 10^-N = standard_denomination`. The standard denomination is the most commonly used denomination for the token.
+- For native SOL, `decimals` is 9 (1 SOL = 10^9 lamports). - For SPL tokens, `decimals` is defined in the token's mint configuration. */
+  decimals: number;
+}
+
+/**
+ * General information about a Solana token. Includes the mint address, and other identifying information.
+ */
+export interface SolanaToken {
+  /** The symbol of this token (ex: SOL, USDC, RAY).
+The token symbol is not unique. It is possible for two different tokens to have the same symbol.
+For the native SOL token, this symbol is "SOL". For SPL tokens, this symbol is defined in the token's metadata.
+Not all tokens have a symbol. This field will only be populated when the token has metadata available. */
+  symbol?: string;
+  /** The name of this token (ex: "Solana", "USD Coin", "Raydium").
+The token name is not unique. It is possible for two different tokens to have the same name.
+For the native SOL token, this name is "Solana". For SPL tokens, this name is defined in the token's metadata.
+Not all tokens have a name. This field will only be populated when the token has metadata available. */
+  name?: string;
+  /**
+   * The mint address of the token.
+For native SOL, the mint address is `So11111111111111111111111111111111111111111`. For SPL tokens, this is the mint address where the token is defined.
+   * @pattern ^[1-9A-HJ-NP-Za-km-z]{32,44}$
+   */
+  mintAddress: string;
+}
+
+export interface SolanaTokenBalance {
+  amount: SolanaTokenAmount;
+  token: SolanaToken;
+}
+
 /**
  * The action of the payment method.
  */
@@ -2226,6 +2279,24 @@ export type RequestSolanaFaucet200 = {
   transactionSignature: string;
 };
 
+export type ListSolanaTokenBalancesParams = {
+  /**
+   * The number of balances to return per page.
+   */
+  pageSize?: number;
+  /**
+   * The token for the next page of balances. Will be empty if there are no more balances to fetch.
+   */
+  pageToken?: string;
+};
+
+export type ListSolanaTokenBalances200AllOf = {
+  /** The list of Solana token balances. */
+  balances: SolanaTokenBalance[];
+};
+
+export type ListSolanaTokenBalances200 = ListSolanaTokenBalances200AllOf & ListResponse;
+
 export type GetCryptoRailsParams = {
   /**
    * Comma separated list of networks to filter the rails by.

package/openapi-client/generated/index.msw.ts

@@ -6,3 +6,4 @@ export * from "./faucets/faucets.msw.js";
 export * from "./payments-alpha/payments-alpha.msw.js";
 export * from "./policy-engine/policy-engine.msw.js";
 export * from "./solana-accounts/solana-accounts.msw.js";
+export * from "./solana-token-balances/solana-token-balances.msw.js";

package/openapi-client/generated/solana-token-balances/solana-token-balances.msw.ts

@@ -0,0 +1,55 @@
+/**
+ * Generated by orval v7.6.0 🍺
+ * Do not edit manually.
+ * Coinbase Developer Platform APIs
+ * The Coinbase Developer Platform APIs - leading the world's transition onchain.
+ * OpenAPI spec version: 2.0.0
+ */
+import { faker } from "@faker-js/faker";
+
+import { HttpResponse, delay, http } from "msw";
+
+import type { ListSolanaTokenBalances200 } from "../coinbaseDeveloperPlatformAPIs.schemas.js";
+
+export const getListSolanaTokenBalancesResponseMock = (): ListSolanaTokenBalances200 => ({
+  ...{
+    balances: Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(
+      () => ({
+        amount: {
+          amount: faker.helpers.fromRegExp("^[0-9]+$"),
+          decimals: faker.number.int({ min: undefined, max: undefined }),
+        },
+        token: {
+          symbol: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+          name: faker.helpers.arrayElement([faker.string.alpha(20), undefined]),
+          mintAddress: faker.helpers.fromRegExp("^[1-9A-HJ-NP-Za-km-z]{32,44}$"),
+        },
+      }),
+    ),
+  },
+  ...{ nextPageToken: faker.helpers.arrayElement([faker.string.alpha(20), undefined]) },
+});
+
+export const getListSolanaTokenBalancesMockHandler = (
+  overrideResponse?:
+    | ListSolanaTokenBalances200
+    | ((
+        info: Parameters<Parameters<typeof http.get>[1]>[0],
+      ) => Promise<ListSolanaTokenBalances200> | ListSolanaTokenBalances200),
+) => {
+  return http.get("*/v2/solana/token-balances/:network/:address", async info => {
+    await delay(0);
+
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse !== undefined
+          ? typeof overrideResponse === "function"
+            ? await overrideResponse(info)
+            : overrideResponse
+          : getListSolanaTokenBalancesResponseMock(),
+      ),
+      { status: 200, headers: { "Content-Type": "application/json" } },
+    );
+  });
+};
+export const getSolanaTokenBalancesMock = () => [getListSolanaTokenBalancesMockHandler()];

package/openapi-client/generated/solana-token-balances/solana-token-balances.ts

@@ -0,0 +1,37 @@
+/**
+ * Generated by orval v7.6.0 🍺
+ * Do not edit manually.
+ * Coinbase Developer Platform APIs
+ * The Coinbase Developer Platform APIs - leading the world's transition onchain.
+ * OpenAPI spec version: 2.0.0
+ */
+import type {
+  ListSolanaTokenBalances200,
+  ListSolanaTokenBalancesNetwork,
+  ListSolanaTokenBalancesParams,
+} from "../coinbaseDeveloperPlatformAPIs.schemas.js";
+
+import { cdpApiClient } from "../../cdpApiClient.js";
+
+type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
+
+/**
+ * Lists the token balances of a Solana address on a given network. The balances include SPL tokens and the native SOL token. The response is paginated, and by default, returns 20 balances per page.
+
+**Note:** This endpoint is still under development and does not yet provide strong availability or freshness guarantees. Freshness and availability of new token balances will improve over the coming weeks.
+ * @summary List Solana token balances
+ */
+export const listSolanaTokenBalances = (
+  network: ListSolanaTokenBalancesNetwork,
+  address: string,
+  params?: ListSolanaTokenBalancesParams,
+  options?: SecondParameter<typeof cdpApiClient>,
+) => {
+  return cdpApiClient<ListSolanaTokenBalances200>(
+    { url: `/v2/solana/token-balances/${network}/${address}`, method: "GET", params },
+    options,
+  );
+};
+export type ListSolanaTokenBalancesResult = NonNullable<
+  Awaited<ReturnType<typeof listSolanaTokenBalances>>
+>;

package/openapi-client/index.ts

@@ -4,6 +4,7 @@ export * from "./generated/evm-smart-accounts/evm-smart-accounts.js";
 export * from "./generated/evm-swaps/evm-swaps.js";
 export * from "./generated/evm-token-balances/evm-token-balances.js";
 export * from "./generated/solana-accounts/solana-accounts.js";
+export * from "./generated/solana-token-balances/solana-token-balances.js";
 export * from "./generated/faucets/faucets.js";
 export * from "./generated/policy-engine/policy-engine.js";
 export * from "./generated/payments-alpha/payments-alpha.js";
@@ -17,6 +18,7 @@ import * as faucets from "./generated/faucets/faucets.js";
 import * as payments from "./generated/payments-alpha/payments-alpha.js";
 import * as policies from "./generated/policy-engine/policy-engine.js";
 import * as solana from "./generated/solana-accounts/solana-accounts.js";
+import * as solanaTokenBalances from "./generated/solana-token-balances/solana-token-balances.js";
 
 export const CdpOpenApiClient = {
   ...evm,
@@ -24,6 +26,7 @@ export const CdpOpenApiClient = {
   ...evmSwaps,
   ...evmTokenBalances,
   ...solana,
+  ...solanaTokenBalances,
   ...faucets,
   ...policies,
   ...payments,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coinbase/cdp-sdk",
-  "version": "1.24.0",
+  "version": "1.26.0",
   "description": "SDK for interacting with the Coinbase Developer Platform Wallet API",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",

package/version.ts

@@ -1 +1 @@
-export const version = "1.24.0";
+export const version = "1.26.0";