Class ManifestClient

baseGlobal

connection

isBase22

isQuote22

market

quoteGlobal

wrapper

batchUpdateIx

• batchUpdateIx(placeParams, cancelParams, cancelAll): TransactionInstruction

• BatchUpdate instruction

  Parameters

  • placeParams: WrapperPlaceOrderParamsExternal[]
  • cancelParams: wrapper.WrapperCancelOrderParams[]
  • cancelAll: boolean

  Returns TransactionInstruction

  TransactionInstruction

cancelAllIx

• cancelAllIx(): TransactionInstruction

• CancelAll instruction. Cancels all orders on a market

  Returns TransactionInstruction

  TransactionInstruction

cancelOrderIx

• cancelOrderIx(params): TransactionInstruction

• CancelOrder instruction

  Parameters

  • params: wrapper.WrapperCancelOrderParams

    CancelOrderParams includes the orderSequenceNumber of the order to cancel.

  Returns TransactionInstruction

  TransactionInstruction

depositIx

• depositIx(payer, mint, amountTokens): TransactionInstruction

• Deposit instruction

  Parameters

  • payer: PublicKey

    PublicKey of the trader
  • mint: PublicKey

    PublicKey for deposit mint. Must be either the base or quote
  • amountTokens: number

    Number of tokens to deposit.

  Returns TransactionInstruction

  TransactionInstruction

killSwitchMarket

• killSwitchMarket(payerKeypair): Promise<string[]>

• killSwitchMarket transactions. Pulls all orders and withdraws all balances from the market in two transactions

  Parameters

  • payerKeypair: Keypair

  Returns Promise<string[]>

  TransactionSignatures[]

placeOrderIx

• placeOrderIx(params): TransactionInstruction

• PlaceOrder instruction

  Parameters

  • params: WrapperPlaceOrderParamsExternal

    PlaceOrderParamsExternal including all the information for placing an order like amount, price, ordertype, ... This is called external because to avoid conflicts with the autogenerated version which has problems with expressing some of the parameters.

  Returns TransactionInstruction

  TransactionInstruction

placeOrderWithRequiredDepositIx

• placeOrderWithRequiredDepositIx(payer, params): Promise<TransactionInstruction[]>

• PlaceOrderWithRequiredDeposit instruction. Only deposits the appropriate base or quote tokens if not in the withdrawable balances.

  Parameters

  • payer: PublicKey

    PublicKey of the trader
  • params: WrapperPlaceOrderParamsExternal

    WrapperPlaceOrderParamsExternal including all the information for placing an order like amount, price, ordertype, ... This is called external because to avoid conflicts with the autogenerated version which has problems with expressing some of the parameters.

  Returns Promise<TransactionInstruction[]>

  TransactionInstruction[]

reload

• reload(): Promise<void>

• Reload the market and wrapper and global objects.

  Returns Promise<void>

swapIx

• swapIx(payer, params): TransactionInstruction

• Swap instruction

  Optimized swap for routers and arb bots. Normal traders should compose depost/withdraw/placeOrder to get limit orders. Does not go through the wrapper.

  Parameters

  • payer: PublicKey

    PublicKey of the trader
  • params: SwapParams

    SwapParams

  Returns TransactionInstruction

  TransactionInstruction

withdrawAllIx

• withdrawAllIx(): TransactionInstruction[]

• Withdraw All instruction. Withdraws all available base and quote tokens

  Returns TransactionInstruction[]

  TransactionInstruction[]

withdrawIx

• withdrawIx(payer, mint, amountTokens): TransactionInstruction

• Withdraw instruction

  Parameters

  • payer: PublicKey

    PublicKey of the trader
  • mint: PublicKey

    PublicKey for withdraw mint. Must be either the base or quote
  • amountTokens: number

    Number of tokens to withdraw.

  Returns TransactionInstruction

  TransactionInstruction

StaticcreateGlobalAddTraderIx

