@coinbase/cdp-sdk/accounts/solana/toSolanaAccount.ts

SDK for interacting with the Coinbase Developer Platform Wallet API

import { Account, SolanaAccount } from "./types.js";
import { SolanaQuote } from "../../actions/Quote.js";
import { SolanaFundOptions, fund } from "../../actions/solana/fund/fund.js";
import { SolanaQuoteFundOptions, quoteFund } from "../../actions/solana/fund/quoteFund.js";
import { requestFaucet } from "../../actions/solana/requestFaucet.js";
import { sendTransaction, SendTransactionResult } from "../../actions/solana/sendTransaction.js";
import { signMessage } from "../../actions/solana/signMessage.js";
import { signTransaction, SignTransactionResult } from "../../actions/solana/signTransaction.js";
import { transfer, type TransferOptions } from "../../actions/solana/transfer.js";
import { FundOperationResult } from "../../actions/types.js";
import {
  WaitForFundOperationOptions,
  WaitForFundOperationResult,
  waitForFundOperationReceipt,
} from "../../actions/waitForFundOperationReceipt.js";
import { Analytics } from "../../analytics.js";
import {
  RequestFaucetOptions,
  SendTransactionOptions,
  SignatureResult,
  SignMessageOptions,
  SignTransactionOptions,
} from "../../client/solana/solana.types.js";
import { CdpOpenApiClientType } from "../../openapi-client/index.js";
/**
 * Options for converting a pre-existing EvmAccount to a EvmServerAccount.
 */
export type ToSolanaAccountOptions = {
  /** The Solana account that was previously created. */
  account: Account;
};

/**
 * Creates a Solana account instance with actions from an existing Solana account.
 * Use this to interact with previously deployed Solana accounts, rather than creating new ones.
 *
 * @param {CdpOpenApiClientType} apiClient - The API client.
 * @param {ToSolanaAccountOptions} options - Configuration options.
 * @param {Account} options.account - The Solana account that was previously created.
 * @returns {SolanaAccount} A configured SolanaAccount instance ready for signing.
 */
export function toSolanaAccount(
  apiClient: CdpOpenApiClientType,
  options: ToSolanaAccountOptions,
): SolanaAccount {
  const account: SolanaAccount = {
    address: options.account.address,
    name: options.account.name,
    policies: options.account.policies,
    async requestFaucet(options: Omit<RequestFaucetOptions, "address">): Promise<SignatureResult> {
      Analytics.trackAction({
        action: "request_faucet",
        accountType: "solana",
      });

      return requestFaucet(apiClient, {
        ...options,
        address: account.address,
      });
    },
    async signMessage(options: Omit<SignMessageOptions, "address">): Promise<SignatureResult> {
      Analytics.trackAction({
        action: "sign_message",
        accountType: "solana",
      });

      return signMessage(apiClient, {
        ...options,
        address: account.address,
      });
    },
    async signTransaction(
      options: Omit<SignTransactionOptions, "address">,
    ): Promise<SignTransactionResult> {
      Analytics.trackAction({
        action: "sign_transaction",
        accountType: "solana",
      });

      return signTransaction(apiClient, {
        ...options,
        address: account.address,
      });
    },
    async sendTransaction(
      options: Omit<SendTransactionOptions, "address">,
    ): Promise<SendTransactionResult> {
      Analytics.trackAction({
        action: "send_transaction",
        accountType: "solana",
      });

      return sendTransaction(apiClient, {
        ...options,
      });
    },
    async transfer(options: Omit<TransferOptions, "from">): Promise<SignatureResult> {
      Analytics.trackAction({
        action: "transfer",
        accountType: "solana",
        properties: {
          network: options.network,
        },
      });

      return transfer(apiClient, {
        ...options,
        from: account.address,
      });
    },
    async quoteFund(options: Omit<SolanaQuoteFundOptions, "address">): Promise<SolanaQuote> {
      Analytics.trackAction({
        action: "quote_fund",
        accountType: "solana",
      });

      return quoteFund(apiClient, {
        ...options,
        address: account.address,
      });
    },
    async fund(options: Omit<SolanaFundOptions, "address">): Promise<FundOperationResult> {
      Analytics.trackAction({
        action: "fund",
        accountType: "solana",
      });

      return fund(apiClient, {
        ...options,
        address: account.address,
      });
    },
    async waitForFundOperationReceipt(
      options: WaitForFundOperationOptions,
    ): Promise<WaitForFundOperationResult> {
      Analytics.trackAction({
        action: "wait_for_fund_operation_receipt",
        accountType: "solana",
      });

      return waitForFundOperationReceipt(apiClient, options);
    },
  };

  return account;
}