@tangle-network/tcloud 0.1.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 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 the 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 the 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 any 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
+
+   Copyright 2024 Tangle Network
+
+   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,354 @@
+# tcloud
+
+TypeScript SDK and CLI for [Tangle AI Cloud](https://tangleai.cloud) — decentralized LLM inference with operator routing, reputation-based selection, and anonymous payments via ShieldedCredits.
+
+Zero framework dependencies. Pure `fetch` + SSE. Works in Node.js, Deno, Bun, and edge runtimes.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [SDK](#sdk)
+  - [Quick Start](#quick-start)
+  - [Model Selection](#model-selection)
+  - [Streaming](#streaming)
+  - [Full Chat Completion](#full-chat-completion)
+  - [Private Inference](#private-inference)
+  - [Operator Routing](#operator-routing)
+  - [Models and Operators](#models-and-operators)
+  - [API Key Management](#api-key-management)
+  - [Cost Estimation](#cost-estimation)
+  - [Spending Limits](#spending-limits)
+- [CLI](#cli)
+  - [Authentication](#authentication)
+  - [Chat](#chat)
+  - [Browse](#browse)
+  - [Credits and Keys](#credits-and-keys)
+  - [Wallet Management](#wallet-management)
+- [Configuration](#configuration)
+- [OpenAI SDK Compatibility](#openai-sdk-compatibility)
+- [Vercel AI SDK Compatibility](#vercel-ai-sdk-compatibility)
+- [Examples](#examples)
+- [License](#license)
+
+## Installation
+
+```bash
+npm install tcloud
+```
+
+Or run the CLI directly:
+
+```bash
+npx tcloud chat "What is Tangle?"
+```
+
+## SDK
+
+### Quick Start
+
+```ts
+import { TCloud } from 'tcloud'
+
+// Set model at client creation — explicit and consistent.
+const client = new TCloud({
+  apiKey: 'sk-tan-...',
+  model: 'gpt-4o-mini',
+})
+
+const answer = await client.ask('What is Tangle Network?')
+console.log(answer)
+```
+
+### Model Selection
+
+Model is set at client creation. Override per-request when needed:
+
+```ts
+// Default model for all requests
+const client = new TCloud({ apiKey: '...', model: 'gpt-4o-mini' })
+await client.ask('Hello')  // uses gpt-4o-mini
+
+// Full control per-request (OpenAI-compatible)
+const completion = await client.chat({
+  model: 'claude-sonnet-4-6',
+  messages: [{ role: 'user', content: 'Hello' }],
+  temperature: 0.5,
+  maxTokens: 100,
+})
+
+// Get full response with usage stats
+const full = await client.askFull('Hello')
+console.log(full.model, full.usage?.total_tokens)
+
+// Search available models
+const llamas = await client.searchModels('llama')
+```
+
+### Streaming
+
+```ts
+for await (const chunk of client.askStream('Explain zero-knowledge proofs')) {
+  process.stdout.write(chunk)
+}
+
+// With model override
+for await (const chunk of client.askStream('Hello', 'claude-sonnet-4-6')) {
+  process.stdout.write(chunk)
+}
+```
+
+### Full Chat Completion
+
+OpenAI-compatible request/response format:
+
+```ts
+const completion = await client.chat({
+  model: 'meta-llama/llama-4-maverick',
+  messages: [
+    { role: 'system', content: 'You are a helpful assistant.' },
+    { role: 'user', content: 'Hello' },
+  ],
+  temperature: 0.7,
+  maxTokens: 1024,
+})
+
+console.log(completion.choices[0].message.content)
+```
+
+### Private Inference
+
+Anonymous inference with no API key. Uses EIP-712 SpendAuth signatures — the operator verifies payment without learning your identity.
+
+```ts
+import { TCloud } from 'tcloud'
+
+const client = TCloud.shielded()
+const answer = await client.ask('Hello from the shadows')
+```
+
+Under the hood: generates an ephemeral wallet, signs a SpendAuth payload, and sends it as an `X-Payment-Signature` header. The operator validates the cryptographic proof and serves inference without knowing who you are.
+
+### Operator Routing
+
+Route requests to specific operators or use strategy-based selection:
+
+```ts
+const client = new TCloud({
+  apiKey: 'sk-tan-...',
+  routing: {
+    prefer: 'operator-slug',    // specific operator
+    strategy: 'lowest-latency', // or 'lowest-price', 'highest-reputation'
+    region: 'us-east',          // geographic preference
+  },
+})
+```
+
+The gateway selects the best operator based on a composite score (reputation 40%, latency 30%, price 30%) and returns the selection in response headers:
+
+```ts
+// After a request, check which operator served it:
+// X-Tangle-Operator: <slug>
+// X-Tangle-Price-Input: <per-token>
+// X-Tangle-Price-Output: <per-token>
+```
+
+### Models and Operators
+
+```ts
+// List all available models
+const models = await client.models()
+models.forEach(m => console.log(m.id, m._provider))
+
+// Search models by name, provider, or capability
+const llamas = await client.searchModels('llama')
+const anthropic = await client.searchModels('anthropic')
+
+// List active operators with stats
+const { operators, stats } = await client.operators()
+console.log(`${stats.activeOperators} operators serving ${stats.totalModels} models`)
+
+// Check credit balance
+const credits = await client.credits()
+console.log(`Balance: $${credits.balance}`)
+```
+
+### API Key Management
+
+Create, list, and revoke API keys programmatically:
+
+```ts
+// Create a new key
+const { key, id } = await client.createKey('my-app')
+console.log(key) // sk-tan-... (shown once, store it)
+
+// List all keys
+const keys = await client.keys()
+keys.forEach(k => console.log(k.name, k.prefix, k.lastUsedAt))
+
+// Revoke a key
+await client.revokeKey(id)
+```
+
+### Cost Estimation
+
+Preview cost before sending a request:
+
+```ts
+const cost = await client.estimateCost({
+  model: 'gpt-4o',
+  inputTokens: 1000,
+  outputTokens: 500,
+})
+console.log(`Estimated: $${cost.total.toFixed(6)}`)
+// { inputCost: 0.005, outputCost: 0.0075, total: 0.0125 }
+```
+
+### Spending Limits
+
+Prevent runaway costs with per-request and total budget caps:
+
+```ts
+const client = new TCloud({
+  apiKey: 'sk-tan-...',
+  model: 'gpt-4o-mini',
+  limits: {
+    maxCostPerRequest: 0.01,     // $0.01 max per request
+    maxTotalSpend: 1.00,         // $1.00 lifetime budget
+    maxRequests: 100,            // hard request cap
+    onLimitWarning: (info) => {
+      console.warn(`${info.type} at ${info.current}/${info.limit}`)
+    },
+  },
+})
+
+// Requests that would exceed limits are blocked with TCloudError (429)
+await client.ask('Hello')
+
+// Check metering
+const { totalSpent, requestCount } = client.usage
+```
+
+## CLI
+
+### Authentication
+
+```bash
+tcloud auth login              # Browser-based device flow
+tcloud auth set-key sk-tan-... # Set key directly
+tcloud auth status             # Check current auth
+```
+
+### Chat
+
+```bash
+tcloud chat "Explain zero-knowledge proofs"
+tcloud chat -m meta-llama/llama-4-maverick "Hello"
+tcloud chat --private "Anonymous request"  # ShieldedCredits mode
+tcloud chat                                # Interactive mode
+```
+
+### Browse
+
+```bash
+tcloud models                  # List available models
+tcloud models -s llama         # Search models
+tcloud operators               # List active operators
+```
+
+### Credits and Keys
+
+```bash
+tcloud credits balance         # Check balance
+tcloud credits add 10          # Add credits
+tcloud keys create my-app      # Create a new API key
+tcloud keys list               # List keys
+```
+
+### Wallet Management
+
+For private inference, manage ephemeral wallets:
+
+```bash
+tcloud wallet generate                    # Create wallet
+tcloud wallet generate -l "research"      # With label
+tcloud wallet list                        # List wallets
+```
+
+Wallets use BIP-39 mnemonics with BIP-44 derivation. Private keys are encrypted at rest with AES-256-GCM (PBKDF2 210K iterations).
+
+## Configuration
+
+Config stored in `~/.tcloud/config.json`:
+
+```bash
+tcloud config --api-url https://api.tangleai.cloud
+tcloud config --model gpt-4o-mini
+```
+
+Environment variables:
+- `TCLOUD_API_KEY` — API key (primary)
+- `OPENAI_API_KEY` — Fallback API key (works because the API is OpenAI-compatible)
+- `TCLOUD_BASE_URL` — Override API base URL
+
+## OpenAI SDK Compatibility
+
+tcloud's API is OpenAI-compatible. You can use the OpenAI SDK directly:
+
+```ts
+import OpenAI from 'openai'
+
+const client = new OpenAI({
+  apiKey: 'sk-tan-...',
+  baseURL: 'https://api.tangleai.cloud/v1',
+})
+
+const completion = await client.chat.completions.create({
+  model: 'meta-llama/llama-4-maverick',
+  messages: [{ role: 'user', content: 'Hello' }],
+})
+```
+
+## Vercel AI SDK Compatibility
+
+Use with the Vercel AI SDK's OpenAI provider:
+
+```ts
+import { createOpenAI } from '@ai-sdk/openai'
+import { generateText } from 'ai'
+
+const tangle = createOpenAI({
+  apiKey: 'sk-tan-...',
+  baseURL: 'https://api.tangleai.cloud/v1',
+})
+
+const { text } = await generateText({
+  model: tangle('meta-llama/llama-4-maverick'),
+  prompt: 'What is decentralized AI?',
+})
+```
+
+## Examples
+
+See the [`examples/`](./examples/) directory — each is a self-contained script:
+
+| # | Example | What it shows |
+|---|---------|---------------|
+| 01 | [Quick Start](./examples/01-quick-start.ts) | Minimum viable setup |
+| 02 | [Model Selection](./examples/02-model-selection.ts) | Three ways to pick a model, search, browse |
+| 03 | [Streaming](./examples/03-streaming.ts) | Real-time SSE output, text + chunk modes |
+| 04 | [Private Inference](./examples/04-private-inference.ts) | ShieldedCredits, ephemeral wallets, auto-replenish |
+| 05 | [Operator Routing](./examples/05-operator-routing.ts) | Prefer operator, strategy, region, list operators |
+| 06 | [Cost & Usage](./examples/06-cost-and-usage.ts) | Estimate cost, track tokens, check balance |
+| 07 | [API Keys](./examples/07-api-keys.ts) | Create, list, revoke keys programmatically |
+| 08 | [OpenAI SDK](./examples/08-openai-compat.ts) | Drop-in replacement via baseURL |
+| 09 | [Vercel AI SDK](./examples/09-vercel-ai-sdk.ts) | generateText + streamText with Tangle |
+| 10 | [Spending Limits](./examples/10-spending-limits.ts) | Budget caps, request limits, warning callbacks |
+
+Run any example:
+```bash
+TCLOUD_API_KEY=sk-tan-... npx tsx examples/01-quick-start.ts
+```
+
+## License
+
+[Apache-2.0](./LICENSE)