-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
77 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -25,9 +25,6 @@ out/ | |
/broadcast/*/31337/ | ||
/broadcast/**/dry-run/ | ||
|
||
# Docs | ||
docs/ | ||
|
||
# Dotenv file | ||
.env | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# Basic Usage | ||
|
||
## Build | ||
|
||
You can either use Forge: | ||
|
||
```shell | ||
btp-scs foundry build | ||
``` | ||
|
||
or Hardhat: | ||
|
||
```shell | ||
btp-scs hardhat build | ||
``` | ||
|
||
## Test | ||
|
||
With Forge: | ||
|
||
```shell | ||
btp-scs foundry test | ||
``` | ||
|
||
or Hardhat: | ||
|
||
```shell | ||
btp-scs hardhat test | ||
``` | ||
|
||
## Format | ||
|
||
To format your contracts, run | ||
|
||
```shell | ||
btp-scs foundry format | ||
``` | ||
|
||
## Deploy to local network | ||
|
||
You can deploy your contracts to a local network. First, run | ||
|
||
```shell | ||
btp-scs hardhat network | ||
``` | ||
|
||
then: | ||
|
||
```shell | ||
btp-scs hardhat deploy local -m ignition/modules/main.ts | ||
``` | ||
|
||
## Deploy to platform network | ||
|
||
You can also deploy your contracts to the network running on the platform by executing the following command: | ||
|
||
```shell | ||
btp-scs hardhat deploy remote -m ignition/modules/main.ts | ||
``` | ||
|
||
## Help | ||
|
||
To get info about the tasks, run: | ||
|
||
```shell | ||
btp-scs --help | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Subgraph Usage | ||
|
||
## Deploy your subgraph | ||
|
||
To index your smart contract events, use The Graph middleware. | ||
First, edit `subgraph.config.json` to set the addresses of your smart contracts. You can find them in the deployment folder created under `ignation`. Then, run: | ||
|
||
```shell | ||
btp-scs subgraph deploy | ||
``` |