@toon-protocol/sdk 2.2.0 → 3.0.0

package/README.md

@@ -60,7 +60,7 @@ const result = await node.start();
 console.log(`Connected to ${result.peerCount} peers`);
 ```
 
-> **Easier path:** If you just want to run a relay, use [`@toon-protocol/town`](../town) — it wraps the SDK with sensible defaults and runs out of the box. The SDK is for building custom services where you control the full pipeline.
+> **Easier path:** If you just want to run a relay, use [`@toon-protocol/relay`](https://github.com/toon-protocol/relay) — it wraps the SDK with sensible defaults and runs out of the box. The SDK is for building custom services where you control the full pipeline.
 
 ## Where It Sits
 
@@ -100,17 +100,17 @@ The SDK is the framework layer. You bring handlers; it handles the protocol.
 | **Self-write bypass**                                    | Events from your own pubkey skip pricing                                                                                                                                                                                                                                       |
 | **Dev mode**                                             | Skip verification and pricing for testing                                                                                                                                                                                                                                      |
 | **[TOON](https://github.com/toon-format/toon) encoding** | Events encoded in compact text format, not JSON                                                                                                                                                                                                                                |
-| **Address assignment**                                   | ILP addresses are derived from peering topology — your upstream peer assigns your address automatically based on your pubkey. A node with multiple upstream peers has multiple addresses. See [Protocol — ILP Address Hierarchy](../../docs/protocol.md#ilp-address-hierarchy) |
+| **Address assignment**                                   | ILP addresses are derived from peering topology — your upstream peer assigns your address automatically based on your pubkey. A node with multiple upstream peers has multiple addresses. See [Protocol — ILP Address Hierarchy](https://github.com/toon-protocol/toon-meta/blob/main/docs/protocol.md#ilp-address-hierarchy) |
 | **Invisible fee calculation**                            | The SDK computes multi-hop fees internally. Each intermediary advertises a fee-per-byte; the SDK sums them along the route so `publishEvent()` callers pay one total amount                                                                                                    |
 
 ## Full Documentation
 
-See the [SDK Guide](../../docs/sdk-guide.md) for the complete API reference, handler patterns, verification pipeline details, publishing events, and error handling.
+See the [SDK Guide](https://github.com/toon-protocol/toon-meta/blob/main/docs/sdk-guide.md) for the complete API reference, handler patterns, verification pipeline details, publishing events, and error handling.
 
 ## Requirements
 
-- Node.js >= 20
-- `@toon-protocol/connector` >= 1.6.0 (peer dependency, optional)
+- Node.js >= 22
+- `@toon-protocol/connector` >= 3.3.3 (peer dependency, optional)
 
 ## License
 

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { ToonError, HandlePacketAcceptResponse, HandlePacketRejectResponse, ReputationScore, SkillDescriptor, EmbeddableConnectorLike, KnownPeer, SettlementConfig, ChainProviderConfigEntry, ConnectorChannelClient, BootstrapEventListener, BootstrapResult, DvmJobStatus, IlpSendResult, ParsedWorkflowDefinition, SwapPair } from '@toon-protocol/core';
-export { BootstrapEvent, BootstrapEventListener, HandlePacketAcceptResponse, HandlePacketRejectResponse, SkillDescriptor, balanceProofFieldsMina, balanceProofHashEvm, balanceProofHashSolana, bigintToBytes32BE, concatBytes, hexToBytes, minaHashToField } from '@toon-protocol/core';
+export { BootstrapEvent, BootstrapEventListener, HandlePacketAcceptResponse, HandlePacketRejectResponse, SkillDescriptor, balanceProofFieldsMina, balanceProofHashEvm, balanceProofHashSolana, bigintToBytes32BE, concatBytes, coopCloseHashEvm, eip712DomainSeparatorEvm, hexToBytes, minaHashToField } from '@toon-protocol/core';
 import { NostrEvent, UnsignedEvent } from 'nostr-tools/pure';
 import { ToonRoutingMeta } from '@toon-protocol/core/toon';
 import { TransportConfig } from '@toon-protocol/connector';
@@ -1788,7 +1788,10 @@ interface SwapSignerConfig {
      */
     address: string;
     /**
-     * On-chain payment-channel contract address (EVM-only).
+     * On-chain payment-channel contract address (EVM-only). Required for EVM
+     * claims: it is the RLP `to` field AND the EIP-712 `verifyingContract` of the
+     * v2 balance-proof digest (connector#324 finding #1), so it now binds the
+     * signature to this exact deployment.
      */
     contractAddress?: string;
     /**
@@ -1796,7 +1799,9 @@ interface SwapSignerConfig {
      */
     programId?: string;
     /**
-     * EVM chain-id (decimal). Required for EVM claims — baked into RLP per EIP-155.
+     * EVM chain-id (decimal). Required for EVM claims — baked into RLP per EIP-155
+     * AND into the EIP-712 domain `chainId` of the v2 balance-proof digest
+     * (connector#324 finding #1), so the signature is valid on this chain only.
      */
     chainId?: number;
 }

package/dist/index.js

@@ -2374,6 +2374,8 @@ import {
   bigintToBytes32BE,
   concatBytes,
   balanceProofHashEvm,
+  coopCloseHashEvm,
+  eip712DomainSeparatorEvm,
   balanceProofHashSolana,
   minaHashToField,
   balanceProofFieldsMina
@@ -2388,7 +2390,19 @@ var EVM_SETTLEMENT_FUNCTION_SELECTOR = keccak_256(
 var EVM_SETTLEMENT_EVENT_TOPIC = "0x" + bytesToHex(
   keccak_256(new TextEncoder().encode(EVM_SETTLEMENT_EVENT_SIGNATURE))
 );
-function recoverEvmSignerAddress(claim) {
+function recoverEvmSignerAddress(claim, chainId, verifyingContract) {
+  if (typeof chainId !== "number" || !Number.isInteger(chainId) || chainId <= 0) {
+    throw new SettlementTxError(
+      "INVALID_INPUT",
+      `EVM v2 digest requires a positive integer chainId, got ${chainId}`
+    );
+  }
+  if (!verifyingContract) {
+    throw new SettlementTxError(
+      "INVALID_INPUT",
+      "EVM v2 digest requires verifyingContract (RollingSwapChannel address)"
+    );
+  }
   if (claim.channelId === void 0 || claim.cumulativeAmount === void 0 || claim.nonce === void 0 || claim.recipient === void 0) {
     throw new SettlementTxError(
       "MISSING_SETTLEMENT_METADATA",
@@ -2415,6 +2429,7 @@ function recoverEvmSignerAddress(claim) {
   try {
     const channelIdBytes = hexToBytes2(claim.channelId);
     const recipientBytes = hexToBytes2(claim.recipient);
+    const verifyingContractBytes = hexToBytes2(verifyingContract);
     if (channelIdBytes.length !== 32) {
       throw new Error(
         `channelId must be 32 bytes (got ${channelIdBytes.length})`
@@ -2425,11 +2440,18 @@ function recoverEvmSignerAddress(claim) {
         `recipient must be 20 bytes (got ${recipientBytes.length})`
       );
     }
+    if (verifyingContractBytes.length !== 20) {
+      throw new Error(
+        `verifyingContract must be 20 bytes (got ${verifyingContractBytes.length})`
+      );
+    }
     msgHash = balanceProofHashEvm(
       channelIdBytes,
       BigInt(claim.cumulativeAmount),
       BigInt(claim.nonce),
-      recipientBytes
+      recipientBytes,
+      BigInt(chainId),
+      verifyingContractBytes
     );
     const sig = secp256k1.Signature.fromBytes(
       compactRS,
@@ -2731,8 +2753,8 @@ function rlpDecodeList(buf) {
   }
   return items;
 }
-function verifyEvmClaimSignature(claim, expectedAddress) {
-  const recovered = recoverEvmSignerAddress(claim);
+function verifyEvmClaimSignature(claim, expectedAddress, chainId, verifyingContract) {
+  const recovered = recoverEvmSignerAddress(claim, chainId, verifyingContract);
   const expected = expectedAddress.toLowerCase();
   return {
     valid: recovered.toLowerCase() === expected,
@@ -3098,7 +3120,9 @@ function buildSettlementTx(params) {
       try {
         const { valid, recovered } = verifyEvmClaimSignature(
           claim,
-          signer.address
+          signer.address,
+          signer.chainId,
+          signer.contractAddress
         );
         if (!valid) {
           rejected.push({
@@ -3348,10 +3372,18 @@ function buildSettlementTx(params) {
 function verifyAccumulatedClaim(claim, signer, minaSignerClient) {
   const kind = chainKindOf(claim.pair.to.chain);
   if (kind === "evm") {
+    if (typeof signer.chainId !== "number" || !Number.isInteger(signer.chainId) || signer.chainId <= 0 || !signer.contractAddress) {
+      return {
+        valid: false,
+        reason: "INVALID_INPUT: EVM signer requires chainId (positive integer) + contractAddress for the v2 EIP-712 digest (connector#324 finding #1)"
+      };
+    }
     try {
       const { valid, recovered } = verifyEvmClaimSignature(
         claim,
-        signer.address
+        signer.address,
+        signer.chainId,
+        signer.contractAddress
       );
       if (valid) return { valid: true };
       return {
@@ -3441,6 +3473,7 @@ export {
   buildSettlementTx,
   buildSkillDescriptor,
   concatBytes,
+  coopCloseHashEvm,
   createArweaveDvmHandler,
   createEventStorageHandler,
   createHandlerContext,
@@ -3451,6 +3484,7 @@ export {
   createSwapHandler,
   createVerificationPipeline,
   decryptFulfillClaim,
+  eip712DomainSeparatorEvm,
   encodeReceiptSigningPayload,
   encryptFulfillClaim,
   fillEvmSettlementTxGas,