Create a New Cover

Search…
Create a New Cover
This example creates a new cover contract on Neptune Mutual protocol on the chosen network/chain. When you create a new cover, a couple of smart contract instances are deployed automatically behind the scenes:
Cover Vault
Cover Token
Step 1: Create a Cover Info Object
Compose a javascript object having the following structure:
1
interface ICoverInfo {
2
  key: string
3
  coverName: string
4
  projectName: string
5
  about: string
6
  tags: string[]
7
  blockchain: {
8
    chainId: number
9
    name: string
10
  }
11
  smartContracts: string[]
12
  rules: string
13
  links: {
14
    website: string
15
    documentation: string
16
    telegram: string
17
    twitter: string
18
    github: string
19
    facebook: string
20
    blog: string
21
    discord: string
22
    linkedin: string
23
    slack: string
24
  }
25
  reportingPeriod: number
26
  resolutionSources: string[]
27
  reassuranceToken: {
28
    at: string
29
    name: string
30
    symbol: string
31
    initialAmount: string
32
  }
33
  stakeWithFees: string
34
  initialLiquidity: string,
35
  minReportingStake: string
36
}
37
​
38
export { ICoverInfo }
Copied!
Example:
1
const info = {
2
  key: '0x70726f746f3a636f6e7472616374733a636f7665723a6366633a303100000000',
3
  coverName: 'Compound Finance Cover',
4
  projectName: 'Compound Finance',
5
  about: 'Compound is an algorithmic, autonomous interest rate protocol built for developers, to unlock a universe of open financial applications.',
6
  tags: ['Smart Contract', 'DeFi', 'Lending'],
7
  blockchain: {
8
    chainId: 1,
9
    name: 'Main Ethereum Network'
10
  },
11
  smartContracts: ['0xc00e94cb662c3520282e6f5717214004a7f26888'],
12
  rules: `1. You must have maintained at least 1 NEP tokens in your wallet during your coverage period.
13
          2. During your coverage period, the protocol faced an attack, hack, exploitation, or vulnerability which resulted in the user assets being stolen or lost and the protocol was also unable to cover the loss themselves. This does not have to be your own loss.
14
          3. The protocol never communicated anything about their plans to cover the lost fund and de-risk their users within 7 days of the incident.
15
          4. The protocol promised but later were unable to cover, write off, or bear at least 75% of the sufferred loss on behalf of their users within 30 days of the incident`,
16
  links: {
17
    website: 'https://compound.finance/',
18
    documentation: 'https://docs.compound.finance/',
19
    telegram: null,
20
    twitter: 'https://twitter.com/compoundfinance',
21
    github: 'https://github.com/compound',
22
    facebook: 'https://facebook.com/compoundfinance',
23
    blog: 'https://blog.medium.com/compoundfinance',
24
    discord: 'https://discord.com/invite/cU7vmVW',
25
    linkedin: 'https://linkedin.com/in/compoundfinance',
26
    slack: null
27
  },
28
  reportingPeriod: 7 * DAYS,
29
  resolutionSources: ['https://twitter.com/compoundfinance', 'https://medium.com/compound-finance', 'https://twitter.com/neptunemutual'],
30
  reassuranceToken: {
31
    at: '0xe8BAb5ca5eA0Fc93b2a4E1aD22376726ED209ed5',
32
    name: 'DAI Stablecoin',
33
    symbol: 'DAI',
34
    initialAmount: ether(50_000)
35
  },
36
  stakeWithFees: ether(50_000),
37
  initialLiquidity: ether(50_000),
38
  minReportingStake: ether(5000)
39
}
Copied!
info.js file
Step 2: Submit Approvals
Before you can create a new cover,  you must submit at least one approval transaction:
NPM Token: Approve Stake and Fees (Required)
Assurance Token: Approve Initial Assurance Amount (Optional)
Stablecoin (DAI/BUSD/xDAI/USDC): Approve Initial Liquidity (Optional)
1
const info = {
2
  // ...,
3
  assuranceToken: {
4
    at: '0x0e7c8a8545352663ee070f1c9a0174f4a50532dc',
5
    name: 'Compound',
6
    symbol: 'COMP',
7
    initialAmount: '5000000000000000000000'
8
  },
9
  stakeWithFees: '5000000000000000000000',
10
  initialLiquidity: '5000000000000000000000'  
11
}
Copied!
If you do not create Assurance Token and Stablecoin approvals, you must set the assuranceToken.initialAmount and initialLiquidity to zero.
Approve Assurance Token (Optional)
If you defined Assurance Token and initial amount in your info.js file, you need to first submit an approval transaction allowing the protocol to transfer the assurance amount to itself.
1
import { ChainId, cover } from '@neptunemutual/sdk'
2
import { info } from './info.js'
3
import { getProvider } from './provider.js'
4
​
5
const create = async () => {
6
  const provider = getProvider()
7
​
8
  const response = await cover.approveAssurance(ChainId.Mumbai, info.assuranceToken.at, { amount: info.assuranceToken.initialAmount }, provider)
9
  console.info(response)
10
}
11
​
12
create()
13
​
14
/*****************************************************************************
15
{
16
  status: 'Success',
17
  result: {
18
    nonce: 1,
19
    gasPrice: BigNumber { _hex: '0x06fc23ac00', _isBigNumber: true },
20
    gasLimit: BigNumber { _hex: '0x6aa8', _isBigNumber: true },
21
    to: '0x0e7C8A8545352663EE070f1C9a0174f4A50532DC',
22
    value: BigNumber { _hex: '0x00', _isBigNumber: true },
23
    data: '0x095ea7b30000000000000000000000006fb2eaf0b7770087314df3cb73c34b510c2c2354ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff',
24
    chainId: 80001,
25
    v: 160038,
26
    r: '0xe24c90cc3b940de7929b634d8672e329ee7c02836ef8cbf65b0db0b6bf2cebc1',
27
    s: '0x3be2aa4932cac043da64a10f35e6bd1fa81ec51a203911d2afc86a800c1d39d4',
28
    from: '0x589C82ee29ab1d609FE2F0856E00c2988e75eE51',
29
    hash: '0x74aeb8be4055afafb7e42fc38a5b0ea46ffa85e2bae0b0314818771de62f12bb',
30
    type: null,
31
    wait: [Function (anonymous)]
32
  }
33
}
34
*****************************************************************************/
Copied!
Approve Initial Liquidity (Optional)
Similarly, if you also defined Initial Liquidity Amount when creating the info.js file, you need to submit an approval transaction in advance, allowing the protocol to transfer the amount to itself.
1
import { ChainId, cover } from '@neptunemutual/sdk'
2
import { info } from './info.js'
3
import { getProvider } from './provider.js'
4
​
5
const create = async () => {
6
  const provider = getProvider()
7
​
8
  await cover.approveAssurance(ChainId.Mumbai, info.assuranceToken.at, { amount: info.assuranceToken.initialAmount }, provider)
9
  const response = await cover.approveInitialLiquidity(ChainId.Mumbai, { amount: info.initialLiquidity }, provider)
10
​
11
  console.info(response)
12
}
13
​
14
create()
15
​
16
/*****************************************************************************
17
{
18
  status: 'Success',
19
  result: {
20
    nonce: 1,
21
    gasPrice: BigNumber { _hex: '0x06fc23ac00', _isBigNumber: true },
22
    gasLimit: BigNumber { _hex: '0x6994', _isBigNumber: true },
23
    to: '0x62E329214173E1C50A7Aee8DC2Ca5e04af6D6B6f',
24
    value: BigNumber { _hex: '0x00', _isBigNumber: true },
25
    data: '0x095ea7b300000000000000000000000071698490a88f937e0ef7ed2cc01a58f98de5fc9c00000000000000000000000000000000000000000000010f0cf064dd59200000',
26
    chainId: 80001,
27
    v: 160037,
28
    r: '0x5e6b3321ac4faa32c1c71ede399eef59de63025efaec9b7a4e2cf9cca11ef1b2',
29
    s: '0x78743438938da20deb63e2bf2e4546fd281284154a7cb862b8596ea0aaf732be',
30
    from: '0x589C82ee29ab1d609FE2F0856E00c2988e75eE51',
31
    hash: '0x27b45289bd5fdd03128e6435a5d9ea9d128ca7af2973348ef7f5177d9712af49',
32
    type: null,
33
    wait: [Function (anonymous)]
34
  }
35
}
36
*****************************************************************************/
Copied!
Approve Stake and Fee (Required)
You need to specify the total amount of NPM tokens to approve which contains both the stake and fees.
1
import { ChainId, cover } from '@neptunemutual/sdk'
2
import { info } from './info.js'
3
import { getProvider } from './provider.js'
4
​
5
const create = async () => {
6
  const provider = getProvider()
7
​
8
  await cover.approveAssurance(ChainId.Mumbai, info.assuranceToken.at, { amount: info.assuranceToken.initialAmount }, provider)
9
  await cover.approveInitialLiquidity(ChainId.Mumbai, { amount: info.initialLiquidity }, provider)
10
  const response = await cover.approveStakeAndFees(ChainId.Mumbai, { amount: info.stakeWithFees }, provider)
11
​
12
  console.info(response)
13
}
14
​
15
create()
16
​
17
/*****************************************************************************
18
{
19
  status: 'Success',
20
  result: {
21
    nonce: 1,
22
    gasPrice: BigNumber { _hex: '0x06fc23ac00', _isBigNumber: true },
23
    gasLimit: BigNumber { _hex: '0x6994', _isBigNumber: true },
24
    to: '0xaa6E152DCF34F54aCa65d5c4a720763e347F42d4',
25
    value: BigNumber { _hex: '0x00', _isBigNumber: true },
26
    data: '0x095ea7b30000000000000000000000009147a5cb1f858a8dc5ca2c26ec929e6ec38bac3200000000000000000000000000000000000000000000010f0cf064dd59200000',
27
    chainId: 80001,
28
    v: 160037,
29
    r: '0x23bb2d67079f17cb2219d83d653579519484e40e7bf97f4928e30644c248a52b',
30
    s: '0x75fa3e04cf1bc0bee5667d4301a39cdba0ca2609afa5b9253816580ac7d5ac17',
31
    from: '0x589C82ee29ab1d609FE2F0856E00c2988e75eE51',
32
    hash: '0x1efb4e593e29999814da5edfb210f3c60a7b3682c063a6bf85265e1d6b498d35',
33
    type: null,
34
    wait: [Function (anonymous)]
35
  }
36
}
37
*****************************************************************************/
Copied!
Step 3: Adding a New Cover
Once you've signed the approval transactions, creating a new cover is very easy. There is only one line to add:
1
await cover.createCover(ChainId.Mumbai, info, provider)
Copied!
The whole thing now looks something like this:
1
import { ChainId, cover } from '@neptunemutual/sdk'
2
import { info } from './info.js'
3
import { getProvider } from './provider.js'
4
​
5
const create = async () => {
6
  const provider = getProvider()
7
  
8
  await cover.approveAssurance(ChainId.Mumbai, info.assuranceToken.at, { amount: info.assuranceToken.initialAmount }, provider)
9
  await cover.approveInitialLiquidity(ChainId.Mumbai, { amount: info.initialLiquidity }, provider)
10
  await cover.approveStakeAndFees(ChainId.Mumbai, { amount: info.stakeWithFees }, provider)
11
  
12
  const response = await cover.createCover(ChainId.Mumbai, info, provider)
13
  console.info(response)
14
}
15
​
16
/*****************************************************************************
17
[info] {
18
  status: 'Success',
19
  result: {
20
    storage: {
21
      hashBytes32: '0x9ddc75bafdada33df8b2bc2613815fac5c22cc53119a23e6914936ae1ccdc22d',
22
      hash: 'QmYxshCcu1R6Pp37BEQpyqgUgJBmaBnvgN9dFxtKsZqN36',
23
      permalink: 'https://ipfs.infura.io/ipfs/QmYxshCcu1R6Pp37BEQpyqgUgJBmaBnvgN9dFxtKsZqN36'
24
    },
25
    tx: {
26
      nonce: 1,
27
      gasPrice: [BigNumber],
28
      gasLimit: [BigNumber],
29
      to: '0xDd4F24aEe772170487B3327e10Cd7a956c0A0E62',
30
      value: [BigNumber],
31
      data: '0x56aeb05f70726f746f3a636f6e7472616374733a636f7665723a6366633a3031000000029ddc75bafdada33df8b2bc2613815fac5c22cc53119a23e6914936ae1ccdc22d0000000000000000000000000000000000000000000000000000000000093a80000000000000000000000000000000000000000000000a968163f0a57b4000000000000000000000000000001dc2c4363d7e5965f3b9cb404c0e47e497ae5df7000000000000000000000000000000000000000000000a968163f0a57b400000000000000000000000000000000000000000000000000a968163f0a57b400000',
32
      chainId: 80001,
33
      v: 160037,
34
      r: '0xc6d48b47da21895623853d4530b1a31cf9ac3fe28d53231c75bc200688768773',
35
      s: '0x03f97ea2c9c0d3b26dc37eccc9dbf6269a0bace42caf1391e8902a08bda7d584',
36
      from: '0x076F91C0A411197e6Fce476F37c6385CCeacd26D',
37
      hash: '0x6678475de0dd18074affcdec1439fd35c17503bb4000eab430de43b89eeb709c',
38
      type: null,
39
      wait: [Function (anonymous)]
40
    }
41
  }
42
}
43
*****************************************************************************/
Copied!
Neptune Mutual SDK - Previous
Provider Configuration
Next - Neptune Mutual SDK
Cover Assurance
Last modified 16d ago
Copy link
Contents
Step 1: Create a Cover Info Object
Step 2: Submit Approvals
Approve Assurance Token (Optional)
Approve Initial Liquidity (Optional)
Approve Stake and Fee (Required)
Step 3: Adding a New Cover