@toon-protocol/sdk 0.1.5 → 0.3.0

package/README.md

@@ -1,6 +1,6 @@
 # @toon-protocol/sdk
 
-The building blocks for creating services that participate in the TOON network.
+The building blocks for creating services that participate in the TOON Protocol network. Events are encoded in [TOON format](https://github.com/toon-format/toon) and discovered via [Nostr](https://github.com/nostr-protocol/nips).
 
 ## What It Does
 
@@ -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 manages the connector externally so you don't need to embed one. 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/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.
 
 ## Where It Sits
 
@@ -95,11 +95,13 @@ The SDK is the framework layer. You bring handlers; it handles the protocol.
 
 | Concept | Description |
 |---------|-------------|
-| **Unified identity** | One secp256k1 key produces both a Nostr pubkey and an EVM address |
+| **Unified identity** | One secp256k1 key produces both a [Nostr](https://github.com/nostr-protocol/nips) pubkey and an EVM address |
 | **Handler pattern** | `ctx.accept()` / `ctx.reject()` — handlers respond, not return |
 | **Self-write bypass** | Events from your own pubkey skip pricing |
 | **Dev mode** | Skip verification and pricing for testing |
-| **TOON encoding** | Events encoded in compact text format, not JSON |
+| **[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) |
+| **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
 

package/dist/chunk-UP2VWCW5.js

@@ -0,0 +1,38 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined") return require.apply(this, arguments);
+  throw Error('Dynamic require of "' + x + '" is not supported');
+});
+var __esm = (fn, res) => function __init() {
+  return fn && (res = (0, fn[__getOwnPropNames(fn)[0]])(fn = 0)), res;
+};
+var __commonJS = (cb, mod) => function __require2() {
+  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+export {
+  __require,
+  __esm,
+  __commonJS,
+  __export,
+  __toCommonJS
+};
+//# sourceMappingURL=chunk-UP2VWCW5.js.map

package/dist/chunk-UP2VWCW5.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}