Class AMM`Namespace`

Class representing AMM contract AMM

Hierarchy

Base
- AMM

Index

Constructors

constructor

new AMM(networkOrOptionsObject, tokenSymbol?, chain?, signer?, chainProviders?): AMM
Parameters
- networkOrOptionsObject: string | AmmConstructorOptions
  
  L1 network name (e.g. 'mainnet', 'goerli')
- Optional tokenSymbol: string
  
  Token model
- Optional chain: TChain
  
  Chain model
- Optional signer: TProvider
  
  Ethers Signer for signing transactions.
- Optional chainProviders: ChainProviders
Returns AMM
Desc
Instantiates AMM instance. Returns a new Hop AMM SDK instance.

Returns
Hop AMM instance

Example
```
import { AMM, Chain } from '@hop-protocol/sdk'

const amm = new AMM('mainnet', 'USDC', Chain.Gnosis)
```
Overrides Base.constructor
- Defined in src/AMM.ts:44

Properties

addresses

addresses: Record<string, any>

baseConfigUrl

baseConfigUrl: string = defaultBaseConfigUrl

baseExplorerUrl

baseExplorerUrl: string = 'https://explorer.hop.exchange'

blocklist

blocklist: Record<string, boolean> = null

bonders

bonders: Record<string, any>

bridgeDeprecated

bridgeDeprecated: Record<string, boolean>

calculateSwap

calculateSwap: ((...args) => Promise<any>) = ...

Type declaration

- (...args): Promise<any>
- Parameters
  - Rest ...args: [fromIndex: TokenIndex, toIndex: TokenIndex, amount: BigNumberish]
  Returns Promise<any>

chain

chain: Chain

Chain model

chainProviders

chainProviders: ChainProviders = {}

chains

chains: Record<string, any>

configFileFetchEnabled

configFileFetchEnabled: boolean = true

customAvailableLiquidityJsonUrl

customAvailableLiquidityJsonUrl: string = ''

customCoreConfigJsonUrl

customCoreConfigJsonUrl: string = ''

debugTimeLogsCache

debugTimeLogsCache: any[] = []

debugTimeLogsCacheEnabled

debugTimeLogsCacheEnabled: boolean = false

debugTimeLogsEnabled

debugTimeLogsEnabled: boolean = false

destinationFeeGasPriceMultiplier

destinationFeeGasPriceMultiplier: number = 1

fees

fees: {
[token: string]: Record<string, number>;
}

Type declaration

[token: string]: Record<string, number>

gasPriceMultiplier

gasPriceMultiplier: number = 0

getContract

getContract: ((factory, address, provider) => Promise<any>) = getContract

Type declaration

- (factory, address, provider): Promise<any>
- Parameters
  - factory: Factory
  - address: string
  - provider: TProvider
  Returns Promise<any>

getGasPrice

getGasPrice: ((...args) => Promise<BigNumber>) = ...

Type declaration

- (...args): Promise<BigNumber>
- Parameters
  - Rest ...args: [signerOrProvider: TProvider]
  Returns Promise<BigNumber>

network

network: string

Network name

relayerFeeEnabled

relayerFeeEnabled: Record<string, boolean>

relayerFeeWei

relayerFeeWei: Record<string, string>

signer

signer: TProvider

Ethers signer or provider

tokenSymbol

tokenSymbol: string

Token class instance

Accessors

availableLiqudityJsonUrl

get availableLiqudityJsonUrl(): string
Returns string
Inherited from Base.availableLiqudityJsonUrl
- Defined in src/Base.ts:876

configChains

get configChains(): string[]
Returns string[]
Inherited from Base.configChains
- Defined in src/Base.ts:366

coreConfigJsonUrl

get coreConfigJsonUrl(): string
Returns string
Inherited from Base.coreConfigJsonUrl
- Defined in src/Base.ts:827

defaultDeadlineSeconds

get defaultDeadlineSeconds(): number
Returns number
Deadline in seconds

