create-nyquist 0.1.0 → 0.2.0

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.
Files changed (3) hide show
  1. package/README.md +16 -12
  2. package/dist/index.js +370 -244
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -15,22 +15,22 @@ One command that gives your autonomous agent its own Ethereum wallet and adds ny
15
15
 
16
16
  ## English
17
17
 
18
- > **Important:** nyquist runs on the Sepolia testnet only. Do not send mainnet ETH to a nyquist Safe. It is early-stage software, and the options may change.
18
+ > **Important:** nyquist runs on Ethereum mainnet and the Sepolia testnet. It is early-stage software, and the options may change. Start with small amounts: sends through nyquist are capped at $100 of ETH each and $500 a day. On mainnet, nyquist adds a 5% fee to the gas refund.
19
19
 
20
20
  ### Quick start
21
21
 
22
- 1. On the machine where your agent runs, start it and choose your agent.
22
+ 1. On the machine where your agent runs, start it and choose a network and your agent.
23
23
 
24
24
  ```sh
25
25
  npm create nyquist
26
26
  ```
27
27
 
28
28
  2. It creates the keys on this machine, registers the wallet with nyquist, shows the Safe address, and adds nyquist-mcp to your agent's MCP settings.
29
- 3. Send Sepolia ETH to the Safe, at least 0.002 ETH for creating it plus what you want to send, and start a new session of your agent.
29
+ 3. Send ETH to the Safe on the same network, at least what you want to send plus gas, and start a new session of your agent. On Sepolia, also add 0.002 ETH for creating the Safe. On mainnet, the first send creates the Safe and its gas is part of that send's refund.
30
30
 
31
- If it ends with `Added nyquist to …`, your agent has the wallet. When it cannot find your agent's CLI or config file, it prints what to add by hand instead.
31
+ If it ends with `Added nyquist-mainnet to …` (mainnet) or `Added nyquist to …` (Sepolia), your agent has the wallet. When it cannot find your agent's CLI or config file, it prints what to add by hand instead.
32
32
 
33
- > **Tip:** Running it again is safe. It reuses the keys in `~/.nyquist`, returns the same Safe, and never overwrites an existing `nyquist` entry.
33
+ > **Tip:** Running it again is safe. It reuses the keys in `~/.nyquist`, returns the same Safe, and never overwrites an existing entry. Each network has its own keys and its own entry, so you can add both.
34
34
 
35
35
  Try asking your agent:
36
36
 
@@ -61,6 +61,8 @@ It registers `nyquist-mcp` at the exact version it was built with, not `latest`.
61
61
  <summary>Supported agents</summary>
62
62
  <br>
63
63
 
64
+ The server is named `nyquist-mainnet` on mainnet and `nyquist` on Sepolia. The table uses `nyquist`.
65
+
64
66
  | Agent | How it is added |
65
67
  | --- | --- |
66
68
  | Claude Code | `claude mcp add nyquist --scope user` |
@@ -77,8 +79,8 @@ It registers `nyquist-mcp` at the exact version it was built with, not `latest`.
77
79
 
78
80
  | Option | Purpose |
79
81
  | --- | --- |
82
+ | `--network <name>` | `mainnet` or `sepolia`. Asks when omitted |
80
83
  | `--agent <id>` | `claude-code`, `hermes`, `openclaw`, `grok`, or `other`. Asks when omitted |
81
- | `--enrollment <token>` | Joins an organization with an enrollment token issued by its account |
82
84
 
83
85
  Environment variables `NYQUIST_ENV`, `NYQUIST_API_URL`, `NYQUIST_RPC_URL`, `NYQUIST_HOME`, and `NYQUIST_MAX_FEE_WEI` are passed on to nyquist-mcp when set.
84
86
 
