This TypeScript SDK provides a CCXT-compatible API for interacting with the XRPL decentralized exchange.
A Python version of this SDK is available here.
This package requires NodeJS v16 or later.
NOTE: We recommend using nvm to manage your NodeJS installations. If
nvm
is installed, typenvm use
in the SDK's root folder to automatically switch to the proper Node version.
Add the SDK package to your project:
$ npm install -S xrpl-dex-sdk
$ yarn add xrpl-dex-sdk
Make sure you have the following installed on your system:
- NodeJS v16 (lts/gallium)
- Yarn
Clone the repo, install dependencies, and build the SDK:
$ git clone https://github.com/AktaryTech/xrpl-dex-sdk.git
$ cd xrpl-dex-sdk
$ yarn
$ yarn build
The compiled SDK will be in the /dist
folder.
To use the SDK, import it into your script and create a new SDK instance:
import { SDK, OrderSide, OrderType, Wallet } from 'xrpl-dex-sdk';
const sdk = new SDK({
network: 'testnet',
privateKey: /* Your XRPL wallet's private key */,
publicKey: /* Your XRPL wallet's public key */,
});
await sdk.client.connect();
Currency codes, market symbols, and Order/Trade IDs are strings that follow the following formats:
Type | Format | Example |
---|---|---|
CurrencyCode | [Currency]+[IssuerAddress] |
USD+rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq |
MarketSymbol | [BaseCurrency]/[QuoteCurrency] |
XRP/USD+rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq |
OrderId, TradeId | [AccountAddress]/[Sequence] |
rpkeJcxB2y5BeAFyycuWwdTTcR3og2a3SR:30419065 |
The following example places an Order to buy 20 TST tokens, issued by the account at rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd
, at a price of 1.5 XRP each:
import { SDK, OrderSide, OrderType, Wallet } from 'xrpl-dex-sdk';
const example = async () => {
const wallet = Wallet.generate();
const sdk = new SDK({
network: 'testnet',
privateKey: wallet.privateKey,
publicKey: wallet.publicKey,
});
await sdk.client.connect();
const orderId = await sdk.createOrder(
'TST+rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd/XRP',
OrderSide.Buy,
OrderType.Limit,
'20',
'1.5'
);
const order = await sdk.fetchOrder(orderId);
console.log(order);
};
example();
It produces the following output:
{
...,
"status": "open",
"symbol": "TST+rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd/XRP",
"type": "limit",
"timeInForce": "GTC",
"side": "buy",
"amount": "20",
"price": "1.5",
"average": "0",
"filled": "0",
"remaining": "20",
"cost": "0",
"trades": [],
"info": {
// ... raw response from XRPL server
}
}
For full SDK documentation, see the docs
folder. To re-generate documentation, run yarn docs:build
.
Pull requests, issues and comments are welcome! Make sure to add tests for new features and bug fixes.
For questions, suggestions, etc, you can reach the maintainer at info@aktarytech.com.
The software is distributed under the MIT license. See LICENSE for details.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this library by you, as defined in the MIT license, shall be licensed as above, without any additional terms or conditions.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Copyright © 2022 Ripple Labs, Inc.