OpenBook CLI

OpenBook CLI is a command-line tool for interacting with OpenBook v2. It provides functionalities to create and close trading and market accounts (via create and close OOA), monitor market data, place, cancel and check orders, deposit and withdraw funds, and check your account balance.

Installation

Ensure you have Node.js and yarn installed. Then, clone this repository and install dependencies:

git clone https://github.com/QuanDeFi/openbook-cli.git
cd openbook-cli
yarn install

and subsequently build the CLI

yarn build

Usage

All commands follow the format:

npx ts-node cli.ts <command> [options]

Commands

List Markets

Loads all market accounts from the exchange and displays for each market:

• Market Name
• Market Pubkey
• Base Token Symbol
• Quote Token Symbol
• Base Deposits (UI units)
• Quote Deposits (UI units)
• Base Deposits in USD
• Quote Deposits in USD

npx ts-node cli.ts listMarkets

Market Data

Monitor the order book for a specified market, chose --bestbidask or --book to watch the orderbook or best bid and ask of a particular market.

npx ts-node cli.ts marketData <MARKET_PUBLIC_KEY> --bestbidask
npx ts-node cli.ts marketData <MARKET_PUBLIC_KEY> --book

Parameter	Description	Required
market	Public key of the market	Yes
bestbidask	Monitor best bid/ask prices	No
book	Display full order book liquidity	No

Create OpenOrders Account (OOA)

Create an OpenOrders account (OOA) for a market. First-time traders need an OOA to start trading on OpenBook and to access new markets. You can create multiple OOAs for the same market, allowing you to separate different trading strategies or to separate account activity between discretionary and systematic trading.

npx ts-node cli.ts createOOA --market <MARKET_PUBKEY> --ownerKeypair <KEYPAIR_FILE_PATH> --name <ACCOUNT_NAME>

Parameter	Description	Required
market	Public key of the market	Yes
ownerKeypair	Path to the keypair file of the owner	Yes
name	Name of the OpenOrders account (default: "default")	No

Get OpenOrders Accounts (OOA)

Fetch OpenOrders accounts for an owner to validate the creation of your OOA and to check which OOAs you have.

npx ts-node cli.ts getOOA <OWNER_PUBLIC_KEY> [--market <MARKET_PUBLIC_KEY>]

Parameter	Description	Required
owner	Public key of the account owner	Yes
market	Public key of the market (to filter results)	No

Close OpenOrders Account (OOA)

The closeOOA command allows you to close an OpenOrders account, all OpenOrders accounts for a market, or the OpenOrders indexer (after all OpenOrdersAccounts are closed).

npx ts-node cli.ts closeOOA --ownerKeypair <KEYPAIR_PATH> --openOrders <OPEN_ORDERS_PUBKEY>
npx ts-node cli.ts closeOOA --ownerKeypair <KEYPAIR_PATH> --market <MARKET_PUBKEY>
npx ts-node cli.ts closeOOA --ownerKeypair <KEYPAIR_PATH> --closeIndexer (does not work right now)

Parameter	Description	Required
--ownerKeypair	Path to the keypair file of the OpenOrders account owner	Yes
--openOrders	Public key of a specific OpenOrders account to close	No
--market	Public key of the market (required if closing all OpenOrders)	No
--closeIndexer	Closes the OpenOrders indexer (does not work right now)	No

Deposit Funds

Deposit tokens into an OpenOrders account. Set Quote or BaseAmount to 0 if you only want to deposit one asset.

npx ts-node cli.ts deposit --market <MARKET_PUBKEY> --openOrders <OPEN_ORDERS_PUBKEY> --ownerKeypair <KEYPAIR_PATH> --baseAmount <BASE_AMOUNT> --quoteAmount <QUOTE_AMOUNT>

Parameter	Description	Required
market	Public key of the market	Yes
openOrders	Public key of the OpenOrders account	Yes
ownerKeypair	Path to the keypair file of the owner	Yes
baseAmount	Amount of base tokens to deposit	Yes
quoteAmount	Amount of quote tokens to deposit	Yes

Check Balance

Fetch the base and quote token balances for an OpenOrders account.

npx ts-node cli.ts balance --openOrders <OPEN_ORDERS_PUBKEY> --market <MARKET_PUBKEY>

Parameter	Description	Required
openOrders	Public key of the OpenOrders account	Yes
market	Public key of the market	Yes

Withdraw Funds

Withdraw funds from an OpenOrders account.

npx ts-node cli.ts withdraw --market <MARKET_PUBKEY> --openOrders <OPEN_ORDERS_PUBKEY> --ownerKeypair <KEYPAIR_PATH>

Parameter	Description	Required
market	Public key of the market	Yes
openOrders	Public key of the OpenOrders account	Yes
ownerKeypair	Path to the keypair file of the owner	Yes

Place a Limit Order

Place a limit order on OpenBook.

npx ts-node cli.ts place-order --market <MARKET_PUBKEY> --openOrders <OPEN_ORDERS_PUBKEY> --ownerKeypair <KEYPAIR_PATH> --side bid --price <PRICE_AMOUNT> --size <SIZE_AMOUNT>

Parameter	Description	Required
market	Public key of the market	Yes
openOrders	Public key of the OpenOrders account	Yes
ownerKeypair	Path to the keypair file of the owner	Yes
side	bid (buy) or ask (sell)	Yes
price	Order price in UI units	Yes
size	Order size in UI units	Yes

Get Open Orders

Retrieve all open orders for an OpenBook trading account or for one particular OOA.

npx ts-node cli.ts position --wallet <WALLET_PUBLIC_KEY>
npx ts-node cli.ts position --openOrders <OPEN_ORDERS_PUBLIC_KEY> [--market <MARKET_PUBLIC_KEY>]

Parameter	Description	Required
wallet	Public key of the wallet (fetch all OOAs)	No
openOrders	Public key of a specific OpenOrders account	No
market	Public key of a market to filter results	No

Cancel an Order

Cancel an open order on OpenBook.

npx ts-node cli.ts cancelOrder --market <MARKET_PUBKEY> --openOrders <OPEN_ORDERS_PUBKEY> --orderId <ORDER_ID> --ownerKeypair <KEYPAIR_PATH>

Parameter	Description	Required
market	Public key of the market	Yes
openOrders	Public key of the OpenOrders account	Yes
orderId	Order ID to cancel	No
clientOrderId	Client-specified order ID	No
side	bid or ask (cancel orders on that side)	No
limit	Maximum number of orders to cancel	No
ownerKeypair	Path to the keypair file of the owner	Yes

License

This project is licensed under the MIT License.

Repository

GitHub: https://github.com/QuanDeFi/openbook-cli

Author

Developed by QuanDeFi