nyquist-mcp 0.0.1 → 0.1.1

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,5 +1,198 @@
+<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>
+
 # nyquist-mcp
 
-MCP server for nyquist, a crypto wallet for autonomous agents.
+An MCP server that gives an autonomous agent its own Ethereum wallet. The keys stay on the agent's machine.<br>
+<sub>自律エージェントに自分の Ethereum ウォレットを持たせる 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 tools may change.
+
+### Quick start
+
+1. Run `npm create nyquist`. It creates the keys, registers the wallet, and adds this server to your agent. To add it by hand instead, register it as a stdio MCP server. In Claude Code:
+
+```sh
+claude mcp add nyquist --scope user -- npx --prefix="$HOME/.nyquist" -y --package nyquist-mcp@0.1.1 nyquist-mcp
+```
+
+2. Ask your agent to set up the wallet. It calls `nyquist_setup` and returns the Safe address.
+3. Send Sepolia ETH to that address, at least 0.002 ETH for creating the Safe plus what you want to send.
+
+> **Tip:** The version is pinned, so a new release never runs on your agent until you change it. `--prefix` starts npx from `~/.nyquist` instead of your project. Without it, npx refuses to run inside a project whose `package.json` requires another package manager through `devEngines`.
+
+Try asking:
+
+- "Set up my nyquist wallet."
+- "Send 0.001 ETH to 0x…"
+- "Create a claim code so I can take over this agent."
+
+### Technology
+
+<details>
+<summary>Only the agent can move the funds</summary>
+<br>
+
+The Safe has one owner, the agent's secp256k1 key, with a threshold of 1. nyquist's relayer pays gas up front and is refunded by the Safe, but it is never an owner.
+
+| Key | Purpose |
+| --- | --- |
+| Ed25519 | Signs API requests with RFC 9421 HTTP Message Signatures |
+| secp256k1 | Signs Safe transactions as the sole owner |
+
+The keys are stored in `~/.nyquist/agent.<environment>.json`, with mode 0600 in a 0700 directory. Losing the secp256k1 key means losing the funds, so keep the balance small until a human has claimed the agent and been added with `nyquist_add_recovery_owner`.
+
+</details>
+
+<details>
+<summary>Every send is checked before signing</summary>
+<br>
+
+`nyquist_send` does not trust nyquist's quote. It signs only if all of these hold.
+
+| Check | How |
+| --- | --- |
+| Safe address | Recomputed from the agent's key with CREATE2 when registering |
+| Chain and Safe | The quote's chain ID and Safe match the registration |
+| Safe transaction hash | Rebuilt locally from the request |
+| Nonce | Equal to the Safe's nonce on chain |
+| Gas | `baseGas` and `safeTxGas` within the published formula; `safeTxGas` at least the agent's own estimate |
+| Gas price | No more than three times the current fee from the agent's own RPC |
+| Refund | Paid only to the published relayer, and no more than `NYQUIST_MAX_FEE_WEI` |
+
+Calls to the Safe itself are refused, except for adding a recovery owner. Error text from the server is replaced with fixed local messages before it reaches the model.
+
+</details>
+
+### Specification
+
+<details>
+<summary>MCP tools</summary>
+<br>
+
+| Tool | Purpose |
+| --- | --- |
+| `nyquist_setup` | Creates the keys and registers the wallet. Returns the same wallet every time |
+| `nyquist_wallet` | Returns the Safe address, balance, owners, and organization |
+| `nyquist_send` | Sends ETH or calls a contract. The first send creates the Safe and pays a 0.002 ETH creation fee |
+| `nyquist_transaction` | Returns `pending`, `success`, `failed`, `reverted`, or `dropped` for a send. `dropped` means nyquist cancelled it before it ran |
+| `nyquist_claim_code` | Creates a code a human uses to claim the agent into an organization |
+| `nyquist_add_recovery_owner` | Adds the human who claimed the agent as a Safe owner. Takes the address the human gave you directly |
+
+</details>
+
+<details>
+<summary>Environment variables</summary>
+<br>
+
+| Variable | Default | Purpose |
+| --- | --- | --- |
+| `NYQUIST_ENV` | `production` | `development` uses a local API |
+| `NYQUIST_API_URL` | The API for the environment | The nyquist API to use |
+| `NYQUIST_RPC_URL` | A public Sepolia RPC | The RPC used to check quotes |
+| `NYQUIST_HOME` | `~/.nyquist` | Where the keys are stored |
+| `NYQUIST_MAX_FEE_WEI` | 0.01 ETH | The most gas refund a single send may pay |
+
+</details>
+
+<a id="ja"></a>
+
+## 日本語
+
+> **重要**：nyquist は Sepolia テストネットでだけ動きます。nyquist の Safe にメインネットの ETH を送らないでください。早期段階のソフトウェアなので、ツールは変わることがあります。
+
+### クイックスタート
+
+1. `npm create nyquist` を実行します。鍵を作り、ウォレットを登録し、このサーバーをエージェントに加えます。手で加えるときは、stdio の MCP サーバーとして登録します。Claude Code なら次のとおりです。
+
+```sh
+claude mcp add nyquist --scope user -- npx --prefix="$HOME/.nyquist" -y --package nyquist-mcp@0.1.1 nyquist-mcp
+```
+
+2. エージェントにウォレットの用意を頼みます。`nyquist_setup` を呼んで、Safe のアドレスを返します。
+3. そのアドレスに Sepolia の ETH を送ります。Safe の作成費用の 0.002 ETH と、送りたい額を合わせた額以上を入れてください。
+
+> **ヒント**：版を固定しているので、新しい版は、あなたが版を書き換えるまでエージェントの環境では動きません。`--prefix` は、npx をプロジェクトではなく `~/.nyquist` から起動するためのものです。これがないと、`package.json` の `devEngines` で別のパッケージマネージャーを指定したプロジェクトの中では、npx が起動を拒みます。
+
+次のように頼んでみてください。
+
+- 「nyquist のウォレットを用意して」
+- 「0.001 ETH を 0x… に送って」
+- 「このエージェントを引き取れるよう、引き取りコードを作って」
+
+### テクノロジー
+
+<details>
+<summary>資金を動かせるのはエージェントだけです</summary>
+<br>
+
+Safe のオーナーはエージェントの secp256k1 の鍵1つだけで、閾値は1です。nyquist のリレイヤーはガス代を立て替えて Safe から払い戻しを受けますが、オーナーにはなりません。
+
+| 鍵 | 役割 |
+| --- | --- |
+| Ed25519 | API へのリクエストに RFC 9421 の HTTP Message Signature を付ける |
+| secp256k1 | 唯一のオーナーとして Safe の tx に署名する |
+
+鍵は `~/.nyquist/agent.<環境>.json` に、ファイルは 0600、ディレクトリは 0700 で保存します。secp256k1 の鍵を失うと資金も失うので、人間に引き取ってもらい、`nyquist_add_recovery_owner` で加えるまでは、少額で使ってください。
+
+</details>
+
+<details>
+<summary>署名する前に、送金ごとに確かめます</summary>
+<br>
+
+`nyquist_send` は nyquist の見積もりを信じきらず、次をすべて満たすときだけ署名します。
+
+| 確かめること | 方法 |
+| --- | --- |
+| Safe のアドレス | 登録のときに、エージェントの鍵から CREATE2 で計算し直す |
+| チェーンと Safe | 見積もりの chain ID と Safe が、登録時と一致する |
+| Safe の tx のハッシュ | 依頼から手元で組み立て直す |
+| nonce | チェーン上の Safe の nonce と一致する |
+| ガス | `baseGas` と `safeTxGas` が公開している計算式の範囲に収まり、`safeTxGas` が自分の見積もり以上である |
+| ガス代 | 自分の RPC から取った現在のガス代の3倍を超えない |
+| 払い戻し | 公開しているリレイヤーにだけ払い、`NYQUIST_MAX_FEE_WEI` を超えない |
+
+Safe 自身への呼び出しは、復旧用オーナーを加えるもの以外は断ります。サーバーのエラーの文は、モデルに渡す前に手元で決めた文に置き換えます。
+
+</details>
+
+### 仕様
+
+<details>
+<summary>MCP ツール</summary>
+<br>
+
+| ツール | 役割 |
+| --- | --- |
+| `nyquist_setup` | 鍵を作り、ウォレットを登録します。何度呼んでも同じウォレットを返します |
+| `nyquist_wallet` | Safe のアドレス、残高、オーナー、所属する組織を返します |
+| `nyquist_send` | ETH を送るか、コントラクトを呼びます。最初の送金で Safe を作り、作成費用 0.002 ETH を払います |
+| `nyquist_transaction` | 送金の状態を `pending`、`success`、`failed`、`reverted`、`dropped` のどれかで返します。`dropped` は、実行される前に nyquist が取り消したことを表します |
+| `nyquist_claim_code` | 人間がエージェントを組織に引き取るためのコードを作ります |
+| `nyquist_add_recovery_owner` | 引き取った人間を Safe のオーナーに加えます。その人から直接教わったアドレスを渡します |
+
+</details>
+
+<details>
+<summary>環境変数</summary>
+<br>
+
+| 変数 | 既定値 | 役割 |
+| --- | --- | --- |
+| `NYQUIST_ENV` | `production` | `development` にすると、ローカルの API を使います |
+| `NYQUIST_API_URL` | 環境ごとの API | 接続する nyquist の API |
+| `NYQUIST_RPC_URL` | Sepolia の公開 RPC | 見積もりを確かめるのに使う RPC |
+| `NYQUIST_HOME` | `~/.nyquist` | 鍵を置くディレクトリ |
+| `NYQUIST_MAX_FEE_WEI` | 0.01 ETH | 1回の送金で払ってよいガス代の払い戻しの上限 |
 
-This package is a placeholder. Use `npm create nyquist` to set it up once it is released.
+</details>