Contracts from the main NuCypher codebase extracted into a separate repo for ease of testing and interoperability with other projects.
deployment
: Deployment utilitiesdeployment/artifacts
: ABI and address of deployed contractscontracts
: Source code for contractsscripts
: Deployment and utilities scriptstests
: Contract testssrc
: NPM package sourcesWe use Ape as the testing and deployment framework of this project.
To install pre-commit locally:
pre-commit install
In future, we may need to set the following:
ETHERSCAN_API_KEY
: Etherscan API token, required to query source files from Etherscan.POLYGONSCAN_API_KEY
: Polygonscan API token, required to query source files from Polygonscan.GITHUB_TOKEN
: Github personal access token, required by py-solc-x when querying installable solc versions.WEB3_INFURA_PROJECT_ID
: Infura project ID, required for connecting to Infura hosted nodes.This project uses tox to standardize the local and remote testing environments.
Note that tox
will install the dependencies from requirements.txt
automatically and run a linter (black
); if that is not desirable, you can just run py.test
.
To run the TypeScript tests, you will need to install the dependencies:
$ npm install
Then you can run the tests:
$ npm test
Configurations for the deployments are in deployments/constructor_params/<domain>/<filename>.yaml
.
Here is an example deployment configuration YAML file, but you can also find a full
examples in deployments/constructor_params/lynx/
:
deployment:
name: example
chain_id: <chain_id>
artifacts:
dir: ./deployment/artifacts/
filename: example.json
contracts:
- MyToken:
_totalSupplyOfTokens: 10000000000000000000000000
- MyContractWithNoParameters
- MyContractWithParameters:
_token: $MyToken
_number_parameter: 123456
_list_parameter: [123456, 789012]
Deployment scripts are located in scripts/<domain>/<name>.py
.
Here is a simple example deployment script, but you can also find a full example in scripts/lynx/deploy_root.py
:
#!/usr/bin/python3
from ape import project
from deployment.constants import (
CONSTRUCTOR_PARAMS_DIR,
)
from deployment.networks import is_local_network
from deployment.params import Deployer
VERIFY = not is_local_network()
CONSTRUCTOR_PARAMS_FILEPATH = CONSTRUCTOR_PARAMS_DIR / "my-domain" / "example.yml"
def main():
deployer = Deployer.from_yaml(filepath=CONSTRUCTOR_PARAMS_FILEPATH,
verify=VERIFY)
token = deployer.deploy(project.MyToken)
my_contract_with_no_parameters = deployer.deploy(
project.MyContractWithNoParameters)
my_contract_with_parameters = deployer.deploy(
project.MyContractWithParameters)
deployments = [
token,
my_contract_with_no_parameters,
my_contract_with_parameters,
]
deployer.finalize(deployments=deployments)
In order to deploy to production you will need to import an account into ape:
$ ape accounts import <id>
You will be asked to input the private key, and to choose a password. The account will then be available as <id>
.
Then you can check the account was imported correctly:
$ ape accounts list
Clear your ape database before deploying to production to avoid conflicts with upgradeable proxies. Please note that this will delete all ape deployment artifacts, so make sure you have a backup of artifacts from other projects before running this command.
$ rm -r ~/.ape/ethereum
Next, Run deployment scripts:
$ ape run <domain> <script_name> --network ethereum:local:test
$ ape run <domain> <script_name> --network polygon:mumbai:infura
$ ape run <domain> <script_name> --network ethereum:goerli:infura
For interoperability, we keep an NPM package with information of deployed smart contracts, such as address, ABI, etc. The NPM package can be found at https://www.npmjs.com/package/@nucypher/nucypher-contracts.
The process to publish a new NPM release is as follows:
Make the required changes to deployment artifacts, usually by running a deployment script.
Update the package version using bump2version
. We don't want to create a git tag, so we are running it with --no-tag
.
Note that we follow semantic versioning.
To update the minor version (e.g. from v1.1.0 to v1.2.0):
> bump2version minor --no-tag
To update the patch version (e.g. from v1.1.0 to v1.1.1):
> bump2version patch --no-tag
Alternatively, modify the version
field in package.json
and setup.cfg
.
It is still necessary to bump the version on the package-lock.json
file, so just run:
> npm install
Create a PR with these changes. We need this PR to be merged before continue.
When these changes are merged, create a new tag on main
branch. The name of the tag must be the new <version>
that is being released (e.g. v0.23.0
).
> git tag -a <version> -m "<version>"
> git push origin <version>
> npm publish