kredo 0.1.0 → 0.2.0

package/README.md

@@ -1,8 +1,12 @@
 # kredo
 
-Charge Kredo credits from your server. Your users buy credits once and spend them in every app on the network. You're paid in USDT on Whitechain for what they spend with you.
+Charge Kredo credits from your server. Your users buy credits once and spend them in every app on the network. You're paid in USDT on NEAR for what they spend with you.
 
-No dependencies. Node 18+.
+```bash
+npm install kredo
+```
+
+No dependencies. Node 18+. It talks to the live network on NEAR testnet by default: pass `baseUrl` and `pagesUrl` to point it elsewhere.
 
 ## Quick start
 
@@ -38,7 +42,7 @@ Every app also gets a test key, `uc_test_...`, from the dashboard. Use it in pla
 
 ```ts
 const credits = new Credits({ apiKey: process.env.CREDITS_TEST_KEY! });
-const { user } = await credits.exchangeCode(`cc_test_${someAddress}`);   // any address, no hosted page
+const { user } = await credits.exchangeCode(`cc_test_${someAccount}`);   // any account, no hosted page
 await credits.charge({ user, credits: 10 });
 ```
 
@@ -50,14 +54,14 @@ A user has to approve a spending limit for your app before you can charge them.
 
 1. Send them to the connect page: `await credits.connectUrl({ credits: 200, returnTo })`.
 2. They sign in with email, approve the limit, and come back to `returnTo?code=...`.
-3. On your server, swap the code for their address and keep it in your session:
+3. On your server, swap the code for their NEAR account and keep it in your session:
 
 ```ts
 const { user } = await credits.exchangeCode(req.query.code);
 req.session.creditsUser = user;
 ```
 
-Never take a user's address from the browser. The code works once, only for your app, for 10 minutes.
+Never take a user's NEAR account from the browser. The code works once, only for your app, for 10 minutes.
 
 The React kit ([`kredo-react`](../react)) does this in a popup, and `credits.session(user)` returns exactly what the kit renders.
 
