Skip to content

convergence-rfq/convergence-sdk

Repository files navigation

Convergence RFQ SDK

Tests Docs

Overview

Installation

npm install @convergence-rfq/sdk @solana/web3.js

Setup

The entry point to the JavaScript SDK is a Convergence instance that will give you access to its API. It accepts a Connection instance from @solana/web3.js that will be used to communicate with the cluster.

Development

Requirements

Setup

yarn 
yarn build

Tests

First run the Solana test validator.

yarn validator

Run the validator logs separately.

yarn validator:logs

Finally run the test in a new terminal.

yarn test
# It is possible to run individual module tests
yarn test -g "integration.spot"

NPM

yarn packages:change
yarn packages:version
yarn packages:publish

TypeDocs

Documentation is built via CI/CD and released here.