@nevellus/v2-core v1.0.0
Nevellus V2
This repository contains the core smart contracts for the Nevellus V2 Protocol. For higher level contracts, see the nevellus-v2-periphery repository.
Bug bounty
This repository is subject to the Nevellus V2 bug bounty program, per the terms defined here.
Local deployment
In order to deploy this code to a local testnet, you should install the npm package
@nevellus/v3-core
and import the factory bytecode located at
@nevellus/v3-core/artifacts/contracts/NevellusV2Factory.sol/NevellusV2Factory.json
.
For example:
import {
abi as FACTORY_ABI,
bytecode as FACTORY_BYTECODE,
} from '@nevellus/v3-core/artifacts/contracts/NevellusV2Factory.sol/NevellusV2Factory.json'
// deploy the bytecode
This will ensure that you are testing against the same bytecode that is deployed to mainnet and public testnets, and all NevellusDex code will correctly interoperate with your local deployment.
Using solidity interfaces
The NevellusDex v3 interfaces are available for import into solidity smart contracts
via the npm artifact @nevellus/v3-core
, e.g.:
import '@nevellus/v3-core/contracts/interfaces/INevellusV2Pool.sol';
contract MyContract {
INevellusV2Pool pool;
function doSomethingWithPool() {
// pool.swap(...);
}
}
Licensing
The primary license for Nevellus V2 Core is the Business Source License 1.1 (BUSL-1.1
), see LICENSE
. However, some files are dual licensed under GPL-2.0-or-later
:
- All files in
contracts/interfaces/
may also be licensed underGPL-2.0-or-later
(as indicated in their SPDX headers), seecontracts/interfaces/LICENSE
- Several files in
contracts/libraries/
may also be licensed underGPL-2.0-or-later
(as indicated in their SPDX headers), seecontracts/libraries/LICENSE
Other Exceptions
contracts/libraries/FullMath.sol
is licensed underMIT
(as indicated in its SPDX header), seecontracts/libraries/LICENSE_MIT
- All files in
contracts/test
remain unlicensed (as indicated in their SPDX headers).
2 years ago