The Vexchange SDK exists to help developers build on top of Vexchange. It’s designed to run in any environment that can execute JavaScript (think websites, node scripts, etc.). While simple enough to use in a hackathon project, it’s also robust enough to power production applications.

Installation

The easiest way to consume the SDK is via npm. To install it in your project, simply run yarn add vexchange-sdk (or npm install vexchange-sdk).

Usage

To run code from the SDK in your application, use an import or require statement, depending on which your environment supports. Note that the guides following this page will use ES6 syntax.

ES6 (import)

import { ChainId } from 'vexchange-sdk'
console.log(`The chainId of mainnet is ${ChainId.MAINNET}.`)
Copy

CommonJS (require)

const VEXCHANGE = require('vexchange-sdk')
console.log(`The chainId of mainnet is ${VEXCHANGE.ChainId.MAINNET}.`)
Copy

Reference

Comprehensive reference material for the SDK is available here.