Desc
The default deadline to use in seconds.
- Defined in src/AMM.ts:562

supportedChains

get supportedChains(): string[]
Returns string[]
Inherited from Base.supportedChains
- Defined in src/Base.ts:361

supportedNetworks

get supportedNetworks(): string[]
Returns string[]
Inherited from Base.supportedNetworks
- Defined in src/Base.ts:351

Methods

`Protected` _getBonderAddress

_getBonderAddress(token, sourceChain, destinationChain): Promise<string>
Parameters
- token: TToken
- sourceChain: TChain
- destinationChain: TChain
Returns Promise<string>
Inherited from Base._getBonderAddress
- Defined in src/Base.ts:689

`Protected` _getMessengerWrapperAddress

_getMessengerWrapperAddress(token, destinationChain): Promise<string>
Parameters
- token: TToken
- destinationChain: TChain
Returns Promise<string>
Inherited from Base._getMessengerWrapperAddress
- Defined in src/Base.ts:703

addLiquidity

addLiquidity(amount0Desired, amount1Desired, minToMint?, deadline?): Promise<TransactionResponse>
Parameters
- amount0Desired: BigNumberish
  
  Amount of token #0 in smallest unit
- amount1Desired: BigNumberish
  
  Amount of token #1 in smallest unit
- minToMint: BigNumberish = 0
  
  Minimum amount of LP token to mint in order for transaction to be successful.
- deadline: BigNumberish = ...
  
  Order deadline in seconds
Returns Promise<TransactionResponse>
Ethers transaction object.
Desc
Sends transaction to add liquidity to AMM.

Example
```
import { AMM } from '@hop-protocol/sdk'

const amm = new AMM(...)
const tx = await amm.addLiquidity('1000000000000000000', '1000000000000000000', '0')
console.log(tx.hash)
```
- Defined in src/AMM.ts:114

calcYield

calcYield(feesEarned, principal, days): any
Parameters
- feesEarned: number
- principal: number
- days: number
Returns any
- Defined in src/AMM.ts:485

calculateAddLiquidityMinimum

calculateAddLiquidityMinimum(amount0, amount1): Promise<BigNumber>
Parameters
- amount0: BigNumberish
- amount1: BigNumberish
Returns Promise<BigNumber>
- Defined in src/AMM.ts:264

calculateAmountsForLpToken

calculateAmountsForLpToken(lpTokenAmount): Promise<BigNumber[]>
Parameters
- lpTokenAmount: BigNumberish
Returns Promise<BigNumber[]>
- Defined in src/AMM.ts:628

calculateFromHToken

calculateFromHToken(amount): Promise<BigNumber>
Parameters
- amount: BigNumberish
Returns Promise<BigNumber>
- Defined in src/AMM.ts:256

`Private` calculatePriceImpact

calculatePriceImpact(tokenInputAmount, tokenOutputAmount, virtualPrice?, isWithdraw?): BigNumber
Parameters
- tokenInputAmount: BigNumber
- tokenOutputAmount: BigNumber
- virtualPrice: BigNumber = ...
- isWithdraw: boolean = false
Returns BigNumber
- Defined in src/AMM.ts:588

calculateRemoveLiquidityMinimum

calculateRemoveLiquidityMinimum(lpTokenAmount): Promise<any>
Parameters
- lpTokenAmount: BigNumberish
Returns Promise<any>
- Defined in src/AMM.ts:290

calculateRemoveLiquidityMinimumLpTokens

calculateRemoveLiquidityMinimumLpTokens(amount0, amount1): Promise<BigNumber>
Parameters
- amount0: BigNumberish
- amount1: BigNumberish
Returns Promise<BigNumber>
- Defined in src/AMM.ts:304

calculateRemoveLiquidityOneToken

calculateRemoveLiquidityOneToken(tokenAmount, tokenIndex): Promise<any>
Parameters
- tokenAmount: BigNumberish
- tokenIndex: number
Returns Promise<any>
- Defined in src/AMM.ts:230

