Class VaultsSDK

Hierarchy

VaultsSDK

Constructors

constructor

new VaultsSDK(c?): VaultsSDK
Parameters
- Optional c: VaultsConfig
  Optional
Returns VaultsSDK
- Defined in src/components/Vaults.ts:130

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>
- Defined in src/components/Vaults.ts:584

burnAndWithdrawSingleCollateral

burnAndWithdrawSingleCollateral(args, signer, options?): Promise<ContractTransaction>
Parameters
- args: SingleCollateralBurnAndWithdrawArguments
- signer: Signer
- options: Overrides = {}
Returns Promise<ContractTransaction>
- Defined in src/components/Vaults.ts:476

`Private` chainDataToVault

chainDataToVault(account, fxTokenAddress, vault, collateralMap): Vault
Parameters
- account: string
- fxTokenAddress: string
- vault: VaultMulticall
- collateralMap: CollateralSymbolMap<BigNumber>
Returns Vault
- Defined in src/components/Vaults.ts:680

`Private` createEmptyIndexedVault

createEmptyIndexedVault(account, fxTokenAddress): IndexedVault
Parameters
- account: string
- fxTokenAddress: string
Returns IndexedVault
- Defined in src/components/Vaults.ts:746

`Private` createMulticallObjectForVaultCollateralBalance

createMulticallObjectForVaultCollateralBalance(account, fxTokenAddress, signerOrProvider): Promisified<CollateralSymbolMap<BigNumber>>
Parameters
- account: string
- fxTokenAddress: string
- signerOrProvider: Signer | Provider
Returns Promisified<CollateralSymbolMap<BigNumber>>
- Defined in src/components/Vaults.ts:657

depositCollateral

depositCollateral(args, signer, options?): Promise<ContractTransaction>
Parameters
- args: DepositCollateralArguments
- signer: Signer
- options: Overrides = {}
Returns Promise<ContractTransaction>
- Defined in src/components/Vaults.ts:544

getIndexedVault

getIndexedVault(account, fxTokenSymbol): Promise<Vault>
Parameters
- account: string
- fxTokenSymbol: string
Returns Promise<Vault>
- Defined in src/components/Vaults.ts:305

getIndexedVaults

getIndexedVaults(account): Promise<Vault[]>
Parameters
- account: string
Returns Promise<Vault[]>
- Defined in src/components/Vaults.ts:325

getSingleCollateralVault

getSingleCollateralVault(account, vaultSymbol, network, signer): Promise<SingleCollateralVault>
Parameters
- account: string
- vaultSymbol: SingleCollateralVaultSymbol
- network: "arbitrum" | "polygon"
- signer: Signer
Returns Promise<SingleCollateralVault>
- Defined in src/components/Vaults.ts:278

getSingleCollateralVaults

getSingleCollateralVaults(account, network, signer): Promise<SingleCollateralVault[]>
Parameters
- account: string
- network: "arbitrum" | "polygon"
- signer: Signer
Returns Promise<SingleCollateralVault[]>
- Defined in src/components/Vaults.ts:342

getVault

getVault(account, fxTokenSymbol, signer): Promise<Vault>
Parameters
- account: string
- fxTokenSymbol: string
- signer: Signer
Returns Promise<Vault>
- Defined in src/components/Vaults.ts:229

`Private` getVaultMulitcall

getVaultMulitcall(account, fxTokenAddress, signerOrProvider): Promisified<VaultMulticall>
Parameters
- account: string
- fxTokenAddress: string
- signerOrProvider: Signer | Provider
Returns Promisified<VaultMulticall>
- Defined in src/components/Vaults.ts:641

getVaults

getVaults(account, provider?, shouldAutoInitialise?): Promise<Vault[]>
Parameters
- account: string
- provider: Provider = sdkConfig.providers.arbitrum
- shouldAutoInitialise: boolean = true
Returns Promise<Vault[]>
- Defined in src/components/Vaults.ts:176

`Private` indexedDataToVault

indexedDataToVault(vault): Vault
Parameters
- vault: IndexedVault
Returns Vault
- Defined in src/components/Vaults.ts:710

initAsync

initAsync(provider?): Promise<void>
Parameters
- provider: Provider = sdkConfig.providers.arbitrum
Returns Promise<void>
- Defined in src/components/Vaults.ts:147

initSync

initSync(protocolParamters, fxTokens, collaterals): void
Parameters
- protocolParamters: ProtocolParameters
- fxTokens: FxToken[]
- collaterals: Collateral[]
Returns void
- Defined in src/components/Vaults.ts:165

`Private` initialisationCheck

initialisationCheck(): void
Returns void
- Defined in src/components/Vaults.ts:740

mint

mint(args, signer, options?): Promise<ContractTransaction>
Parameters
- args: MintArguments
- signer: Signer
- options: Overrides = {}
Returns Promise<ContractTransaction>
- Defined in src/components/Vaults.ts:376

mintAndDepositSingleCollateral

mintAndDepositSingleCollateral(args, signer, options?): Promise<ContractTransaction>
Parameters
- args: SingleCollateralMintAndDepositArguments
- signer: Signer
- options: Overrides = {}
Returns Promise<ContractTransaction>
- Defined in src/components/Vaults.ts:432

supplyFxTokenSingleCollateral

supplyFxTokenSingleCollateral(args, signer, options?): Promise<ContractTransaction>
Parameters
- args: SingleCollateralSupplyFxToken
- signer: Signer
- options: Overrides = {}
Returns Promise<ContractTransaction>
- Defined in src/components/Vaults.ts:516

withdrawCollateral

withdrawCollateral(args, signer, options?): Promise<ContractTransaction>
Parameters
- args: WithdrawCollateralArguments
- signer: Signer
- options: Overrides = {}
Returns Promise<ContractTransaction>
- Defined in src/components/Vaults.ts:605

Generated using TypeDoc