Welcome to the Neptune Mutual SDK quick-start guide. If you are new to Neptune Mutual, you might want to first read the documentation.

After completing these initial steps, you will be ready to start developing on top of Neptune Mutual protocol using Typescript or Javascript. We assume that you have fundamental understanding of javascript, node, git, solidity, evm, ethers/web3, and other related technologies.

Install SDK#

The Cover SDK is an NPM package that requires Node 12.14.1 or above.

npm install @neptunemutual/sdk

https://www.npmjs.com/package/@neptunemutual/sdk

Source Code

https://github.com/neptune-mutual-blue/sdk

About the SDK#

The Cover SDK assists developers to build on top of Neptune Mutual protocol. The SDK is built using Typescript and is intended to work on both browser and node environments. If you encounter an issue, create a new Github issue and reach out to us on Telegram.

Import the package

import sdk from '@neptunemutual/sdk'

Import required features only

import {
  ChainId,
  cover,
  reassurance,
  liquidity,
  policy,
  cxToken,
  registry,
  types,
  entities,
  config,
  claimsProcessor,
  governance,
  multicall,
  net,
  resolution,
  utils
} from '@neptunemutual/sdk'

Supported Blockchains (WIP)

The Neptune Mutual Protocol and Cover SDK are both work in progress. We will add support for more blockchains in the days to come.

Protocol Contracts

• Ethereum: https://neptunemutual.com/protocol/ethereum/contracts/
• Arbitrum: https://neptunemutual.com/protocol/arbitrum/contracts/
• Fuji: https://neptunemutual.com/protocol/fuji/contracts/