Class SolanaClient

The namespace containing all Solana methods.

Implements

Constructors

constructor

Methods

createAccount exportAccount getAccount getOrCreateAccount listAccounts requestFaucet signMessage signTransaction updateAccount

Constructors

constructor

Methods

createAccount

  • createAccount(
        options?: CreateAccountOptions,
    ): Promise<
        {
            address: string;
            createdAt?: string;
            name?: string;
            policies?: string[];
            requestFaucet: (
                options: Omit<RequestFaucetOptions, "address">,
            ) => Promise<SignatureResult>;
            signMessage: (
                options: Omit<SignMessageOptions, "address">,
            ) => Promise<SignatureResult>;
            signTransaction: (
                options: Omit<SignTransactionOptions, "address">,
            ) => Promise<SignatureResult>;
            transfer: (
                options: Omit<TransferOptions, "from">,
            ) => Promise<SignatureResult>;
            updatedAt?: string;
        },
    >

    Creates a new Solana account.

    Parameters

    • options: CreateAccountOptions = {}

      Parameters for creating the Solana account.

      Options for creating a Solana account.

      • OptionalaccountPolicy?: string

        The policy ID to apply to the account.

      • OptionalidempotencyKey?: string

        The idempotency key.

      • Optionalname?: string

        The name of the account.

    Returns Promise<
        {
            address: string;
            createdAt?: string;
            name?: string;
            policies?: string[];
            requestFaucet: (
                options: Omit<RequestFaucetOptions, "address">,
            ) => Promise<SignatureResult>;
            signMessage: (
                options: Omit<SignMessageOptions, "address">,
            ) => Promise<SignatureResult>;
            signTransaction: (
                options: Omit<SignTransactionOptions, "address">,
            ) => Promise<SignatureResult>;
            transfer: (
                options: Omit<TransferOptions, "from">,
            ) => Promise<SignatureResult>;
            updatedAt?: string;
        },
    >

    A promise that resolves to the newly created account.

    Example: **Without arguments**

             const account = await cdp.solana.createAccount();

    Example: **With a name**

             const account = await cdp.solana.createAccount({ name: "MyAccount" });

    Example: **With an idempotency key**

             const idempotencyKey = uuidv4();

             // First call
             await cdp.solana.createAccount({ idempotencyKey });

             // Second call with the same idempotency key will return the same account
             await cdp.solana.createAccount({ idempotencyKey });

exportAccount

  • exportAccount(options: ExportAccountOptions): Promise<string>

    Exports a CDP Solana account's private key. It is important to store the private key in a secure place after it's exported.

    Parameters

    • options: ExportAccountOptions

      Parameters for exporting the Solana account.

      Options for exporting a Solana account.

      • Optionaladdress?: string

        The address of the account.

      • OptionalidempotencyKey?: string

        The idempotency key.

      • Optionalname?: string

        The name of the account.

    Returns Promise<string>

    A promise that resolves to the exported account's full 64-byte private key as a base58 encoded string.

    Example: **With an address**

    const privateKey = await cdp.solana.exportAccount({
      address: "1234567890123456789012345678901234567890",
    });

    Example: **With a name**

    const privateKey = await cdp.solana.exportAccount({
      name: "MyAccount",
    });

getAccount

  • getAccount(
        options: GetAccountOptions,
    ): Promise<
        {
            address: string;
            createdAt?: string;
            name?: string;
            policies?: string[];
            requestFaucet: (
                options: Omit<RequestFaucetOptions, "address">,
            ) => Promise<SignatureResult>;
            signMessage: (
                options: Omit<SignMessageOptions, "address">,
            ) => Promise<SignatureResult>;
            signTransaction: (
                options: Omit<SignTransactionOptions, "address">,
            ) => Promise<SignatureResult>;
            transfer: (
                options: Omit<TransferOptions, "from">,
            ) => Promise<SignatureResult>;
            updatedAt?: string;
        },
    >

    Gets a Solana account by its address.

    Parameters

    • options: GetAccountOptions

      Parameters for getting the Solana account. Either address or name must be provided. If both are provided, lookup will be done by address and name will be ignored.

      Options for getting a Solana account.

      • Optionaladdress?: string

        The address of the account.

      • Optionalname?: string

        The name of the account.

    Returns Promise<
        {
            address: string;
            createdAt?: string;
            name?: string;
            policies?: string[];
            requestFaucet: (
                options: Omit<RequestFaucetOptions, "address">,
            ) => Promise<SignatureResult>;
            signMessage: (
                options: Omit<SignMessageOptions, "address">,
            ) => Promise<SignatureResult>;
            signTransaction: (
                options: Omit<SignTransactionOptions, "address">,
            ) => Promise<SignatureResult>;
            transfer: (
                options: Omit<TransferOptions, "from">,
            ) => Promise<SignatureResult>;
            updatedAt?: string;
        },
    >

    A promise that resolves to the account.

    Example: **Get an account by address**

             const account = await cdp.solana.getAccount({
               address: "1234567890123456789012345678901234567890",
             });

    Example: **Get an account by name**

             const account = await cdp.solana.getAccount({
               name: "MyAccount",
             });

