Skip to content

Commit

Permalink
feat: add package.json and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tansawit committed Jul 25, 2024
1 parent d2cb9c6 commit 476087a
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 65 deletions.
67 changes: 2 additions & 65 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,3 @@
## Foundry
# Initia EVM Contracts

**Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.**

Foundry consists of:

- **Forge**: Ethereum testing framework (like Truffle, Hardhat and DappTools).
- **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data.
- **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network.
- **Chisel**: Fast, utilitarian, and verbose solidity REPL.

## Documentation

https://book.getfoundry.sh/

## Usage

### Build

```shell
$ forge build
```

### Test

```shell
$ forge test
```

### Format

```shell
$ forge fmt
```

### Gas Snapshots

```shell
$ forge snapshot
```

### Anvil

```shell
$ anvil
```

### Deploy

```shell
$ forge script script/Counter.s.sol:CounterScript --rpc-url <your_rpc_url> --private-key <your_private_key>
```

### Cast

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

### Help

```shell
$ forge --help
$ anvil --help
$ cast --help
```
This repository contains the various smart contracts for interacting and developing with the Initia MiniEVM framework.
22 changes: 22 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"name": "@initia/initia-evm-contracts",
"license": "MIT",
"version": "0.1.0",
"description": "**Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.**",
"author": "Initia Labs",
"files": [
"src/*.sol",
"src/interfaces/*.sol"
],
"repository": {
"type": "git",
"url": "git+https://github.com/initia-labs/initia-evm-contracts.git"
},
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"bugs": {
"url": "https://github.com/initia-labs/initia-evm-contracts/issues"
},
"homepage": "https://github.com/initia-labs/initia-evm-contracts#readme"
}

0 comments on commit 476087a

Please sign in to comment.