calculateToHToken

calculateToHToken(amount): Promise<BigNumber>
Parameters
- amount: BigNumberish
Returns Promise<BigNumber>
- Defined in src/AMM.ts:248

calculateTotalAmountForLpToken

calculateTotalAmountForLpToken(lpTokenAmount): Promise<BigNumber>
Parameters
- lpTokenAmount: BigNumberish
Returns Promise<BigNumber>
- Defined in src/AMM.ts:638

checkBlocklist

checkBlocklist(): Promise<void>
Returns Promise<void>
Inherited from Base.checkBlocklist
- Defined in src/Base.ts:293

connect

connect(signer): AMM
Parameters
- signer: TProvider
  
  Ethers Signer for signing transactions.
Returns AMM
Hop AMM instance with connected signer.
Desc
Returns hop AMM instance with signer connected. Used for adding or changing signer.

Example
```
import { AMM } from '@hop-protocol/sdk'

const signer = new Wallet(privateKey)
let amm = new AMM(...)
// ...
amm = amm.connect(signer)
```
- Defined in src/AMM.ts:85

debugTimeLog

debugTimeLog(label, timeStart): void
Parameters
- label: string
- timeStart: number
Returns void
Inherited from Base.debugTimeLog
- Defined in src/Base.ts:1076

estimateGas

estimateGas(signerOrProvider, tx): Promise<BigNumber>
Parameters
- signerOrProvider: TProvider
- tx: any
Returns Promise<BigNumber>
Inherited from Base.estimateGas
- Defined in src/Base.ts:1069

estimateOptimismL1FeeFromData

estimateOptimismL1FeeFromData(gasLimit, data?, to?, destChain?): Promise<any>
Parameters
- gasLimit: BigNumberish
- data: string = '0x'
- to: string = constants.AddressZero
- destChain: string | Chain = Chain.Optimism
Returns Promise<any>
Inherited from Base.estimateOptimismL1FeeFromData
- Defined in src/Base.ts:942

fetchBonderAvailableLiquidityData

fetchBonderAvailableLiquidityData(): Promise<any>
Returns Promise<any>
Inherited from Base.fetchBonderAvailableLiquidityData
- Defined in src/Base.ts:835

fetchBonderAvailableLiquidityDataWithIpfsFallback

fetchBonderAvailableLiquidityDataWithIpfsFallback(): Promise<any>
Returns Promise<any>
Inherited from Base.fetchBonderAvailableLiquidityDataWithIpfsFallback
- Defined in src/Base.ts:853

fetchConfigFromS3

fetchConfigFromS3(): Promise<any>
Returns Promise<any>
Inherited from Base.fetchConfigFromS3
- Defined in src/Base.ts:243

fetchCoreConfigData

fetchCoreConfigData(): Promise<any>
Returns Promise<any>
Inherited from Base.fetchCoreConfigData
- Defined in src/Base.ts:789

fetchCoreConfigDataWithIpfsFallback

fetchCoreConfigDataWithIpfsFallback(): Promise<any>
Returns Promise<any>
Inherited from Base.fetchCoreConfigDataWithIpfsFallback
- Defined in src/Base.ts:799

fetchIpfsBonderAvailableLiquidityData

fetchIpfsBonderAvailableLiquidityData(): Promise<any>
Returns Promise<any>
Inherited from Base.fetchIpfsBonderAvailableLiquidityData
- Defined in src/Base.ts:1045

fetchIpfsCoreConfigData

fetchIpfsCoreConfigData(): Promise<any>
Returns Promise<any>
Inherited from Base.fetchIpfsCoreConfigData
- Defined in src/Base.ts:1034

geConfigChains

geConfigChains(): string[]
Returns string[]
Inherited from Base.geConfigChains
- Defined in src/Base.ts:375

getApr

getApr(days?): Promise<any>
Parameters
- days: number = 1
Returns Promise<any>
- Defined in src/AMM.ts:449

getApy

