create-nyquist 0.0.1 → 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,8 @@
+nyquist
+Copyright 2026 Arata Ouchi
+
+This product is licensed under the Apache License, Version 2.0.
+
+The nyquist name and logo are trademarks of Arata Ouchi. They are not
+licensed under the Apache License, Version 2.0, and may not be used
+without permission, except to refer to this project.

package/README.md

@@ -1,9 +1,158 @@
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://www.nyquist.sh/brand/logo-dark.png">
+  <source media="(prefers-color-scheme: light)" srcset="https://www.nyquist.sh/brand/logo.png">
+  <img src="https://www.nyquist.sh/brand/logo-outline.png" width="240" alt="nyquist">
+</picture>
+
 # create-nyquist
 
-Set up nyquist, a crypto wallet for autonomous agents.
+One command that gives your autonomous agent its own Ethereum wallet and adds nyquist-mcp to it.<br>
+<sub>1つのコマンドで、自律エージェントに自分の Ethereum ウォレットを持たせ、nyquist-mcp を登録します。</sub>
+
+<p align="center"><a href="#en">Read more in English</a> · <a href="#ja">日本語で読む</a></p>
+
+<a id="en"></a>
+
+## English
+
+> **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.
+
+### Quick start
+
+1. On the machine where your agent runs, start it and choose your agent.
 
 ```sh
 npm create nyquist
 ```
 
-This package is a placeholder. The setup command is coming soon.
+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.
+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.
+
+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.
+
+> **Tip:** Running it again is safe. It reuses the keys in `~/.nyquist`, returns the same Safe, and never overwrites an existing `nyquist` entry.
+
+Try asking your agent:
+
+- "Show my nyquist wallet."
+- "Send 0.001 ETH to 0x…"
+
+### Technology
+
+<details>
+<summary>The keys never leave this machine</summary>
+<br>
+
+The keys are created here and stored in `~/.nyquist`. Only the public key and the signer address are sent to nyquist. The Safe address nyquist returns is recomputed locally from the key before it is saved, so a wrong server cannot make you fund someone else's address.
+
+</details>
+
+<details>
+<summary>The MCP server is pinned</summary>
+<br>
+
+It registers `nyquist-mcp` at the exact version it was built with, not `latest`. A new release never runs on your agent until you run `npm create nyquist` again.
+
+</details>
+
+### Specification
+
+<details>
+<summary>Supported agents</summary>
+<br>
+
+| Agent | How it is added |
+| --- | --- |
+| Claude Code | `claude mcp add nyquist --scope user` |
+| Hermes Agent | Adds `nyquist` under `mcp_servers` in `~/.hermes/config.yaml`, keeping comments and order |
+| OpenClaw | `openclaw mcp set nyquist`. Restart the gateway afterwards |
+| Grok Bot | Prints a message to paste into the chat. Grok Bot runs the server and keeps the keys on its own computer |
+| Other MCP client | Prints the stdio server settings |
+
+</details>
+
+<details>
+<summary>Options</summary>
+<br>
+
+| Option | Purpose |
+| --- | --- |
+| `--agent <id>` | `claude-code`, `hermes`, `openclaw`, `grok`, or `other`. Asks when omitted |
+| `--enrollment <token>` | Joins an organization with an enrollment token issued by its account |
+
+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.
+
+</details>
+
+<a id="ja"></a>
+
+## 日本語
+
+> **重要**：nyquist は Sepolia テストネットでだけ動きます。nyquist の Safe にメインネットの ETH を送らないでください。早期段階のソフトウェアなので、オプションは変わることがあります。
+
+### クイックスタート
+
+1. エージェントが動いている端末で実行し、エージェントを選びます。
+
+```sh
+npm create nyquist
+```
+
+2. この端末で鍵を作り、nyquist にウォレットを登録して Safe のアドレスを表示し、エージェントの MCP 設定に nyquist-mcp を加えます。
+3. Safe に Sepolia の ETH を送り、エージェントを新しく立ち上げます。作成費用の 0.002 ETH と、送りたい額を合わせた額以上を入れてください。
+
+最後に `Added nyquist to …` と出れば、エージェントがウォレットを持っています。エージェントの CLI や設定ファイルが見つからないときは、代わりに手で加える内容を表示します。
+
+> **ヒント**：何度実行しても大丈夫です。`~/.nyquist` の鍵を使い回して同じ Safe を返し、すでにある `nyquist` の設定は上書きしません。
+
+エージェントに次のように頼んでみてください。
+
+- 「nyquist のウォレットを見せて」
+- 「0.001 ETH を 0x… に送って」
+
+### テクノロジー
+
+<details>
+<summary>鍵はこの端末から出ません</summary>
+<br>
+
+鍵はここで作り、`~/.nyquist` に保存します。nyquist に送るのは公開鍵と signer のアドレスだけです。nyquist が返した Safe のアドレスは、保存する前に鍵から手元で計算し直すので、誤ったサーバーが他人のアドレスへ入金させることはできません。
+
+</details>
+
+<details>
+<summary>MCP サーバーの版を固定します</summary>
+<br>
+
+`nyquist-mcp` を `latest` ではなく、ビルドしたときの版で登録します。新しい版は、`npm create nyquist` をもう一度実行するまで、エージェントの環境では動きません。
+
+</details>
+
+### 仕様
+
+<details>
+<summary>対応するエージェント</summary>
+<br>
+
+| エージェント | 加え方 |
+| --- | --- |
+| Claude Code | `claude mcp add nyquist --scope user` |
+| Hermes Agent | `~/.hermes/config.yaml` の `mcp_servers` に `nyquist` を加えます。コメントや並び順は残します |
+| OpenClaw | `openclaw mcp set nyquist`。そのあとゲートウェイを再起動します |
+| Grok Bot | チャットに貼る文を表示します。Grok Bot は自分のコンピューターでサーバーを動かし、鍵もそこに置きます |
+| その他の MCP クライアント | stdio のサーバーの設定を表示します |
+
+</details>
+
+<details>
+<summary>オプション</summary>
+<br>
+
+| オプション | 役割 |
+| --- | --- |
+| `--agent <id>` | `claude-code`、`hermes`、`openclaw`、`grok`、`other` のいずれか。省略すると選択肢を出します |
+| `--enrollment <token>` | 組織のアカウントが発行した登録トークンで、その組織に属します |
+
+環境変数 `NYQUIST_ENV`、`NYQUIST_API_URL`、`NYQUIST_RPC_URL`、`NYQUIST_HOME`、`NYQUIST_MAX_FEE_WEI` を指定して実行すると、同じ値を nyquist-mcp にも渡します。
+
+</details>