Class Pool

Hierarchy

  • default
    • Pool

Constructors

constructor

Properties

abi address bytecode provider

Methods

addLiquidity addWrappedLiquidity balance burnAndRelease call g getEventLogs gmrx lockCooldown lockLP lockedLP lp lpAddQuote lpRemoveQuote mrx removeLiquidity reserves send swapPairTokens swapQuote swapTokens totalLockedLP traderDiscount unlockLP

Constructors

constructor

  • new Pool(address, provider): Pool

  • Parameters

    • address: string
    • provider: Provider

    Returns Pool

Properties

abi

abi: any[]

address

address: string

bytecode

bytecode: undefined | string

provider

provider: Provider

Methods

addLiquidity

  • addLiquidity(amountGMRX, minimum, allowHighSlippage?, amountMRX?, gasLimit?): Promise<Transaction>

  • Add liquidity to the pool

    Parameters

    • amountGMRX: bigint

      the amount of gMRX to add

    • minimum: bigint

      the minimum amount of LP tokens to receive as wei

    • allowHighSlippage: boolean = false

      allow high slippage that can result in trading fees

    • amountMRX: undefined | string = '0'

      the amount of MRX to send with the transaction and add as MRX

    • gasLimit: undefined | number = 250000

      the optional limit for gas units that can be consumed

    Returns Promise<Transaction>

    an array of TransactionReceipt objects

addWrappedLiquidity

  • addWrappedLiquidity(amountMRX, amountGMRX, minimum, allowHighSlippage?, gasLimit?): Promise<Transaction>

  • Add liquidity to the pool

    Parameters

    • amountMRX: bigint

      the amount of wMRX to add as satoshi

    • amountGMRX: bigint

      the amount of gMRX to add as satoshi

    • minimum: bigint

      the minimum amount of LP tokens to receive as wei

    • allowHighSlippage: boolean = false

      allow high slippage that can result in trading fees

    • gasLimit: undefined | number = 250000

      the optional limit for gas units that can be consumed

    Returns Promise<Transaction>

    an array of TransactionReceipt objects

balance

  • balance(): Promise<bigint>

  • Get this contract balance

    Returns Promise<bigint>

    the satoshi balance of this contract

burnAndRelease

  • burnAndRelease(amountGMRX, minimum, unwrapMRX?, gasLimit?): Promise<Transaction>

  • Burn gMRX releasing wMRX or MRX

    Parameters

    • amountGMRX: bigint

      amount of gMRX to burn as satoshi

    • minimum: bigint

      the minimum amount of MRX or wMRX to receive as satoshi

    • unwrapMRX: boolean = false

      unwrap the wMRX to MRX

    • gasLimit: undefined | number = ...

      the optional limit for gas units that can be consumed

    Returns Promise<Transaction>

    an array of TransactionReceipt objects

call

  • call(method, args): Promise<undefined | Result>

  • Perform calltocontract

    Parameters

    • method: string

      The contract method to call

    • args: any[]

      The arguments

    Returns Promise<undefined | Result>

    see Result

g

  • g(): Promise<string>

  • Get the g contract address

    Returns Promise<string>

    the EVM style address of the g contract

getEventLogs

  • getEventLogs(): Promise<EventLogs>

  • Get receipts from a transaction

    Returns Promise<EventLogs>

    an EventLogs object

gmrx

  • gmrx(): Promise<string>

  • Get the gMRX contract address

    Returns Promise<string>

    the EVM style address of the gMRX contract

lockCooldown

  • lockCooldown(locker): Promise<bigint>

  • Get the block number of cooldown for a specific address

    Parameters

    • locker: string

      the EVM style address of the locker

    Returns Promise<bigint>

    the block number which cooldown ends

lockLP

  • lockLP(amountLP, gasLimit?): Promise<Transaction>

  • Lock liquidity in the pool

    Parameters

    • amountLP: bigint

      the amount of LGP-LP to add

    • gasLimit: undefined | number = 250000

      the optional limit for gas units that can be consumed

    Returns Promise<Transaction>

    an array of TransactionReceipt objects

lockedLP

  • lockedLP(locker): Promise<bigint>

  • Get the amount of LGP-LP locked by a specific address

    Parameters

    • locker: string

      the EVM style address of the locker

    Returns Promise<bigint>

    the amount of LGP-LP locked as wei

lp

  • lp(): Promise<string>

  • Get the LGP-LP contract address

    Returns Promise<string>

    the EVM style address of the LGP-LP contract