getOrCreateAccount

  • getOrCreateAccount(
        options: GetOrCreateAccountOptions,
    ): Promise<
        {
            address: string;
            createdAt?: string;
            name?: string;
            policies?: string[];
            requestFaucet: (
                options: Omit<RequestFaucetOptions, "address">,
            ) => Promise<SignatureResult>;
            signMessage: (
                options: Omit<SignMessageOptions, "address">,
            ) => Promise<SignatureResult>;
            signTransaction: (
                options: Omit<SignTransactionOptions, "address">,
            ) => Promise<SignatureResult>;
            transfer: (
                options: Omit<TransferOptions, "from">,
            ) => Promise<SignatureResult>;
            updatedAt?: string;
        },
    >

    Gets a Solana account by its address.

    Parameters

    • options: GetOrCreateAccountOptions

      Parameters for getting or creating the Solana account.

      Options for getting a Solana account.

      • name: string

        The name of the account.

    Returns Promise<
        {
            address: string;
            createdAt?: string;
            name?: string;
            policies?: string[];
            requestFaucet: (
                options: Omit<RequestFaucetOptions, "address">,
            ) => Promise<SignatureResult>;
            signMessage: (
                options: Omit<SignMessageOptions, "address">,
            ) => Promise<SignatureResult>;
            signTransaction: (
                options: Omit<SignTransactionOptions, "address">,
            ) => Promise<SignatureResult>;
            transfer: (
                options: Omit<TransferOptions, "from">,
            ) => Promise<SignatureResult>;
            updatedAt?: string;
        },
    >

    A promise that resolves to the account.

    Example

    const account = await cdp.solana.getOrCreateAccount({
      name: "MyAccount",
    });