@@ -66,14 +70,14 @@ The React kit ([`kredo-react`](../react)) does this in a popup, and `credits.ses
 | Call | What it does |
 |---|---|
 | `quote({ action, quantity })` | Price in credits and dollars, and what you keep after the network fee |
-| `user(address)` | Balance, whether they connected you, the limit left, and what's spendable now |
+| `user(account)` | Balance, whether they connected you, the limit left, and what's spendable now |
 | `charge({ user, action \| credits, ref })` | Charges now |
 | `hold({ user, action \| credits, ref, ttlSeconds })` | Reserves credits for a job, price locked |
 | `capture(holdId, { credits? })` | Charges all or part of a hold, returns the rest |
 | `release(holdId)` | Returns the whole hold |
 | `refund({ user, credits, ref })` | Gives credits back, up to what they spent with you |
 | `setExchangeRate(rate)`, `convert({ user, credits })` | Light mode: sell your own credits for ours |
-| `payout()` | Pays your unpaid earnings in USDT to your payout address |
+| `payout()` | Pays your unpaid earnings in USDT to your payout account |
 | `activity()`, `exportCsv()`, `gas()` | Reporting. Gas is paid by the network, never by you or your users |
 | `setWebhook(url)`, `webhookDeliveries()` | Signed event delivery |
 | `connectUrl()`, `buyUrl()`, `accountUrl()` | Links to the hosted pages |

package/dist/client.d.ts

@@ -1,10 +1,10 @@
-import type { ActivityItem, Amount, CreditsSession, AmountInput, AppInfo, Capture, Conversion, Credits as CreditAmount, GasReport, Hold, HoldStatus, Operation, Payout, PriceList, PriceListInput, Quote, UserState, WebhookDelivery } from "./types.js";
+import type { ActivityItem, Amount, CreditsSession, AmountInput, AppInfo, AppProfileInput, Capture, Conversion, Credits as CreditAmount, GasReport, Hold, HoldStatus, Operation, Payout, PriceList, PriceListInput, Quote, UserState, WebhookDelivery } from "./types.js";
 export type CreditsOptions = {
     /** Your app's API key, `uc_live_...`. */
     apiKey: string;
-    /** The network's API. Defaults to https://kredo-api.onrender.com. */
+    /** The network's API. Defaults to https://kredo-near-api.onrender.com. */
     baseUrl?: string;
-    /** The network's hosted pages (connect, buy, wallet). Defaults to https://kredo-omega.vercel.app. */
+    /** The network's hosted pages (connect, buy, wallet). Defaults to https://kredo-near.vercel.app. */
     pagesUrl?: string;
     /** Extra tries after a network failure or a rate limit. Writes are safe to retry: each carries a ref. Default 2. */
     retries?: number;
@@ -23,15 +23,20 @@ export declare class Credits {
     private readonly timeoutMs;
     private readonly fetchFn;
     constructor(opts: CreditsOptions);
-    /** Your app: payout address, fee, unpaid earnings, prices and webhook. */
+    /** Your app: payout account, fee, unpaid earnings, prices and webhook. */
     app(): Promise<AppInfo>;
     prices(): Promise<PriceList>;
     /** Replaces your price list, in credits: `{ "chat.message": { price: 2 }, "video.render": { rate: 8, unit: "second" } }`. */
     setPrices(prices: PriceListInput): Promise<PriceList>;
+    /** Sets how your app appears in the Kredo directory: name, description, logo, website and category. */
+    setProfile(profile: AppProfileInput): Promise<AppProfileInput & {
+        id: string;
+        name: string;
+    }>;
     /** What an action costs the user, and what you keep after the network fee. Show it before the job starts. */
     quote(input: AmountInput): Promise<Quote>;
     /** A user's balance, whether they've connected your app, and the most you can charge them now. */
-    user(address: string): Promise<UserState>;
+    user(account: string): Promise<UserState>;
     /**
      * Charges the user now. Pass your own `ref` (an order or message id) to make retries safe:
      * the same ref always returns the first result. Throws a CreditsError with `isDeclined` when
@@ -89,8 +94,8 @@ export declare class Credits {
     /** @deprecated Use accountUrl(). */
     walletUrl(): string;
     /**
-     * Swaps the one-time code from the connect page for the user's address and email. Call it from
-     * your server, then keep both in your own session. Never take an address from the browser.
+     * Swaps the one-time code from the connect page for the user's NEAR account and email. Call it from
+     * your server, then keep both in your own session. Never take an account from the browser.
      */
     exchangeCode(code: string): Promise<{
         user: string;
@@ -105,7 +110,7 @@ export declare class Credits {
     session(user: string | undefined, opts?: {
         email?: string | null;
     }): Promise<CreditsSession>;
-    /** Pays all your unpaid earnings in USDT to your payout address, on Whitechain. */
+    /** Pays all your unpaid earnings in USDT to your payout account, on NEAR. */
     payout(): Promise<Payout>;
     /** Every vault event for your app, newest first. */
     activity(opts?: {

package/dist/client.js

@@ -26,14 +26,14 @@ export class Credits {
         if (!opts.apiKey)
             throw new Error("Credits: apiKey is required");
         this.apiKey = opts.apiKey;
-        this.baseUrl = (opts.baseUrl ?? "https://kredo-api.onrender.com").replace(/\/+$/, "");
-        this.pagesUrl = (opts.pagesUrl ?? "https://kredo-omega.vercel.app").replace(/\/+$/, "");
+        this.baseUrl = (opts.baseUrl ?? "https://kredo-near-api.onrender.com").replace(/\/+$/, "");
+        this.pagesUrl = (opts.pagesUrl ?? "https://kredo-near.vercel.app").replace(/\/+$/, "");
         this.retries = opts.retries ?? 2;
         this.timeoutMs = opts.timeoutMs ?? 60_000;
         this.fetchFn = opts.fetch ?? globalThis.fetch;
     }
     // ---------------------------------------------------------------- your app
-    /** Your app: payout address, fee, unpaid earnings, prices and webhook. */
+    /** Your app: payout account, fee, unpaid earnings, prices and webhook. */
     async app() {
         const app = await this.request("GET", "/v1/app");
         this.appId = app.id;
@@ -46,14 +46,18 @@ export class Credits {
     setPrices(prices) {
         return this.request("PUT", "/v1/prices", { body: { prices } });
     }
+    /** Sets how your app appears in the Kredo directory: name, description, logo, website and category. */
+    setProfile(profile) {
+        return this.request("PATCH", "/v1/profile", { body: profile });
+    }
     // ---------------------------------------------------------------- prices and users
     /** What an action costs the user, and what you keep after the network fee. Show it before the job starts. */
     quote(input) {
         return this.request("GET", "/v1/quote", { query: amountQuery(input) });
     }
     /** A user's balance, whether they've connected your app, and the most you can charge them now. */
-    user(address) {
-        return this.request("GET", `/v1/users/${encodeURIComponent(address)}`);
+    user(account) {
+        return this.request("GET", `/v1/users/${encodeURIComponent(account)}`);
     }
     // ---------------------------------------------------------------- charging
     /**
@@ -114,8 +118,8 @@ export class Credits {
         return this.accountUrl();
     }
     /**
-     * Swaps the one-time code from the connect page for the user's address and email. Call it from
-     * your server, then keep both in your own session. Never take an address from the browser.
+     * Swaps the one-time code from the connect page for the user's NEAR account and email. Call it from
+     * your server, then keep both in your own session. Never take an account from the browser.
      */
     exchangeCode(code) {
         return this.request("POST", "/v1/connect/exchange", { body: { code } });
@@ -132,11 +136,11 @@ export class Credits {
         const u = await this.user(user);
         return {
             app,
-            user: { address: u.user, email: opts.email ?? null, balance: u.balance, connected: u.connected, limit: u.limit, spendable: u.spendable },
+            user: { account: u.user, email: opts.email ?? null, balance: u.balance, connected: u.connected, limit: u.limit, spendable: u.spendable },
         };
     }
     // ---------------------------------------------------------------- money out and reporting
-    /** Pays all your unpaid earnings in USDT to your payout address, on Whitechain. */
+    /** Pays all your unpaid earnings in USDT to your payout account, on NEAR. */
     payout() {
         return this.request("POST", "/v1/payout", { body: {} });
     }

package/dist/network.d.ts

@@ -1,12 +1,12 @@
 import type { Amount, DirectoryEntry, NetworkStats, Reserves } from "./types.js";
 export type Health = {
     ok: boolean;
-    chainId: number;
+    network: string;
     block: number;
     vault: string;
     usdt: string;
     relayer: {
-        address: string;
+        account: string;
         balance: string;
         symbol: string;
     };
@@ -14,7 +14,6 @@ export type Health = {
     indexer: {
         block: number;
         head: number;
-        lag: number;
         backed: boolean;
         events: number;
         pendingWebhooks: number;

package/dist/network.js

@@ -4,7 +4,7 @@ export class CreditsNetwork {
     baseUrl;
     fetchFn;
     constructor(opts = {}) {
-        this.baseUrl = (opts.baseUrl ?? "https://kredo-api.onrender.com").replace(/\/+$/, "");
+        this.baseUrl = (opts.baseUrl ?? "https://kredo-near-api.onrender.com").replace(/\/+$/, "");
         this.fetchFn = opts.fetch ?? globalThis.fetch;
     }
     health() {

package/dist/types.d.ts

@@ -80,6 +80,15 @@ export type PriceListInput = Record<string, {
     rate: Credits;
     unit: string;
 }>;
+export type AppCategory = "ai" | "media" | "audio" | "developer" | "games" | "productivity" | "other";
+/** How your app appears in the Kredo directory. Fields left out stay as they are. */
+export type AppProfileInput = {
+    name?: string;
+    description?: string;
+    logoUrl?: string;
+    website?: string;
+    category?: AppCategory;
+};
 export type AppInfo = {
     id: string;
     name: string;
@@ -102,11 +111,12 @@ export type Payout = Operation & {
     to: string;
     usdt: string;
 };
+/** Gas the network paid for your app's transactions: yoctoNEAR, and the same as NEAR in `gas`. */
 export type GasReport = {
     transactions: number;
-    wei: string;
+    yocto: string;
     gas: string;
-    symbol: string;
+    symbol: "NEAR";
     paidBy: "network";
 };
 /** One vault event, newest first in every feed. */
@@ -177,7 +187,7 @@ export type CreditsSession = {
         name: string;
     };
     user: {
-        address: string;
+        account: string;
         email: string | null;
         balance: Amount;
         connected: boolean;

package/package.json

@@ -1,15 +1,20 @@
 {
   "name": "kredo",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Server kit for charging Kredo credits from a company backend",
   "license": "MIT",
-  "homepage": "https://kredo-omega.vercel.app/docs/sdk",
+  "homepage": "https://kredo-near.vercel.app/docs/sdk",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/chandrabosep/near-hacks-kredo.git",
+    "directory": "packages/sdk"
+  },
   "keywords": [
     "kredo",
     "credits",
     "payments",
     "usdt",
-    "whitechain",
+    "near",
     "sdk"
   ],
   "type": "module",
@@ -35,9 +40,9 @@
   },
   "devDependencies": {
     "@types/node": "^20.19.43",
+    "near-api-js": "7.4.0",
     "tsx": "^4.23.15",
-    "typescript": "^5.9.3",
-    "viem": "^2.57.16"
+    "typescript": "^5.9.3"
   },
   "publishConfig": {
     "access": "public"