Spark

In this section, we will introduce the Spark SDK interfaces, which provide developers with a convenient and efficient way to interact with the Spark protocol. These interfaces cover various aspects of the protocol, including supply, withdraw, borrow, repay, and flash loan. They are designed to be used easily and flexibly.

The following section will introduce the interfaces related to the Spark protocol, which can be accessed through the api.protocols.spark. prefix.

Supply

The following code defines interfaces and functions related to the Spark supply logic:

Types

• SupplyParams: A type that represents the input parameters for the Spark supply logic

interface SupplyParams {
  input: {
    token: {
      chainId: number;
      address: string;
      decimals: number;
      symbol: string;
      name: string;
    };
    amount: string;
  };
  tokenOut: {
    chainId: number;
    address: string;
    decimals: number;
    symbol: string;
    name: string;
  };
}

• SupplyFields: A type that represents the fields required for the Spark supply logic.

interface SupplyFields {
  input: {
    token: {
      chainId: number;
      address: string;
      decimals: number;
      symbol: string;
      name: string;
    };
    amount: string;
  };
  output: {
    token: {
      chainId: number;
      address: string;
      decimals: number;
      symbol: string;
      name: string;
    };
    amount: string;
  };
}

• SupplyLogic: An interface that extends the Logic interface and represents the Spark supply logic. It includes the rid, and fields properties.

interface SupplyLogic {
  rid: string;
  fields: SupplyFields;
}

Functions

• getSupplyTokenList(chainId: number): An asynchronous function that retrieves the list of tokens supported by the Spark supply logic on the specified chainId.

• getSupplyQuotation(chainId: number, params: SupplyParams): An asynchronous function that retrieves a quotation for supplying assets on the Spark protocol with the specified params object on the specified chainId.

• newSupplyLogic(fields: SupplyFields): A function that creates the Spark supply logic data with the given fields object.

Example Code

import * as api from '@protocolink/api';

const chainId = 1;

const tokenList = await api.protocols.spark.getSupplyTokenList(chainId);
const underlyingToken = tokenList[0][0];
const aToken = tokenList[0][1];

const supplyQuotation = await api.protocols.spark.getSupplyQuotation(chainId, {
  input: {
    token: underlyingToken,
    amount: '10',
  },
  tokenOut: aToken,
});

const supplyLogic = await api.protocols.spark.newSupplyLogic(supplyQuotation);

Withdraw

The following code defines interfaces and functions related to the Spark withdraw logic:

Types

• WithdrawParams: A type that represents the input parameters for the Spark withdraw logic

interface WithdrawParams {
  input: {
    token: {
      chainId: number;
      address: string;
      decimals: number;
      symbol: string;
      name: string;
    };
    amount: string;
  };
  tokenOut: {
    chainId: number;
    address: string;
    decimals: number;
    symbol: string;
    name: string;
  };
}

• WithdrawFields: A type that represents the fields required for the Spark withdraw logic.

interface WithdrawFields {
  input: {
    token: {
      chainId: number;
      address: string;
      decimals: number;
      symbol: string;
      name: string;
    };
    amount: string;
  };
  output: {
    token: {
      chainId: number;
      address: string;
      decimals: number;
      symbol: string;
      name: string;
    };
    amount: string;
  };
}

• WithdrawLogic: An interface that extends the Logic interface and represents the Spark withdraw logic. It includes the rid, and fields properties.

interface WithdrawLogic {
  rid: string;
  fields: WithdrawFields;
}

Functions

• getWithdrawTokenList(chainId: number): An asynchronous function that retrieves the list of tokens supported by the Spark withdraw logic on the specified chainId.

• getWithdrawQuotation(chainId: number, params: WithdrawParams): An asynchronous function that retrieves a quotation for withdrawing assets from the Spark protocol with the specified params object on the specified chainId.

• newWithdrawLogic(fields: WithdrawFields): A function that creates the Spark withdraw logic data with the given fields object.

Example Code

import * as api from '@protocolink/api';

const chainId = 1;

const tokenList = await api.protocols.spark.getWithdrawTokenList(chainId);
const aToken = tokenList[0][0];
const underlyingToken = tokenList[0][1];

const withdrawQuotation = await api.protocols.spark.getWithdrawQuotation(chainId, {
  input: {
    token: aToken,
    amount: '10',
  },
  tokenOut: underlyingToken,
});

const withdrawLogic = await api.protocols.spark.newWithdrawLogic(withdrawQuotation);

Borrow

The following code defines interfaces and functions related to the Spark borrow logic:

Types

• BorrowFields: A type that represents the fields required for the Spark borrow logic.

import * as logics from '@protocolink/logics';

