{"id":13408853,"url":"https://github.com/project-serum/serum-js","last_synced_at":"2025-03-14T13:32:09.491Z","repository":{"id":56315268,"uuid":"285655156","full_name":"project-serum/serum-js","owner":"project-serum","description":"JavaScript client library for interacting with the Project Serum DEX.","archived":true,"fork":false,"pushed_at":"2020-11-15T03:29:49.000Z","size":524,"stargazers_count":82,"open_issues_count":0,"forks_count":33,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-07-31T20:32:02.033Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/project-serum.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-08-06T19:33:05.000Z","updated_at":"2024-06-02T14:46:56.000Z","dependencies_parsed_at":"2022-08-15T16:31:25.164Z","dependency_job_id":null,"html_url":"https://github.com/project-serum/serum-js","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/project-serum%2Fserum-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/project-serum%2Fserum-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/project-serum%2Fserum-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/project-serum%2Fserum-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/project-serum","download_url":"https://codeload.github.com/project-serum/serum-js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243584496,"owners_count":20314774,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-30T20:00:55.913Z","updated_at":"2025-03-14T13:32:09.025Z","avatar_url":"https://github.com/project-serum.png","language":"TypeScript","funding_links":[],"categories":["DEX Integration","👩‍🚀 Product Examples"],"sub_categories":["RPC servers","`Serum`"],"readme":"[![npm (scoped)](https://img.shields.io/npm/v/@project-serum/serum)](https://www.npmjs.com/package/@project-serum/serum)\n[![Build Status](https://travis-ci.com/project-serum/serum-js.svg?branch=master)](https://travis-ci.com/project-serum/serum-js)\n\n# Moved\n\nThis repository has been moved to the serum-ts [monorepo](https://github.com/project-serum/serum-ts/tree/master/packages/serum).\n\n# Serum JS Client Library\n\nJavaScript client library for interacting with the Project Serum DEX.\n\n## Installation\n\nUsing npm:\n\n```\nnpm install @solana/web3.js @project-serum/serum\n```\n\nUsing yarn:\n\n```\nyarn add @solana/web3.js @project-serum/serum\n```\n\n## Usage\n\n```js\nimport { Account, Connection, PublicKey } from '@solana/web3.js';\nimport { Market } from '@project-serum/serum';\n\nlet connection = new Connection('https://testnet.solana.com');\nlet marketAddress = new PublicKey('...');\nlet market = await Market.load(connection, marketAddress);\n\n// Fetching orderbooks\nlet bids = await market.loadBids(connection);\nlet asks = await market.loadAsks(connection);\n// L2 orderbook data\nfor (let [price, size] of bids.getL2(20)) {\n  console.log(price, size);\n}\n// Full orderbook data\nfor (let order of asks) {\n  console.log(\n    order.orderId,\n    order.price,\n    order.size,\n    order.side, // 'buy' or 'sell'\n  );\n}\n\n// Placing orders\nlet owner = new Account('...');\nlet payer = new PublicKey('...'); // spl-token account\nawait market.placeOrder(connection, {\n  owner,\n  payer,\n  side: 'buy', // 'buy' or 'sell'\n  price: 123.45,\n  size: 17.0,\n  orderType: 'limit', // 'limit', 'ioc', 'postOnly'\n});\n\n// Retrieving open orders by owner\nlet myOrders = await market.loadOrdersForOwner(connection, owner.publicKey);\n\n// Cancelling orders\nfor (let order of myOrders) {\n  await market.cancelOrder(connection, owner, order);\n}\n\n// Retrieving fills\nfor (let fill of await market.loadFills(connection)) {\n  console.log(\n    fill.orderId,\n    fill.price,\n    fill.size,\n    fill.side,\n  );\n}\n\n// Settle funds\nfor (let openOrders of await market.findOpenOrdersAccountsForOwner(\n  connection,\n  owner.publicKey,\n)) {\n  if (openOrders.baseTokenFree \u003e 0 || openOrders.quoteTokenFree \u003e 0) {\n    // spl-token accounts to which to send the proceeds from trades\n    let baseTokenAccount = new PublicKey('...');\n    let quoteTokenAccount = new PublicKey('...');\n\n    await market.settleFunds(\n      connection,\n      owner,\n      openOrders,\n      baseTokenAccount,\n      quoteTokenAccount,\n    );\n  }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fproject-serum%2Fserum-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fproject-serum%2Fserum-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fproject-serum%2Fserum-js/lists"}