listAccounts

  • listAccounts(options?: ListAccountsOptions): Promise<ListAccountsResult>

    Lists all Solana accounts.

    Parameters

    • options: ListAccountsOptions = {}

      Parameters for listing the Solana accounts.

      Options for listing Solana accounts.

      • OptionalpageSize?: number

        The page size.

      • OptionalpageToken?: string

        The page token.

    Returns Promise<ListAccountsResult>

    A promise that resolves to an array of Solana account instances.

    Example: **Without arguments**

             const accounts = await cdp.solana.listAccounts();

    Example: **With pagination**

             let page = await cdp.solana.listAccounts();

             while (page.nextPageToken) {
               page = await cdp.solana.listAccounts({ pageToken: page.nextPageToken });
             }

             page.accounts.forEach(account => console.log(account));
             ```
    }

requestFaucet

  • requestFaucet(options: RequestFaucetOptions): Promise<SignatureResult>

    Requests funds from a Solana faucet.

    Parameters

    • options: RequestFaucetOptions

      Parameters for requesting funds from the Solana faucet.

      Options for requesting funds from a Solana faucet.

      • address: string

        The address of the account.

      • OptionalidempotencyKey?: string

        The idempotency key.

      • token: "usdc" | "sol"

        The token to request funds for.

    Returns Promise<SignatureResult>

    A promise that resolves to the transaction signature.

    Example

             const signature = await cdp.solana.requestFaucet({
               address: "1234567890123456789012345678901234567890",
               token: "sol",
             });

signMessage

  • signMessage(options: SignMessageOptions): Promise<SignatureResult>

    Signs a message.

    Parameters

    • options: SignMessageOptions

      Parameters for signing the message.

      Options for signing a Solana message.

      • address: string

        The address of the account.

      • OptionalidempotencyKey?: string

        The idempotency key.

      • message: string

        The message to sign.

    Returns Promise<SignatureResult>

    A promise that resolves to the signature.

    Example

    // Create a Solana account
    const account = await cdp.solana.createAccount();

    // When you want to sign a message, you can do so by address
    const signature = await cdp.solana.signMessage({
      address: account.address,
      message: "Hello, world!",
    });

signTransaction

  • signTransaction(options: SignTransactionOptions): Promise<SignatureResult>

    Signs a transaction.

    Parameters

    • options: SignTransactionOptions

      Parameters for signing the transaction.

      Options for signing a Solana transaction.

      • address: string

        The address of the account.

      • OptionalidempotencyKey?: string

        The idempotency key.

      • transaction: string

        The base64 encoded transaction to sign.

    Returns Promise<SignatureResult>

    A promise that resolves to the signature.

    Example

    // Create a Solana account
    const account = await cdp.solana.createAccount();

    // Add your transaction instructions here
    const transaction = new Transaction()

    // Make sure to set requireAllSignatures to false, since signing will be done through the API
    const serializedTransaction = transaction.serialize({
      requireAllSignatures: false,
    });

    // Base64 encode the serialized transaction
    const transaction = Buffer.from(serializedTransaction).toString("base64");

    // When you want to sign a transaction, you can do so by address and base64 encoded transaction
    const signature = await cdp.solana.signTransaction({
      address: account.address,
      transaction,
    });

updateAccount

  • updateAccount(
        options?: UpdateSolanaAccountOptions,
    ): Promise<
        {
            address: string;
            createdAt?: string;
            name?: string;
            policies?: string[];
            requestFaucet: (
                options: Omit<RequestFaucetOptions, "address">,
            ) => Promise<SignatureResult>;
            signMessage: (
                options: Omit<SignMessageOptions, "address">,
            ) => Promise<SignatureResult>;
            signTransaction: (
                options: Omit<SignTransactionOptions, "address">,
            ) => Promise<SignatureResult>;
            transfer: (
                options: Omit<TransferOptions, "from">,
            ) => Promise<SignatureResult>;
            updatedAt?: string;
        },
    >

    Updates a CDP Solana account.

    Parameters

    • Optionaloptions: UpdateSolanaAccountOptions

      Optional parameters for creating the account.

      Options for creating a SOL server account.

      • address: string

        The address of the account.

      • OptionalidempotencyKey?: string

        The idempotency key.

      • update: UpdateSolanaAccountBody

        The updates to apply to the account

    Returns Promise<
        {
            address: string;
            createdAt?: string;
            name?: string;
            policies?: string[];
            requestFaucet: (
                options: Omit<RequestFaucetOptions, "address">,
            ) => Promise<SignatureResult>;
            signMessage: (
                options: Omit<SignMessageOptions, "address">,
            ) => Promise<SignatureResult>;
            signTransaction: (
                options: Omit<SignTransactionOptions, "address">,
            ) => Promise<SignatureResult>;
            transfer: (
                options: Omit<TransferOptions, "from">,
            ) => Promise<SignatureResult>;
            updatedAt?: string;
        },
    >

    A promise that resolves to the updated account.

    Example: **With a name**

             const account = await cdp.sol.updateAccount({ address: "...", update: { name: "New Name" } });

    Example: **With an account policy**

             const account = await cdp.sol.updateAccount({ address: "...", update: { accountPolicy: "73bcaeeb-d7af-4615-b064-42b5fe83a31e" } });

    Example: **With an idempotency key**

             const idempotencyKey = uuidv4();

             // First call
             await cdp.sol.updateAccount({
               address: "0x...",
               update: { accountPolicy: "73bcaeeb-d7af-4615-b064-42b5fe83a31e" },
               idempotencyKey,
             });

             // Second call with the same idempotency key will not update
             await cdp.sol.updateAccount({
               address: '0x...',
               update: { name: "" },
               idempotencyKey,
             });

Settings

Member Visibility

On This Page

Constructors
Methods