Class WidoCompoundSdk

Hierarchy

WidoCompoundSdk

Index

Constructors

Methods

getDeployments getSupportedCollaterals getUserCollaterals getUserCurrentPosition getUserPredictedPosition getCollateralSwapRoute swapCollateral

Constructors

constructor

new WidoCompoundSdk(signer: Signer & TypedDataSigner, comet: string): WidoCompoundSdk
Parameters
- signer: Signer & TypedDataSigner
- comet: string
Returns WidoCompoundSdk
- Defined in wido-compound-sdk.ts:29

Methods

`Static` getDeployments

getDeployments(): Deployments
Returns a list of the existing deployments

Returns Deployments
- Defined in wido-compound-sdk.ts:39

getSupportedCollaterals

getSupportedCollaterals(): Promise<Assets>
Returns a list of the collaterals supported by the given Comet

Returns Promise<Assets>
- Defined in wido-compound-sdk.ts:54

getUserCollaterals

getUserCollaterals(): Promise<UserAssets>
Returns a list of user owned collaterals on the given Comet

Returns Promise<UserAssets>
- Defined in wido-compound-sdk.ts:71

getUserCurrentPosition

getUserCurrentPosition(): Promise<Position>
Returns the user's current position details in a Comet

Returns Promise<Position>
- Defined in wido-compound-sdk.ts:100

getUserPredictedPosition

getUserPredictedPosition(swapQuote: CollateralSwapRoute): Promise<Position>
Returns the user's current position details in a Comet
Parameters
- swapQuote: CollateralSwapRoute
Returns Promise<Position>
- Defined in wido-compound-sdk.ts:115

getCollateralSwapRoute

getCollateralSwapRoute(fromCollateral: string, toCollateral: string, amount: BigNumber): Promise<CollateralSwapRoute>
Quotes the possible outcome of the collateral swap
Parameters
- fromCollateral: string
- toCollateral: string
- amount: BigNumber
Returns Promise<CollateralSwapRoute>
- Defined in wido-compound-sdk.ts:145

swapCollateral

swapCollateral(swapQuote: CollateralSwapRoute): Promise<string>
Executes a collateral swap on a Comet given an existing quote
Parameters
- swapQuote: CollateralSwapRoute
Returns Promise<string>
- Defined in wido-compound-sdk.ts:245

Generated using TypeDoc