Skip to content

Commit

Permalink
adding readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bl0up committed Apr 26, 2024
1 parent 2a70a72 commit 98f27c3
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ERC20

A basic ERC20 token contract.
A Diamond Bond contract.

## Get started

Expand All @@ -9,7 +9,7 @@ Launch this smart contract set in the SettleMint Blockchain Transformation platf
If you want to use it separately, bootstrap a new project using

```shell
forge init my-erc20-token --template settlemint/solidity-token-erc20
forge init my-diamond-bond --template settlemint/solidity-diamond-bond
```

## DX: Foundry
Expand All @@ -25,77 +25,77 @@ Foundry consists of:

## Documentation

- https://console.settlemint.com/documentation/docs/using-platform/integrated-development-environment/
- https://book.getfoundry.sh/
- <https://console.settlemint.com/documentation/docs/using-platform/integrated-development-environment/>
- <https://book.getfoundry.sh/>

## Usage

### Build

```shell
$ forge build
forge build
```

### Test

```shell
$ forge test
forge test
```

### Format

```shell
$ forge fmt
forge fmt
```

### Gas Snapshots

```shell
$ forge snapshot
forge snapshot
```

### Anvil

Anvil is a local development node, open a terminal in the IDE and launch anvil. You can then deploy to it using `make deploy-anvil`

```shell
$ anvil
anvil
```

### Deploy

Deploy to a local anvil node:

```shell
$ make deploy-anvil
make deploy-anvil
```

When prompted to enter a private key, copy one of the private keys shown in the terminal when you start the anvil node.

Deploy to the connected platform node:

```shell
$ make deploy-btp
make deploy-btp
```

If you have a private key activated on the connected node, it will be used automatically. Else, you will be prompted to enter a private key. You can copy-paste a private key from the platform.

### Cast

```shell
$ cast <subcommand>
cast <subcommand>
```

### Deploy your subgraph

```shell
$ make subgraph
make subgraph
```

### Help

```shell
$ forge --help
$ anvil --help
$ cast --help
forge --help
anvil --help
cast --help
```

0 comments on commit 98f27c3

Please sign in to comment.