Node.js Environment Setup for Web3 API Integration

1. Import Essential Node.js Libraries

Begin by importing the necessary Node.js libraries and configuring your environment variables.

const cryptoJS = require('crypto-js'); // Encryption module for secure calculations
const { Web3 } = require('web3'); // Web3 library for Ethereum interactions
const fetch = (...args) =>
  import('node-fetch').then(({ default: fetch }) => fetch(...args)); // HTTP request library

2. Configure Environment Variables

Define core variables for API requests and initialize Web3—a library suite for interacting with Ethereum nodes via HTTP, IPC, or WebSocket.

const apiBaseUrl = 'https://web3.okx.com/'; // Base API endpoint
const web3RpcUrl = 'https://.....pro'; // Ethereum node URL
const privateKey = '0x...xxx'; // Wallet private key (NEVER SHARE)
const chainId = '1'; // Mainnet
const fromTokenAddress = '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee'; // Native token placeholder
const toTokenAddress = '0xdac17f958d2ee523a2206206994597c13d831ec7'; // USDT contract
const userWalletAddress = '0x...35'; // User's wallet address
const secretKey = '31...D2'; // Secured API secret
const apiKey = '42d0fd46-6f11-4681-a64a-9ba17d99d406'; // API key
const passphrase = '*********'; // Key passphrase
const date = new Date();
const timestamp = date.toISOString(); // ISO-formatted timestamp
const web3 = new Web3(new Web3.providers.HttpProvider(web3RpcUrl)); // Web3 instance

3. Create Helper Functions

Build utility functions to streamline API interactions.

// Generate full API request URL
const getRequestUrl = (apiBaseUrl, api, queryParams) => {
  return apiBaseUrl + api + '?' + new URLSearchParams(queryParams).toString();
};
const apiRequestUrl = getRequestUrl(apiBaseUrl, '/swap', swapParams);

4. Construct Header Parameters

Configure standardized headers for API requests. The apiRequestUrl varies per request, while other parameters remain consistent.

const headersParams = {
  'Content-Type': 'application/json',
  'OK-ACCESS-KEY': apiKey,
  'OK-ACCESS-SIGN': cryptoJS.enc.Base64.stringify(
    cryptoJS.HmacSHA256(timestamp + 'GET' + '/api/v5/dex/aggregator/xxx?xxx=xxx', secretKey)
  ),
  'OK-ACCESS-TIMESTAMP': timestamp,
  'OK-ACCESS-PASSPHRASE': passphrase,
};

👉 Explore Web3 API Advanced Features

FAQ Section

Q1: Why is Web3 initialization crucial for this setup?
A1: Web3.js enables direct interaction with Ethereum blockchains, facilitating smart contract calls and transaction management.

Q2: How do I securely store my private key?
A2: Use environment variables (.env files) or hardware security modules (HSMs)—never hardcode keys in repositories.

Q3: What’s the purpose of the OK-ACCESS-SIGN header?
A3: It cryptographically verifies request authenticity using HMAC-SHA256, ensuring tamper-proof API calls.

Q4: Can I use this setup for testnets?
A4: Yes! Replace chainId and web3RpcUrl with testnet values (e.g., 5 for Goerli).

👉 Get Started with OKX Web3 APIs