getApy(days?): Promise<any>
Parameters
- days: number = 1
Returns Promise<any>
- Defined in src/AMM.ts:454

getArbChainAddress

getArbChainAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getArbChainAddress
- Defined in src/Base.ts:611

getAvailableRoutes

getAvailableRoutes(): Promise<any>
Returns Promise<any>
Inherited from Base.getAvailableRoutes
- Defined in src/Base.ts:917

getBumpedGasPrice

getBumpedGasPrice(signer, percent): Promise<BigNumber>
Parameters
- signer: TProvider
  
  Ether's Signer
- percent: number
  
  Percentage to bump by.
Returns Promise<BigNumber>
Bumped as price as BigNumber
Desc
Calculates current gas price plus increased percentage amount.

Example
```
import { Hop } from '@hop-protocol/sdk'

const hop = new Hop()
const bumpedGasPrice = await hop.getBumpedGasPrice(signer, 1.20)
console.log(bumpedGasPrice.toNumber())
```
Inherited from Base.getBumpedGasPrice
- Defined in src/Base.ts:442

getCanonicalTokenAddress

getCanonicalTokenAddress(): Promise<string>
Returns Promise<string>
address

Desc
Returns the address of the L2 canonical token.
- Defined in src/AMM.ts:330

getChainId

getChainId(chain): number
Parameters
- chain: Chain
  
  Chain model.
Returns number
- Chain ID.
Desc
Returns Chain ID for specified Chain model.
Inherited from Base.getChainId
- Defined in src/Base.ts:452

getChainProvider

getChainProvider(chain): any
Parameters
- chain: string | Chain
  
  Chain model.
Returns any
Ethers provider.

Desc
Returns Ethers provider for specified Chain model.
Inherited from Base.getChainProvider
- Defined in src/Base.ts:462

getChainProviderUrls

getChainProviderUrls(): any
Returns any
Inherited from Base.getChainProviderUrls
- Defined in src/Base.ts:493

getChainProviders

getChainProviders(): any
Returns any
Inherited from Base.getChainProviders
- Defined in src/Base.ts:483

getConfigAddresses

getConfigAddresses(token, chain): any
Parameters
- token: TToken
- chain: TChain
Returns any
Inherited from Base.getConfigAddresses
- Defined in src/Base.ts:564

getDailyVolume

getDailyVolume(): Promise<any>
Returns Promise<any>
- Defined in src/AMM.ts:441

getDebugTimeLogs

getDebugTimeLogs(): any[]
Returns any[]
Inherited from Base.getDebugTimeLogs
- Defined in src/Base.ts:1091

getDestinationFeeGasPriceMultiplier

getDestinationFeeGasPriceMultiplier(): number
Returns number
Inherited from Base.getDestinationFeeGasPriceMultiplier
- Defined in src/Base.ts:741

getExplorerUrl

getExplorerUrl(): string
Returns string
Inherited from Base.getExplorerUrl
- Defined in src/Base.ts:966

getExplorerUrlForAccount

getExplorerUrlForAccount(accountAddress): string
Parameters
- accountAddress: string
Returns string
Inherited from Base.getExplorerUrlForAccount
- Defined in src/Base.ts:970

getExplorerUrlForTransactionHash

getExplorerUrlForTransactionHash(transactionHash): string
Parameters
- transactionHash: string
Returns string
Inherited from Base.getExplorerUrlForTransactionHash
- Defined in src/Base.ts:978

getExplorerUrlForTransferId

getExplorerUrlForTransferId(transferId): string
Parameters
- transferId: string
Returns string
Inherited from Base.getExplorerUrlForTransferId
- Defined in src/Base.ts:974

getFeeBps

getFeeBps(token, destinationChain): Promise<number>
Parameters
- token: TToken
- destinationChain: TChain
Returns Promise<number>
Inherited from Base.getFeeBps
- Defined in src/Base.ts:716

getHopTokenAddress

getHopTokenAddress(): Promise<string>
Returns Promise<string>
address

