zcashname-sdk 0.7.2 → 0.8.0

package/README.md

@@ -67,6 +67,7 @@ console.log("Memo:", memo);
 | `prepareUpdate(name, newAddress, nonce, registryAddress)` | Change address |
 | `prepareBuy(name, buyerAddress, registryAddress)` | Buy a listed name |
 | `prepareRelease(name, nonce, registryAddress)` | Release name (burn) |
+| `prepareSetPrice(prices, nonce, registryAddress)` | Admin: set pricing tiers |
 
 ## Reading Data
 

package/dist/zns.cjs

@@ -30,6 +30,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/zns.ts
 var zns_exports = {};
 __export(zns_exports, {
+  BUY_COMMISSION: () => BUY_COMMISSION,
   DEFAULT_URL: () => DEFAULT_URL,
   MAINNET_UIVK: () => MAINNET_UIVK,
   TESTNET_UIVK: () => TESTNET_UIVK,
@@ -38,6 +39,11 @@ __export(zns_exports, {
 module.exports = __toCommonJS(zns_exports);
 var ed25519 = __toESM(require("@noble/ed25519"), 1);
 var import_bech32 = require("bech32");
+
+// src/types.ts
+var BUY_COMMISSION = 1e4;
+
+// src/zns.ts
 var DEFAULT_URL = "https://light.zcash.me/zns-testnet";
 var TESTNET_UIVK = "uivktest1hzw7wyadutvzfgpna80yftsk5l7jeyu2p5me5quvp28tytxueta00cx4068wnlzcv7tx9n3t3gfhsy83pe4y6jrhxtzaq0hj6xtg5zrk2dn7zen3vns2a5pgs4fxdjlletmqrhfa42";
 var MAINNET_UIVK = "uivk1gl26qy0xjja7lqhyg3pf0x4j4j66kqwewrjkdcg28eqq4wgtzjmujpee7x9cs2ec9xhnlgrm8ptlw8z80j2aryw8nqtssser2ys778a0s00uvgkdjnfr58sndhfvc3f4zqjs6ywva6";
@@ -154,7 +160,7 @@ var ZNS = class {
    */
   async verifyListing(listing, adminPubkey) {
     const pubkey = listing.pubkey ?? adminPubkey;
-    const payload = `LIST:${listing.name}:${listing.price}:${listing.nonce}`;
+    const payload = `LIST:${listing.name}:${listing.price}:${listing.pay_taddr}:${listing.nonce}`;
     return this.verifyEd25519(payload, listing.signature, pubkey);
   }
   /**
@@ -185,6 +191,15 @@ var ZNS = class {
     const idx = Math.min(Math.max(nameLength - 1, 0), pricing.tiers.length - 1);
     return pricing.tiers[idx];
   }
+  /**
+   * Get the listing commission in zatoshis (10% of the minimum pricing tier).
+   * @param pricing The pricing configuration - obtain from {@link status}
+   * @returns The commission in zatoshis, or null if pricing is unavailable
+   */
+  listCommission(pricing) {
+    if (pricing.tiers.length === 0) return null;
+    return Math.min(...pricing.tiers) * 0.1;
+  }
   /** Parse a ZIP-321 URI into its components. */
   parseZip321Uri(uri) {
     const withoutScheme = String(uri ?? "").replace(/^zcash:/i, "");
@@ -221,15 +236,16 @@ var ZNS = class {
       }
     };
   }
-  prepareList(name, price, nonce) {
+  prepareList(name, price, pay_taddr, nonce) {
     this.requireValidName(name);
     return {
       name,
       price,
+      pay_taddr,
       nonce,
-      payload: `LIST:${name}:${price}:${nonce}`,
+      payload: `LIST:${name}:${price}:${pay_taddr}:${nonce}`,
       complete: (signature, userPubkey) => {
-        const memo = userPubkey ? `ZNS:LIST:${name}:${price}:${nonce}:${signature}:${userPubkey}` : `ZNS:LIST:${name}:${price}:${nonce}:${signature}`;
+        const memo = userPubkey ? `ZNS:LIST:${name}:${price}:${pay_taddr}:${nonce}:${signature}:${userPubkey}` : `ZNS:LIST:${name}:${price}:${pay_taddr}:${nonce}:${signature}`;
         return { memo, uri: this.buildZcashUri(this.registryAddress, void 0, memo) };
       }
     };
@@ -262,7 +278,7 @@ var ZNS = class {
       }
     };
   }
-  prepareBuy(name, buyerAddress) {
+  prepareBuy(name, buyerAddress, price) {
     this.requireValidName(name);
     if (!this.isValidUnifiedAddress(buyerAddress)) {
       throw new Error(`Invalid Zcash Unified Address: ${buyerAddress}`);
@@ -270,10 +286,11 @@ var ZNS = class {
     return {
       name,
       buyerAddress,
+      price,
       payload: `BUY:${name}:${buyerAddress}`,
       complete: (signature, userPubkey) => {
-        const memo = userPubkey ? `ZNS:BUY:${name}:${buyerAddress}:${signature}:${userPubkey}` : `ZNS:BUY:${name}:${buyerAddress}:${signature}`;
-        return { memo, uri: this.buildZcashUri(this.registryAddress, void 0, memo) };
+        const memo = userPubkey ? `ZNS:BUY:${name}:${buyerAddress}:${price}:${signature}:${userPubkey}` : `ZNS:BUY:${name}:${buyerAddress}:${price}:${signature}`;
+        return { memo, uri: this.buildZcashUri(this.registryAddress, BUY_COMMISSION, memo) };
       }
     };
   }
@@ -289,6 +306,17 @@ var ZNS = class {
       }
     };
   }
+  prepareSetPrice(prices, nonce) {
+    return {
+      prices,
+      nonce,
+      payload: `SETPRICE:${prices.length}:${prices.join(":")}:${nonce}`,
+      complete: (signature) => {
+        const memo = `ZNS:SETPRICE:${prices.length}:${prices.join(":")}:${nonce}:${signature}`;
+        return { memo, uri: this.buildZcashUri(this.registryAddress, void 0, memo) };
+      }
+    };
+  }
   // ── Private helpers ────────────────────────────────────────────────────────
   registrationPayload(reg) {
     switch (reg.last_action) {
@@ -381,6 +409,7 @@ var ZNS = class {
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  BUY_COMMISSION,
   DEFAULT_URL,
   MAINNET_UIVK,
   TESTNET_UIVK,

package/dist/zns.d.cts

@@ -2,6 +2,8 @@
  *  All monetary values in ZNS are denominated in zats.
  *  Note: JavaScript number precision degrades above 2^53 (~9e15 zats, or ~90M ZEC) */
 type Zats = number;
+/** Commission sent with a BUY claim memo (0.0001 ZEC = 10,000 zats). */
+declare const BUY_COMMISSION: Zats;
 interface Registration {
     name: string;
     address: string;
@@ -20,11 +22,20 @@ type EventAction = "CLAIM" | "LIST" | "DELIST" | "RELEASE" | "UPDATE" | "BUY" |
 interface Listing {
     name: string;
     price: Zats;
+    pay_taddr: string;
     nonce: number;
     txid: string;
     height: number;
     signature: string;
     pubkey: string | null;
+    pending_buy: PendingBuy | null;
+}
+interface PendingBuy {
+    buyer_ua: string;
+    price: Zats;
+    claim_height: number;
+    expires_at: number;
+    txid: string;
 }
 interface Pricing {
     nonce: number;
@@ -89,6 +100,7 @@ interface PreparedClaim extends PreparedAction {
 interface PreparedList extends PreparedAction {
     readonly name: string;
     readonly price: Zats;
+    readonly pay_taddr: string;
     readonly nonce: number;
 }
 /** Prepared DELIST action */
@@ -106,12 +118,18 @@ interface PreparedUpdate extends PreparedAction {
 interface PreparedBuy extends PreparedAction {
     readonly name: string;
     readonly buyerAddress: string;
+    readonly price: Zats;
 }
 /** Prepared RELEASE action */
 interface PreparedRelease extends PreparedAction {
     readonly name: string;
     readonly nonce: number;
 }
+/** Prepared SETPRICE action (admin only) */
+interface PreparedSetPrice extends PreparedAction {
+    readonly prices: readonly Zats[];
+    readonly nonce: number;
+}
 
 declare const DEFAULT_URL = "https://light.zcash.me/zns-testnet";
 declare const TESTNET_UIVK = "uivktest1hzw7wyadutvzfgpna80yftsk5l7jeyu2p5me5quvp28tytxueta00cx4068wnlzcv7tx9n3t3gfhsy83pe4y6jrhxtzaq0hj6xtg5zrk2dn7zen3vns2a5pgs4fxdjlletmqrhfa42";
@@ -187,6 +205,12 @@ declare class ZNS {
      * @returns The cost in zatoshis, or null if pricing is unavailable
      */
     claimCost(nameLength: number, pricing: Pricing): Zats | null;
+    /**
+     * Get the listing commission in zatoshis (10% of the minimum pricing tier).
+     * @param pricing The pricing configuration - obtain from {@link status}
+     * @returns The commission in zatoshis, or null if pricing is unavailable
+     */
+    listCommission(pricing: Pricing): Zats | null;
     /** Parse a ZIP-321 URI into its components. */
     parseZip321Uri(uri: string): {
         address: string;
@@ -202,11 +226,12 @@ declare class ZNS {
      * @returns Prepared claim ready for signature completion
      */
     prepareClaim(name: string, address: string, cost: Zats): PreparedClaim;
-    prepareList(name: string, price: Zats, nonce: number): PreparedList;
+    prepareList(name: string, price: Zats, pay_taddr: string, nonce: number): PreparedList;
     prepareDelist(name: string, nonce: number): PreparedDelist;
     prepareUpdate(name: string, newAddress: string, nonce: number): PreparedUpdate;
-    prepareBuy(name: string, buyerAddress: string): PreparedBuy;
+    prepareBuy(name: string, buyerAddress: string, price: Zats): PreparedBuy;
     prepareRelease(name: string, nonce: number): PreparedRelease;
+    prepareSetPrice(prices: Zats[], nonce: number): PreparedSetPrice;
     private registrationPayload;
     private verifyEd25519;
     private requireValidName;
@@ -218,4 +243,4 @@ declare class ZNS {
     private rpc;
 }
 
-export { type CompletedAction, DEFAULT_URL, type Event, type EventAction, type EventsFilter, type EventsResult, type LastAction, type Listing, MAINNET_UIVK, type Network, type PreparedBuy, type PreparedClaim, type PreparedDelist, type PreparedList, type PreparedRelease, type PreparedUpdate, type Pricing, type Registration, type Status, TESTNET_UIVK, ZNS, type Zats };
+export { BUY_COMMISSION, type CompletedAction, DEFAULT_URL, type Event, type EventAction, type EventsFilter, type EventsResult, type LastAction, type Listing, MAINNET_UIVK, type Network, type PendingBuy, type PreparedBuy, type PreparedClaim, type PreparedDelist, type PreparedList, type PreparedRelease, type PreparedSetPrice, type PreparedUpdate, type Pricing, type Registration, type Status, TESTNET_UIVK, ZNS, type Zats };

package/dist/zns.d.ts

@@ -2,6 +2,8 @@
  *  All monetary values in ZNS are denominated in zats.
  *  Note: JavaScript number precision degrades above 2^53 (~9e15 zats, or ~90M ZEC) */
 type Zats = number;
+/** Commission sent with a BUY claim memo (0.0001 ZEC = 10,000 zats). */
+declare const BUY_COMMISSION: Zats;
 interface Registration {
     name: string;
     address: string;
@@ -20,11 +22,20 @@ type EventAction = "CLAIM" | "LIST" | "DELIST" | "RELEASE" | "UPDATE" | "BUY" |
 interface Listing {
     name: string;
     price: Zats;
+    pay_taddr: string;
     nonce: number;
     txid: string;
     height: number;
     signature: string;
     pubkey: string | null;
+    pending_buy: PendingBuy | null;
+}
+interface PendingBuy {
+    buyer_ua: string;
+    price: Zats;
+    claim_height: number;
+    expires_at: number;
+    txid: string;
 }
 interface Pricing {
     nonce: number;
@@ -89,6 +100,7 @@ interface PreparedClaim extends PreparedAction {
 interface PreparedList extends PreparedAction {
     readonly name: string;
     readonly price: Zats;
+    readonly pay_taddr: string;
     readonly nonce: number;
 }
 /** Prepared DELIST action */
@@ -106,12 +118,18 @@ interface PreparedUpdate extends PreparedAction {
 interface PreparedBuy extends PreparedAction {
     readonly name: string;
     readonly buyerAddress: string;
+    readonly price: Zats;
 }
 /** Prepared RELEASE action */
 interface PreparedRelease extends PreparedAction {
     readonly name: string;
     readonly nonce: number;
 }
+/** Prepared SETPRICE action (admin only) */
+interface PreparedSetPrice extends PreparedAction {
+    readonly prices: readonly Zats[];
+    readonly nonce: number;
+}
 
 declare const DEFAULT_URL = "https://light.zcash.me/zns-testnet";
 declare const TESTNET_UIVK = "uivktest1hzw7wyadutvzfgpna80yftsk5l7jeyu2p5me5quvp28tytxueta00cx4068wnlzcv7tx9n3t3gfhsy83pe4y6jrhxtzaq0hj6xtg5zrk2dn7zen3vns2a5pgs4fxdjlletmqrhfa42";
@@ -187,6 +205,12 @@ declare class ZNS {
      * @returns The cost in zatoshis, or null if pricing is unavailable
      */
     claimCost(nameLength: number, pricing: Pricing): Zats | null;
+    /**
+     * Get the listing commission in zatoshis (10% of the minimum pricing tier).
+     * @param pricing The pricing configuration - obtain from {@link status}
+     * @returns The commission in zatoshis, or null if pricing is unavailable
+     */
+    listCommission(pricing: Pricing): Zats | null;
     /** Parse a ZIP-321 URI into its components. */
     parseZip321Uri(uri: string): {
         address: string;
@@ -202,11 +226,12 @@ declare class ZNS {
      * @returns Prepared claim ready for signature completion
      */
     prepareClaim(name: string, address: string, cost: Zats): PreparedClaim;
-    prepareList(name: string, price: Zats, nonce: number): PreparedList;
+    prepareList(name: string, price: Zats, pay_taddr: string, nonce: number): PreparedList;
     prepareDelist(name: string, nonce: number): PreparedDelist;
     prepareUpdate(name: string, newAddress: string, nonce: number): PreparedUpdate;
-    prepareBuy(name: string, buyerAddress: string): PreparedBuy;
+    prepareBuy(name: string, buyerAddress: string, price: Zats): PreparedBuy;
     prepareRelease(name: string, nonce: number): PreparedRelease;
+    prepareSetPrice(prices: Zats[], nonce: number): PreparedSetPrice;
     private registrationPayload;
     private verifyEd25519;
     private requireValidName;
@@ -218,4 +243,4 @@ declare class ZNS {
     private rpc;
 }
 
-export { type CompletedAction, DEFAULT_URL, type Event, type EventAction, type EventsFilter, type EventsResult, type LastAction, type Listing, MAINNET_UIVK, type Network, type PreparedBuy, type PreparedClaim, type PreparedDelist, type PreparedList, type PreparedRelease, type PreparedUpdate, type Pricing, type Registration, type Status, TESTNET_UIVK, ZNS, type Zats };
+export { BUY_COMMISSION, type CompletedAction, DEFAULT_URL, type Event, type EventAction, type EventsFilter, type EventsResult, type LastAction, type Listing, MAINNET_UIVK, type Network, type PendingBuy, type PreparedBuy, type PreparedClaim, type PreparedDelist, type PreparedList, type PreparedRelease, type PreparedSetPrice, type PreparedUpdate, type Pricing, type Registration, type Status, TESTNET_UIVK, ZNS, type Zats };

package/dist/zns.js

@@ -1,6 +1,11 @@
 // src/zns.ts
 import * as ed25519 from "@noble/ed25519";
 import { bech32m } from "bech32";
+
+// src/types.ts
+var BUY_COMMISSION = 1e4;
+
+// src/zns.ts
 var DEFAULT_URL = "https://light.zcash.me/zns-testnet";
 var TESTNET_UIVK = "uivktest1hzw7wyadutvzfgpna80yftsk5l7jeyu2p5me5quvp28tytxueta00cx4068wnlzcv7tx9n3t3gfhsy83pe4y6jrhxtzaq0hj6xtg5zrk2dn7zen3vns2a5pgs4fxdjlletmqrhfa42";
 var MAINNET_UIVK = "uivk1gl26qy0xjja7lqhyg3pf0x4j4j66kqwewrjkdcg28eqq4wgtzjmujpee7x9cs2ec9xhnlgrm8ptlw8z80j2aryw8nqtssser2ys778a0s00uvgkdjnfr58sndhfvc3f4zqjs6ywva6";
@@ -117,7 +122,7 @@ var ZNS = class {
    */
   async verifyListing(listing, adminPubkey) {
     const pubkey = listing.pubkey ?? adminPubkey;
-    const payload = `LIST:${listing.name}:${listing.price}:${listing.nonce}`;
+    const payload = `LIST:${listing.name}:${listing.price}:${listing.pay_taddr}:${listing.nonce}`;
     return this.verifyEd25519(payload, listing.signature, pubkey);
   }
   /**
@@ -148,6 +153,15 @@ var ZNS = class {
     const idx = Math.min(Math.max(nameLength - 1, 0), pricing.tiers.length - 1);
     return pricing.tiers[idx];
   }
+  /**
+   * Get the listing commission in zatoshis (10% of the minimum pricing tier).
+   * @param pricing The pricing configuration - obtain from {@link status}
+   * @returns The commission in zatoshis, or null if pricing is unavailable
+   */
+  listCommission(pricing) {
+    if (pricing.tiers.length === 0) return null;
+    return Math.min(...pricing.tiers) * 0.1;
+  }
   /** Parse a ZIP-321 URI into its components. */
   parseZip321Uri(uri) {
     const withoutScheme = String(uri ?? "").replace(/^zcash:/i, "");
@@ -184,15 +198,16 @@ var ZNS = class {
       }
     };
   }
-  prepareList(name, price, nonce) {
+  prepareList(name, price, pay_taddr, nonce) {
     this.requireValidName(name);
     return {
       name,
       price,
+      pay_taddr,
       nonce,
-      payload: `LIST:${name}:${price}:${nonce}`,
+      payload: `LIST:${name}:${price}:${pay_taddr}:${nonce}`,
       complete: (signature, userPubkey) => {
-        const memo = userPubkey ? `ZNS:LIST:${name}:${price}:${nonce}:${signature}:${userPubkey}` : `ZNS:LIST:${name}:${price}:${nonce}:${signature}`;
+        const memo = userPubkey ? `ZNS:LIST:${name}:${price}:${pay_taddr}:${nonce}:${signature}:${userPubkey}` : `ZNS:LIST:${name}:${price}:${pay_taddr}:${nonce}:${signature}`;
         return { memo, uri: this.buildZcashUri(this.registryAddress, void 0, memo) };
       }
     };
@@ -225,7 +240,7 @@ var ZNS = class {
       }
     };
   }
-  prepareBuy(name, buyerAddress) {
+  prepareBuy(name, buyerAddress, price) {
     this.requireValidName(name);
     if (!this.isValidUnifiedAddress(buyerAddress)) {
       throw new Error(`Invalid Zcash Unified Address: ${buyerAddress}`);
@@ -233,10 +248,11 @@ var ZNS = class {
     return {
       name,
       buyerAddress,
+      price,
       payload: `BUY:${name}:${buyerAddress}`,
       complete: (signature, userPubkey) => {
-        const memo = userPubkey ? `ZNS:BUY:${name}:${buyerAddress}:${signature}:${userPubkey}` : `ZNS:BUY:${name}:${buyerAddress}:${signature}`;
-        return { memo, uri: this.buildZcashUri(this.registryAddress, void 0, memo) };
+        const memo = userPubkey ? `ZNS:BUY:${name}:${buyerAddress}:${price}:${signature}:${userPubkey}` : `ZNS:BUY:${name}:${buyerAddress}:${price}:${signature}`;
+        return { memo, uri: this.buildZcashUri(this.registryAddress, BUY_COMMISSION, memo) };
       }
     };
   }
@@ -252,6 +268,17 @@ var ZNS = class {
       }
     };
   }
+  prepareSetPrice(prices, nonce) {
+    return {
+      prices,
+      nonce,
+      payload: `SETPRICE:${prices.length}:${prices.join(":")}:${nonce}`,
+      complete: (signature) => {
+        const memo = `ZNS:SETPRICE:${prices.length}:${prices.join(":")}:${nonce}:${signature}`;
+        return { memo, uri: this.buildZcashUri(this.registryAddress, void 0, memo) };
+      }
+    };
+  }
   // ── Private helpers ────────────────────────────────────────────────────────
   registrationPayload(reg) {
     switch (reg.last_action) {
@@ -343,6 +370,7 @@ var ZNS = class {
   }
 };
 export {
+  BUY_COMMISSION,
   DEFAULT_URL,
   MAINNET_UIVK,
   TESTNET_UIVK,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zcashname-sdk",
-  "version": "0.7.2",
+  "version": "0.8.0",
   "type": "module",
   "description": "TypeScript SDK for the Zcash Name System (ZNS)",
   "main": "dist/zns.cjs",