interface BorrowFields {
  interestRateMode: logics.spark.InterestRateMode;
  output: {
    token: {
      chainId: number;
      address: string;
      decimals: number;
      symbol: string;
      name: string;
    };
    amount: string;
  };
}

• BorrowLogic: An interface that extends the Logic interface and represents the Spark borrow logic. It includes the rid, and fields properties.

interface BorrowLogic {
  rid: string;
  fields: BorrowFields;
}

Functions

• getBorrowTokenList(chainId: number): An asynchronous function that retrieves the list of tokens supported by the Spark borrow logic on the specified chainId.

• newBorrowLogic(fields: BorrowFields): A function that creates the Spark borrow logic data with the given fields object.

Example Code

import * as api from '@protocolink/api';
import * as logics from '@protocolink/logics';

const chainId = 1;

const tokenList = await api.protocols.spark.getBorrowTokenList(chainId);
const underlyingToken = tokenList[0];

const borrowLogic = await api.protocols.spark.newBorrowLogic({
  interestRateMode: logics.spark.InterestRateMode.variable,
  output: {
    token: underlyingToken,
    amount: '10',
  },
});

Repay

The following code defines interfaces and functions related to the Spark repay logic:

Types

• RepayParams: A type that represents the input parameters for the Spark repay logic

import * as logics from '@protocolink/logics';

interface RepayParams {
  tokenIn: {
    chainId: number;
    address: string;
    decimals: number;
    symbol: string;
    name: string;
  };
  borrower: string;
  interestRateMode: logics.spark.InterestRateMode;
}

RepayFields: A type that represents the fields required for the Spark repay logic.

import * as logics from '@protocolink/logics';

interface RepayFields {
  input: {
    token: {
      chainId: number;
      address: string;
      decimals: number;
      symbol: string;
      name: string;
    };
    amount: string;
  };
  borrower: string;
  interestRateMode: logics.spark.InterestRateMode;
}

• RepayLogic: An interface that extends the Logic interface and represents the Spark repay logic. It includes the rid, and fields properties.

interface RepayLogic {
  rid: string;
  fields: RepayFields;
}

Functions

• getRepayTokenList(chainId: number): An asynchronous function that retrieves the list of tokens supported by the Spark repay logic on the specified chainId.

• getRepayQuotation(chainId: number, params: RepayParams): A function that retrieves a quotation for repaying a loan using the specified parameters and Spark protocol on the specified chain.

• newRepayLogic(fields: RepayFields): A function that creates the Spark repay logic data with the given fields object.

Example Code

import * as api from '@protocolink/api';
import * as logics from '@protocolink/logics';

const chainId = 1;
const account = '0xaAaAaAaaAaAaAaaAaAAAAAAAAaaaAaAaAaaAaaAa';

const tokenList = await api.protocols.spark.getRepayTokenList(chainId);
const underlyingToken = tokenList[0];

const repayQuotation = await api.protocols.spark.getRepayQuotation(chainId, {
  borrower: account,
  tokenIn: underlyingToken,
  interestRateMode: logics.spark.InterestRateMode.variable,
});

const repayLogic = await api.protocols.spark.newRepayLogic(repayQuotation);

FlashLoan

The following code defines functions related to the Spark flash loan logic:

Types

Please refer to the FlashLoan Logic section for more information.

Functions

• getFlashLoanTokenList(chainId: number): An asynchronous function that retrieves the list of tokens supported by the Spark flash loan logic on the specified chainId.

• getFlashLoanQuotation(chainId: number, params: FlashLoanParams): An asynchronous function that retrieves a quotation for flash loaning assets on the Spark protocol with the specified params object on the specified chainId.

• newFlashLoanLogic(fields: FlashLoanFields): A function that creates the Spark flash loan logic data with the given fields object.

• newFlashLoanLogicPair(loans: FlashLoanFields['loans']): A function that creates the Spark flash loan logic data pair with the given loans object.

Example Code

import * as api from '@protocolink/api';

const chainId = 1;

const tokenList = await api.protocols.spark.getFlashLoanTokenList(chainId);
const underlyingToken = tokenList[0];

const loans = [
  {
    token: underlyingToken,
    amount: '10000',
  },
];

const flashLoanQuotation = await api.protocols.spark.getFlashLoanQuotation(chainId, {
  loans,
});

const [flashLoanLoanLogic, flashLoanRepayLogic] = api.protocols.spark.newFlashLoanLogicPair(loans);
const logics = [flashLoanLoanLogic];
// logics.push(swapLogic)
// logics.push(supplyLogic)
// logics.push(...)
logics.push(flashLoanRepayLogic);