Skip to main content

IDepositablePosition

@node-fi/sdk-core / Exports / IDepositablePosition

Interface: IDepositablePosition

Implemented by

Table of contents

Properties

Properties

deposit

deposit: (inputToken: string, inputAmount: BigintIsh, opts?: Partial<MinimaOptions>) => Promise<{ approvalTarget?: string ; execute?: TransactionStep ; expectedOutput: TokenAmount ; minimumOutput: TokenAmount ; transaction?: TransactionRequest }>

Type declaration

▸ (inputToken, inputAmount, opts?): Promise<{ approvalTarget?: string ; execute?: TransactionStep ; expectedOutput: TokenAmount ; minimumOutput: TokenAmount ; transaction?: TransactionRequest }>

Parameters
NameType
inputTokenstring
inputAmountBigintIsh
opts?Partial<MinimaOptions>
Returns

Promise<{ approvalTarget?: string ; execute?: TransactionStep ; expectedOutput: TokenAmount ; minimumOutput: TokenAmount ; transaction?: TransactionRequest }>

Defined in

packages/sdk-core/src/Earn/DepositablePosition.ts:23


withdraw

withdraw: (amount: BigNumberish | TokenAmount, destinationToken: string | Token, opts?: Partial<MinimaOptions>) => Promise<{ approvalTarget?: string ; execute?: TransactionStep ; expectedOutput: JSBI | TokenAmount ; minimumOutput: JSBI | TokenAmount ; transaction?: TransactionRequest }>

Type declaration

▸ (amount, destinationToken, opts?): Promise<{ approvalTarget?: string ; execute?: TransactionStep ; expectedOutput: JSBI | TokenAmount ; minimumOutput: JSBI | TokenAmount ; transaction?: TransactionRequest }>

Parameters
NameType
amountBigNumberish | TokenAmount
destinationTokenstring | Token
opts?Partial<MinimaOptions>
Returns

Promise<{ approvalTarget?: string ; execute?: TransactionStep ; expectedOutput: JSBI | TokenAmount ; minimumOutput: JSBI | TokenAmount ; transaction?: TransactionRequest }>

Defined in

packages/sdk-core/src/Earn/DepositablePosition.ts:35