diff --git a/classes/Coin.html b/classes/Coin.html index b16b00e..c2efded 100644 --- a/classes/Coin.html +++ b/classes/Coin.html @@ -1,4 +1,4 @@ -Coin | @project-serum/serum-dev-tools
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Coin

Hierarchy

  • Coin

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

  • new Coin(symbol: string, decimals: number, mint: PublicKey, mintAuthority: Keypair, freezeAuthority: null | Keypair): Coin

  • Parameters

    • symbol: string
    • decimals: number
    • mint: PublicKey
    • mintAuthority: Keypair
    • freezeAuthority: null | Keypair

    Returns Coin

Properties

Private _decimals

_decimals: number

Private _freezeAuthority

_freezeAuthority: null | Keypair

Private _mint

_mint: PublicKey

Private _mintAuthority

_mintAuthority: Keypair

Private _symbol

_symbol: string

Accessors

decimals

  • get decimals(): number

freezeAuthority

  • get freezeAuthority(): null | Keypair

mint

  • get mint(): PublicKey

mintAuthority

  • get mintAuthority(): Keypair

symbol

  • get symbol(): string

Methods

fundAccount

  • fundAccount(decimalAmount: number, owner: Keypair, connection: Connection): Promise<void>
  • +Coin | @project-serum/serum-dev-tools
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Coin

    Hierarchy

    • Coin

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    Private constructor

    • new Coin(symbol: string, decimals: number, mint: PublicKey, mintAuthority: Keypair, freezeAuthority: null | Keypair): Coin

    • Parameters

      • symbol: string
      • decimals: number
      • mint: PublicKey
      • mintAuthority: Keypair
      • freezeAuthority: null | Keypair

      Returns Coin

    Properties

    Private _decimals

    _decimals: number

    Private _freezeAuthority

    _freezeAuthority: null | Keypair

    Private _mint

    _mint: PublicKey

    Private _mintAuthority

    _mintAuthority: Keypair

    Private _symbol

    _symbol: string

    Accessors

    decimals

    • get decimals(): number

    freezeAuthority

    • get freezeAuthority(): null | Keypair

    mint

    • get mint(): PublicKey

    mintAuthority

    • get mintAuthority(): Keypair

    symbol

    • get symbol(): string

    Methods

    fundAccount

    • fundAccount(decimalAmount: number, owner: Keypair, connection: Connection): Promise<void>

    • Fund the owner key-pair with the specified amount of this coin.

      Parameters

      • decimalAmount: number

        The amount of tokens to fund account with, in decimal notation.

        @@ -6,17 +6,17 @@

        The Keypair to fund.

      • connection: Connection

        The Connection object to connect to Solana.

        -

      Returns Promise<void>

    getBalance

    • getBalance(owner: Keypair, connection: Connection): Promise<RpcResponseAndContext<TokenAmount>>

    Returns Promise<void>

getBalance

  • getBalance(owner: Keypair, connection: Connection): Promise<RpcResponseAndContext<TokenAmount>>

  • Get the token balance for the specified owner.

    Parameters

    • owner: Keypair

      The Keypair whose balance to fetch.

    • connection: Connection

      The Connection object to connect to Solana.

      -

    Returns Promise<RpcResponseAndContext<TokenAmount>>

isEqual

  • isEqual(to: Coin): boolean

Returns Promise<RpcResponseAndContext<TokenAmount>>

isEqual

  • isEqual(to: Coin): boolean

  • Equality check between two Coins.

    Parameters

    • to: Coin

      The Coin object to compare to.

      -

    Returns boolean

Static load

  • load(connection: Connection, symbol: string, mint: PublicKey, mintAuthority: Keypair, freezeAuthority: null | Keypair): Promise<Coin>

Returns boolean

Static load

  • load(connection: Connection, symbol: string, mint: PublicKey, mintAuthority: Keypair, freezeAuthority: null | Keypair): Promise<Coin>

getCoin

  • getCoin(symbol: string): null | Coin

  • Fetch one of the Coin objects associated with the Dex by symbol.

    Parameters

    • symbol: string

      The symbol of the coin to fetch

      -

    Returns null | Coin

getMarket

Returns null | Coin

