Class CollateralsSDK

constructor

• new CollateralsSDK(c?): CollateralsSDK

• Parameters

  • Optional c: CollateralsConfig

  Returns CollateralsSDK

tokens

getCollateral

• getCollateral(collateralSymbol, provider): Promise<Collateral>

• Parameters

  • collateralSymbol: CollateralSymbol
  • provider: Provider

  Returns Promise<Collateral>

getCollaterals

• getCollaterals(provider): Promise<Collateral[]>

• Parameters

  • provider: Provider

  Returns Promise<Collateral[]>

getDepositAllowance

• getDepositAllowance(collateralSymbol, account, action, signer): Promise<BigNumber>

• Parameters

  • collateralSymbol: CollateralSymbol
  • account: string
  • action: "deposit" | "mintAndDeposit"
  • signer: Signer

  Returns Promise<BigNumber>

getIndexedCollaterals

• getIndexedCollaterals(): Promise<Collateral[]>

• Returns Promise<Collateral[]>

getSingleCollateralDepositAllowance

• getSingleCollateralDepositAllowance(vaultSymbol, account, network, signer): Promise<BigNumber>

• Parameters

  • vaultSymbol: SingleCollateralVaultSymbol
  • account: string
  • network: "arbitrum" | "polygon"
  • signer: Signer

  Returns Promise<BigNumber>

setDepositAllowance

• setDepositAllowance(collateralSymbol, amount, action, signer, options?): Promise<ContractTransaction>

• Parameters

  • collateralSymbol: CollateralSymbol
  • amount: BigNumber
  • action: "deposit" | "mintAndDeposit"
  • signer: Signer
  • options: Overrides = {}

  Returns Promise<ContractTransaction>

setSingleCollateralDepositAllowance

• setSingleCollateralDepositAllowance(vaultSymbol, amount, network, signer, options?): Promise<ContractTransaction>

• Parameters

  • vaultSymbol: SingleCollateralVaultSymbol
  • amount: BigNumber
  • network: "arbitrum" | "polygon"
  • signer: Signer
  • options: Overrides = {}

  Returns Promise<ContractTransaction>