Neptune Mutual Cover

Anyone who has NPM tokens can create a cover contract. To avoid spam, questionable, and confusing cover contracts, a creator has to burn 1000 NPM tokens. Additionally, the contract creator also needs to stake 4000 NPM tokens or more. The higher the sake, the more visibility the contract gets if there are multiple cover contracts with the same name or similar terms.

Read More

[comment]: #solidoc Start

Cover Contract (Cover.sol)

View Source: contracts/core/lifecycle/Cover.sol

↗ Extends: CoverBase

Cover

The cover contract enables you to manage onchain covers.

Functions

• constructor(IStore store)
• addCover(bytes32 coverKey, bytes32 info, string tokenName, string tokenSymbol, bool supportsProducts, bool requiresWhitelist, uint256[] values)
• updateCover(bytes32 coverKey, bytes32 info)
• addProduct(bytes32 coverKey, bytes32 productKey, bytes32 info, bool requiresWhitelist, uint256[] values)
• updateProduct(bytes32 coverKey, bytes32 productKey, bytes32 info, uint256[] values)
• disablePolicy(bytes32 coverKey, bytes32 productKey, bool status, string reason)
• updateCoverCreatorWhitelist(address account, bool status)
• updateCoverUsersWhitelist(bytes32 coverKey, bytes32 productKey, address[] accounts, bool[] statuses)
• checkIfWhitelistedCoverCreator(address account)
• checkIfWhitelistedUser(bytes32 coverKey, bytes32 productKey, address account)

Constructs this contract

function (IStore store) public nonpayable CoverBase 

Arguments

Name	Type	Description
store	IStore	Enter the store

Source Code

constructor(IStore store) CoverBase(store) {}

addCover

Adds a new coverage pool or cover contract. To add a new cover, you need to pay cover creation fee and stake minimum amount of NPM in the Vault.

Through the governance portal, projects will be able redeem the full cover fee at a later date.

Apply for Fee Redemption
https://docs.neptunemutual.com/covers/cover-fee-redemption

Read the documentation to learn more about the fees:
https://docs.neptunemutual.com/covers/contract-creators

function addCover(bytes32 coverKey, bytes32 info, string tokenName, string tokenSymbol, bool supportsProducts, bool requiresWhitelist, uint256[] values) external nonpayable nonReentrant 
returns(address)

Arguments

Name	Type	Description
coverKey	bytes32	Enter a unique key for this cover
info	bytes32	IPFS hash. Check out the documentation for more info.
tokenName	string	Enter the token name of the POD contract that will be deployed.
tokenSymbol	string	Enter the token symbol of the POD contract that will be deployed.
supportsProducts	bool	Indicates that this cover supports product(s)
requiresWhitelist	bool	Signifies if this cover only enables whitelisted addresses to purchase policies.
values	uint256[]	[0] stakeWithFee Enter the total NPM amount (stake + fee) to transfer to this contract.

Source Code

function addCover(
    bytes32 coverKey,
    bytes32 info,
    string calldata tokenName,
    string calldata tokenSymbol,
    bool supportsProducts,
    bool requiresWhitelist,
    uint256[] calldata values
  ) external override nonReentrant returns (address) {
    s.mustNotBePaused();
    s.senderMustBeWhitelistedCoverCreator();

    require(values[0] >= s.getUintByKey(ProtoUtilV1.NS_COVER_CREATION_MIN_STAKE), "Your stake is too low");

    s.addCoverInternal(coverKey, supportsProducts, info, requiresWhitelist, values);

    emit CoverCreated(coverKey, info, tokenName, tokenSymbol, supportsProducts, requiresWhitelist);

    address vault = s.deployVaultInternal(coverKey, tokenName, tokenSymbol);
    emit VaultDeployed(coverKey, vault);

    return vault;
  }

updateCover

Updates the cover contract. This feature is accessible only to the cover manager during withdrawal period.

function updateCover(bytes32 coverKey, bytes32 info) external nonpayable nonReentrant 

Arguments

Name	Type	Description
coverKey	bytes32	Enter the cover key
info	bytes32	IPFS hash. Check out the documentation for more info.

Source Code

function updateCover(bytes32 coverKey, bytes32 info) external override nonReentrant {
    s.mustNotBePaused();
    s.mustEnsureAllProductsAreNormal(coverKey);
    AccessControlLibV1.mustBeCoverManager(s);
    s.mustBeDuringWithdrawalPeriod(coverKey);

    require(s.getBytes32ByKeys(ProtoUtilV1.NS_COVER_INFO, coverKey) != info, "Duplicate content");

    s.updateCoverInternal(coverKey, info);
    emit CoverUpdated(coverKey, info);
  }

addProduct

Adds a product under a diversified cover pool

function addProduct(bytes32 coverKey, bytes32 productKey, bytes32 info, bool requiresWhitelist, uint256[] values) external nonpayable

Arguments

