@inodra/sui 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/README.md

@@ -0,0 +1,237 @@
+# @inodra/sui
+
+TypeScript/JavaScript SDK for the [Inodra](https://inodra.com) Sui platform:
+gRPC (native + gRPC-Web), GraphQL, Warp real-time streams, webhooks, the
+indexer data API, and **generated, validated types for 120+ protocol events**.
+
+Works in Node.js (>=18), Bun, edge runtimes, and browsers. Ships ESM + CommonJS
+with full type declarations — usable from TypeScript and plain JavaScript.
+
+## Install
+
+```bash
+npm install @inodra/sui
+# for the gRPC / GraphQL clients (wrapped from the official Sui SDK):
+npm install @mysten/sui @protobuf-ts/grpcweb-transport
+# only for native gRPC on Node.js (@inodra/sui/node, @inodra/sui/grpc):
+npm install @protobuf-ts/grpc-transport @grpc/grpc-js
+```
+
+Heavy dependencies are optional peers — the lean subpaths (`/warp`, `/manage`,
+`/webhooks`, `/events`) work without any of them.
+
+## Quickstart
+
+```ts
+import { Inodra } from "@inodra/sui";
+// On Node.js backends, prefer native HTTP/2 gRPC:
+// import { Inodra } from "@inodra/sui/node";
+
+const inodra = new Inodra({
+	network: "mainnet",
+	auth: { apiKey: process.env.INODRA_API_KEY! },
+});
+
+// Sui node access — the full @mysten/sui client API over Inodra's gateway
+const balance = await inodra.grpc.core.getBalance({ owner, coinType });
+const chain = await inodra.graphql.query({ query: "query { chainIdentifier }" });
+
+// Real-time: catalog event → typed live stream in one call
+const swaps = await inodra.warp.streamCatalogEvent("cetus.swap", { ephemeral: true });
+for await (const { payload, envelope } of swaps) {
+	console.log(envelope.txDigest, payload.amount_in, payload.amount_out);
+}
+
+// Indexer data API
+const account = await inodra.data.accounts.balance("0x...");
+for await (const tx of inodra.data.accounts.iterateTransactions("0x...")) {
+	// lazily walks every page
+}
+```
+
+### Namespaces
+
+| Namespace | What it covers |
+|---|---|
+| `inodra.grpc` | `SuiGrpcClient` from `@mysten/sui`, authenticated against Inodra (gRPC-Web transport everywhere; native HTTP/2 via `@inodra/sui/node`) |
+| `inodra.graphql` | `SuiGraphQLClient` from `@mysten/sui` over Inodra's GraphQL gateway |
+| `inodra.warp` | Warp subscriptions (CRUD) + live SSE/WebSocket delivery + `streamCatalogEvent` |
+| `inodra.webhooks` | Webhook subscriptions (CRUD) + `verifySignature` / `constructEvent` |
+| `inodra.data` | Indexer REST: accounts, coins, objects, packages, chain, validators, SuiNS |
+| `inodra.catalog` | Curated protocol event catalog (live: protocols, events, filters) |
+| `inodra.account` | `me()` (key/org/project/tier introspection) + `usage()` (CU, latency) |
+
+Namespaces are lazy — nothing is constructed until first touched. Credentials
+are pluggable: `auth` accepts an API key string, `{ apiKey }`,
+`{ sessionToken }`, or a custom `{ getCredentials }` provider, so future
+credential types (wallet sessions) won't change any constructor.
+
+Rate-limit and credit headers from every REST response are surfaced on
+`inodra.lastResponseMeta` and via the `onResponseMeta` callback.
+
+## Typed catalog events
+
+Every event in Inodra's curated protocol catalog (Cetus, DeepBook, Suilend,
+Walrus, … 120+ events across 27 protocols) ships with a **generated zod schema
+and TypeScript type**, validated against live chain data before each release:
+
+```ts
+import { parseCatalogEvent, matchCatalogEvent, catalogEvents } from "@inodra/sui/events";
+
+stream.on("message", (msg) => {
+	const swap = parseCatalogEvent(msg, "cetus.swap");
+	if (swap) {
+		swap.amount_in;  // string — u64s are normalized to decimal strings
+		swap.atob;       // boolean
+	}
+});
+```
+
+- `matchCatalogEvent(msg, id)` — typed as received on the wire, no validation.
+- `parseCatalogEvent(msg, id)` — validates and normalizes (u64 → string,
+  `TypeName` → string, `Option<T>` → `T | null`). Returns `undefined` for other
+  events; throws if a *matching* event fails its schema (drift worth surfacing).
+- Both accept a Warp stream message, a bare event payload, or a webhook body.
+- Schemas are **loose**: unknown fields added by protocol upgrades pass through
+  instead of breaking your pipeline.
+
+Schemas are generated from the live catalog (`bun run generate:events`) and
+verified against recent on-chain events (`bun run verify:events`).
+
+### Your own events — reflection + codegen
+
+Uncataloged event types (your protocol, anyone's) get the same treatment,
+two ways:
+
+**Runtime reflection** — the SDK fetches the Move struct layout on-chain
+(through Inodra's gateway with your key), substitutes concrete generics,
+recurses into nested structs, and builds the same normalizing schema. Cached
+per type:
+
+```ts
+const schema = await inodra.events.schemaFor("0xpkg::vault::Deposit<0x2::sui::SUI>");
+
+stream.on("message", async (msg) => {
+	const payload = await inodra.events.parseEvent(msg, "0xpkg::vault::Deposit");
+	if (payload) console.log(payload.amount); // validated + normalized
+});
+```
+
+Generic type params are typed **concretely** from each instantiation — pass a
+base type (no `<…>`) to `parseEvent` and every instantiation matches with its
+own reflected schema.
+
+**Build-time codegen** — static TypeScript types for your events, generated
+into your project (the graphql-codegen pattern):
+
+```bash
+INODRA_API_KEY=... npx inodra-sui codegen-events \
+  "0xpkg::vault::Deposit<0x2::sui::SUI>" -o src/vault-events.gen.ts
+```
+
+Without a key it falls back to the public Sui GraphQL endpoint. The emitted
+file imports only `zod` and `@inodra/sui/events`.
+
+## Warp streams
+
+```ts
+// Managed subscription + connection in separate steps:
+const sub = await inodra.warp.createEventStream({ eventType: "0xpkg::mod::Event" });
+const stream = inodra.warp.connect(sub.data.id);          // SSE (at-least-once)
+const ws = inodra.warp.connectWebSocket(sub.data.id);     // WS (exactly-once, acks)
+
+stream.on("message", (event) => console.log(event.type, event.data));
+
+// Or consume any stream as an async iterable:
+for await (const event of stream) {
+	// ends when you close(); throws on abnormal close (quota, reconnect budget)
+	// breaking the loop closes the stream (connection time bills)
+}
+```
+
+Lower-level `WarpSseStream` / `WarpWebSocketStream` remain available from
+`@inodra/sui/warp` (zero dependencies).
+
+Both transports reconnect with exponential backoff and resume from the last
+seen event ID. Policy closes (quota exceeded, already connected) are terminal.
+The first connect is **live** by default: backlog buffered while disconnected
+(up to 30 min / 2,000 events) is dropped. Pass `mode: "resume"` (or
+`lastEventId`) to replay it. SDK reconnects always pass the last delivered
+event ID, so transient drops never lose events in either mode.
+
+WebSocket acks are automatic after your handlers finish without throwing;
+throwing skips the ack so the event redelivers. Pass `autoAck: false` and call
+`stream.ack(id)` to control the exactly-once window yourself.
+
+## Webhooks
+
+```ts
+const hook = await inodra.webhooks.createEvent({
+	eventType: "0xpkg::module::Event",
+	webhookUrl: "https://your-app.com/hooks/inodra",
+});
+
+// In your receiver — verify + parse in one step:
+const body = await inodra.webhooks.constructEvent({
+	payload: rawRequestBody, // exact raw body string, before JSON.parse
+	signature: request.headers["x-inodra-signature"],
+	secret: hook.data.webhookSecret,
+});
+// body.payload.{txDigest, checkpoint, type, sender, data}
+
+// Narrow to a typed catalog event:
+import { parseCatalogEvent } from "@inodra/sui/events";
+const swap = parseCatalogEvent(body, "cetus.swap");
+```
+
+Signatures are `t=<unix>,v1=<hmac-sha256-hex>` over `<timestamp>.<body>`,
+verified with a constant-time comparison and a 5-minute tolerance window.
+Standalone `verifyWebhookSignature` lives in `@inodra/sui/webhooks` (zero
+dependencies).
+
+## Entry points
+
+| Import | What you get |
+|---|---|
+| `@inodra/sui` | `Inodra` client (all namespaces) + core types/errors |
+| `@inodra/sui/node` | Same `Inodra`, with native HTTP/2 gRPC (Node.js) |
+| `@inodra/sui/events` | Generated event schemas + `parseCatalogEvent` helpers |
+| `@inodra/sui/grpc` | `createInodraGrpcClient` (native gRPC factory) |
+| `@inodra/sui/grpc-web` | `createInodraGrpcWebClient` (browser gRPC factory) |
+| `@inodra/sui/graphql` | `createInodraGraphQLClient` |
+| `@inodra/sui/warp` | `WarpSseStream`, `WarpWebSocketStream`, `iterateStream` |
+| `@inodra/sui/manage` | `InodraManagementClient` (CRUD only, zero deps) |
+| `@inodra/sui/webhooks` | `verifyWebhookSignature` (zero deps) |
+
+The root entry statically references `@mysten/sui`; frontend apps that only
+need Warp/webhooks and want a Mysten-free bundle should use the lean subpaths.
+
+Every client authenticates with `x-api-key` (or `Authorization: Bearer`) and
+identifies itself with an `x-inodra-sdk` header. `network:
+"mainnet" | "testnet"` defaults to mainnet; every endpoint is overridable via
+`endpoints` for local development.
+
+Retry policy: reads and idempotent writes retry on 429/5xx with backoff
+honoring `Retry-After`; non-idempotent POSTs retry only on 429 (never applied
+server-side) unless you pass `idempotent: true`.
+
+## For LLMs / coding agents
+
+`llms.txt` at the repo root (also shipped in the npm package) is a dense,
+verified reference of the entire SDK surface — auth, every namespace, all 121
+catalog event ids, webhook receiver contract, and delivery semantics. Point
+your agent at it instead of having it crawl the source.
+
+## Development
+
+```bash
+bun install              # from sdks/ (workspace root)
+bun run check-types
+bun run test:run
+bun run build            # ESM + CJS + d.ts for all entry points
+bun run generate         # refresh generated OpenAPI types + event schemas
+bun run verify:events    # validate generated schemas vs live chain data
+INODRA_API_KEY=... node examples/smoke.mjs   # live smoke test of every surface
+```
+
+See `../sdk-test-proj` for a runnable consumer app (TypeScript + CommonJS).

package/bin/inodra-sui.mjs

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import "../dist/cli.js";