Please report any security issues to [email protected]

BondFactory: https://etherscan.io/address/0x9f20521ef789fd2020e708390b1e6c701d8218ba

BondFactory: 0x0ae42cF40Fb46A926e2dcCE92b2Fe785d2D1E0A0

Smart Contracts powering the Porter protocol.

For local development there are environment variables necessary to enable some hardhat plugins.

Using hardhat-deploy all of the scripts in the ./deploy folder are run. This will run the whole integration flow as well which includes deploying of the factory, tokens, creating bonds, doing bond actions, and starting auctions. If that is not desired, add a tags flag with what you want to deploy.

npx hardhat deploy --tags main-deployment # deploy bond factory
npx hardhat deploy --tags test-deployment # and deploy tokens
npx hardhat deploy --tags permissions # and grant roles & permissions
npx hardhat deploy --tags bonds # and deploy test bonds
npx hardhat deploy --tags auctions # and start bond auctions
npx hardhat deploy --tags actions # and do bond actions

Additionally, all of the above commands can be run with --network rinkeby to deploy to the Rinkeby test network.

Note: The deploy script will run with the npx hardhat node as well as the npx hardhat test tasks.

Verify deployed contracts with hardhat-etherscan.

npx hardhat verify <address>

Running the hardhat test suite

npx hardhat test

Fork testing requires first running the mainnet-fork

npx hardhat node

and making the target for testing the local node

npx hardhat test --network localhost

Running the fuzzing test suite with Echidna

• Get latest release https://github.com/crytic/echidna
• Install to /usr/local/bin
• npm run echidna
• change the config located at echidna.config.yaml to tweak execution

npx hardhat help
npx hardhat compile # create contract artifacts
npx hardhat clean # removes artifacts and maybe other things
npx hardhat coverage # runs the contract coverage report
npx hardhat integration # runs the integration task
npx hardhat settle-auction --auctionId <auctionId> # settles an auction
npx eslint '**/*.{js,ts}' --fix
npx prettier '**/*.{json,sol,md,ts}' --write
npx solhint 'contracts/**/*.sol' --fix