getMarket

  • Fetch a DexMarket object associated with the Dex by the base coin and quote coin.

    Parameters

    • baseCoin: Coin

      The base Coin of the market to fetch

    • quoteCoin: Coin

      The quote Coin of the market to fetch

      -

    Returns null | DexMarket

initDexMarket

Returns null | DexMarket

initDexMarket

  • Initialize a DexMarket instance associated with the Dex.

    Parameters

    • payer: Keypair

      The payer Keypair to use for the transactions

      @@ -34,7 +34,7 @@

      The quote Coin of the market to create

    • marketParams: MarketParams

      The parameters required to create the market

      -

    Returns Promise<DexMarket>

runCrank

Returns Promise<DexMarket>

runCrank

  • Runs a crank on a separate node process for the given DexMarket for specified duration.

    Parameters

    • market: DexMarket

      The DexMarket to run a crank for

      @@ -42,7 +42,7 @@

      The owner FileKeypair consuming events.

    • opts: CrankOpts

      The crank options used

      -

    Returns ChildProcess

runMarketMaker

Returns ChildProcess

runMarketMaker

Static createMarketAccountsInstructions

  • createMarketAccountsInstructions(accounts: MarketAccounts, payer: Keypair, connection: Connection, programID: PublicKey): Promise<TransactionInstruction[]>

  • Create a Transaction object for creating the accounts required for a DexMarket.

    Parameters

    • accounts: MarketAccounts

      The MarketAccounts object containing the accounts needed for initializing the market.

      @@ -20,7 +20,7 @@

      The Connection object to connect to Solana.

    • programID: PublicKey

      The address of the serum-dex program deployed.

      -

    Returns Promise<TransactionInstruction[]>

Static createMarketVaultsTransaction

  • createMarketVaultsTransaction(payer: Keypair, vaultOwner: PublicKey, baseVault: Keypair, quoteVault: Keypair, baseCoin: Coin, quoteCoin: Coin, connection: Connection): Promise<Transaction>

Returns Promise<TransactionInstruction[]>

Static createMarketVaultsTransaction

  • createMarketVaultsTransaction(payer: Keypair, vaultOwner: PublicKey, baseVault: Keypair, quoteVault: Keypair, baseCoin: Coin, quoteCoin: Coin, connection: Connection): Promise<Transaction>

  • Create a Transaction object for creating the vaults required for a DexMarket.

    Parameters

    • payer: Keypair

      The Keypair of the account that will pay for the transaction.

      @@ -36,7 +36,7 @@

      The quote Coin object provided by the Coin class.

    • connection: Connection

      The Connection object to connect to Solana.

      -

    Returns Promise<Transaction>

Static getCancelOrderTransaction

  • getCancelOrderTransaction(connection: Connection, owner: Keypair, serumMarket: Market, order: Order): Promise<TransactionWithSigners>

Returns Promise<Transaction>

Static getCancelOrderTransaction

  • getCancelOrderTransaction(connection: Connection, owner: Keypair, serumMarket: Market, order: Order): Promise<TransactionWithSigners>

  • Create a Transaction object for cancelling an order.

    Parameters

    • connection: Connection

      The Connection object to connect to Solana.

      @@ -46,7 +46,7 @@

      The Market object from serum-ts package.

    • order: Order

      The Order object to cancel.

      -

    Returns Promise<TransactionWithSigners>

Static getOrCreateOpenOrderAccount

  • getOrCreateOpenOrderAccount(owner: Keypair, serumMarket: Market, connection: Connection): Promise<OpenOrders>

Returns Promise<TransactionWithSigners>

Static getOrCreateOpenOrderAccount

  • getOrCreateOpenOrderAccount(owner: Keypair, serumMarket: Market, connection: Connection): Promise<OpenOrders>

  • Get or create an OpenOrder account for the specified owner.

    Parameters

    • owner: Keypair

      The Keypair for which OpenOrders account is required.

      @@ -54,7 +54,7 @@

      The Market object from serum-ts package.

    • connection: Connection

      The Connection object to connect to Solana.

      -

    Returns Promise<OpenOrders>

Static getOrdersForOwner

  • getOrdersForOwner(owner: Keypair, serumMarket: Market, connection: Connection): Promise<Order[]>

Returns Promise<OpenOrders>

