Utility

In this section, we will cover the functionalities provided by our Utility logics, which includes FlashLoan Aggregator, Multi Send, Send Token, and Wrapped Native Token. These logics are designed to make common operations more streamlined and efficient for developers. Whether you're building a dApp or working on a complex project, our Utility logics can help you save time and improve your workflow.

The following section will introduce the interfaces of Utility logics, which can be accessed through the api.protocols.utility. prefix.

FlashLoan Aggregator

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

Types

  • FlashLoanAggregatorLogicParams: This type represents the params used to configure the parameters required for making Flash Loan quote requests. By using the loans or repays parameter, you can specify the desired loan or repayment amounts.

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

type FlashLoanAggregatorLoanParams = {
  loans: common.TokenAmounts;
  protocolId?: string;
};

type FlashLoanAggregatorRepayParams = {
  repays: common.TokenAmounts;
  protocolId?: string;
};

type FlashLoanAggregatorLogicParams = FlashLoanAggregatorLoanParams | FlashLoanAggregatorRepayParams;

  • FlashLoanAggregatorLogicFields: This type represents the fields required for FlashLoanAggregatorLogic, including the unique id, loans, a boolean isLoan and protocolId field.

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

interface FlashLoanLogicFields {
  id: string;
  loans: common.TokenAmounts;
  isLoan: boolean;
  protocolId: string;
}

  • FlashLoanAggregatorFields: A type that represents the fields required for the Utility flash loan aggregator logic.

interface FlashLoanAggregatorFields {
  id: string;
  loans: {
    token: {
      chainId: number;
      address: string;
      decimals: number;
      symbol: string;
      name: string;
    };
    amount: string;
  }[];
  isLoan: boolean;
  protocolId: string;
}

  • FlashLoanAggregatorLogic: An interface that extends the Logic interface and represents the Utility flash loan aggregator logic. It includes the rid, and fields properties.

interface FlashLoanAggregatorLogic {
  rid: string;
  fields: FlashLoanAggregatorFields;
}

Functions

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

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

  • newFlashLoanAggregatorLogic(fields: FlashLoanFields): A function that creates the Utility flash loan aggregator logic data with the given fields object.

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

Example Code

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

const chainId = 1;

const tokenList = await api.protocols.utility.getFlashLoanAggregatorTokenList(chainId);
const underlyingToken = tokenList[0];

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

const flashLoanAggregatorQuotation = await api.protocols.utility.getFlashLoanAggregatorQuotation(chainId, {
  loans,
});

const [flashLoanAggregatorLoanLogic, flashLoanAggregatorRepayLogic] = api.protocols.utility.newFlashLoanAggregatorLogicPair(loans);
const logics = [flashLoanAggregatorLoanLogic];
// logics.push(swapLogic)
// logics.push(supplyLogic)
// logics.push(...)
logics.push(flashLoanAggregatorRepayLogic);

WrappedNativeToken

The following code defines interfaces and functions related to the Utility wrapped native token logic:

Types

  • WrappedNativeTokenParams: A type that represents the input parameters for the Utility wrapped native token logic

interface WrappedNativeTokenParams {
  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;
  };
}

  • WrappedNativeTokenFields: A type that represents the fields required for the Utility wrapped native token logic.

interface WrappedNativeTokenFields {
  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;
  };
}

  • WrappedNativeTokenLogic: An interface that extends the Logic interface and represents the Utility wrapped native token logic. It includes the rid, and fields properties.

interface WrappedNativeTokenLogic {
  rid: string;
  fields: WrappedNativeTokenFields;
}

Functions

  • getWrappedNativeTokenTokenList(chainId: number): An asynchronous function that retrieves the list of tokens supported by the Utility wrapped native token logic on the specified chainId.

  • getWrappedNativeTokenQuotation(chainId: number, params: WrappedNativeTokenParams): An asynchronous function that retrieves a quotation for wrapping or unwrapping native token with the specified params object on the specified chainId.

  • newWrappedNativeTokenLogic(fields: WrappedNativeTokenFields): A function that creates the Utility wrapped native token logic data with the given fields object.

Example Code

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

const chainId = 1;

const tokenList = await api.protocols.utility.getWrappedNativeTokenTokenList(chainId);

// wrap: native token to wrapped native token
const wrapTokenIn = tokenList[0][0]; // native token
const wrapTokenOut = tokenList[0][1]; // wrapped native token

const wrapQuotation = await api.protocols.utility.getWrappedNativeTokenQuotation(chainId, {
  input: {
    token: wrapTokenIn,
    amount: '10',
  },
  tokenOut: wrapTokenOut,
});

const wrapLogic = await api.protocols.utility.newWrappedNativeTokenLogic(wrapQuotation);

// unwrap: wrapped native token to native token
const unwrapTokenIn = tokenList[1][0]; // wrapped native token
const unwrapTokenOut = tokenList[1][1]; // native token

const unwrapQuotation = await api.protocols.utility.getWrappedNativeTokenQuotation(chainId, {
  input: {
    token: unwrapTokenIn,
    amount: '10',
  },
  tokenOut: unwrapTokenOut,
});

