Class: ERC20RouterSDK

Implements

• IDappSDK

Constructors

constructor

• new ERC20RouterSDK(teleportSDK, optionalParams?): ERC20RouterSDK

Parameters

Name	Type
teleportSDK	TeleportSDK
optionalParams?	ERC20RouterOptionalParams

Returns

ERC20RouterSDK

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:46

Properties

_teleportSDK

• Protected _teleportSDK: TeleportSDK

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:44

---

abridgeBackendURL

• abridgeBackendURL: string

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:36

---

backendAxios

• backendAxios: AxiosInstance

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:35

---

blackListedTokens

• blackListedTokens: TokenInfo[]

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:37

---

config

• config: ERC20ChainSDKConfig

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:34

---

DAPP_NAME

▪ Static Readonly DAPP_NAME: "ERC20"

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:33

Accessors

isReadOnly

• get isReadOnly(): boolean

Returns

boolean

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:41

---

signerOrProvider

• get signerOrProvider(): ValidProvider

Returns

ValidProvider

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:38

Methods

_decodeErc20Transmissions

▸ _decodeErc20Transmissions(transmissions): Erc20Claims[]

Parameters

Name	Type
transmissions	ABDappClaim[]

Returns

Erc20Claims[]

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:104

---

allowance

▸ allowance(tokenAddress, userAddress): Promise<AllowanceWithDecimals>

Parameters

Name	Type
tokenAddress	string
userAddress	string

Returns

Promise<AllowanceWithDecimals>

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:201

---

approve

▸ approve(tokenAddress, amount): PayableCall

Parameters

Name	Type
tokenAddress	string
amount	BigNumberish

Returns

PayableCall

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:205

---

approveMaxInt

▸ approveMaxInt(tokenAddress): PayableCall

Parameters

Name	Type
tokenAddress	string

Returns

PayableCall

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:206

---

balanceOf

▸ balanceOf(tokenAddress, userAddress): Promise<{ balance: BigNumber ; tokenDecimals: number }>

Parameters

Name	Type
tokenAddress	string
userAddress	string

Returns

Promise<{ balance: BigNumber ; tokenDecimals: number }>

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:180

---

balanceOfMulticall

▸ balanceOfMulticall(tokenAddresses, userAddress): Promise<BigNumber[]>

Parameters

Name	Type
tokenAddresses	string[]
userAddress	string

Returns

Promise<BigNumber[]>

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:207

---

canProcessDappId

▸ canProcessDappId(dappId): boolean

Parameters

Name	Type
dappId	string

Returns

boolean

Implementation of

IDappSDK.canProcessDappId

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:63

---

canProcessTransmission

▸ canProcessTransmission(transmission): boolean

Parameters

Name	Type
transmission	DeliverableTransmission

Returns

boolean

Implementation of

IDappSDK.canProcessTransmission

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:60

---

checkTokenBlackListed

▸ checkTokenBlackListed(tokenAddress): Promise<boolean>

Parameters

Name	Type
tokenAddress	any

Returns

Promise<boolean>

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:161

---

estimateErc20AutoClaim

▸ estimateErc20AutoClaim(sourceChainId, targetChainId, tokenAddress, amount, senderAddress, receiverAddress): Promise<Erc20AutoClaimEstimation>

Parameters

Name	Type
sourceChainId	number
targetChainId	number
tokenAddress	string
amount	string
senderAddress	string
receiverAddress	string

Returns

Promise<Erc20AutoClaimEstimation>

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:79

---

getErc20Claims

▸ getErc20Claims(targetChainId, userAddress): Promise<Erc20Claims[]>

Parameters

Name	Type
targetChainId	number
userAddress	string

Returns

Promise<Erc20Claims[]>

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:95

---

getFeeAmountByToken

▸ getFeeAmountByToken(tokenAddress): Promise<BigNumber>

Parameters

Name	Type
tokenAddress	string

Returns

Promise<BigNumber>

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:211

---

getFeeTokens

▸ getFeeTokens(): Promise<string[]>

Returns

Promise<string[]>

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:212

---

getNativeTokenByWrappedAddress

▸ getNativeTokenByWrappedAddress(wrappedTokenAddress): Promise<NativeTokenInfo>

Parameters

Name	Type
wrappedTokenAddress	any

Returns

Promise<NativeTokenInfo>

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:188

---

getProviderFee

▸ getProviderFee(options): Promise<BigNumber>

Parameters

Name	Type
options	SendErc20Options

Returns

Promise<BigNumber>

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:186

---

getServiceFee

▸ getServiceFee(options): Promise<BigNumber>

Parameters

Name	Type
options	SendErc20Options

Returns

Promise<BigNumber>

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:184

---

getTokenDecimals

▸ getTokenDecimals(tokenAddress): Promise<number>

Parameters

Name	Type
tokenAddress	string | Uint8Array

Returns

Promise<number>

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:200

---

getTokenDetails

▸ getTokenDetails(tokenAddress): Promise<ERC20TokenMetadata>

Parameters

Name	Type
tokenAddress	string

Returns

Promise<ERC20TokenMetadata>

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:199

---

getTokenDetailsMulticall

▸ getTokenDetailsMulticall(tokenAddresses, userAddress?): Promise<ERC20TokenMetadataWithBalance[]>

Parameters

Name	Type
tokenAddresses	string[]
userAddress?	string

Returns

Promise<ERC20TokenMetadataWithBalance[]>

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:195

---

getTokenName

▸ getTokenName(tokenAddress): Promise<undefined | string>

Parameters

Name	Type
tokenAddress	string | Uint8Array

Returns

Promise<undefined | string>

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:194

---

getTokenSymbol

▸ getTokenSymbol(tokenAddress): Promise<undefined | string>

Parameters

Name	Type
tokenAddress	string | Uint8Array

Returns

Promise<undefined | string>

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:193

---

getWrappedForNativeToken

▸ getWrappedForNativeToken(nativeChainId, nativeToken): Promise<string>

Parameters

Name	Type
nativeChainId	number
nativeToken	string

Returns

Promise<string>

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:189

---

getWrappedTokenDetails

▸ getWrappedTokenDetails(nativeTokenAddress, nativeChainId): Promise<undefined | ERC20TokenMetadata>

Parameters

Name	Type
nativeTokenAddress	string[]
nativeChainId	number

Returns

Promise<undefined | ERC20TokenMetadata>

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:213

---

isTokenApproved

▸ isTokenApproved(tokenAddress, userAddress, threshold?): Promise<boolean>

Parameters

Name	Type
tokenAddress	string
userAddress	string
threshold?	BigNumberish

Returns

Promise<boolean>

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:217

---

sendErc20

▸ sendErc20(options): PayableCall

Parameters

Name	Type
options	SendErc20Options

Returns

PayableCall

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:179

---

setParams

▸ setParams(optionalParams): void

Parameters

Name	Type
optionalParams	any

Returns

void

Defined in

modules/ERC20Router/ERC20RouterSDK.ts:71