@cloakely/sdk 0.8.3 → 0.8.5

package/dist/names.js

@@ -0,0 +1,59 @@
+import { isAddress, parseAbi, zeroAddress } from "viem";
+/**
+ * .ely names (Elysium Name Service): type `bona.ely` instead of a long address. Two read-only calls on one contract,
+ * no API key and no backend. Mainnet's address is published at launch; until then only testnet resolves.
+ */
+export const ELY_NAMES = {
+    99801: "0x13A130B336400409c956dF042C128238F1486ddD", // Elysium testnet
+};
+export const elyNamesAbi = parseAbi([
+    "function resolve(string label) view returns (address)",
+    "function primaryNameOf(address owner) view returns (string)",
+    "function text(string label, string key) view returns (string)",
+]);
+/**
+ * The label of a .ely name, or null if the input isn't one: trimmed, lowercased, a trailing `.ely` removed, then
+ * 2 to 63 of a-z, 0-9 and hyphens, not starting or ending with a hyphen.
+ */
+export function elyLabel(input) {
+    const s = input.trim().toLowerCase().replace(/\.ely$/, "");
+    return /^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])$/.test(s) ? s : null;
+}
+/** True when the input looks like a .ely name (it ends in `.ely` and its label is valid). */
+export const isElyName = (input) => /\.ely$/i.test(input.trim()) && elyLabel(input) !== null;
+/**
+ * The wallet a .ely name points to now, or null if the name isn't registered, has expired, or the chain has no name
+ * service. Resolve at the moment of sending and don't store the result: names expire and change hands.
+ */
+export async function resolveEly(publicClient, name) {
+    const label = elyLabel(name);
+    const at = ELY_NAMES[publicClient.chain?.id ?? (await publicClient.getChainId())];
+    if (!label || !at)
+        return null;
+    const a = await publicClient.readContract({ address: at, abi: elyNamesAbi, functionName: "resolve", args: [label] });
+    return a && a !== zeroAddress ? a : null;
+}
+/** A wallet's chosen .ely name (like `bona.ely`), or null if it has none. Safe to display: only the owner can set it. */
+export async function elyNameOf(publicClient, address) {
+    const at = ELY_NAMES[publicClient.chain?.id ?? (await publicClient.getChainId())];
+    if (!at)
+        return null;
+    const n = await publicClient.readContract({ address: at, abi: elyNamesAbi, functionName: "primaryNameOf", args: [address] });
+    return n ? (n.endsWith(".ely") ? n : `${n}.ely`) : null;
+}
+/**
+ * A recipient typed by a person: a 0x address as it is, or a .ely name resolved now. Throws a readable error for
+ * anything else, and for a name that doesn't resolve (never send to the zero address).
+ */
+export async function resolveRecipient(publicClient, input) {
+    const s = input.trim();
+    if (isAddress(s))
+        return { address: s };
+    if (isElyName(s)) {
+        const address = await resolveEly(publicClient, s);
+        if (!address)
+            throw new Error(`${elyLabel(s)}.ely isn't registered, or it has expired.`);
+        return { address, name: `${elyLabel(s)}.ely` };
+    }
+    throw new Error("Enter a 0x address or a .ely name.");
+}

package/dist/private/prover.d.ts

@@ -16,18 +16,25 @@ export declare function createProver(wasm: Uint8Array, zkey: Uint8Array): Prover
 /** Groth16 prover for the shared launch-token vault (`transactionMA2x2`, 8 public signals). */
 export declare function createSharedProver(wasm: Uint8Array, zkey: Uint8Array): Prover;
 /** Hosted circuit artifacts. */
+/**
+ * Where the circuit files are served: a free CDN (jsDelivr, pinned to the commit that last changed them, so the files
+ * never change), then Cloak's own site if the CDN can't be reached. Every download is checked against the pinned
+ * hashes, so where it came from doesn't matter for safety.
+ */
+export declare const CIRCUITS_CDN = "https://cdn.jsdelivr.net/gh/NECOKIZZ/Cloak@f55a12a40d475561ce2b4db933ab82855419eb2d/apps/web/public/circuits";
 export declare const CIRCUITS_URL = "https://cloak.boblabs.tech/circuits";
+export declare const CIRCUITS_SOURCES: string[];
 /** SHA-256 of the artifacts this SDK version was built and tested against. */
 export declare const CIRCUIT_HASHES: {
     readonly wasm: "e44f07497b34f3498352da5bfd9fd7a100c2e8cb7ebddc643f1e6e29d4dfcf6a";
     readonly zkey: "5d64f2162ef439ae53f0e3c61f276245f7fa1b934907ef66ce3cf149056acad0";
 };
 /**
- * Fetch the circuit artifacts (12 MB, once) and build a prover. Works in browsers and Node 18+. The files are checked
+ * Fetch the circuit artifacts (15 MB, once; from the CDN, else Cloak's site, or the URL or URLs you pass) and build a prover. Works in browsers and Node 18+. The files are checked
  * against `CIRCUIT_HASHES`, so a tampered or mismatched download is refused; pass `hashes: null` to skip that when
  * serving your own build. In Node you can also read the files yourself and call `createProver`.
  */
-export declare function loadProver(baseUrl?: string, opts?: {
+export declare function loadProver(baseUrl?: string | string[], opts?: {
     hashes?: {
         wasm: string;
         zkey: string;
@@ -42,7 +49,7 @@ export declare const SHARED_CIRCUIT_HASHES: {
  * Fetch the shared launch-token vault's circuit (`transactionMA2x2`, 15 MB, once) and build its prover. Checked against
  * `SHARED_CIRCUIT_HASHES` like `loadProver`; pass `hashes: null` to skip that when serving your own build.
  */
-export declare function loadSharedProver(baseUrl?: string, opts?: {
+export declare function loadSharedProver(baseUrl?: string | string[], opts?: {
     hashes?: {
         wasm: string;
         zkey: string;

package/dist/private/prover.js

@@ -43,7 +43,40 @@ export function createSharedProver(wasm, zkey) {
     };
 }
 /** Hosted circuit artifacts. */
+/**
+ * Where the circuit files are served: a free CDN (jsDelivr, pinned to the commit that last changed them, so the files
+ * never change), then Cloak's own site if the CDN can't be reached. Every download is checked against the pinned
+ * hashes, so where it came from doesn't matter for safety.
+ */
+export const CIRCUITS_CDN = "https://cdn.jsdelivr.net/gh/NECOKIZZ/Cloak@f55a12a40d475561ce2b4db933ab82855419eb2d/apps/web/public/circuits";
 export const CIRCUITS_URL = "https://cloak.boblabs.tech/circuits";
+export const CIRCUITS_SOURCES = [CIRCUITS_CDN, CIRCUITS_URL];
+/** Download a circuit's two files from the first source that serves them with the expected hashes. */
+async function fetchCircuit(baseUrl, names, want, what) {
+    const bases = (Array.isArray(baseUrl) ? baseUrl : [baseUrl]).map((b) => b.replace(/\/$/, ""));
+    let last;
+    for (const base of bases) {
+        try {
+            const get = async (name) => {
+                const res = await fetch(`${base}/${name}`);
+                if (!res.ok)
+                    throw new Error(`could not download ${name} from ${base} (${res.status})`);
+                return new Uint8Array(await res.arrayBuffer());
+            };
+            const [wasm, zkey] = await Promise.all(names.map(get));
+            if (want) {
+                const [hw, hz] = await Promise.all([sha256(wasm), sha256(zkey)]);
+                if (hw !== want.wasm || hz !== want.zkey)
+                    throw new Error(`${what} files from ${base} don't match this SDK version's hashes; refusing to prove with them`);
+            }
+            return [wasm, zkey];
+        }
+        catch (e) {
+            last = e;
+        }
+    }
+    throw last;
+}
 /** SHA-256 of the artifacts this SDK version was built and tested against. */
 export const CIRCUIT_HASHES = {
     wasm: "e44f07497b34f3498352da5bfd9fd7a100c2e8cb7ebddc643f1e6e29d4dfcf6a",
@@ -54,25 +87,13 @@ async function sha256(bytes) {
     return Array.from(d, (b) => b.toString(16).padStart(2, "0")).join("");
 }
 /**
- * Fetch the circuit artifacts (12 MB, once) and build a prover. Works in browsers and Node 18+. The files are checked
+ * Fetch the circuit artifacts (15 MB, once; from the CDN, else Cloak's site, or the URL or URLs you pass) and build a prover. Works in browsers and Node 18+. The files are checked
  * against `CIRCUIT_HASHES`, so a tampered or mismatched download is refused; pass `hashes: null` to skip that when
  * serving your own build. In Node you can also read the files yourself and call `createProver`.
  */
-export async function loadProver(baseUrl = CIRCUITS_URL, opts = {}) {
-    const base = baseUrl.replace(/\/$/, "");
-    const get = async (name) => {
-        const res = await fetch(`${base}/${name}`);
-        if (!res.ok)
-            throw new Error(`could not download ${name} from ${base} (${res.status})`);
-        return new Uint8Array(await res.arrayBuffer());
-    };
-    const [wasm, zkey] = await Promise.all([get("transaction2x2.wasm"), get("transaction2x2_final.zkey")]);
+export async function loadProver(baseUrl = CIRCUITS_SOURCES, opts = {}) {
     const want = opts.hashes === undefined ? CIRCUIT_HASHES : opts.hashes;
-    if (want) {
-        const [hw, hz] = await Promise.all([sha256(wasm), sha256(zkey)]);
-        if (hw !== want.wasm || hz !== want.zkey)
-            throw new Error("circuit files don't match this SDK version's hashes; refusing to prove with them");
-    }
+    const [wasm, zkey] = await fetchCircuit(baseUrl, ["transaction2x2.wasm", "transaction2x2_final.zkey"], want, "circuit");
     return createProver(wasm, zkey);
 }
 /** SHA-256 of the shared-vault circuit artifacts this SDK version was built and tested against. */
@@ -84,20 +105,8 @@ export const SHARED_CIRCUIT_HASHES = {
  * Fetch the shared launch-token vault's circuit (`transactionMA2x2`, 15 MB, once) and build its prover. Checked against
  * `SHARED_CIRCUIT_HASHES` like `loadProver`; pass `hashes: null` to skip that when serving your own build.
  */
-export async function loadSharedProver(baseUrl = CIRCUITS_URL, opts = {}) {
-    const base = baseUrl.replace(/\/$/, "");
-    const get = async (name) => {
-        const res = await fetch(`${base}/${name}`);
-        if (!res.ok)
-            throw new Error(`could not download ${name} from ${base} (${res.status})`);
-        return new Uint8Array(await res.arrayBuffer());
-    };
-    const [wasm, zkey] = await Promise.all([get("transactionMA2x2.wasm"), get("transactionMA2x2_final.zkey")]);
+export async function loadSharedProver(baseUrl = CIRCUITS_SOURCES, opts = {}) {
     const want = opts.hashes === undefined ? SHARED_CIRCUIT_HASHES : opts.hashes;
-    if (want) {
-        const [hw, hz] = await Promise.all([sha256(wasm), sha256(zkey)]);
-        if (hw !== want.wasm || hz !== want.zkey)
-            throw new Error("shared-vault circuit files don't match this SDK version's hashes; refusing to prove with them");
-    }
+    const [wasm, zkey] = await fetchCircuit(baseUrl, ["transactionMA2x2.wasm", "transactionMA2x2_final.zkey"], want, "shared-vault circuit");
     return createSharedProver(wasm, zkey);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloakely/sdk",
-  "version": "0.8.3",
+  "version": "0.8.5",
   "description": "Cloak on Elysium: sealed-bid token launches, sealed NFT drops and WL spot sales, and private trading (shielded balances, private swaps, batch auctions, private sends) with on-device zero-knowledge proofs.",
   "keywords": [
     "cloak",