Getting Started
Last updated
Last updated
In order to use the D8X Node SDK you will need to have TypeScript and Yarn installed:
Install Typescript:
$ npm install -g typescript
$ npm install -g ts-node
You can install the SDK using NPM or Yarn to access the latest stable version of the package, or by cloning the repo in order to have access to experimental and state-of-the art developments in the D8X API. We recommend using Yarn.
Once the SDK is installed, import the modules you need from @d8x/d8x-futures-node-sdk:
Read-only modules, such as MarketData, do not require you to specify a private key and can be instantiated without any additional user-provided data:
Modules that require the user to cryptographically sign, such as AccountTrade that allows you to post orders on the blockchain, do require you to specify your private key. We recommend setting your private key as an environment variable, e.g. in a terminal prompt:
You can then instantiate modules with write-access as follows:
The D8X Node SDK package provides default configuration files and readSDKConfig
accepts the choices "cardona"
(for chainId 2442), "zkevm"
(for chainId 1101), "x1"
(for chainId 195) and "xlayer"
(for chainId 196). The configuration file is required to initialize the node-package classes. There is most likely no reason to deviate from either of the default configuration files, but if you want you can, by providing a path to your configuration file:
Install Node via nvm,
Install Yarn,
Install node.js with nvm-windows,
Clone the official repo