https://github.com/pure-peace/bunnyworld-bridge
https://github.com/pure-peace/bunnyworld-bridge
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/pure-peace/bunnyworld-bridge
- Owner: Pure-Peace
- License: mit
- Created: 2022-08-30T10:23:17.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-09-28T07:32:04.000Z (almost 4 years ago)
- Last Synced: 2025-08-21T05:37:25.846Z (11 months ago)
- Language: TypeScript
- Size: 39.1 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BunnyWorld-Bridge-Contracts
## Docs generate
```
yarn docs
```
## Display contract size
```
yarn size
```
## Contracts deploy
```
yarn deploy-prod
```
## Contracts upgrade cli
```
yarn upgrade-cli
```
## INSTALL
```bash
yarn
```
## TEST
```bash
yarn test
```
## SCRIPTS
Here is the list of npm scripts you can execute:
Some of them relies on [./\_scripts.js](./_scripts.js) to allow parameterizing it via command line argument (have a look inside if you need modifications)
`yarn prepare`
As a standard lifecycle npm script, it is executed automatically upon install. It generate config file and typechain to get you started with type safe contract interactions
`yarn lint`, `yarn lint:fix`, `yarn format` and `yarn format:fix`
These will lint and format check your code. the `:fix` version will modifiy the files to match the requirement specified in `.eslintrc` and `.prettierrc.`
`yarn compile`
These will compile your contracts
`yarn void:deploy`
This will deploy your contracts on the in-memory hardhat network and exit, leaving no trace. quick way to ensure deployments work as intended without consequences
`yarn test [mocha args...]`
These will execute your tests using mocha. you can pass extra arguments to mocha
`yarn coverage`
These will produce a coverage report in the `coverage/` folder
`yarn gas`
These will produce a gas report for function used in the tests
`yarn dev`
These will run a local hardhat network on `localhost:8545` and deploy your contracts on it. Plus it will watch for any changes and redeploy them.
`yarn local:dev`
This assumes a local node it running on `localhost:8545`. It will deploy your contracts on it. Plus it will watch for any changes and redeploy them.
`yarn execute [args...]`
This will execute the script `` against the specified network
`yarn deploy [args...]`
This will deploy the contract on the specified network.
Behind the scene it uses `hardhat deploy` command so you can append any argument for it
`yarn export `
This will export the abi+address of deployed contract to ``
`yarn fork:execute [--blockNumber ] [--deploy] [args...]`
This will execute the script `` against a temporary fork of the specified network
if `--deploy` is used, deploy scripts will be executed
`yarn fork:deploy [--blockNumber ] [args...]`
This will deploy the contract against a temporary fork of the specified network.
Behind the scene it uses `hardhat deploy` command so you can append any argument for it
`yarn fork:test [--blockNumber ] [mocha args...]`
This will test the contract against a temporary fork of the specified network.
`yarn fork:dev [--blockNumber ] [args...]`
This will deploy the contract against a fork of the specified network and it will keep running as a node.
Behind the scene it uses `hardhat node` command so you can append any argument for it