lpAddQuote

  • lpAddQuote(amountMRX, amountGMRX): Promise<bigint>

  • Get a quote for LP based on the current reserves in the pool

    Parameters

    • amountMRX: bigint

      amount of MRX to add as satoshi

    • amountGMRX: bigint

      amount of gMRX to add as satoshi

    Returns Promise<bigint>

    the amount of LGP-LP to receive as wei

lpRemoveQuote

  • lpRemoveQuote(amountLP): Promise<[amountMRX: bigint, amountGMRX: bigint]>

  • Get a redemption quote based on the current reserves in the pool

    Parameters

    • amountLP: bigint

      amount of LGP-LP to add as wei

    Returns Promise<[amountMRX: bigint, amountGMRX: bigint]>

    the amount of MRX and gMRX received as satoshi

mrx

  • mrx(): Promise<string>

  • Get the wMRX contract address

    Returns Promise<string>

    the EVM style address of the wMRX contract

removeLiquidity

  • removeLiquidity(amountLP, unwrapMRX?, gasLimit?): Promise<Transaction>

  • Remove liquidity for the underlying wMRX/MRX and gMRX

    Parameters

    • amountLP: bigint

      amount of LP to remove

    • unwrapMRX: boolean = false

      unwrap the wMRX to MRX

    • gasLimit: undefined | number = 250000

      the optional limit for gas units that can be consumed

    Returns Promise<Transaction>

    an array of TransactionReceipt objects

reserves

  • reserves(): Promise<[mrxReserve: bigint, gmrxReserve: bigint]>

  • Get the current reserves in the pool

    Returns Promise<[mrxReserve: bigint, gmrxReserve: bigint]>

    the reserves of the pool

send

  • send(method, args, value?, gasLimit?, gasPrice?): Promise<{
        hash160: string;
        sender: string;
        txid: string;
    }>

  • Perform sendtocontract

    Parameters

    • method: string

      The contract method to send to

    • args: any[]

      The arguments to use

    • Optionalvalue: string

      The amount to send to the contract

    • OptionalgasLimit: number

      The amount of gas units allowed

    • OptionalgasPrice: number

      The satoshi price per gas

    Returns Promise<{
        hash160: string;
        sender: string;
        txid: string;
    }>

    see Result

swapPairTokens

  • swapPairTokens(amount, from, to, minimum, slippage, unwrapMRX, gasLimit?): Promise<Transaction>

  • Swap between gMRX and wMRX

    Parameters

    • amount: bigint

      the amount of tokens to input as satoshi

    • from: string

      the input token

    • to: string

      the output token

    • minimum: bigint

      the minimum amount of tokens to receive as satoshi

    • slippage: bigint

      the allowed amount of slippage as basis points

    • unwrapMRX: boolean

      unwrap the wMRX to MRX

    • gasLimit: undefined | number = ...

      the optional limit for gas units that can be consumed

    Returns Promise<Transaction>

    an array of TransactionReceipt objects

swapQuote

  • swapQuote(from, to, amountIn): Promise<[amountOut: bigint, slippage: bigint]>

  • Get a swap quote based on the current reserves in the pool

    Parameters

    • from: string

      token to input

    • to: string

      token to output

    • amountIn: bigint

      input amount of tokens

    Returns Promise<[amountOut: bigint, slippage: bigint]>

    the price quote in satoshi and the slippage as basis points

swapTokens

  • swapTokens(minimum, slippage, amountMRX?, gasLimit?): Promise<Transaction>

  • Swap MRX for gMRX, sending MRX and automatically wrapping it

    Parameters

    • minimum: bigint

      the minimum amount of gMRX tokens to receive as satoshi

    • slippage: bigint

      the allowed amount of slippage as basis points

    • amountMRX: undefined | string = '0'

      amount of MRX to send with the transaction

    • gasLimit: undefined | number = 250000

      the optional limit for gas units that can be consumed

    Returns Promise<Transaction>

    an array of TransactionReceipt objects

totalLockedLP

  • totalLockedLP(): Promise<bigint>

  • Get the total amount of LGP-LP locked in the pool

    Returns Promise<bigint>

    the amount of LGP-LP locked as wei

traderDiscount

  • traderDiscount(trader): Promise<boolean>

  • Check if a specific trader has swap fee waiver

    Parameters

    • trader: string

      the EVM style address of the trader to check

    Returns Promise<boolean>

    if the trader a discount

unlockLP

  • unlockLP(amountLP, gasLimit?): Promise<Transaction>

  • Unlock liquidity in the pool

    Parameters

    • amountLP: bigint

      the amount of LGP-LP to remove

    • gasLimit: undefined | number = 250000

      the optional limit for gas units that can be consumed

    Returns Promise<Transaction>

    an array of TransactionReceipt objects

Settings

Member Visibility

On This Page

Constructors
Properties
Methods