Class FlashLoanContract

FlashLoanContract class for managing flash loans.

Index

Constructors

constructor

Methods

borrowBaseAsset borrowQuoteAsset returnBaseAsset returnQuoteAsset

Constructors

constructor

new FlashLoanContract(config: DeepBookConfig): FlashLoanContract
Parameters
- config: DeepBookConfig
  Configuration object for DeepBook
Returns FlashLoanContract
- Defined in deepbook-v3/src/transactions/flashLoans.ts:16

Methods

borrowBaseAsset

borrowBaseAsset(
    poolKey: string,
    borrowAmount: number,
): (
    tx: Transaction,
) => readonly [
    { $kind: "NestedResult"; NestedResult: [number, number] },
    { $kind: "NestedResult"; NestedResult: [number, number] },
]
Parameters
- poolKey: string
  The key to identify the pool
- borrowAmount: number
  The amount to borrow
Returns (
    tx: Transaction,
) => readonly [
    { $kind: "NestedResult"; NestedResult: [number, number] },
    { $kind: "NestedResult"; NestedResult: [number, number] },
]
A function that takes a Transaction object

Description
Borrow base asset from the pool
- Defined in deepbook-v3/src/transactions/flashLoans.ts:26

borrowQuoteAsset

borrowQuoteAsset(
    poolKey: string,
    borrowAmount: number,
): (
    tx: Transaction,
) => readonly [
    { $kind: "NestedResult"; NestedResult: [number, number] },
    { $kind: "NestedResult"; NestedResult: [number, number] },
]
Parameters
- poolKey: string
  The key to identify the pool
- borrowAmount: number
  The amount to borrow
Returns (
    tx: Transaction,
) => readonly [
    { $kind: "NestedResult"; NestedResult: [number, number] },
    { $kind: "NestedResult"; NestedResult: [number, number] },
]
A function that takes a Transaction object

Description
Borrow quote asset from the pool
- Defined in deepbook-v3/src/transactions/flashLoans.ts:78

returnBaseAsset

returnBaseAsset(
    poolKey: string,
    borrowAmount: number,
    baseCoinInput: TransactionObjectArgument,
    flashLoan: TransactionObjectArgument,
): (tx: Transaction) => TransactionObjectArgument
Parameters
- poolKey: string
  The key to identify the pool
- borrowAmount: number
  The amount of the base asset to return
- baseCoinInput: TransactionObjectArgument
  Coin object representing the base asset to be returned
- flashLoan: TransactionObjectArgument
  FlashLoan object representing the loan to be settled
Returns (tx: Transaction) => TransactionObjectArgument
A function that takes a Transaction object

Description
Return base asset to the pool after a flash loan.
- Defined in deepbook-v3/src/transactions/flashLoans.ts:48

returnQuoteAsset

returnQuoteAsset(
    poolKey: string,
    borrowAmount: number,
    quoteCoinInput: TransactionObjectArgument,
    flashLoan: TransactionObjectArgument,
): (tx: Transaction) => TransactionObjectArgument
Parameters
- poolKey: string
  The key to identify the pool
- borrowAmount: number
  The amount of the quote asset to return
- quoteCoinInput: TransactionObjectArgument
  Coin object representing the quote asset to be returned
- flashLoan: TransactionObjectArgument
  FlashLoan object representing the loan to be settled
Returns (tx: Transaction) => TransactionObjectArgument
A function that takes a Transaction object

Description
Return quote asset to the pool after a flash loan.
- Defined in deepbook-v3/src/transactions/flashLoans.ts:100

Class FlashLoanContract

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns FlashLoanContract

Methods

borrowBaseAsset

Parameters

Returns (
    tx: Transaction,
) => readonly [
    { $kind: "NestedResult"; NestedResult: [number, number] },
    { $kind: "NestedResult"; NestedResult: [number, number] },
]

Description

borrowQuoteAsset

Parameters

Returns (
    tx: Transaction,
) => readonly [
    { $kind: "NestedResult"; NestedResult: [number, number] },
    { $kind: "NestedResult"; NestedResult: [number, number] },
]

Description

returnBaseAsset

Parameters

Returns (tx: Transaction) => TransactionObjectArgument

Description

returnQuoteAsset

Parameters

Returns (tx: Transaction) => TransactionObjectArgument

Description

Settings

On This Page

Class FlashLoanContract

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns FlashLoanContract

Methods

borrowBaseAsset

Parameters

Returns ( tx: Transaction,) => readonly [ { $kind: "NestedResult"; NestedResult: [number, number] }, { $kind: "NestedResult"; NestedResult: [number, number] },]

Description

borrowQuoteAsset

Parameters

Returns ( tx: Transaction,) => readonly [ { $kind: "NestedResult"; NestedResult: [number, number] }, { $kind: "NestedResult"; NestedResult: [number, number] },]

Description

returnBaseAsset

Parameters

Returns (tx: Transaction) => TransactionObjectArgument

Description

returnQuoteAsset

Parameters

Returns (tx: Transaction) => TransactionObjectArgument

Description

Settings

On This Page

Returns (
tx: Transaction,
) => readonly [
{ $kind: "NestedResult"; NestedResult: [number, number] },
{ $kind: "NestedResult"; NestedResult: [number, number] },
]

Returns (
tx: Transaction,
) => readonly [
{ $kind: "NestedResult"; NestedResult: [number, number] },
{ $kind: "NestedResult"; NestedResult: [number, number] },
]