Getting Started with User-Controlled Wallets - Node.js

Use the Node.js SDK to interact with Circle's User-Controlled Wallet APIs, which allow you to embed secure wallets in your applications and create blockchain transactions using the Developer Services platform.

This page provides short examples of how to install and use the User-Controlled Wallets SDK. For complete examples, see the Sample Projects page. For more information see the User-Controlled Wallets documentation.

To successfully use the User-Controlled Wallets SDK, you need the following:

• Have Node.js and npm installed. Circle recommends Node 16 or higher.
• Have an active Circle Developer Account.
• Generate an API key to use in requests to the Circle API.

Use the following commands to install the SDK. You can view the package information on the npm site.

npm install @circle-fin/user-controlled-wallets --save

To start using the SDK, you first need to configure a client. Import the initiateUserControlledWalletsClient factory from the SDK, and then initialize the client using your API key.

The following example shows how to import the client and configure it to use your API key:

const {
  initiateUserControlledWalletsClient,
} = require('@circle-fin/user-controlled-wallets')
const client = initiateUserControlledWalletsClient({
  apiKey: '<your-api-key>',
})

The following example shows how to create a transaction using the client:

const response = await client.createTransaction({
  userToken: 'dummy-user-token',
  amounts: ['0.01'],
  destinationAddress: '0xa51c9c604b79a0fadbfed35dd576ca1bce71da0a',
  tokenId: '738c8a6d-8896-46d1-b2cb-083600c1c69b',
  walletId: 'a635d679-4207-4e37-b12e-766afb9b3892',
  fee: {
    type: 'level',
    config: {
      feeLevel: 'HIGH',
    },
  },
})
console.log(response.data?.challengeId)

The client for the User-Controlled Wallets SDK accepts the following configuration parameters: