ckb-session-kit 0.0.0-stage → 2.0.0

package/dist/transfer.d.ts

@@ -0,0 +1,19 @@
+import { ccc } from "@ckb-ccc/core";
+import { type Session } from "./session.js";
+export declare class ScopeError extends Error {
+    constructor(reason: string);
+}
+export declare function sessionSigner(session: Session, client: ccc.Client): ccc.SignerCkbPrivateKey;
+/** The address the session key controls. Fund it to give the session a budget. */
+export declare function sessionAddress(session: Session, client: ccc.Client): Promise<string>;
+/**
+ * Sends `amount` shannons to `to`, signed by the session key with no wallet
+ * dialog. The scope is checked before anything is built or signed.
+ *
+ * Until the session lock lands, the scope is enforced here in the browser only;
+ * the on-chain lock will make the same refusal binding.
+ */
+export declare function sendInScope(session: Session, client: ccc.Client, request: {
+    to: string;
+    amount: bigint;
+}, now?: Date): Promise<ccc.Hex>;

package/dist/transfer.js

@@ -0,0 +1,33 @@
+import { ccc } from "@ckb-ccc/core";
+import { checkRequest } from "./session.js";
+export class ScopeError extends Error {
+    constructor(reason) {
+        super(`refused by session scope: ${reason}`);
+        this.name = "ScopeError";
+    }
+}
+export function sessionSigner(session, client) {
+    return new ccc.SignerCkbPrivateKey(client, session.privateKey);
+}
+/** The address the session key controls. Fund it to give the session a budget. */
+export async function sessionAddress(session, client) {
+    return sessionSigner(session, client).getRecommendedAddress();
+}
+/**
+ * Sends `amount` shannons to `to`, signed by the session key with no wallet
+ * dialog. The scope is checked before anything is built or signed.
+ *
+ * Until the session lock lands, the scope is enforced here in the browser only;
+ * the on-chain lock will make the same refusal binding.
+ */
+export async function sendInScope(session, client, request, now = new Date()) {
+    const check = checkRequest(session, request, now);
+    if (!check.ok)
+        throw new ScopeError(check.reason);
+    const signer = sessionSigner(session, client);
+    const { script: lock } = await ccc.Address.fromString(request.to, client);
+    const tx = ccc.Transaction.from({ outputs: [{ lock, capacity: request.amount }] });
+    await tx.completeInputsByCapacity(signer);
+    await tx.completeFeeBy(signer);
+    return signer.sendTransaction(tx);
+}

package/package.json

@@ -1,6 +1,80 @@
-{
-  "name": "ckb-session-kit",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+{
+  "name": "ckb-session-kit",
+  "version": "2.0.0",
+  "description": "Browser-held self-custody sessions for CKB applications",
+  "keywords": [
+    "ckb",
+    "nervos",
+    "session-keys",
+    "lock-script",
+    "self-custody",
+    "ccc"
+  ],
+  "license": "MIT",
+  "author": "Luong Thanh Tung (https://github.com/luongthanhtung03)",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/luongthanhtung03/ckb-session-kit.git"
+  },
+  "homepage": "https://github.com/luongthanhtung03/ckb-session-kit#readme",
+  "bugs": "https://github.com/luongthanhtung03/ckb-session-kit/issues",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "CHANGELOG.md"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "build": "node -e \"require('fs').rmSync('dist',{recursive:true,force:true})\" && tsc -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit && tsc -p examples && tsc -p e2e && tsc -p scripts",
+    "check:lock-hash": "node scripts/check-lock-hash.mjs",
+    "evidence": "node scripts/evidence.mjs",
+    "test": "vitest run",
+    "e2e": "playwright test -c e2e",
+    "smoke:testnet": "tsx scripts/testnet-smoke.ts",
+    "demo": "npm run build && npm run dev -w demo",
+    "build:demo": "npm run build && npm run build -w demo",
+    "deploy:testnet": "tsx scripts/deploy-session-lock.ts",
+    "smoke:lock": "tsx scripts/testnet-lock-smoke.ts",
+    "smoke:flow": "tsx scripts/testnet-session-flow.ts",
+    "smoke:pay-per-read": "tsx scripts/testnet-pay-per-read.ts",
+    "setup:creator": "tsx scripts/setup-creator.ts",
+    "setup:board": "tsx scripts/setup-board.ts",
+    "setup:charger": "tsx scripts/setup-charger.ts",
+    "setup:token": "tsx scripts/setup-token.ts",
+    "setup:subscription-payout": "tsx scripts/setup-subscription-payout.ts",
+    "smoke:recover": "tsx scripts/testnet-recover.ts",
+    "smoke:place": "tsx scripts/testnet-place.ts",
+    "smoke:listen": "tsx --tsconfig examples/tsconfig.json scripts/testnet-listen.ts",
+    "smoke:token": "tsx scripts/testnet-token.ts",
+    "smoke:read-tokens": "tsx scripts/testnet-read-tokens.ts",
+    "smoke:subscription": "tsx scripts/testnet-subscription.ts",
+    "smoke:subscription-token": "tsx scripts/testnet-subscription-token.ts",
+    "smoke:contention": "tsx scripts/testnet-contention.ts",
+    "smoke:clear-planted": "tsx scripts/testnet-clear-planted.ts",
+    "smoke:owner-locks": "tsx scripts/testnet-owner-locks.ts",
+    "matrix:wallets": "tsx scripts/wallet-matrix.ts",
+    "prepack": "npm run build",
+    "pack:check": "node scripts/pack-check.mjs"
+  },
+  "devDependencies": {
+    "@noble/curves": "^2.4.0",
+    "@noble/hashes": "^2.4.0",
+    "@playwright/test": "^1.64.1",
+    "@types/node": "^22.20.5",
+    "ckb-testtool": "^1.0.5",
+    "tsx": "^4.23.15",
+    "typescript": "~5.8.2",
+    "vitest": "^4.1.12"
+  },
+  "dependencies": {
+    "@ckb-ccc/core": "^1.23.0"
+  },
+  "workspaces": [
+    "demo"
+  ]
+}