https://github.com/project-serum/serum-js

JavaScript client library for interacting with the Project Serum DEX.
https://github.com/project-serum/serum-js

Last synced: 3 months ago
JSON representation

JavaScript client library for interacting with the Project Serum DEX.

• Host: GitHub
• URL: https://github.com/project-serum/serum-js
• Owner: project-serum
• Archived: true
• Created: 2020-08-06T19:33:05.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-11-15T03:29:49.000Z (about 4 years ago)
• Last Synced: 2024-07-31T20:32:02.033Z (6 months ago)
• Language: TypeScript
• Homepage:
• Size: 512 KB
• Stars: 82
• Watchers: 11
• Forks: 33
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![npm (scoped)](https://img.shields.io/npm/v/@project-serum/serum)](https://www.npmjs.com/package/@project-serum/serum)

[![Build Status](https://travis-ci.com/project-serum/serum-js.svg?branch=master)](https://travis-ci.com/project-serum/serum-js)

# Moved

This repository has been moved to the serum-ts [monorepo](https://github.com/project-serum/serum-ts/tree/master/packages/serum).

# Serum JS Client Library

JavaScript client library for interacting with the Project Serum DEX.

## Installation

Using npm:

```

npm install @solana/web3.js @project-serum/serum

```

Using yarn:

```

yarn add @solana/web3.js @project-serum/serum

```

## Usage

```js

import { Account, Connection, PublicKey } from '@solana/web3.js';

import { Market } from '@project-serum/serum';

let connection = new Connection('https://testnet.solana.com');

let marketAddress = new PublicKey('...');

let market = await Market.load(connection, marketAddress);

// Fetching orderbooks

let bids = await market.loadBids(connection);

let asks = await market.loadAsks(connection);

// L2 orderbook data

for (let [price, size] of bids.getL2(20)) {

  console.log(price, size);

}

// Full orderbook data

for (let order of asks) {

  console.log(

    order.orderId,

    order.price,

    order.size,

    order.side, // 'buy' or 'sell'

  );

}

// Placing orders

let owner = new Account('...');

let payer = new PublicKey('...'); // spl-token account

await market.placeOrder(connection, {

  owner,

  payer,

  side: 'buy', // 'buy' or 'sell'

  price: 123.45,

  size: 17.0,

  orderType: 'limit', // 'limit', 'ioc', 'postOnly'

});

// Retrieving open orders by owner

let myOrders = await market.loadOrdersForOwner(connection, owner.publicKey);

// Cancelling orders

for (let order of myOrders) {

  await market.cancelOrder(connection, owner, order);

}

// Retrieving fills

for (let fill of await market.loadFills(connection)) {

  console.log(

    fill.orderId,

    fill.price,

    fill.size,

    fill.side,

  );

}

// Settle funds

for (let openOrders of await market.findOpenOrdersAccountsForOwner(

  connection,

  owner.publicKey,

)) {

  if (openOrders.baseTokenFree > 0 || openOrders.quoteTokenFree > 0) {

    // spl-token accounts to which to send the proceeds from trades

    let baseTokenAccount = new PublicKey('...');

    let quoteTokenAccount = new PublicKey('...');

    await market.settleFunds(

      connection,

      owner,

      openOrders,

      baseTokenAccount,

      quoteTokenAccount,

    );

  }

}

```