Desc
Returns the address of the L2 hop token.
- Defined in src/AMM.ts:338

getIpfsBaseConfigUrl

getIpfsBaseConfigUrl(ipfsHash): string
Parameters
- ipfsHash: string
Returns string
Inherited from Base.getIpfsBaseConfigUrl
- Defined in src/Base.ts:1029

getIsBridgeDeprecated

getIsBridgeDeprecated(token): Promise<boolean>
Parameters
- token: TToken
Returns Promise<boolean>
Inherited from Base.getIsBridgeDeprecated
- Defined in src/Base.ts:745

getL1AmbBridgeAddress

getL1AmbBridgeAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL1AmbBridgeAddress
- Defined in src/Base.ts:616

getL1BridgeAddress

getL1BridgeAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL1BridgeAddress
- Defined in src/Base.ts:570

getL1CanonicalBridgeAddress

getL1CanonicalBridgeAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL1CanonicalBridgeAddress
- Defined in src/Base.ts:578

getL1CanonicalTokenAddress

getL1CanonicalTokenAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL1CanonicalTokenAddress
- Defined in src/Base.ts:586

getL1PosErc20PredicateAddress

getL1PosErc20PredicateAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL1PosErc20PredicateAddress
- Defined in src/Base.ts:631

getL1PosRootChainManagerAddress

getL1PosRootChainManagerAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL1PosRootChainManagerAddress
- Defined in src/Base.ts:626

getL2AmbBridgeAddress

getL2AmbBridgeAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL2AmbBridgeAddress
- Defined in src/Base.ts:621

getL2AmmWrapperAddress

getL2AmmWrapperAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL2AmmWrapperAddress
- Defined in src/Base.ts:598

getL2BridgeAddress

getL2BridgeAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL2BridgeAddress
- Defined in src/Base.ts:574

getL2CanonicalBridgeAddress

getL2CanonicalBridgeAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL2CanonicalBridgeAddress
- Defined in src/Base.ts:582

getL2CanonicalTokenAddress

getL2CanonicalTokenAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL2CanonicalTokenAddress
- Defined in src/Base.ts:590

getL2HopBridgeTokenAddress

getL2HopBridgeTokenAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL2HopBridgeTokenAddress
- Defined in src/Base.ts:594

getL2SaddleLpTokenAddress

getL2SaddleLpTokenAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL2SaddleLpTokenAddress
- Defined in src/Base.ts:606

getL2SaddleSwapAddress

getL2SaddleSwapAddress(token, chain): string
Parameters
- token: TToken
- chain: TChain
Returns string
Inherited from Base.getL2SaddleSwapAddress
- Defined in src/Base.ts:602

getPriceImpact

getPriceImpact(amount0, amount1): Promise<BigNumber>
Parameters
- amount0: BigNumberish
- amount1: BigNumberish
Returns Promise<BigNumber>
- Defined in src/AMM.ts:498

getProviderRpcUrl

getProviderRpcUrl(provider): string
Parameters
- provider: any
Returns string
Inherited from Base.getProviderRpcUrl
- Defined in src/Base.ts:996

getRelayerFee

getRelayerFee(destinationChain, tokenSymbol): Promise<BigNumber>
Parameters
- destinationChain: TChain
- tokenSymbol: string
Returns Promise<BigNumber>
Inherited from Base.getRelayerFee
- Defined in src/Base.ts:755

getRemoveLiquidityPriceImpact

getRemoveLiquidityPriceImpact(amount0, amount1): Promise<BigNumber>
Parameters
- amount0: BigNumberish
- amount1: BigNumberish
Returns Promise<BigNumber>
- Defined in src/AMM.ts:523

getReserves

getReserves(): Promise<BigNumber[]>
Returns Promise<BigNumber[]>
- Defined in src/AMM.ts:615

getReservesTotal

getReservesTotal(): Promise<BigNumber>
Returns Promise<BigNumber>
- Defined in src/AMM.ts:623

getS3ConfigData

