Skip to content

Latest commit

 

History

History
129 lines (96 loc) · 5.16 KB

README.md

File metadata and controls

129 lines (96 loc) · 5.16 KB
Raw

Welcome to our DeFi Adapter Library! 🚀

This library is designed to simplify and standardise the process of fetching data and interacting with various DeFi protocols, which often have unique interfaces and data structures. Our adapters 1) fetch and transform underlying protocol data into a standardised format that can be easily used by portfolio dashboards and 2) generate transaction params to create and update protocol positions.

Note: Please note that in this library, adapters must query on-chain data to ensure accuracy and reliability, we do not accept centralised APIs to get positions, withdrawals, deposits, profits or rewards.

How to create a Read Adapter

Setup steps

Watch the setup video for a detailed guide.

  1. Install:
    • nvm use to select the environment
    • npm i to install dependencies
    • npm run build to build the CLI
  2. Run project:
    • npm run dev to run the project

Continue watching videos for the following steps or, alternatively, find a written version in Steps to create a read adapter

Build adapter steps

Watch the build adapter video for a detailed guide.

  1. Use CLI:
    • npm run new-adapter this launches our interactive CLI that will prompt you with a series of questions

Inspect your automatically created adapter file and implement unfinished methods

Watch the inspect your adapter video for a detailed guide.

Build Smart Contract Classes from ABIs

Watch the build contract classes from ABIs video for a detailed guide.

  1. Save a json file with your abi and add it to your ${protocolName}/contracts/abis/ folder
  2. Run:
    • npm run build-types to generate your smart contract classes

Build your DeFi asset metadata

Watch the build your DeFi asset metadata video for a detailed guide.

  1. Implement the getProtocolToken method in your adapter and make sure it is decorated with @CacheToDb.
  • If the adapter requires additional metadata. The AdditionalMetadata type should be updated accordingly, otherwise it should be deleted.
  • You can add any data that is serializable as JSON (including BigInt) as additional metadata.
  • There are four protected fields that, if added, must adhere to stricter types. Those are:
{
  underlyingTokens?: Erc20ExtendedMetadata[]
  rewardTokens?: Erc20ExtendedMetadata[]
  extraRewardTokens?: Erc20ExtendedMetadata[]
  tokenId?: string
}
  1. Run:
    • npm run build-metadata-db -- -p <protocol-id> -pd <product-id> to create your metadata files

Build your Snapshot tests

Watch the build your snapshot tests video for a detailed guide.

  1. Populate your test cases file.
  2. Run:
    • npm run build-snapshots -- -p <protocol-id> to build your snapshot tests

How to create a Write Adapter

The tutorial video below shows an intro to on how to add write adapter actions to an existing read adapter:

Don't have a read adapter? And don't intend to create a read adapter? Then:

  1. Select "WriteOnlyAdapterTemplate" on our new-adapter CLI. See section "Build adapter steps" above for more information.
  2. Implement the getProtocolToken method see section "Build your DeFi asset metadata" above for more information.
  3. Then follow the video tutorial below:

Watch the build write adapter video for a detailed guide.

Example code for write-adapters, as described in the above video:

export const WriteActionInputs = {
  [WriteActions.Deposit]: z.object({
    asset: z.string(),
    amount: z.string(),
    onBehalfOf: z.string(),
    referralCode: z.number(),
  }),
  [WriteActions.Withdraw]: z.object({
    asset: z.string(),
    amount: z.string(),
    to: z.string(),
  }),
} satisfies WriteActionInputSchemas

async getTransactionParams({
  action,
  inputs,
}: Extract<
  GetTransactionParams,
  { protocolId: typeof Protocol.YourProtocolKey; productId: 'YourProductId' }
>): Promise<{ to: string; data: string }> {
  switch (action) {
    case WriteActions.Deposit: {
      const { asset, amount, onBehalfOf, referralCode } = inputs
      return poolContract.supply.populateTransaction(
        asset,
        amount,
        onBehalfOf,
        referralCode,
      )
    }
    case WriteActions.Withdraw: {
      const { asset, amount, to } = inputs
      return poolContract.withdraw.populateTransaction(asset, amount, to)
    }
  }
}