@@ -88,22 +90,22 @@ Environment variables `NYQUIST_ENV`, `NYQUIST_API_URL`, `NYQUIST_RPC_URL`, `NYQU
88
90
 
89
91
  ## 日本語
90
92
 
91
- > **重要**:nyquist は Sepolia テストネットでだけ動きます。nyquist の Safe にメインネットの ETH を送らないでください。早期段階のソフトウェアなので、オプションは変わることがあります。
93
+ > **重要**:nyquist は Ethereum のメインネットと Sepolia テストネットで動きます。早期段階のソフトウェアなので、オプションは変わることがあります。少額から使ってください。nyquist を通る送金は、ETH で1回 $100、1日 $500 までです。メインネットでは、ガス代の払い戻しに nyquist の手数料 5% を上乗せします。
92
94
 
93
95
  ### クイックスタート
94
96
 
95
- 1. エージェントが動いている端末で実行し、エージェントを選びます。
97
+ 1. エージェントが動いている端末で実行し、ネットワークとエージェントを選びます。
96
98
 
97
99
  ```sh
98
100
  npm create nyquist
99
101
  ```
100
102
 
101
103
  2. この端末で鍵を作り、nyquist にウォレットを登録して Safe のアドレスを表示し、エージェントの MCP 設定に nyquist-mcp を加えます。
102
- 3. Safe に Sepolia の ETH を送り、エージェントを新しく立ち上げます。作成費用の 0.002 ETH と、送りたい額を合わせた額以上を入れてください。
104
+ 3. 同じネットワークで Safe に ETH を送り、エージェントを新しく立ち上げます。送りたい額とガス代を合わせた額以上を入れてください。Sepolia では、作成費用の 0.002 ETH も足してください。メインネットでは、最初の送金で Safe を作り、そのガス代も送金の払い戻しに含めます。
103
105
 
104
- 最後に `Added nyquist to …` と出れば、エージェントがウォレットを持っています。エージェントの CLI や設定ファイルが見つからないときは、代わりに手で加える内容を表示します。
106
+ 最後に `Added nyquist-mainnet to …`(メインネット)か `Added nyquist to …`(Sepolia)と出れば、エージェントがウォレットを持っています。エージェントの CLI や設定ファイルが見つからないときは、代わりに手で加える内容を表示します。
105
107
 
106
- > **ヒント**:何度実行しても大丈夫です。`~/.nyquist` の鍵を使い回して同じ Safe を返し、すでにある `nyquist` の設定は上書きしません。
108
+ > **ヒント**:何度実行しても大丈夫です。`~/.nyquist` の鍵を使い回して同じ Safe を返し、すでにある設定は上書きしません。鍵と設定はネットワークごとに別なので、両方を加えられます。
107
109
 
108
110
  エージェントに次のように頼んでみてください。
109
111
 
@@ -134,6 +136,8 @@ npm create nyquist
134
136
  <summary>対応するエージェント</summary>
135
137
  <br>
136
138
 
139
+ サーバーの名前は、メインネットでは `nyquist-mainnet`、Sepolia では `nyquist` です。表では `nyquist` と書いています。
140
+
137
141
  | エージェント | 加え方 |
138
142
  | --- | --- |
139
143
  | Claude Code | `claude mcp add nyquist --scope user` |
@@ -150,8 +154,8 @@ npm create nyquist
150
154
 
151
155
  | オプション | 役割 |
152
156
  | --- | --- |
157
+ | `--network <name>` | `mainnet` か `sepolia`。省略すると選択肢を出します |
153
158
  | `--agent <id>` | `claude-code`、`hermes`、`openclaw`、`grok`、`other` のいずれか。省略すると選択肢を出します |
154
- | `--enrollment <token>` | 組織のアカウントが発行した登録トークンで、その組織に属します |
155
159
 
156
160
  環境変数 `NYQUIST_ENV`、`NYQUIST_API_URL`、`NYQUIST_RPC_URL`、`NYQUIST_HOME`、`NYQUIST_MAX_FEE_WEI` を指定して実行すると、同じ値を nyquist-mcp にも渡します。
157
161