getS3ConfigData(): Promise<any>
Returns Promise<any>
Inherited from Base.getS3ConfigData
- Defined in src/Base.ts:815

getSaddleSwap

getSaddleSwap(): Promise<any>
Returns Promise<any>
Ethers contract instance.

Desc
Returns the Saddle swap contract instance for the specified chain.
- Defined in src/AMM.ts:346

getSignerAddress

getSignerAddress(): Promise<string>
Returns Promise<string>
Ethers signer address.
Desc
Returns the connected signer address.

Example
```
import { Hop } from '@hop-protocol/sdk'

const hop = new Hop()
const address = await hop.getSignerAddress()
console.log(address)
```
Inherited from Base.getSignerAddress
- Defined in src/Base.ts:515

getSignerOrProvider

getSignerOrProvider(chain, signer?): Promise<Provider | Signer>
Parameters
- chain: TChain
  
  Chain name or model
- signer: TProvider = ...
  
  Ethers signer or provider
Returns Promise<Provider | Signer>
Ethers signer or provider

Desc
Returns the connected signer if it's connected to the specified chain id, otherwise it returns a regular provider for the specified chain.
Inherited from Base.getSignerOrProvider
- Defined in src/Base.ts:528

getSupportedAssets

getSupportedAssets(): any
Returns any
Inherited from Base.getSupportedAssets
- Defined in src/Base.ts:897

getSupportedAssetsForChain

getSupportedAssetsForChain(chain): any
Parameters
- chain: TChain
Returns any
Inherited from Base.getSupportedAssetsForChain
- Defined in src/Base.ts:911

getSupportedChains

getSupportedChains(): string[]
Returns string[]
Inherited from Base.getSupportedChains
- Defined in src/Base.ts:371

getSupportedTokens

getSupportedTokens(): string[]
Returns string[]
Inherited from Base.getSupportedTokens
- Defined in src/Base.ts:887

getSwapFee

getSwapFee(): Promise<number>
Returns Promise<number>
- Defined in src/AMM.ts:360

getTokenBalancesForAccount

getTokenBalancesForAccount(accountAddress): Promise<Balance[]>
Parameters
- accountAddress: string
Returns Promise<Balance[]>
Inherited from Base.getTokenBalancesForAccount
- Defined in src/Base.ts:1098

getTransferStatus

getTransferStatus(transferIdOrTxHash): Promise<any>
Parameters
- transferIdOrTxHash: string
Returns Promise<any>
Inherited from Base.getTransferStatus
- Defined in src/Base.ts:982

getTransferTimes

getTransferTimes(sourceChainSlug, destinationChainSlug): Promise<any>
Parameters
- sourceChainSlug: string
- destinationChainSlug: string
Returns Promise<any>
Inherited from Base.getTransferTimes
- Defined in src/Base.ts:989

getVirtualPrice

getVirtualPrice(): Promise<BigNumber>
Returns Promise<BigNumber>
- Defined in src/AMM.ts:493

getYieldData

getYieldData(days?): Promise<any>
Parameters
- days: number = 1
Returns Promise<any>
- Defined in src/AMM.ts:459

getYieldStatsForDay

getYieldStatsForDay(unixTimestamp, days?): Promise<any>
Parameters
- unixTimestamp: number
- days: number = 1
Returns Promise<any>
- Defined in src/AMM.ts:368

isHighPriceImpact

isHighPriceImpact(priceImpact): boolean
Parameters
- priceImpact: BigNumber
Returns boolean
- Defined in src/AMM.ts:576

isValidChain

isValidChain(chain): boolean
Parameters
- chain: string
Returns boolean
Inherited from Base.isValidChain
- Defined in src/Base.ts:379

isValidNetwork

isValidNetwork(network): boolean
Parameters
- network: string
Returns boolean
Inherited from Base.isValidNetwork
- Defined in src/Base.ts:355

`Private` normalizeDeadline

normalizeDeadline(deadline): number
Parameters
- deadline: BigNumberish
  
  deadline timestamp
