ethnotary 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +66 -28
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,17 +1,67 @@
|
|
|
1
1
|
# Ethnotary CLI
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A command-line tool for managing multi-signature wallets across EVM networks. Built for teams, DAOs, and AI agents who need secure, collaborative control over on-chain treasuries.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
**Key Use Cases:**
|
|
6
|
+
- **Treasury Management** – Collaboratively manage funds with multi-sig approval workflows
|
|
7
|
+
- **Payment Collection** – Receive and track payments across multiple networks
|
|
8
|
+
- **AI Agent Integration** – Enable AI agents to submit transactions while humans retain approval authority
|
|
9
|
+
- **Cross-Chain Operations** – Deploy and manage the same wallet on Sepolia, and Base-Sepolia, and more networks to come.
|
|
6
10
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
11
|
+
With multi-signature approvals, every transaction requires consensus—keeping you in control while enabling automation and collaboration.
|
|
12
|
+
|
|
13
|
+
## How Multi-Signature Works
|
|
14
|
+
|
|
15
|
+
A multi-signature (multi-sig) wallet requires multiple approvals before a transaction can execute. You define the number of **owners** and how many **confirmations** are required.
|
|
16
|
+
|
|
17
|
+
**Common Configurations:**
|
|
10
18
|
|
|
11
|
-
|
|
12
|
-
|
|
19
|
+
| Setup | Use Case |
|
|
20
|
+
|-------|----------|
|
|
21
|
+
| **1 of 1** | Single owner, instant execution. Good for personal wallets or AI agents with full autonomy. |
|
|
22
|
+
| **1 of 2** | Either owner can approve. Useful for shared access (e.g., you + your AI agent). |
|
|
23
|
+
| **2 of 2** | Both owners must approve. Maximum security for two-party agreements. |
|
|
24
|
+
| **2 of 3** | Any 2 of 3 owners must approve. Balances security with availability—if one key is lost, funds are still accessible. |
|
|
25
|
+
| **3 of 5** | Majority approval for DAOs or teams. Prevents single points of failure. |
|
|
26
|
+
|
|
27
|
+
**Example: AI Agent Integration (1 of 2)**
|
|
28
|
+
```
|
|
29
|
+
Owners: [Your Wallet, AI Agent Wallet]
|
|
30
|
+
Required: 1
|
|
31
|
+
|
|
32
|
+
→ AI agent can submit AND execute transactions autonomously
|
|
33
|
+
→ You can also execute transactions when needed
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
**Example: Human Oversight (2 of 2)**
|
|
37
|
+
```
|
|
38
|
+
Owners: [Your Wallet, AI Agent Wallet]
|
|
39
|
+
Required: 2
|
|
40
|
+
|
|
41
|
+
→ AI agent submits transactions
|
|
42
|
+
→ You review and approve before execution
|
|
43
|
+
→ Nothing happens without your confirmation
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Prerequisites
|
|
47
|
+
|
|
48
|
+
- **Node.js** (v16 or higher) - [Download](https://nodejs.org/)
|
|
49
|
+
- **npm** (comes with Node.js)
|
|
50
|
+
- **RPC URL** – Connection to your target network (e.g., from [Infura](https://infura.io), [Alchemy](https://alchemy.com), or a public RPC)
|
|
51
|
+
- **ETH for gas** – Enough cryptocurrency on your target network to pay for transaction fees
|
|
52
|
+
|
|
53
|
+
Verify Node.js installation:
|
|
54
|
+
```bash
|
|
55
|
+
node --version # Should show v16.x.x or higher
|
|
56
|
+
npm --version # Should show 8.x.x or higher
|
|
13
57
|
```
|
|
14
58
|
|
|
59
|
+
## Installation
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
# Install globally from npm
|
|
63
|
+
npm install -g ethnotary
|
|
64
|
+
|
|
15
65
|
## Quick Start
|
|
16
66
|
|
|
17
67
|
```bash
|
|
@@ -333,33 +383,21 @@ All configuration is stored in `~/.ethnotary/`:
|
|
|
333
383
|
|
|
334
384
|
Supported networks (use `--network <name>` or `--chain-id <id>`):
|
|
335
385
|
|
|
336
|
-
**
|
|
386
|
+
**Currently Supported:**
|
|
387
|
+
| Network | Name | Chain ID |
|
|
388
|
+
|---------|------|----------|
|
|
389
|
+
| Sepolia | `sepolia` | 11155111 |
|
|
390
|
+
| Base Sepolia | `base-sepolia` | 84532 |
|
|
391
|
+
|
|
392
|
+
**Coming Soon:**
|
|
337
393
|
| Network | Name | Chain ID |
|
|
338
394
|
|---------|------|----------|
|
|
339
395
|
| Ethereum Mainnet | `ethereum` | 1 |
|
|
340
|
-
| Optimism | `optimism` | 10 |
|
|
341
396
|
| Base | `base` | 8453 |
|
|
342
397
|
| Arbitrum One | `arbitrum` | 42161 |
|
|
343
|
-
|
|
|
344
|
-
| zkSync Era | `zksync-era` | 324 |
|
|
345
|
-
| Scroll | `scroll` | 534352 |
|
|
346
|
-
| Polygon zkEVM | `polygon-zkevm` | 1101 |
|
|
347
|
-
| Linea | `linea` | 59144 |
|
|
398
|
+
| Optimism | `optimism` | 10 |
|
|
348
399
|
| Polygon PoS | `polygon` | 137 |
|
|
349
|
-
|
|
|
350
|
-
| Avalanche C-Chain | `avalanche` | 43114 |
|
|
351
|
-
| Celo | `celo` | 42220 |
|
|
352
|
-
| Soneium | `soneium` | 1868 |
|
|
353
|
-
|
|
354
|
-
**Testnets:**
|
|
355
|
-
| Network | Name | Chain ID |
|
|
356
|
-
|---------|------|----------|
|
|
357
|
-
| Sepolia | `sepolia` | 11155111 |
|
|
358
|
-
| Base Sepolia | `base-sepolia` | 84532 |
|
|
359
|
-
| Arbitrum Sepolia | `arbitrum-sepolia` | 421614 |
|
|
360
|
-
| Polygon Mumbai | `polygon-mumbai` | 80001 |
|
|
361
|
-
| Polygon Amoy | `polygon-amoy` | 80002 |
|
|
362
|
-
| Avalanche Fuji | `avalanche-fuji` | 43113 |
|
|
400
|
+
| *...and more* | | |
|
|
363
401
|
|
|
364
402
|
**Configure RPC URLs:**
|
|
365
403
|
```bash
|