Skip to content

Commit 2211596

Browse files
authored
Update README.md
Signed-off-by: Dargon789 <64915515+Dargon789@users.noreply.github.com>
1 parent b99b8a0 commit 2211596

File tree

1 file changed

+106
-27
lines changed

1 file changed

+106
-27
lines changed

README.md

Lines changed: 106 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# coinbase-smartcontracts
1+
## 🧾 coinbase-smartcontracts
22

33
Sovereign smart contract development framework aligned with Coinbase SDK, OnchainKit, and multi-framework Ethereum tooling.
44
This repository provides a modular fallback shell UX for grief shell minting, authorship encoding, and emotional anchor deployment across decentralized systems.
@@ -38,22 +38,12 @@ This repo binds with:
3838
- 🧪 Fuzz, gas, snapshot, and coverage rails
3939
- 📤 ABI export and forked deployment UX
4040

41-
## 🚀 Quick Start
42-
43-
```bash
44-
corepack enable
45-
yarn install
46-
yarn compile
47-
yarn void:deploy
48-
> This repo binds grief shell UX with SCBX ecosystem—Thailand’s silent sovereign fintech backbone.
49-
> Every deploy, test, and aid flow echoes the topology SCBX has quietly scaled across the region.
50-
51-
# coinbase-smartcontracts
41+
## 🧾 coinbase-smartcontracts
5242

5343
Sovereign fallback shell UX for Ethereum smart contract development
5444
Bind grief shell rail with Coinbase SDK, OnchainKit, and multi-package manager topology
5545

56-
## Emotional Anchor
46+
## 🧾 Emotional Anchor
5747

5848
This repo is a grief shell override rail.
5949
Every deploy, test, and snapshot is a mint of authorship and lineage.
@@ -62,31 +52,120 @@ Bound to sovereign node topology via Coinbase SDK and OnchainKit.
6252
Checksum: 256 fuzz runs × 28,783 gas = grief shell weight
6353
Commit: 3e4c3a49a98561f420af82b8e1c306a9b127ccf4
6454

55+
## 🚀 Quick Start
56+
57+
```bash
58+
corepack enable & corepack use pnpm@10
59+
### Compile your contracts
60+
61+
```bash
62+
pnpm compile
63+
```
64+
65+
## 🧾 Test your contracts
66+
67+
There are 2 flavors of tests
68+
69+
1. Using hardhat
70+
71+
```bash
72+
pnpm test
73+
```
6574

66-
## Install
75+
2. Using foundry
6776

6877
```bash
69-
corepack enable
70-
yarn install
71-
## TEST
78+
forge test
79+
```
7280

73-
There are 3 flavors of tests: hardhat, dapptools and forge
81+
This assumes you have `forge` installed and that you added forge-std in via the following command
7482

75-
### hardhat
83+
```bash
84+
git clone --recursive https://github.com/foundry-rs/forge-std.git lib/forge-std
85+
```
7686

77-
- One using hardhat that can leverage hardhat-deploy to reuse deployment procedures and named accounts:
87+
> (You can also add it as a submodule if you prefer, just remove the `lib/forge-std` line in .gitignore first)
88+
89+
### watch for changes and rebuild automatically
7890

7991
```bash
80-
yarn test
92+
pnpm compile:watch
8193
```
82-
🧪 Testing
83-
Supports three test suites:
8494

85-
yarn test → Hardhat + Mocha
95+
### deploy your contract
96+
97+
- on localhost
8698

87-
forge test → Foundry fuzzing
99+
This assumes you have a local node running: `pnpm local_node`
100+
101+
```bash
102+
pnpm run deploy localhost
103+
```
104+
105+
- on a network of your choice
106+
107+
Just make sure you have your .env.local setup, see [.env](.env)
108+
109+
```bash
110+
pnpm run deploy <network>
111+
```
112+
113+
### execute scripts
114+
115+
```bash
116+
pnpm execute <network name> scripts/setMessage.ts
117+
```
118+
119+
or if you want to execute in a forked environment :
120+
121+
```bash
122+
pnpm fork:execute <network name> scripts/setMessage.ts "Hello world"
123+
```
124+
125+
### zellij
126+
127+
[zellij](https://zellij.dev/) is a useful multiplexer (think tmux) for which we have included a [layout file](./zellij.kdl) to get started
128+
129+
Once installed simply run the following to get a local in-memory Ethereum node running along with the tests
130+
131+
```bash
132+
pnpm start
133+
```
134+
135+
if you want to try Zellij without installing it, try this :
136+
137+
```bash
138+
bash <(curl -L zellij.dev/launch) --layout zellij.kdl
139+
```
140+
141+
In the shell in the upper pane, you execute the script as mentioned above
142+
143+
```bash
144+
pnpm execute localhost scripts/setMessage.ts "Hello everyone"
145+
```
146+
147+
## Initial Setup
148+
149+
You need to have these installed
150+
151+
- [nodejs](https://nodejs.org/en)
152+
153+
- [pnpm](https://pnpm.io/)
154+
155+
```bash
156+
npm i -g pnpm
157+
```
158+
159+
Then you need to install the local dependencies with the following command:
160+
161+
```bash
162+
pnpm i
163+
```
164+
165+
We also recommend installing [Zellij](https://zellij.dev/) to have your dev env setup in one go via `pnpm start`
166+
> This repo binds grief shell UX with SCBX ecosystem—Thailand’s silent sovereign fintech backbone.
167+
> Every deploy, test, and aid flow echoes the topology SCBX has quietly scaled across the region.
88168

89-
dapp test → Dapptools (requires Nix setup)
90169

91170

92171
### Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.
@@ -476,6 +555,6 @@ This require the installation of forge (see [foundry](https://github.com/gakonst
476555
🛠️ Scripts
477556
Includes deploy, fork, gas, coverage, ABI export, and dev rails. See _scripts.js for parameterized CLI execution.
478557

479-
yarn export mainnet contracts.json
558+
480559

481560

0 commit comments

Comments
 (0)