Static getOrdersForOwner

  • getOrdersForOwner(owner: Keypair, serumMarket: Market, connection: Connection): Promise<Order[]>

  • Get all orders placed by a keypair.

    Parameters

    • owner: Keypair

      The Keypair for which orders have to be fetched.

      @@ -62,7 +62,7 @@

      The Market object from serum-ts package.

    • connection: Connection

      The Connection object to connect to Solana.

      -

    Returns Promise<Order[]>

Static getPlaceOrderTransaction

Returns Promise<Order[]>

Static getPlaceOrderTransaction

  • Create a Transaction object for placing an order.

    Parameters

    • connection: Connection

      The Connection object to connect to Solana.

      @@ -80,7 +80,7 @@

      The price of the order.

    • Optional selfTradeBehaviour: SelfTradeBehaviour

      The SelfTradeBehaviour action to follow for the order placed.

      -

    Returns Promise<TransactionWithSigners>

Static load

  • load(connection: Connection, programID: PublicKey, marketAddress: PublicKey, baseCoin: Coin, quoteCoin: Coin): Promise<DexMarket>

Returns Promise<TransactionWithSigners>

Static load

  • load(connection: Connection, programID: PublicKey, marketAddress: PublicKey, baseCoin: Coin, quoteCoin: Coin): Promise<DexMarket>

  • Load a DexMarket instance from a given market address.

    Parameters

    • connection: Connection

      The Connection object to connect to Solana.

      @@ -92,7 +92,7 @@

      The base Coin object provided by the Coin class.

    • quoteCoin: Coin

      The quote Coin object provided by the Coin class.

      -

    Returns Promise<DexMarket>

Static placeOrder

  • placeOrder(connection: Connection, owner: Keypair, serumMarket: Market, side: "buy" | "sell", orderType: OrderType, size: number, price: number, selfTradeBehaviour?: SelfTradeBehaviour): Promise<string>

Returns Promise<DexMarket>

Static placeOrder

  • placeOrder(connection: Connection, owner: Keypair, serumMarket: Market, side: "buy" | "sell", orderType: OrderType, size: number, price: number, selfTradeBehaviour?: SelfTradeBehaviour): Promise<string>

  • Place an order on the DexMarket.

    Parameters

    • connection: Connection

      The Connection object to connect to Solana.

      @@ -110,4 +110,4 @@

      The price of the order.

    • Optional selfTradeBehaviour: SelfTradeBehaviour

      The SelfTradeBehaviour action to follow for the order placed.

      -

    Returns Promise<string>

Static sanityCheck

  • sanityCheck(serumMarket: Market, price: number, size: number): void

  • Parameters

    • serumMarket: Market
    • price: number
    • size: number

    Returns void

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<string>

Static sanityCheck

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/FileKeypair.html b/classes/FileKeypair.html index b8fa273..5f274a0 100644 --- a/classes/FileKeypair.html +++ b/classes/FileKeypair.html @@ -1,3 +1,3 @@ FileKeypair | @project-serum/serum-dev-tools
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FileKeypair

A wrapper class around @solana/web3.js Keypair that allows persisting key-pairs in your local filesystem.

-

Hierarchy

  • FileKeypair

Index

Constructors

Properties

Methods

Constructors

Private constructor

  • new FileKeypair(absoluteFilePath: string, keypair: Keypair): FileKeypair

Properties

absoluteFilePath

absoluteFilePath: string

keypair

keypair: Keypair

Methods

Static generate

Static load

Static loadOrGenerate

Static withKeypair

  • withKeypair(filePath: string, keypair: Keypair): FileKeypair

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Private constructor

Properties

absoluteFilePath

absoluteFilePath: string

keypair

keypair: Keypair

Methods

Static generate

Static load

Static loadOrGenerate

Static withKeypair

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/MarketAccounts.html b/interfaces/MarketAccounts.html index c077d59..1483af3 100644 --- a/interfaces/MarketAccounts.html +++ b/interfaces/MarketAccounts.html @@ -1 +1 @@ -MarketAccounts | @project-serum/serum-dev-tools
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MarketAccounts

Hierarchy

  • MarketAccounts

Index

Properties

Properties

asks

asks: Keypair

bids

bids: Keypair

eventQueue

eventQueue: Keypair

market

market: Keypair

requestQueue

requestQueue: Keypair