Name	Type	Description
coverKey	bytes32	Enter a cover key
productKey	bytes32	Enter the product key
info	bytes32	IPFS hash. Check out the documentation for more info.
requiresWhitelist	bool	Enter true if you want to maintain a whitelist and restrict non-whitelisted users to purchase policies.
values	uint256[]	[0] Product status

Source Code

function addProduct(
    bytes32 coverKey,
    bytes32 productKey,
    bytes32 info,
    bool requiresWhitelist,
    uint256[] calldata values
  ) external override {
    // @suppress-zero-value-check The uint values are validated in the function `addProductInternal`
    s.mustNotBePaused();
    s.senderMustBeWhitelistedCoverCreator();
    s.senderMustBeCoverOwnerOrAdmin(coverKey);

    s.addProductInternal(coverKey, productKey, info, requiresWhitelist, values);
    emit ProductCreated(coverKey, productKey, info, requiresWhitelist, values);
  }

updateProduct

Updates a cover product. This feature is accessible only to the cover manager during withdrawal period.

function updateProduct(bytes32 coverKey, bytes32 productKey, bytes32 info, uint256[] values) external nonpayable

Arguments

Name	Type	Description
coverKey	bytes32	Enter the cover key
productKey	bytes32	Enter the product key
info	bytes32	Enter a new IPFS URL to update
values	uint256[]	[0] Product status

Source Code

function updateProduct(
    bytes32 coverKey,
    bytes32 productKey,
    bytes32 info,
    uint256[] calldata values
  ) external override {
    // @suppress-zero-value-check The uint values are validated in the function `updateProductInternal`
    s.mustNotBePaused();
    s.mustBeSupportedProductOrEmpty(coverKey, productKey);
    AccessControlLibV1.mustBeCoverManager(s);
    s.mustBeDuringWithdrawalPeriod(coverKey);

    s.updateProductInternal(coverKey, productKey, info, values);
    emit ProductUpdated(coverKey, productKey, info, values);
  }

disablePolicy

Allows disabling and enabling the purchase of policy for a product or cover. This function enables governance admin to disable or enable the purchase of policy for a product or cover. A cover contract when stopped restricts new policy purchases and frees up liquidity as policies expires.

1. The policy purchases can be disabled and later enabled after current policies expire and liquidity is withdrawn.
2. The policy purchases can be disabled temporarily to allow liquidity providers a chance to exit.

function disablePolicy(bytes32 coverKey, bytes32 productKey, bool status, string reason) external nonpayable nonReentrant 

Arguments

Name	Type	Description
coverKey	bytes32	Enter the cover key you want to disable policy purchases
productKey	bytes32	Enter the product key you want to disable policy purchases
status	bool	Set this to true if you disable or false to enable policy purchases
reason	string	Provide a reason to disable the policy purchases

Source Code

function disablePolicy(
    bytes32 coverKey,
    bytes32 productKey,
    bool status,
    string calldata reason
  ) external override nonReentrant {
    s.mustNotBePaused();
    AccessControlLibV1.mustBeGovernanceAdmin(s);
    s.mustBeSupportedProductOrEmpty(coverKey, productKey);

    require(status != s.isPolicyDisabledInternal(coverKey, productKey), status ? "Already disabled" : "Already enabled");

    s.disablePolicyInternal(coverKey, productKey, status);

    emit ProductStateUpdated(coverKey, productKey, msg.sender, status, reason);
  }

updateCoverCreatorWhitelist

Adds or removes an account to the cover creator whitelist. For the first version of the protocol, a cover creator has to be whitelisted before they can call the addCover function.

function updateCoverCreatorWhitelist(address account, bool status) external nonpayable nonReentrant 

Arguments

Name	Type	Description
account	address	Enter the address of the cover creator
status	bool	Set this to true if you want to add to or false to remove from the whitelist

Source Code

function updateCoverCreatorWhitelist(address account, bool status) external override nonReentrant {
    s.mustNotBePaused();
    AccessControlLibV1.mustBeGovernanceAgent(s);

    s.updateCoverCreatorWhitelistInternal(account, status);
    emit CoverCreatorWhitelistUpdated(account, status);
  }

updateCoverUsersWhitelist

Adds or removes an account from the cover user whitelist. Whitelisting is an optional feature cover creators can enable. When a cover requires whitelist, you must add accounts to the cover user whitelist before they are able to purchase policies.

function updateCoverUsersWhitelist(bytes32 coverKey, bytes32 productKey, address[] accounts, bool[] statuses) external nonpayable nonReentrant 

Arguments

Name	Type	Description
coverKey	bytes32	Enter cover key
productKey	bytes32	Enter product key
accounts	address[]	Enter a list of accounts you would like to update the whitelist statuses of.
statuses	bool[]	Enter respective statuses of the specified whitelisted accounts.

Source Code

