Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: typos #5

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Fix: typos #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
- [coralX-config.js](#coralx-configjs)
- [coralX-scenarios.js](#coralx-scenariosjs)
- [Compilation](#compilation)
- [Scenario file sctructures](#scenario-file-sctructures)
- [Scenario file structures](#scenario-file-structures)
- [Tests](#tests)
- [Contributing](#contributing)
- [Advanced Usage](#advanced-usage)
Expand Down Expand Up @@ -43,7 +43,7 @@ CoralX features plan:
- [ ] Console log from Solidity code
- [ ] Bundled local development blockchain server
- [ ] Multiple compiler versions support
- [ ] ... any good ideas are welcomed!
- [ ] ... any good ideas are welcome!

CoralX is designed to be used for the development of big projects.
It was tested on a project with 400+ smart contracts and long setup scripts.
Expand Down Expand Up @@ -189,7 +189,7 @@ Run:
$ coralX compile
```

### Scenario file sctructures
### Scenario file structures

Example of smart contract deployment (used proxy patterned smart contracts where Implementation address is constructor argument for Proxy smart contract: `constructor(address implementation`)):

Expand Down Expand Up @@ -295,7 +295,7 @@ $ coralX execute --path scripts/migrations
+ `--params`: a custom input parameters for the scripts
```
// --params issuer=0xA3E48...7bA4a,issuerPropertyId=0x1bea5a...a8de
// you can access this parameters in the script via `params`
// you can access these parameters in the script via `params`
// params = {issuer: 0xA3E48...7bA4a, issuerPropertyId: 0x1bea5a...a8de}

// in the script
Expand All @@ -312,7 +312,7 @@ $ coralX execute --path scripts/custom/add-system-role.js --params issuer=0xA3E4
Example:
$ coralX execute --path scripts/migrations --network gorli
```
+ `--output`: if script returns something it will be saved into the apropriate
+ `--output`: if script returns something it will be saved into the appropriate
file in the build/custom-scripts-output folder
```
Example:
Expand All @@ -326,7 +326,7 @@ Executes scenario from the coralX-config.js file.

Supports next options:

+ `--run`: specifies scenarion that will be executed
+ `--run`: specifies scenario that will be executed
```
Scenario example:
deployGorli: [
Expand Down Expand Up @@ -403,4 +403,4 @@ coralX fnFinder --path <build_folder_path> --data <method_signature>

## License

[MIT](./LICENSE)
[MIT](./LICENSE)