• createGlobalAddTraderIx(payer, globalMint): TransactionInstruction

• CreateGlobalAddTrader instruction. Adds a new trader to the global account. Static because it does not require a wrapper.

  Parameters

  • payer: PublicKey

    PublicKey of the trader
  • globalMint: PublicKey

    PublicKey of the globalMint

  Returns TransactionInstruction

  TransactionInstruction

StaticgetClientForMarket

• getClientForMarket(connection, marketPk, payerKeypair): Promise<ManifestClient>

• Create a new client which creates a wrapper and claims seat if needed.

  Parameters

  • connection: Connection

    Connection
  • marketPk: PublicKey

    PublicKey of the market
  • payerKeypair: Keypair

    Keypair of the trader

  Returns Promise<ManifestClient>

  ManifestClient

StaticgetClientForMarketNoPrivateKey

• getClientForMarketNoPrivateKey(connection, marketPk, trader): Promise<ManifestClient>

• Create a new client. throws if setup ixs are needed. Call ManifestClient.getSetupIxs to check if ixs are needed. This is the way to create a client without directly passing in Keypair types (for example when building a UI).

  Parameters

  • connection: Connection

    Connection
  • marketPk: PublicKey

    PublicKey of the market
  • trader: PublicKey

    PublicKey of the trader

  Returns Promise<ManifestClient>

  ManifestClient

StaticgetClientReadOnly

• getClientReadOnly(connection, marketPk, trader?): Promise<ManifestClient>

• Create a new client that is read only. Cannot send transactions or generate instructions.

  Parameters

  • connection: Connection

    Connection
  • marketPk: PublicKey

    PublicKey of the market
  • Optionaltrader: PublicKey

    PublicKey for trader whose wrapper to fetch

  Returns Promise<ManifestClient>

  ManifestClient

StaticgetMarketProgramAccounts

• getMarketProgramAccounts(connection): Promise<GetProgramAccountsResponse>

• Get all market program accounts. This is expensive RPC load..

  Parameters

  • connection: Connection

    Connection

  Returns Promise<GetProgramAccountsResponse>

  GetProgramAccountsResponse

StaticgetSetupIxs

• getSetupIxs(connection, marketPk, trader): Promise<SetupData>

• generate ixs which need to be executed in order to run a manifest client for a given market. { setupNeeded: false } means all good. this function should be used before getClientForMarketNoPrivateKey for UI cases where Keypairs cannot be directly passed in.

  Parameters

  • connection: Connection

    Connection
  • marketPk: PublicKey

    PublicKey of the market
  • trader: PublicKey

    PublicKey of the trader

  Returns Promise<SetupData>

  Promise

StaticglobalDepositIx

• globalDepositIx(connection, payer, globalMint, amountTokens): Promise<TransactionInstruction>

• Global deposit instruction. Static because it does not require a wrapper.

  Parameters

  • connection: Connection

    Connection to pull mint info
  • payer: PublicKey

    PublicKey of the trader
  • globalMint: PublicKey

    PublicKey for global mint deposit.
  • amountTokens: number

    Number of tokens to deposit.

  Returns Promise<TransactionInstruction>

  Promise

StaticglobalWithdrawIx

• globalWithdrawIx(connection, payer, globalMint, amountTokens): Promise<TransactionInstruction>

• Global withdraw instruction. Static because it does not require a wrapper.

  Parameters

  • connection: Connection

    Connection to pull mint info
  • payer: PublicKey

    PublicKey of the trader
  • globalMint: PublicKey

    PublicKey for global mint withdraw.
  • amountTokens: number

    Number of tokens to withdraw.

  Returns Promise<TransactionInstruction>

  Promise

StaticlistMarketPublicKeys

• listMarketPublicKeys(connection): Promise<PublicKey[]>

• list all Manifest markets using getProgramAccounts. caution: this is a heavy call.

  Parameters

  • connection: Connection

    Connection

  Returns Promise<PublicKey[]>

  PublicKey[]