Interface ISwitcher

You need to implement this interface if you want to integrate new tokens into Ankr Switch.

interface

Hierarchy

ISwitcher

Implemented by

Index

Methods

Methods

addTokenToWallet

addTokenToWallet(token: string): Promise<boolean>

- Defined in packages/staking-sdk/src/modules/switcher/index.ts:97
Add token to wallet.

Parameters
- token: string
  
  token symbol.
Returns Promise<boolean>

approveACForAB

approveACForAB(amount?: BigNumber, scale?: Value): Promise<undefined | IWeb3SendResult>

- Defined in packages/staking-sdk/src/modules/switcher/index.ts:70
Approve -c token for -b token, i.e. allow -b token smart contract to access and transfer -c tokens.

note
-b and -c tokens are Ankr Liquid Staking tokens, such as aETHb or ankrETH or ankrMATIC.
Read more about Ankr LS token types.

Parameters
- Optional amount: BigNumber
- Optional scale: Value
Returns Promise<undefined | IWeb3SendResult>

fetchTxData

fetchTxData(txHash: string): Promise<IFetchTxData>

- Defined in packages/staking-sdk/src/modules/switcher/index.ts:54
Fetch transaction data.

Parameters
- txHash: string
  
  transaction hash.
Returns Promise<IFetchTxData>

fetchTxReceipt

fetchTxReceipt(txHash: string): Promise<null | TransactionReceipt>

- Defined in packages/staking-sdk/src/modules/switcher/index.ts:61
Fetch transaction receipt.

Parameters
- txHash: string
  
  transaction hash.
Returns Promise<null | TransactionReceipt>

getABBalance

getABBalance(isFormatted?: boolean): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/switcher/index.ts:22
Get -b token balance.

note
A -b token is a reward-earning Ankr Liquid Staking token, such as aETHb or aMATICb.
Read more about Ankr LS token types.

Parameters
- Optional isFormatted: boolean
Returns Promise<BigNumber>

getACAllowance

getACAllowance(spender?: string): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/switcher/index.ts:47
Get -c token allowance.

note
A -c token is a reward-bearing Ankr Liquid Staking token, such as ankrETH or ankrMATIC.
Read more about Ankr LS token types.

note
Allowance is the amount which spender is still allowed to withdraw from owner.

Parameters
- Optional spender: string
Returns Promise<BigNumber>
- returns value in wei

getACBalance

getACBalance(isFormatted?: boolean): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/switcher/index.ts:30
Get -c token balance.

note
A -c token is a reward-bearing Ankr Liquid Staking token, such as ankrETH or ankrMATIC.
Read more about Ankr LS token types.

Parameters
- Optional isFormatted: boolean
Returns Promise<BigNumber>

getACRatio

getACRatio(isFormatted?: boolean): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/switcher/index.ts:38
Get -c token ratio.

note
A -c token is a reward-bearing Ankr Liquid Staking token, such as ankrETH or ankrMATIC.
Read more about Ankr LS token types.

Parameters
- Optional isFormatted: boolean
Returns Promise<BigNumber>

lockShares

lockShares(data: IShareArgs): Promise<IWeb3SendResult>

- Defined in packages/staking-sdk/src/modules/switcher/index.ts:82
Switch -c token to -b token, such as switch ankrBNB to aBNBb.

note
This function is used, e.g., when switching -c tokens for -b tokens.

note
-b and -c tokens are Ankr Liquid Staking tokens, such as aETHb or ankrETH or ankrMATIC.
Read more about Ankr LS token types.

Parameters
- data: IShareArgs
  
  lock shares args.
Returns Promise<IWeb3SendResult>

unlockShares

unlockShares(data: IShareArgs): Promise<IWeb3SendResult>

- Defined in packages/staking-sdk/src/modules/switcher/index.ts:90
Switch -b token to -c token, such as switch aBNBb to ankrBNB.

note
-b and -c tokens are Ankr Liquid Staking tokens, such as aETHb or ankrETH or ankrMATIC.
Read more about Ankr LS token types.

Parameters
- data: IShareArgs
  
  lock shares args.
Returns Promise<IWeb3SendResult>

Generated using TypeDoc