function updateCoverUsersWhitelist(
    bytes32 coverKey,
    bytes32 productKey,
    address[] calldata accounts,
    bool[] calldata statuses
  ) external override nonReentrant {
    s.mustNotBePaused();
    s.mustBeSupportedProductOrEmpty(coverKey, productKey);
    s.senderMustBeCoverOwnerOrAdmin(coverKey);

    s.updateCoverUsersWhitelistInternal(coverKey, productKey, accounts, statuses);
  }

checkIfWhitelistedCoverCreator

Signifies if the given account is a whitelisted cover creator

function checkIfWhitelistedCoverCreator(address account) external view
returns(bool)

Arguments

Name	Type	Description
account	address

Source Code

function checkIfWhitelistedCoverCreator(address account) external view override returns (bool) {
    return s.getAddressBooleanByKey(ProtoUtilV1.NS_COVER_CREATOR_WHITELIST, account);
  }

checkIfWhitelistedUser

Signifies if the given account is a whitelisted user

function checkIfWhitelistedUser(bytes32 coverKey, bytes32 productKey, address account) external view
returns(bool)

Arguments

Name	Type	Description
coverKey	bytes32
productKey	bytes32
account	address

Source Code

function checkIfWhitelistedUser(
    bytes32 coverKey,
    bytes32 productKey,
    address account
  ) external view override returns (bool) {
    return s.getAddressBooleanByKeys(ProtoUtilV1.NS_COVER_USER_WHITELIST, coverKey, productKey, account);
  }

Contracts

• AaveStrategy
• AccessControl
• AccessControlLibV1
• Address
• BaseLibV1
• BokkyPooBahsDateTimeLibrary
• BondPool
• BondPoolBase
• BondPoolLibV1
• CompoundStrategy
• Context
• Cover
• CoverBase
• CoverLibV1
• CoverReassurance
• CoverStake
• CoverUtilV1
• cxToken
• cxTokenFactory
• cxTokenFactoryLibV1
• Delayable
• Destroyable
• ERC165
• ERC20
• FakeAaveLendingPool
• FakeCompoundDaiDelegator
• FakePriceOracle
• FakeRecoverable
• FakeStore
• FakeToken
• FakeUniswapPair
• FakeUniswapV2FactoryLike
• FakeUniswapV2PairLike
• FakeUniswapV2RouterLike
• FaultyAaveLendingPool
• FaultyCompoundDaiDelegator
• Finalization
• ForceEther
• Governance
• GovernanceUtilV1
• IAaveV2LendingPoolLike
• IAccessControl
• IBondPool
• IClaimsProcessor
• ICompoundERC20DelegatorLike
• ICover
• ICoverReassurance
• ICoverStake
• ICxToken
• ICxTokenFactory
• IERC165
• IERC20
• IERC20Detailed
• IERC20Metadata
• IERC3156FlashBorrower
• IERC3156FlashLender
• IFinalization
• IGovernance
• ILendingStrategy
• ILiquidityEngine
• IMember
• InvalidStrategy
• IPausable
• IPolicy
• IPolicyAdmin
• IPriceOracle
• IProtocol
• IRecoverable
• IReporter
• IResolution
• IResolvable
• IStakingPools
• IStore
• IStoreLike
• IUniswapV2FactoryLike
• IUniswapV2PairLike
• IUniswapV2RouterLike
• IUnstakable
• IVault
• IVaultDelegate
• IVaultFactory
• IWitness
• LiquidityEngine
• MaliciousToken
• MockAccessControlUser
• MockCoverUtilUser
• MockCxToken
• MockCxTokenPolicy
• MockCxTokenStore
• MockFlashBorrower
• MockLiquidityEngineUser
• MockProcessorStore
• MockProcessorStoreLib
• MockProtocol
• MockRegistryClient
• MockStore
• MockStoreKeyUtilUser
• MockValidationLibUser
• MockVault
• MockVaultLibUser
• NPM
• NpmDistributor
• NTransferUtilV2
• NTransferUtilV2Intermediate
• Ownable
• Pausable
• Policy
• PolicyAdmin
• PolicyHelperV1
• PoorMansERC20
• POT
• PriceLibV1
• Processor
• ProtoBase
• Protocol
• ProtoUtilV1
• Recoverable
• ReentrancyGuard
• RegistryLibV1
• Reporter
• Resolution
• Resolvable
• RoutineInvokerLibV1
• SafeERC20
• StakingPoolBase
• StakingPoolCoreLibV1
• StakingPoolInfo
• StakingPoolLibV1
• StakingPoolReward
• StakingPools
• Store
• StoreBase
• StoreKeyUtil
• StrategyLibV1
• Strings
• TimelockController
• Unstakable
• ValidationLibV1
• Vault
• VaultBase
• VaultDelegate
• VaultDelegateBase
• VaultDelegateWithFlashLoan
• VaultFactory
• VaultFactoryLibV1
• VaultLibV1
• VaultLiquidity
• VaultStrategy
• WithFlashLoan
• WithPausability
• WithRecovery
• Witness

[comment]: #solidoc End