Class VaultsSDK

Constructors

constructor

Properties

collaterals collateralsSDK config fxTokens fxTokensSDK graph initialised protocolParameters protocolSDK

Methods

burn burnAndWithdrawSingleCollateral chainDataToVault createEmptyIndexedVault createMulticallObjectForVaultCollateralBalance depositCollateral getIndexedVault getIndexedVaults getSingleCollateralVault getSingleCollateralVaults getVault getVaultMulitcall getVaults indexedDataToVault initAsync initSync initialisationCheck mint mintAndDepositSingleCollateral supplyFxTokenSingleCollateral withdrawCollateral

Constructors

constructor

Properties

Private collaterals

collaterals: Collateral[] = []

Private collateralsSDK

collateralsSDK: CollateralsSDK

Private config

config: VaultsConfig

Private fxTokens

fxTokens: FxToken[] = []

Private fxTokensSDK

fxTokensSDK: FxTokensSDK

Private graph

graph: GraphSDK

Private initialised

initialised: boolean = false

Private protocolParameters

protocolParameters: ProtocolParameters

Private protocolSDK

protocolSDK: ProtocolSDK

Methods

burn

  • burn(args, signer, options?): Promise<ContractTransaction>

  • Parameters

    • args: BurnArguments
    • signer: Signer
    • options: Overrides = {}

    Returns Promise<ContractTransaction>

burnAndWithdrawSingleCollateral

  • burnAndWithdrawSingleCollateral(args, signer, options?): Promise<ContractTransaction>

  • Parameters

    • args: SingleCollateralBurnAndWithdrawArguments
    • signer: Signer
    • options: Overrides = {}

    Returns Promise<ContractTransaction>

Private chainDataToVault

  • chainDataToVault(account, fxTokenAddress, vault, collateralMap): Vault

  • Parameters

    • account: string
    • fxTokenAddress: string
    • vault: VaultMulticall
    • collateralMap: CollateralSymbolMap<BigNumber>

    Returns Vault

Private createEmptyIndexedVault

Private createMulticallObjectForVaultCollateralBalance

  • createMulticallObjectForVaultCollateralBalance(account, fxTokenAddress, signerOrProvider): Promisified<CollateralSymbolMap<BigNumber>>

  • Parameters

    • account: string
    • fxTokenAddress: string
    • signerOrProvider: Signer | Provider

    Returns Promisified<CollateralSymbolMap<BigNumber>>

depositCollateral

  • depositCollateral(args, signer, options?): Promise<ContractTransaction>

  • Parameters

    • args: DepositCollateralArguments
    • signer: Signer
    • options: Overrides = {}

    Returns Promise<ContractTransaction>

getIndexedVault

getIndexedVaults

getSingleCollateralVault

getSingleCollateralVaults

getVault

Private getVaultMulitcall

  • getVaultMulitcall(account, fxTokenAddress, signerOrProvider): Promisified<VaultMulticall>

  • Parameters

    • account: string
    • fxTokenAddress: string
    • signerOrProvider: Signer | Provider

    Returns Promisified<VaultMulticall>

getVaults

  • getVaults(account, provider?, shouldAutoInitialise?): Promise<Vault[]>

  • Parameters

    • account: string
    • provider: Provider = sdkConfig.providers.arbitrum
    • shouldAutoInitialise: boolean = true

    Returns Promise<Vault[]>

Private indexedDataToVault

initAsync

  • initAsync(provider?): Promise<void>

  • Parameters

    • provider: Provider = sdkConfig.providers.arbitrum

    Returns Promise<void>

initSync

Private initialisationCheck

mint

  • mint(args, signer, options?): Promise<ContractTransaction>

  • Parameters

    • args: MintArguments
    • signer: Signer
    • options: Overrides = {}

    Returns Promise<ContractTransaction>

mintAndDepositSingleCollateral

  • mintAndDepositSingleCollateral(args, signer, options?): Promise<ContractTransaction>

  • Parameters

    • args: SingleCollateralMintAndDepositArguments
    • signer: Signer
    • options: Overrides = {}

    Returns Promise<ContractTransaction>

supplyFxTokenSingleCollateral

  • supplyFxTokenSingleCollateral(args, signer, options?): Promise<ContractTransaction>

  • Parameters

    • args: SingleCollateralSupplyFxToken
    • signer: Signer
    • options: Overrides = {}

    Returns Promise<ContractTransaction>

withdrawCollateral

  • withdrawCollateral(args, signer, options?): Promise<ContractTransaction>

  • Parameters

    • args: WithdrawCollateralArguments
    • signer: Signer
    • options: Overrides = {}

    Returns Promise<ContractTransaction>

Settings

Member Visibility

Theme

On This Page

constructorcollateralscollateralsSDKconfigfxTokensfxTokensSDKgraphinitialisedprotocolParametersprotocolSDKburnburnAndWithdrawSingleCollateralchainDataToVaultcreateEmptyIndexedVaultcreateMulticallObjectForVaultCollateralBalancedepositCollateralgetIndexedVaultgetIndexedVaultsgetSingleCollateralVaultgetSingleCollateralVaultsgetVaultgetVaultMulitcallgetVaultsindexedDataToVaultinitAsyncinitSyncinitialisationCheckmintmintAndDepositSingleCollateralsupplyFxTokenSingleCollateralwithdrawCollateral