Class OmniBridge`Abstract`

Hierarchy

OmniBridge
- ForeignBridge
- HomeBridge

Index

Constructors

Properties

Methods

calculateAmount checkLimits getBridgeToken getDataForNativeSwap getDataForTokenSwap getMinAmountToken isTokenRegistered isCustomWrap

Constructors

constructor

new OmniBridge(fromToken: Token<"ETH" | "PULSECHAIN">, toToken: Token<"ETH" | "PULSECHAIN">): OmniBridge
Parameters
- fromToken: Token<"ETH" | "PULSECHAIN">
- toToken: Token<"ETH" | "PULSECHAIN">
Returns OmniBridge
- Defined in src/features/cross-chain/calculation-manager/providers/pulse-chain-bridge/omni-bridge-entities/omni-bridge.ts:41

Properties

`Readonly` sourceBridgeAddress

sourceBridgeAddress: string

Methods

calculateAmount

calculateAmount(toAddress: string, fromAmount: string): Promise<BigNumber>
Calculate output amount for trade.
Parameters
- toAddress: string
  
  Token address in target network.
- fromAmount: string
  
  Amount of tokens to send.
Returns Promise<BigNumber>
- Defined in src/features/cross-chain/calculation-manager/providers/pulse-chain-bridge/omni-bridge-entities/omni-bridge.ts:194

checkLimits

checkLimits(fromAddress: string, toAddress: string, amount: string): Promise<void>
Check if allowed to swap.
Parameters
- fromAddress: string
  
  Token address in source network.
- toAddress: string
  
  Token address in target network.
- amount: string
  
  Swap amount.
Returns Promise<void>
- Defined in src/features/cross-chain/calculation-manager/providers/pulse-chain-bridge/omni-bridge-entities/omni-bridge.ts:126

getBridgeToken

getBridgeToken(fromAddress: string): Promise<string>
Get bridge token address in target network.
Parameters
- fromAddress: string
  
  Token address in source network.
Returns Promise<string>
- Defined in src/features/cross-chain/calculation-manager/providers/pulse-chain-bridge/omni-bridge-entities/omni-bridge.ts:93

`Abstract` getDataForNativeSwap

getDataForNativeSwap(receiverAddress: string, value: string): EvmEncodeConfig
Get swap data for native token trade.
Parameters
- receiverAddress: string
  
  Receiver address user get money to.
- value: string
  
  Amount of money user spend.
Returns EvmEncodeConfig
- Defined in src/features/cross-chain/calculation-manager/providers/pulse-chain-bridge/omni-bridge-entities/omni-bridge.ts:212

`Abstract` getDataForTokenSwap

getDataForTokenSwap(receiverAddress: string, amount: string, isERC677: boolean, tokenAddress: string): EvmEncodeConfig
Get swap data for native token trade.
Parameters
- receiverAddress: string
  
  Receiver address user get money to.
- amount: string
  
  Amount of money user spend.
- isERC677: boolean
  
  Is token part of ERC677 token standard.
- tokenAddress: string
  
  Address of sending token.
Returns EvmEncodeConfig
- Defined in src/features/cross-chain/calculation-manager/providers/pulse-chain-bridge/omni-bridge-entities/omni-bridge.ts:221

`Abstract` getMinAmountToken

getMinAmountToken(address: string): Promise<BigNumber>
Get min swap amount in source network.
Parameters
- address: string
  
  Token address in source network.
Returns Promise<BigNumber>
- Defined in src/features/cross-chain/calculation-manager/providers/pulse-chain-bridge/omni-bridge-entities/omni-bridge.ts:104

`Abstract` isTokenRegistered

isTokenRegistered(address: string): Promise<boolean>
Check if token registered in source network.
Parameters
- address: string
  
  Token address in source network.
Returns Promise<boolean>
- Defined in src/features/cross-chain/calculation-manager/providers/pulse-chain-bridge/omni-bridge-entities/omni-bridge.ts:69

`Static` isCustomWrap

isCustomWrap(token: Token<BlockchainName>): boolean
Parameters
- token: Token<BlockchainName>
Returns boolean
- Defined in src/features/cross-chain/calculation-manager/providers/pulse-chain-bridge/omni-bridge-entities/omni-bridge.ts:200

Class OmniBridgeAbstract

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

fromToken: Token<"ETH" | "PULSECHAIN">

toToken: Token<"ETH" | "PULSECHAIN">

Returns OmniBridge

Properties

Readonly sourceBridgeAddress

Methods

calculateAmount

Parameters

toAddress: string

fromAmount: string

Returns Promise<BigNumber>

checkLimits

Parameters

fromAddress: string

toAddress: string

amount: string

Returns Promise<void>

getBridgeToken

Parameters

fromAddress: string

Returns Promise<string>

Abstract getDataForNativeSwap

Parameters

receiverAddress: string

value: string

Returns EvmEncodeConfig

Abstract getDataForTokenSwap

Parameters

receiverAddress: string

amount: string

isERC677: boolean

tokenAddress: string

Returns EvmEncodeConfig

Abstract getMinAmountToken

Parameters

address: string

Returns Promise<BigNumber>

Abstract isTokenRegistered

Parameters

address: string

Returns Promise<boolean>

Static isCustomWrap

Parameters

token: Token<BlockchainName>

Returns boolean

Settings

Member Visibility

Theme

Class OmniBridge`Abstract`

`Readonly` sourceBridgeAddress

`Abstract` getDataForNativeSwap

`Abstract` getDataForTokenSwap

`Abstract` getMinAmountToken

`Abstract` isTokenRegistered

`Static` isCustomWrap