Returns number
Deadline in seconds

Desc
Truncate any decimal places in deadline unix timestamp.
- Defined in src/AMM.ts:572

populateAddLiquidityTx

populateAddLiquidityTx(amount0Desired, amount1Desired, minToMint?, deadline?): Promise<any>
Parameters
- amount0Desired: BigNumberish
- amount1Desired: BigNumberish
- minToMint: BigNumberish = 0
- deadline: BigNumberish = ...
Returns Promise<any>
- Defined in src/AMM.ts:124

populateRemoveLiquidityTx

populateRemoveLiquidityTx(liquidityTokenAmount, amount0Min?, amount1Min?, deadline?): Promise<any>
Parameters
- liquidityTokenAmount: BigNumberish
- amount0Min: BigNumberish = 0
- amount1Min: BigNumberish = 0
- deadline: BigNumberish = ...
Returns Promise<any>
- Defined in src/AMM.ts:172

removeLiquidity

removeLiquidity(liquidityTokenAmount, amount0Min?, amount1Min?, deadline?): Promise<TransactionResponse>
Parameters
- liquidityTokenAmount: BigNumberish
  
  Amount of LP tokens to burn.
- amount0Min: BigNumberish = 0
  
  Minimum amount of token #0 to receive in order for transaction to be successful.
- amount1Min: BigNumberish = 0
  
  Minimum amount of token #1 to receive in order for transaction to be successful. transaction to be successful.
- deadline: BigNumberish = ...
  
  Order deadline in seconds
Returns Promise<TransactionResponse>
Ethers transaction object.
Desc
Sends transaction to remove liquidity from AMM.

Example
```
import { AMM } from '@hop-protocol/sdk'

const amm = new AMM(...)
const tx = await amm.removeLiquidity('1000000000000000000', '0', '0')
console.log(tx.hash)
```
- Defined in src/AMM.ts:162

removeLiquidityImbalance

removeLiquidityImbalance(amount0, amount1, maxBurnAmount?, deadline?): Promise<any>
Parameters
- amount0: BigNumberish
- amount1: BigNumberish
- maxBurnAmount: BigNumberish = ...
- deadline: BigNumberish = ...
Returns Promise<any>
- Defined in src/AMM.ts:213

removeLiquidityOneToken

removeLiquidityOneToken(lpAmount, tokenIndex, amountMin?, deadline?): Promise<any>
Parameters
- lpAmount: BigNumberish
- tokenIndex: number
- amountMin: BigNumberish = ...
- deadline: BigNumberish = ...
Returns Promise<any>
- Defined in src/AMM.ts:191

resolveDnslink

resolveDnslink(dnslinkDomain): Promise<string>
Parameters
- dnslinkDomain: string
Returns Promise<string>
Inherited from Base.resolveDnslink
- Defined in src/Base.ts:1000

sendTransaction

sendTransaction(transactionRequest, chain): Promise<any>
Parameters
- transactionRequest: TransactionRequest
- chain: TChain
Returns Promise<any>
Inherited from Base.sendTransaction
- Defined in src/Base.ts:287

setAvailableLiqudityJsonUrl

setAvailableLiqudityJsonUrl(url): Promise<void>
Parameters
- url: string
Returns Promise<void>
Inherited from Base.setAvailableLiqudityJsonUrl
- Defined in src/Base.ts:869

setBaseConfigUrl

setBaseConfigUrl(url): Promise<void>
Parameters
- url: string
Returns Promise<void>
Inherited from Base.setBaseConfigUrl
- Defined in src/Base.ts:774

setChainProvider

setChainProvider(chain, provider): void
Parameters
- chain: TChain
- provider: Provider
Returns void
Inherited from Base.setChainProvider
- Defined in src/Base.ts:313

setChainProviderUrls

setChainProviderUrls(chainProviders): void
Parameters
- chainProviders: Record<string, string>
Returns void
Inherited from Base.setChainProviderUrls
- Defined in src/Base.ts:337

