Class Coinswap

Implementation of the Constant Product Market Maker Model token exchange protocol on IRISHub.

Hierarchy

Coinswap

Index

Methods

Methods

buy

buy(request: SwapOrderRequest, baseTx: BaseTx): Promise<TxResult>

- Defined in src/modules/coinswap.ts:100
Swap coin by exact output, calculated input

since

v1.0

Parameters
- request: SwapOrderRequest
  
  Buy order request
- baseTx: BaseTx
Returns Promise<TxResult>

calculateDeposit

calculateDeposit(exactStdAmt: number, calculatedDenom: string): Promise<DepositRequest>

- Defined in src/modules/coinswap.ts:269
Calculate token amount and liquidity amount of the deposit request by exact standard token amount

since

v1.0

Parameters
- exactStdAmt: number
  
  Exact standard token amount to be deposited
- calculatedDenom: string
  
  The token denom being calculated
Returns Promise<DepositRequest>

The DepositRequest, max_token = -1 means the liquidity pool is empty, users can deposit any amount of the token

Private calculateDoubleWithExactInput

calculateDoubleWithExactInput(exactSoldCoin: Coin, boughtTokenDenom: string): Promise<number>

- Defined in src/modules/coinswap.ts:357
Parameters
- exactSoldCoin: Coin
- boughtTokenDenom: string
Returns Promise<number>

Private calculateDoubleWithExactOutput

calculateDoubleWithExactOutput(exactBoughtCoin: Coin, soldTokenDenom: string): Promise<number>

- Defined in src/modules/coinswap.ts:372
Parameters
- exactBoughtCoin: Coin
- soldTokenDenom: string
Returns Promise<number>

calculateWithExactInput

calculateWithExactInput(exactSoldCoin: Coin, boughtTokenDenom: string): Promise<number>

- Defined in src/modules/coinswap.ts:147
Calculate the amount of another token to be received based on the exact amount of tokens sold

since

v1.0

Parameters
- exactSoldCoin: Coin
  
  sold coin
- boughtTokenDenom: string
Returns Promise<number>

output token amount to be received

calculateWithExactOutput

calculateWithExactOutput(exactBoughtCoin: Coin, soldTokenDenom: string): Promise<number>

- Defined in src/modules/coinswap.ts:206
Calculate the amount of the token to be paid based on the exact amount of the token to be bought

return:

input amount to be paid

since

v1.0

Parameters
- exactBoughtCoin: Coin
- soldTokenDenom: string
Returns Promise<number>

calculateWithdraw

calculateWithdraw(exactWithdrawLiquidity: Coin): Promise<WithdrawRequest>

- Defined in src/modules/coinswap.ts:312
Calculate how many tokens can be withdrawn by exact liquidity amount

since

v1.0

Parameters
- exactWithdrawLiquidity: Coin
  
  Exact liquidity amount to be withdrawn
Returns Promise<WithdrawRequest>

The WithdrawRequest

deposit

deposit(request: DepositRequest, baseTx: BaseTx): Promise<TxResult>

- Defined in src/modules/coinswap.ts:66
Add liquidity by exact iris amount, calculated token and liquidity amount

since

v1.0

Parameters
- request: DepositRequest
  
  Add liquidity request
- baseTx: BaseTx
Returns Promise<TxResult>

Private getInputPrice

getInputPrice(inputAmt: number, inputReserve: number, outputReserve: number, fee: number): number

- Defined in src/modules/coinswap.ts:390
Parameters
- inputAmt: number
- inputReserve: number
- outputReserve: number
- fee: number
Returns number

Private getOutputPrice

getOutputPrice(outputAmt: number, inputReserve: number, outputReserve: number, fee: number): number

- Defined in src/modules/coinswap.ts:408
Parameters
- outputAmt: number
- inputReserve: number
- outputReserve: number
- fee: number
Returns number

Private getUniDenomFromDenoms

getUniDenomFromDenoms(denom1: string, denom2: string): string

- Defined in src/modules/coinswap.ts:125
Parameters
- denom1: string
- denom2: string
Returns string

queryLiquidity

queryLiquidity(id: string): Promise<Liquidity>

- Defined in src/modules/coinswap.ts:50
Query liquidity by id

since

v1.0

Parameters
- id: string
  
  The liquidity id
Returns Promise<Liquidity>

sell

sell(request: SwapOrderRequest, baseTx: BaseTx): Promise<TxResult>

- Defined in src/modules/coinswap.ts:116
Swap coin by exact input, calculated output

since

v1.0

Parameters
- request: SwapOrderRequest
  
  Sell order request
- baseTx: BaseTx
Returns Promise<TxResult>

withdraw

withdraw(request: WithdrawRequest, baseTx: BaseTx): Promise<TxResult>

- Defined in src/modules/coinswap.ts:83
Remove liquidity by exact liquidity amount, calculated iris and token amount

since

v1.0

Parameters
- request: WithdrawRequest
  
  Remove liquidity request
- baseTx: BaseTx
Returns Promise<TxResult>

Generated using TypeDoc