From 476087a6b046053676e6cec23c477adc9249e97c Mon Sep 17 00:00:00 2001 From: Sawit Trisirisatayawong Date: Thu, 25 Jul 2024 15:42:05 +0700 Subject: [PATCH] feat: add package.json and update readme --- README.md | 67 ++-------------------------------------------------- package.json | 22 +++++++++++++++++ 2 files changed, 24 insertions(+), 65 deletions(-) create mode 100644 package.json diff --git a/README.md b/README.md index 9265b45..6d8ac8f 100644 --- a/README.md +++ b/README.md @@ -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 --private-key -``` - -### Cast - -```shell -$ cast -``` - -### Help - -```shell -$ forge --help -$ anvil --help -$ cast --help -``` +This repository contains the various smart contracts for interacting and developing with the Initia MiniEVM framework. diff --git a/package.json b/package.json new file mode 100644 index 0000000..c7b14a1 --- /dev/null +++ b/package.json @@ -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" +}