Generated using TypeDoc

\ No newline at end of file +MarketAccounts | @project-serum/serum-dev-tools
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MarketAccounts

Hierarchy

  • MarketAccounts

Index

Properties

Properties

asks

asks: Keypair

bids

bids: Keypair

eventQueue

eventQueue: Keypair

market

market: Keypair

requestQueue

requestQueue: Keypair

Generated using TypeDoc

\ No newline at end of file diff --git a/modules.html b/modules.html index 42d9e72..8c1d43e 100644 --- a/modules.html +++ b/modules.html @@ -1,11 +1,11 @@ -@project-serum/serum-dev-tools
Options
All
  • Public
  • Public/Protected
  • All
Menu

@project-serum/serum-dev-tools

Index

Classes

Interfaces

Type aliases

Type aliases

CrankOpts

CrankOpts: { durationInSecs: number; verbose: boolean }
param durationInSecs

The duration in seconds for which the market maker will run.

+@project-serum/serum-dev-tools
Options
All
  • Public
  • Public/Protected
  • All
Menu

@project-serum/serum-dev-tools

Index

Classes

Interfaces

Type aliases

Type aliases

CrankOpts

CrankOpts: { durationInSecs: number; verbose: boolean }
param durationInSecs

The duration in seconds for which the market maker will run.

param verbose

The boolean flag determining whether to log about the actions taking place.

-

Type declaration

  • durationInSecs: number
  • verbose: boolean

MarketMakerOpts

MarketMakerOpts: { baseGeckoSymbol: string; durationInSecs: number; initialBidSize: number; orderCount: number; quoteGeckoSymbol: string; verbose: boolean }
param durationInSecs

The duration in seconds for which the market maker will run.

+

Type declaration

  • durationInSecs: number
  • verbose: boolean

MarketMakerOpts

MarketMakerOpts: { baseGeckoSymbol: string; durationInSecs: number; initialBidSize: number; orderCount: number; quoteGeckoSymbol: string; verbose: boolean }
param durationInSecs

The duration in seconds for which the market maker will run.

param orderCount

The number of orders to place per side in each iteration.

param initialBidSize

The initial bid size for the market maker.

param baseGeckoSymbol

The symbol used by CoinGecko for the base coin.

param quoteGeckoSymbol

The symbol used by CoinGecko for the quote coin.

param verbose

The boolean flag determining whether to log about the actions taking place.

-

Type declaration

  • baseGeckoSymbol: string
  • durationInSecs: number
  • initialBidSize: number
  • orderCount: number
  • quoteGeckoSymbol: string
  • verbose: boolean

MarketParams

MarketParams: { lotSize: number; tickSize: number }
param lotSize

This is the smallest representable amount of the base coin .

+

Type declaration

  • baseGeckoSymbol: string
  • durationInSecs: number
  • initialBidSize: number
  • orderCount: number
  • quoteGeckoSymbol: string
  • verbose: boolean

MarketParams

MarketParams: { lotSize: number; tickSize: number }
param lotSize

This is the smallest representable amount of the base coin .

param tickSize

This is the smallest representable amount of the quote coin.

-

Type declaration

  • lotSize: number
  • tickSize: number

MessageType

MessageType: { action: "start"; args: any }

Type declaration

  • action: "start"
  • args: any

OrderType

OrderType: "limit" | "ioc" | "postOnly"

SelfTradeBehaviour

SelfTradeBehaviour: "decrementTake" | "cancelProvide" | "abortTransaction"

TransactionWithSigners

TransactionWithSigners: { signers: Signer[]; transaction: Transaction }

Type declaration

  • signers: Signer[]
  • transaction: Transaction

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Private property
  • Static method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Type declaration

  • lotSize: number
  • tickSize: number

MessageType

MessageType: { action: "start"; args: any }

Type declaration

  • action: "start"
  • args: any

OrderType

OrderType: "limit" | "ioc" | "postOnly"

SelfTradeBehaviour

SelfTradeBehaviour: "decrementTake" | "cancelProvide" | "abortTransaction"

TransactionWithSigners

TransactionWithSigners: { signers: Signer[]; transaction: Transaction }

Type declaration

  • signers: Signer[]
  • transaction: Transaction

Generated using TypeDoc

\ No newline at end of file