commerce-node

The Coinbase Commerce Node SDK provides a convenient way to interact with the Coinbase Commerce API.

Installation

1# Using yarn
2yarn add commerce-node
3
4# Using npm
5npm install commerce-node

Configuration

Create a new SDK instance with your API credentials:

1import { CommerceSDK } from 'commerce-node';
2
3const commerce = new CommerceSDK({
4  apiKey: 'YOUR_API_KEY', // Required
5  baseUrl: 'YOUR_API_URL', // Optional, defaults to https://api.commerce.coinbase.com
6  baseRpcUrl: 'RPC_URL', // Optional, needed for payments
7});

See SDKConfig for possible configuration parameters.

Usage

Creating and Hydrating a Charge

1// Create a new charge
2const { data: newCharge } = await commerce.charges.createCharge({
3  pricing_type: 'fixed_price',
4  local_price: {
5    amount: '100.00',
6    currency: 'USD',
7  },
8});
9
10// Hydrate the charge with Web3 data
11const { data: hydratedCharge } = await commerce.charges.hydrateCharge(
12  newCharge.data.id,
13  {
14    sender: '0x5770D0616b99E89817A8D9BDe61fddc3A941BdF7',
15    chain_id: 1,
16  },
17);
18
19// Get charge
20const { data: charges } = await sdk.charges.getCharges();

See examples folder for a full list.

SDK docs: https://nicommerce.github.io/commerce-node/

Error Handling

The SDK throws SDKError instances for various error cases:

1try {
2  const { data: charge } = await commerce.charges.createCharge({
3    // ... charge details
4  });
5} catch (error) {
6  if (error instanceof SDKError) {
7    console.error(`Error type: ${error.type}`);
8    console.error(`Message: ${error.message}`);
9  }
10}

Error types include:

• AUTHENTICATION: API key issues
• NETWORK: Network connectivity problems
• VALIDATION: Invalid request parameters
• RATE_LIMIT: Too many requests
• SERVER: Server-side errors
• UNKNOWN: Unexpected errors

Development

1corepack enable
2# Install dependencies
3yarn install
4
5# Build the SDK
6yarn build
7
8# Run tests
9yarn test
10
11# Run integration tests
12yarn test:integration

Docs

To generate SDK docs:

1yarn run docs

License

MIT

Documentation

SKD Docs

SDK docs.

Api Docs

For detailed API documentation, visit the Coinbase Commerce API Reference.

Known Issues

There is a known issue with viem. The temporary workaround is to add the following to your tsconfig.sjon

1"skipLibCheck": true