Quickstart
Cover DAO SDK Quick Setup Guide
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.
Join our telegram channel @neptunemutualchat if you have questions or need support.
Install SDK
The Cover SDK is an NPM package that requires Node 12.14.1 or above.
1
npm install @neptunemutual/sdk
Copied!
npm: @neptunemutual/sdk
npm

Source Code

GitHub - neptune-mutual/sdk: Neptune Mutual SDK
GitHub

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
1
import sdk from '@neptunemutual/sdk'
Copied!
Import required features only
1
import {
2
ChainId,
3
cover,
4
provision,
5
assurance,
6
liquidity,
7
policy,
8
cToken,
9
registry,
10
types,
11
entities,
12
config
13
} from '@neptunemutual/sdk'
Copied!

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.
Neptune Mutual Token (NPM) / Pool / POD Mining Contracts
  • Ethereum (Primary)
  • Binance Smart Chain (Bridged)
  • Polygon (Bridged)
  • Fantom (TBD)
  • xDaichain (TBD)
  • MoonBeam (TBD)

Todo: Multi-Chain ERC-20 Token

In order to support multiple blockchains with no inflation, we will re-develop the NEP token in the future with an updated token design and a new ticker (NPM).
Protocol Testnet
  • Polygon Mumbai
  • Ropsten
Currently, the Neptune Mutual SDK Alpha only works with Ropsten, Binance Smart Chain Testnet, and Polygon Mumbai.
Protocol Contracts
Last modified 2mo ago