const unwrapLogic = await api.protocols.utility.newWrappedNativeTokenLogic(unwrapQuotation);

SendToken

The following code defines interfaces and functions related to the Utility send token logic:

Types

  • SendTokenFields: A type that represents the fields required for the Utility send token logic.

interface SendTokenFields {
  input: {
    token: {
      chainId: number;
      address: string;
      decimals: number;
      symbol: string;
      name: string;
    };
    amount: string;
  };
  recipient: string;
}

  • SendTokenLogic: An interface that extends the Logic interface and represents the Utility send token logic. It includes the rid, and fields properties.

interface SendTokenLogic {
  rid: string;
  fields: SendTokenFields;
}

Functions

  • getSendTokenTokenList(chainId: number): An asynchronous function that retrieves the list of tokens supported by the Utility send token logic on the specified chainId.

  • newSendTokenLogic(fields: SendTokenFields): A function that creates the Utility send token logic data with the given fields object.

Example Code

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

const chainId = 1;

const tokenList = await api.protocols.utility.getSendTokenTokenList(chainId);
const tokenIn = tokenList[0];

const sendTokenLogic = await api.protocols.utility.newSendTokenLogic({
  input: {
    token: tokenIn,
    amount: '10',
  },
  recipient: '0xaAaAaAaaAaAaAaaAaAAAAAAAAaaaAaAaAaaAaaAa',
});

MultiSend

The following code defines interfaces and functions related to the Utility multi-send logic:

Types

  • MultiSendFields: A type that represents the fields required for the Utility multi-send logic.

type MultiSendFields = {
  input: {
    token: {
      chainId: number;
      address: string;
      decimals: number;
      symbol: string;
      name: string;
    };
    amount: string;
  };
  recipient: string;
}[];

  • MultiSendLogic: An interface that extends the Logic interface and represents the Utility multi-send logic. It includes the rid, and fields properties.

interface MultiSendLogic {
  rid: string;
  fields: MultiSendFields;
}

Functions

  • getMultiSendTokenList(chainId: number): An asynchronous function that retrieves the list of tokens supported by the Utility multi-send logic on the specified chainId.

  • newMultiSendLogic(fields: MultiSendFields): A function that creates the Utility multi-send logic data with the given fields object.

Example Code

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

const chainId = 1;

const tokenList = await api.protocols.utility.getMultiSendTokenList(chainId);
const tokenA = tokenList[0];
const tokenB = tokenList[1];

const multiSendLogic = await api.protocols.utility.newMultiSendLogic([
  {
    input: {
      token: tokenA,
      amount: '10',
    },
    recipient: '0xaAaAaAaaAaAaAaaAaAAAAAAAAaaaAaAaAaaAaaAa',
  },
  {
    input: {
      token: tokenB,
      amount: '10',
    },
    recipient: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
  },
  ...
]);

CustomData

If you want to interact with protocols that are not currently supported by our SDK, you can combine the intended transaction to and data, along with the amount of tokens to be spent and received, to create the Utility custom data logic data. And you can also use this with our supported protocols.

The following code defines interfaces and functions related to the Utility custom data logic:

Types

  • CustomDataFields: A type that represents the fields required for the Utility custom data logic.

interface CustomDataFields {
  inputs?: {
    token: {
      chainId: number;
      address: string;
      decimals: number;
      symbol: string;
      name: string;
    };
    amount: string;
  }[];
  outputs?: {
    token: {
      chainId: number;
      address: string;
      decimals: number;
      symbol: string;
      name: string;
    };
    amount: string;
  }[];
  to: string;
  data: string;
}

  • CustomDataLogic: An interface that extends the Logic interface and represents the Utility custom data logic. It includes the rid, and fields properties.

interface CustomDataLogic {
  rid: string;
  fields: CustomDataFields;
}

Functions

  • newCustomDataLogic(fields: CustomDataFields): A function that creates the Utility custom data logic data with the given fields object.

Example Code

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

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

const fromToken = {
  chainId: 1,
  address: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
  decimals: 6,
  symbol: 'USDC',
  name: 'USD Coin',
};
const toToken = {
  chainId: 1,
  address: '0x6B175474E89094C44Da98b954EedeAC495271d0F',
  decimals: 18,
  symbol: 'DAI',
  name: 'Dai Stablecoin',
};
const input = new common.TokenAmount(fromToken, '100');

const { data } = await axios.get(`https://api.1inch.io/v5.0/${chainId}/swap`, {
  params: {
    fromTokenAddress: fromToken.address,
    toTokenAddress: toToken.address,
    amount: input.amountWei.toString(),
    fromAddress: account,
    slippage: 1,
    disableEstimate: true,
  },
});
const output = new common.TokenAmount(toToken).setWei(data.toTokenAmount);

const customDataLogic = await api.protocols.utility.newCustomDataLogic({
  inputs: [input],
  outputs: [output],
  to: data.tx.to,
  data: data.tx.data,
});
PreviousStargateNextUniswap V3

Last updated