Nexus Mutual SDK

Installation

npm install @nexusmutual/sdk

Usage

This package only exports CommonJS modules. You can import it like this:

// Usage with ES6 modules
import { products, productTypes } from '@nexusmutual/sdk'

Nexus Mutual contract addresses and abis

Source of truth for the latest mainnet addresses. Feeds into https://api.nexusmutual.io/sdk/.

Listed products and product types metadata

The products folder contains all protocols listed on Nexus Mutual.

If you're a protocol owner and want to update any details (i.e. logo, website, etc), please submit a PR. Logos should meet the following criteria:

• svg format, with 1:1 ratio
• no fixed width or height
• the image should reach the edge of the viewbox

Development

Install dependencies

npm ci

Install husky

npx husky install

to activate husky in project

ENV variables setup

Copy the .env.example file into .env and populate with the required values.

Build locally

npm build