@metamask-institutional/mmi-defi-adapters

Description

MMI Defi adapter library

We have created an open source DeFi adapater library. The aim of this library is to provide the tools and scaffolding for a DeFi protocol to build an adapter. This adapter will provide read and write capabilities within the MMI and MetaMask portfolio dashboards. Our goal is to (i) connect users with DeFi protocols (ii) benefit the wider ecosystem (iii) simplify and standardize adapter building.

Getting Started

Requirements

• Node v18

Installation

Create a copy of .env.example as .env.

Run the following command:

npm i

Building

Run the following command for building the app once

npm run build

Run the following command for constantly building the app during development

npm run build:watch

Running the app

CLI help

Specific details on what commands are available can be shown running:

npm run adapters-cli

For getting the arguments and options for specific commands:

npm run positions -- --help

Filtering

It is possible to get results for specific protocols and chains for every command by adding --chain <chainId> and/or --protocol <protocolName>

For example:

npm run positions 0x6b8Be925ED8277fE4D27820aE4677e76Ebf4c255 -- --protocol stargate --chain 1

Get positions

npm run positions 0x6b8Be925ED8277fE4D27820aE4677e76Ebf4c255

Get PnL

npm run profits 0xB0D502E938ed5f4df2E681fE6E419ff29631d62b

Get price per share

npm run prices

Get total value lock

npm run tvl

Get APR

npm run apr

Get APY

npm run apy

Get deposits

npm run deposits 0x6b8Be925ED8277fE4D27820aE4677e76Ebf4c255 17719334 17719336

Get withdrawals

npm run withdrawals 0x6b8Be925ED8277fE4D27820aE4677e76Ebf4c255 17719334 17719336

Support for a new protocol

mmi-defi-adapters/
│
└── src/
    ├── adapters/                                       # Folder for all the protocol adapters and code
    │   ├── example-protocol/                           # Folder for the new protocol called example-protocol
    │   │   ├── products/                               # Folder for the different protocol product
    │   │   │   ├── pool/                               # Folder for the pool product
    │   │   │   │   ├── ethereum/                       # Folder with protocol specific metadata and code
    │   │   │   │   ├── optimism/                       # Folder with protocol specific metadata and code
    │   │   │   │   ├── arbitrum/                       # Folder with protocol specific metadata and code
    │   │   │   │   └── protocolNamePoolAdapter.ts      # Implementation of IProtocolAdapter
    │   │   │   │
    │   │   │   └── vesting/                            # Folder for the staking product
    │   │   │       ├── ethereum/                       # Folder with protocol specific metadata and code
    │   │   │       ├── arbitrum/                       # Folder with protocol specific metadata and code
    │   │   │       └── protocolNameVestingAdapter.ts   # Implementation of IProtocolAdapter
    │   │   │
    │   │   └── buildMetadata.ts                        # Metadata builder script
    │   │
    │   ├── index.ts                                    # Exports supportedProtocols object
    │   └── metadataBuilders.ts                         # Exports protocolMetadataBuilders object
    │
    └── contracts/
        └── abis/
            └── example-protocol/                       # Folder to place all the protocol contract abis
                ├── example-lp-factory-contract.json    # Abi for the protocol lp-factory contract
                └── example-staking-contract.json       # Abi for the protocol staking contract

Contributing

See CONTRIBUTING.md.

Adding a new Adapter (CLI)

Run the following command to add a new adapter

npm run new-adapter <Example> <example-product> [Chains]

Where:

• <Example> is the name of your protocol as you'd like it to appear.
• <example-product> is the name of the product for the adapter in kebab-case
• [Chains] is an optional argument with a comma separated list of supported chains (e.g. Ethereum,Arbitrum,Optimism). Default: Ethereum

Adding a New Protocol (manual)

To integrate a new protocol:

• Update src/adapters/index.ts:
  • Add to Protocol object: key in CamelCase, value in kebab-case (matching folder name).
  • Add to supportedProtocols object.
• Create a new folder in src/adapters, named in kebab-case, e.g., src/${protocolName}/products/${productName}/productAdapter.ts.

Adding an Adapter (manual)

After adding your protocol:

• Generate metadata: e.g., src/adapters/stargate/products/pool/arbitrum/metadata.json using src/adapters/stargate/buildMetadata.ts.
• Add metadata script to protocolMetadataBuilders object in src/adapters/metadataBuilders.ts and test npm run metadata
• Create product folder: src/${protocolName}/products/${productName}.
• Copy and paste the example adapter from src/adapters/example/products/example-product/exampleProductAdapter.ts to your product folder.
• Replace hardcoded responses with your adapter code.
• Add your adapter to supportedProtocols in src/adapters/index.ts.
• Test your adapter (change userAddress accordingly):
  • Positions: npm run positions 0x6b8Be925ED8277fE4D27820aE4677e76Ebf4c255.
  • Profits: npm run profits 0x6b8Be925ED8277fE4D27820aE4677e76Ebf4c255.
  • Prices: npm run prices 0x6b8Be925ED8277fE4D27820aE4677e76Ebf4c255.

Contract Factories

Add a JSON file with the abi of any new contract to the folder src/contracts/abis/<protocol-name>.

Run the following command to generate factories and abis for those contracts automatically:

npm run build-types

Contributors ✨

JP

Bernardo

Johann