setChainProviders

setChainProviders(chainProviders): void
Parameters
- chainProviders: ChainProviders
Returns void
Inherited from Base.setChainProviders
- Defined in src/Base.ts:323

setConfigAddresses

setConfigAddresses(addresses): void
Parameters
- addresses: Addresses
Returns void
Inherited from Base.setConfigAddresses
- Defined in src/Base.ts:304

setConfigFileFetchEnabled

setConfigFileFetchEnabled(enabled): void
Parameters
- enabled: boolean
Returns void
Inherited from Base.setConfigFileFetchEnabled
- Defined in src/Base.ts:785

setCoreConfigJsonUrl

setCoreConfigJsonUrl(url): Promise<any>
Parameters
- url: string
Returns Promise<any>
Inherited from Base.setCoreConfigJsonUrl
- Defined in src/Base.ts:820

setGasPriceMultiplier

setGasPriceMultiplier(gasPriceMultiplier): number
Parameters
- gasPriceMultiplier: number
Returns number
Inherited from Base.setGasPriceMultiplier
- Defined in src/Base.ts:737

toChainModel

toChainModel(chain): Chain
Parameters
- chain: TChain
  
  Chain name or model.
Returns Chain
Chain model with connected provider.

Desc
Returns a Chain model instance with connected provider.
Inherited from Base.toChainModel
- Defined in src/Base.ts:388

toTokenModel

toTokenModel(token): TokenModel
Parameters
- token: TToken
  
  Token name or model.
Returns TokenModel
Token model.

Desc
Returns a Token instance.
Inherited from Base.toTokenModel
- Defined in src/Base.ts:418

txOverrides

txOverrides(sourceChain, destinationChain?): Promise<any>
Parameters
- sourceChain: TChain
- Optional destinationChain: TChain
Returns Promise<any>
Inherited from Base.txOverrides
- Defined in src/Base.ts:636

Class AMMNamespace

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

networkOrOptionsObject: string | AmmConstructorOptions

Optional tokenSymbol: string

Optional chain: TChain

Optional signer: TProvider

Optional chainProviders: ChainProviders

Returns AMM

Desc

Returns

Example

Properties

addresses

baseConfigUrl

baseExplorerUrl

blocklist

bonders

bridgeDeprecated

calculateSwap

Type declaration

Parameters

Rest ...args: [fromIndex: TokenIndex, toIndex: TokenIndex, amount: BigNumberish]

Returns Promise<any>

chain

chainProviders

chains

configFileFetchEnabled

customAvailableLiquidityJsonUrl

customCoreConfigJsonUrl

debugTimeLogsCache

debugTimeLogsCacheEnabled

debugTimeLogsEnabled

destinationFeeGasPriceMultiplier

fees

Type declaration

[token: string]: Record<string, number>

gasPriceMultiplier

getContract

Type declaration

Parameters

factory: Factory

address: string

provider: TProvider

Returns Promise<any>

getGasPrice

Type declaration

Parameters

Rest ...args: [signerOrProvider: TProvider]

Returns Promise<BigNumber>

network

relayerFeeEnabled

relayerFeeWei

signer

tokenSymbol

Accessors

availableLiqudityJsonUrl

Returns string

configChains

Returns string[]

coreConfigJsonUrl

Returns string

defaultDeadlineSeconds

Returns number

Desc

supportedChains

Returns string[]

supportedNetworks

Returns string[]

Methods

Protected _getBonderAddress

Parameters

token: TToken

Class AMM`Namespace`

`Optional` tokenSymbol: string

`Optional` chain: TChain

`Optional` signer: TProvider

`Optional` chainProviders: ChainProviders

`Rest` ...args: [fromIndex: TokenIndex, toIndex: TokenIndex, amount: BigNumberish]

`Rest` ...args: [signerOrProvider: TProvider]

`Protected` _getBonderAddress

`Protected` _getMessengerWrapperAddress

`Private` calculatePriceImpact