@ckb-ccc/udt 0.1.0

package/dist.commonjs/index.js

@@ -0,0 +1,31 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.udt = void 0;
+__exportStar(require("./barrel.js"), exports);
+exports.udt = __importStar(require("./barrel.js"));

package/dist.commonjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist.commonjs/udt/index.d.ts

@@ -0,0 +1,108 @@
+import { ccc } from "@ckb-ccc/core";
+import { ssri } from "@ckb-ccc/ssri";
+/**
+ * Represents a User Defined Token (UDT) script compliant with the SSRI protocol.
+ *
+ * This class provides a comprehensive implementation for interacting with User Defined Tokens,
+ * supporting various token operations such as querying metadata, checking balances, and performing transfers.
+ * It supports both SSRI-compliant UDTs and legacy sUDT/xUDT standard tokens.
+ *
+ * @public
+ * @category Blockchain
+ * @category Token
+ */
+export declare class Udt extends ssri.Trait {
+    readonly script: ccc.Script;
+    /**
+     * Constructs a new UDT (User Defined Token) script instance.
+     * By default it is a SSRI-compliant UDT. By providing `xudtType`, it is compatible with the legacy xUDT.
+     *
+     * @param executor - The SSRI executor instance.
+     * @param code - The script code cell of the UDT.
+     * @param script - The type script of the UDT.
+     * @example
+     * ```typescript
+     * const udt = new Udt(executor, code, script);
+     * ```
+     */
+    constructor(code: ccc.OutPointLike, script: ccc.ScriptLike, config?: {
+        executor?: ssri.Executor | null;
+    } | null);
+    /**
+     * Retrieves the human-readable name of the User Defined Token.
+     *
+     * @returns A promise resolving to the token's name.
+     */
+    name(context?: ssri.ContextScript): Promise<ssri.ExecutorResponse<string | undefined>>;
+    /**
+     * Retrieves the symbol of the UDT.
+     * @returns The symbol of the UDT.
+     */
+    symbol(context?: ssri.ContextScript): Promise<ssri.ExecutorResponse<string | undefined>>;
+    /**
+     * Retrieves the decimals of the UDT.
+     * @returns The decimals of the UDT.
+     */
+    decimals(context?: ssri.ContextScript): Promise<ssri.ExecutorResponse<ccc.Num | undefined>>;
+    /**
+     * Retrieves the icon of the UDT
+     * @returns The icon of the UDT.
+     */
+    icon(context?: ssri.ContextScript): Promise<ssri.ExecutorResponse<string | undefined>>;
+    /**
+     * Transfers UDT to specified addresses.
+     * @param tx - Transfer on the basis of an existing transaction to achieve combined actions. If not provided, a new transaction will be created.
+     * @param transfers - The array of transfers.
+     * @param transfers.to - The receiver of token.
+     * @param transfers.amount - The amount of token to the receiver.
+     * @returns The transaction result.
+     * @tag Mutation - This method represents a mutation of the onchain state and will return a transaction object.
+     * @example
+     * ```typescript
+     * const { script: change } = await signer.getRecommendedAddressObj();
+     * const { script: to } = await ccc.Address.fromString(receiver, signer.client);
+     *
+     * const udt = new Udt(
+     *   {
+     *     txHash: "0x4e2e832e0b1e7b5994681b621b00c1e65f577ee4b440ef95fa07db9bb3d50269",
+     *     index: 0,
+     *   },
+     *   {
+     *     codeHash: "0xcc9dc33ef234e14bc788c43a4848556a5fb16401a04662fc55db9bb201987037",
+     *     hashType: "type",
+     *     args: "0x71fd1985b2971a9903e4d8ed0d59e6710166985217ca0681437883837b86162f"
+     *   },
+     * );
+     *
+     * const { res: tx } = await udtTrait.transfer(
+     *   signer,
+     *   [{ to, amount: 100 }],
+     * );
+     *
+     * const completedTx = udt.completeUdtBy(tx, signer);
+     * await completedTx.completeInputsByCapacity(signer);
+     * await completedTx.completeFeeBy(signer);
+     * const transferTxHash = await signer.sendTransaction(completedTx);
+     * ```
+     */
+    transfer(signer: ccc.Signer, transfers: {
+        to: ccc.ScriptLike;
+        amount: ccc.NumLike;
+    }[], tx?: ccc.TransactionLike | null): Promise<ssri.ExecutorResponse<ccc.Transaction>>;
+    /**
+     * Mints new tokens to specified addresses. See the example in `transfer` as they are similar.
+     * @param tx - Optional existing transaction to build upon
+     * @param mints - Array of mints
+     * @param mints.to - receiver of token
+     * @param mints.amount - amount to the receiver
+     * @returns The transaction containing the mint operation
+     * @tag Mutation - This method represents a mutation of the onchain state
+     */
+    mint(signer: ccc.Signer, mints: {
+        to: ccc.ScriptLike;
+        amount: ccc.NumLike;
+    }[], tx?: ccc.TransactionLike | null): Promise<ssri.ExecutorResponse<ccc.Transaction>>;
+    completeChangeToLock(txLike: ccc.TransactionLike, signer: ccc.Signer, change: ccc.ScriptLike): Promise<ccc.Transaction>;
+    completeBy(tx: ccc.TransactionLike, from: ccc.Signer): Promise<ccc.Transaction>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist.commonjs/udt/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/udt/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAErC;;;;;;;;;;GAUG;AACH,qBAAa,GAAI,SAAQ,IAAI,CAAC,KAAK;IACjC,SAAgB,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC;IAEnC;;;;;;;;;;;OAWG;gBAED,IAAI,EAAE,GAAG,CAAC,YAAY,EACtB,MAAM,EAAE,GAAG,CAAC,UAAU,EACtB,MAAM,CAAC,EAAE;QACP,QAAQ,CAAC,EAAE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;KACjC,GAAG,IAAI;IAMV;;;;OAIG;IACG,IAAI,CACR,OAAO,CAAC,EAAE,IAAI,CAAC,aAAa,GAC3B,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAcrD;;;OAGG;IACG,MAAM,CACV,OAAO,CAAC,EAAE,IAAI,CAAC,aAAa,GAC3B,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAmBrD;;;OAGG;IACG,QAAQ,CACZ,OAAO,CAAC,EAAE,IAAI,CAAC,aAAa,GAC3B,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,GAAG,SAAS,CAAC,CAAC;IAmBtD;;;OAGG;IACG,IAAI,CACR,OAAO,CAAC,EAAE,IAAI,CAAC,aAAa,GAC3B,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAcrD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACG,QAAQ,CACZ,MAAM,EAAE,GAAG,CAAC,MAAM,EAClB,SAAS,EAAE;QACT,EAAE,EAAE,GAAG,CAAC,UAAU,CAAC;QACnB,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC;KACrB,EAAE,EACH,EAAE,CAAC,EAAE,GAAG,CAAC,eAAe,GAAG,IAAI,GAC9B,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IA2ClD;;;;;;;;OAQG;IACG,IAAI,CACR,MAAM,EAAE,GAAG,CAAC,MAAM,EAClB,KAAK,EAAE;QACL,EAAE,EAAE,GAAG,CAAC,UAAU,CAAC;QACnB,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC;KACrB,EAAE,EACH,EAAE,CAAC,EAAE,GAAG,CAAC,eAAe,GAAG,IAAI,GAC9B,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IA2C5C,oBAAoB,CACxB,MAAM,EAAE,GAAG,CAAC,eAAe,EAC3B,MAAM,EAAE,GAAG,CAAC,MAAM,EAClB,MAAM,EAAE,GAAG,CAAC,UAAU;IAqBlB,UAAU,CAAC,EAAE,EAAE,GAAG,CAAC,eAAe,EAAE,IAAI,EAAE,GAAG,CAAC,MAAM;CAK3D"}

package/dist.commonjs/udt/index.js

@@ -0,0 +1,226 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Udt = void 0;
+const core_1 = require("@ckb-ccc/core");
+const ssri_1 = require("@ckb-ccc/ssri");
+/**
+ * Represents a User Defined Token (UDT) script compliant with the SSRI protocol.
+ *
+ * This class provides a comprehensive implementation for interacting with User Defined Tokens,
+ * supporting various token operations such as querying metadata, checking balances, and performing transfers.
+ * It supports both SSRI-compliant UDTs and legacy sUDT/xUDT standard tokens.
+ *
+ * @public
+ * @category Blockchain
+ * @category Token
+ */
+class Udt extends ssri_1.ssri.Trait {
+    /**
+     * Constructs a new UDT (User Defined Token) script instance.
+     * By default it is a SSRI-compliant UDT. By providing `xudtType`, it is compatible with the legacy xUDT.
+     *
+     * @param executor - The SSRI executor instance.
+     * @param code - The script code cell of the UDT.
+     * @param script - The type script of the UDT.
+     * @example
+     * ```typescript
+     * const udt = new Udt(executor, code, script);
+     * ```
+     */
+    constructor(code, script, config) {
+        super(code, config?.executor);
+        this.script = core_1.ccc.Script.from(script);
+    }
+    /**
+     * Retrieves the human-readable name of the User Defined Token.
+     *
+     * @returns A promise resolving to the token's name.
+     */
+    async name(context) {
+        if (this.executor) {
+            const res = await this.executor.runScriptTry(this.code, "UDT.name", [], {
+                script: this.script,
+                ...context,
+            });
+            if (res) {
+                return res.map((res) => core_1.ccc.bytesTo(res, "utf8"));
+            }
+        }
+        return ssri_1.ssri.ExecutorResponse.new(undefined);
+    }
+    /**
+     * Retrieves the symbol of the UDT.
+     * @returns The symbol of the UDT.
+     */
+    async symbol(context) {
+        if (this.executor) {
+            const res = await this.executor.runScriptTry(this.code, "UDT.symbol", [], {
+                script: this.script,
+                ...context,
+            });
+            if (res) {
+                return res.map((res) => core_1.ccc.bytesTo(res, "utf8"));
+            }
+        }
+        return ssri_1.ssri.ExecutorResponse.new(undefined);
+    }
+    /**
+     * Retrieves the decimals of the UDT.
+     * @returns The decimals of the UDT.
+     */
+    async decimals(context) {
+        if (this.executor) {
+            const res = await this.executor.runScriptTry(this.code, "UDT.decimals", [], {
+                script: this.script,
+                ...context,
+            });
+            if (res) {
+                return res.map((res) => core_1.ccc.numFromBytes(res));
+            }
+        }
+        return ssri_1.ssri.ExecutorResponse.new(undefined);
+    }
+    /**
+     * Retrieves the icon of the UDT
+     * @returns The icon of the UDT.
+     */
+    async icon(context) {
+        if (this.executor) {
+            const res = await this.executor.runScriptTry(this.code, "UDT.icon", [], {
+                script: this.script,
+                ...context,
+            });
+            if (res) {
+                return res.map((res) => core_1.ccc.bytesTo(res, "utf8"));
+            }
+        }
+        return ssri_1.ssri.ExecutorResponse.new(undefined);
+    }
+    /**
+     * Transfers UDT to specified addresses.
+     * @param tx - Transfer on the basis of an existing transaction to achieve combined actions. If not provided, a new transaction will be created.
+     * @param transfers - The array of transfers.
+     * @param transfers.to - The receiver of token.
+     * @param transfers.amount - The amount of token to the receiver.
+     * @returns The transaction result.
+     * @tag Mutation - This method represents a mutation of the onchain state and will return a transaction object.
+     * @example
+     * ```typescript
+     * const { script: change } = await signer.getRecommendedAddressObj();
+     * const { script: to } = await ccc.Address.fromString(receiver, signer.client);
+     *
+     * const udt = new Udt(
+     *   {
+     *     txHash: "0x4e2e832e0b1e7b5994681b621b00c1e65f577ee4b440ef95fa07db9bb3d50269",
+     *     index: 0,
+     *   },
+     *   {
+     *     codeHash: "0xcc9dc33ef234e14bc788c43a4848556a5fb16401a04662fc55db9bb201987037",
+     *     hashType: "type",
+     *     args: "0x71fd1985b2971a9903e4d8ed0d59e6710166985217ca0681437883837b86162f"
+     *   },
+     * );
+     *
+     * const { res: tx } = await udtTrait.transfer(
+     *   signer,
+     *   [{ to, amount: 100 }],
+     * );
+     *
+     * const completedTx = udt.completeUdtBy(tx, signer);
+     * await completedTx.completeInputsByCapacity(signer);
+     * await completedTx.completeFeeBy(signer);
+     * const transferTxHash = await signer.sendTransaction(completedTx);
+     * ```
+     */
+    async transfer(signer, transfers, tx) {
+        let resTx;
+        if (this.executor) {
+            const txReq = core_1.ccc.Transaction.from(tx ?? {});
+            await txReq.completeInputsAtLeastOne(signer);
+            const res = await this.executor.runScriptTry(this.code, "UDT.transfer", [
+                txReq.toBytes(),
+                core_1.ccc.ScriptVec.encode(transfers.map(({ to }) => to)),
+                core_1.ccc.mol.Uint128Vec.encode(transfers.map(({ amount }) => amount)),
+            ], {
+                script: this.script,
+            });
+            if (res) {
+                resTx = res.map((res) => core_1.ccc.Transaction.fromBytes(res));
+            }
+        }
+        if (!resTx) {
+            const transfer = core_1.ccc.Transaction.from(tx ?? {});
+            for (const { to, amount } of transfers) {
+                transfer.addOutput({
+                    lock: to,
+                    type: this.script,
+                }, core_1.ccc.numLeToBytes(amount, 16));
+            }
+            resTx = ssri_1.ssri.ExecutorResponse.new(transfer);
+        }
+        resTx.res.addCellDeps({
+            outPoint: this.code,
+            depType: "code",
+        });
+        return resTx;
+    }
+    /**
+     * Mints new tokens to specified addresses. See the example in `transfer` as they are similar.
+     * @param tx - Optional existing transaction to build upon
+     * @param mints - Array of mints
+     * @param mints.to - receiver of token
+     * @param mints.amount - amount to the receiver
+     * @returns The transaction containing the mint operation
+     * @tag Mutation - This method represents a mutation of the onchain state
+     */
+    async mint(signer, mints, tx) {
+        let resTx;
+        if (this.executor) {
+            const txReq = core_1.ccc.Transaction.from(tx ?? {});
+            await txReq.completeInputsAtLeastOne(signer);
+            const res = await this.executor.runScriptTry(this.code, "UDT.mint", [
+                txReq.toBytes(),
+                core_1.ccc.ScriptVec.encode(mints.map(({ to }) => to)),
+                core_1.ccc.mol.Uint128Vec.encode(mints.map(({ amount }) => amount)),
+            ], {
+                script: this.script,
+            });
+            if (res) {
+                resTx = res.map((res) => core_1.ccc.Transaction.fromBytes(res));
+            }
+        }
+        if (!resTx) {
+            const mint = core_1.ccc.Transaction.from(tx ?? {});
+            for (const { to, amount } of mints) {
+                mint.addOutput({
+                    lock: to,
+                    type: this.script,
+                }, core_1.ccc.numLeToBytes(amount));
+            }
+            resTx = ssri_1.ssri.ExecutorResponse.new(mint);
+        }
+        resTx.res.addCellDeps({
+            outPoint: this.code,
+            depType: "code",
+        });
+        return resTx;
+    }
+    async completeChangeToLock(txLike, signer, change) {
+        const tx = core_1.ccc.Transaction.from(txLike);
+        await tx.completeInputsByUdt(signer, this.script);
+        const balanceDiff = (await tx.getInputsUdtBalance(signer.client, this.script)) -
+            tx.getOutputsUdtBalance(this.script);
+        if (balanceDiff > core_1.ccc.Zero) {
+            tx.addOutput({
+                lock: change,
+                type: this.script,
+            }, core_1.ccc.numLeToBytes(balanceDiff, 16));
+        }
+        return tx;
+    }
+    async completeBy(tx, from) {
+        const { script } = await from.getRecommendedAddressObj();
+        return this.completeChangeToLock(tx, from, script);
+    }
+}
+exports.Udt = Udt;

package/dist.commonjs/udtPausable/index.d.ts

@@ -0,0 +1,41 @@
+import { ccc } from "@ckb-ccc/core";
+import { ssri } from "@ckb-ccc/ssri";
+import { Udt } from "../udt/index.js";
+/**
+ * Represents a UDT (User Defined Token) with pausable functionality.
+ * @extends {Udt} This must be a SSRI UDT that does not fallback to xUDT.
+ * @public
+ */
+export declare class UdtPausable extends Udt {
+    constructor(code: ccc.OutPointLike, script: ccc.ScriptLike, config: {
+        executor: ssri.Executor;
+    });
+    /**
+     * Pauses the UDT for the specified lock hashes. Pausing/Unpause without lock hashes should take effect on the global level. Note that this method is only available if the pausable UDT uses external pause list.
+     * @param {ccc.HexLike[]} lockHashes - The array of lock hashes to be paused.
+     * @param {ccc.TransactionLike} tx - The transaction to be used.
+     * @returns The transaction result.
+     * @tag Mutation - This method represents a mutation of the onchain state and will return a transaction to be sent.
+     */
+    pause(signer: ccc.Signer, locks: ccc.ScriptLike[], tx?: ccc.TransactionLike | null, extraLockHashes?: ccc.HexLike[] | null): Promise<ssri.ExecutorResponse<ccc.Transaction>>;
+    /**
+     * Unpauses the UDT for the specified lock hashes. Note that this method is only available if the pausable UDT uses external pause list.
+     * @param tx - The transaction to be used.
+     * @param lockHashes - The array of lock hashes to be unpaused.
+     * @returns The transaction result.
+     * @tag Mutation - This method represents a mutation of the onchain state and will return a transaction to be sent.
+     */
+    unpause(signer: ccc.Signer, locks: ccc.ScriptLike[], tx?: ccc.TransactionLike | null, extraLockHashes?: ccc.HexLike[] | null): Promise<ssri.ExecutorResponse<ccc.Transaction>>;
+    /**
+     * Checks if the UDT is paused for the specified lock hashes within a transaction. If not using external pause list, it can also be run on Code environment level.
+     * @param lockHashes - The lock hashes to check.
+     * @returns True if any of the lock hashes are paused, false otherwise.
+     */
+    isPaused(locks: ccc.ScriptLike[], extraLockHashes?: ccc.HexLike[] | null): Promise<ssri.ExecutorResponse<boolean[]>>;
+    /**
+     * Enumerates all paused lock hashes in UDTPausableData.
+     * @returns The array of lock hashes.
+     */
+    enumeratePaused(offset?: ccc.Num, limit?: ccc.Num): Promise<ssri.ExecutorResponse<ccc.Hex[]>>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist.commonjs/udtPausable/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/udtPausable/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AACrC,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAEtC;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,GAAG;gBAEhC,IAAI,EAAE,GAAG,CAAC,YAAY,EACtB,MAAM,EAAE,GAAG,CAAC,UAAU,EACtB,MAAM,EAAE;QACN,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC;KACzB;IAKH;;;;;;OAMG;IACG,KAAK,CACT,MAAM,EAAE,GAAG,CAAC,MAAM,EAClB,KAAK,EAAE,GAAG,CAAC,UAAU,EAAE,EACvB,EAAE,CAAC,EAAE,GAAG,CAAC,eAAe,GAAG,IAAI,EAC/B,eAAe,CAAC,EAAE,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,GACrC,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAyBlD;;;;;;OAMG;IACG,OAAO,CACX,MAAM,EAAE,GAAG,CAAC,MAAM,EAClB,KAAK,EAAE,GAAG,CAAC,UAAU,EAAE,EACvB,EAAE,CAAC,EAAE,GAAG,CAAC,eAAe,GAAG,IAAI,EAC/B,eAAe,CAAC,EAAE,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,GACrC,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAyBlD;;;;OAIG;IACG,QAAQ,CACZ,KAAK,EAAE,GAAG,CAAC,UAAU,EAAE,EACvB,eAAe,CAAC,EAAE,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,GACrC,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC;IAgB5C;;;OAGG;IACG,eAAe,CACnB,MAAM,CAAC,EAAE,GAAG,CAAC,GAAG,EAChB,KAAK,CAAC,EAAE,GAAG,CAAC,GAAG,GACd,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;CAU7C"}

package/dist.commonjs/udtPausable/index.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UdtPausable = void 0;
+const core_1 = require("@ckb-ccc/core");
+const index_js_1 = require("../udt/index.js");
+/**
+ * Represents a UDT (User Defined Token) with pausable functionality.
+ * @extends {Udt} This must be a SSRI UDT that does not fallback to xUDT.
+ * @public
+ */
+class UdtPausable extends index_js_1.Udt {
+    constructor(code, script, config) {
+        super(code, script, config);
+    }
+    /**
+     * Pauses the UDT for the specified lock hashes. Pausing/Unpause without lock hashes should take effect on the global level. Note that this method is only available if the pausable UDT uses external pause list.
+     * @param {ccc.HexLike[]} lockHashes - The array of lock hashes to be paused.
+     * @param {ccc.TransactionLike} tx - The transaction to be used.
+     * @returns The transaction result.
+     * @tag Mutation - This method represents a mutation of the onchain state and will return a transaction to be sent.
+     */
+    async pause(signer, locks, tx, extraLockHashes) {
+        const txReq = core_1.ccc.Transaction.from(tx ?? {});
+        await txReq.completeInputsAtLeastOne(signer);
+        const res = await this.assertExecutor().runScript(this.code, "UDTPausable.pause", [
+            txReq.toBytes(),
+            core_1.ccc.mol.Byte32Vec.encode(locks
+                .map((l) => core_1.ccc.Script.from(l).hash())
+                .concat(extraLockHashes?.map(core_1.ccc.hexFrom) ?? [])),
+        ], { script: this.script });
+        const resTx = res.map((res) => core_1.ccc.Transaction.fromBytes(res));
+        resTx.res.addCellDeps({
+            outPoint: this.code,
+            depType: "code",
+        });
+        return resTx;
+    }
+    /**
+     * Unpauses the UDT for the specified lock hashes. Note that this method is only available if the pausable UDT uses external pause list.
+     * @param tx - The transaction to be used.
+     * @param lockHashes - The array of lock hashes to be unpaused.
+     * @returns The transaction result.
+     * @tag Mutation - This method represents a mutation of the onchain state and will return a transaction to be sent.
+     */
+    async unpause(signer, locks, tx, extraLockHashes) {
+        const txReq = core_1.ccc.Transaction.from(tx ?? {});
+        await txReq.completeInputsAtLeastOne(signer);
+        const res = await this.assertExecutor().runScript(this.code, "UDTPausable.unpause", [
+            txReq.toBytes(),
+            core_1.ccc.mol.Byte32Vec.encode(locks
+                .map((l) => core_1.ccc.Script.from(l).hash())
+                .concat(extraLockHashes?.map(core_1.ccc.hexFrom) ?? [])),
+        ], { script: this.script });
+        const resTx = res.map((res) => core_1.ccc.Transaction.fromBytes(res));
+        resTx.res.addCellDeps({
+            outPoint: this.code,
+            depType: "code",
+        });
+        return resTx;
+    }
+    /**
+     * Checks if the UDT is paused for the specified lock hashes within a transaction. If not using external pause list, it can also be run on Code environment level.
+     * @param lockHashes - The lock hashes to check.
+     * @returns True if any of the lock hashes are paused, false otherwise.
+     */
+    async isPaused(locks, extraLockHashes) {
+        const res = await this.assertExecutor().runScript(this.code, "UDTPausable.is_paused", [
+            core_1.ccc.mol.Byte32Vec.encode(locks
+                .map((l) => core_1.ccc.Script.from(l).hash())
+                .concat(extraLockHashes?.map(core_1.ccc.hexFrom) ?? [])),
+        ], { script: this.script });
+        return res.map((res) => core_1.ccc.mol.BoolVec.decode(res));
+    }
+    /**
+     * Enumerates all paused lock hashes in UDTPausableData.
+     * @returns The array of lock hashes.
+     */
+    async enumeratePaused(offset, limit) {
+        const res = await this.assertExecutor().runScript(this.code, "UDTPausable.enumerate_paused", [core_1.ccc.numToBytes(offset ?? 0, 8), core_1.ccc.numToBytes(limit ?? 0, 8)], { script: this.script });
+        return res.map((res) => core_1.ccc.mol.Byte32Vec.decode(res));
+    }
+}
+exports.UdtPausable = UdtPausable;

package/jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+};

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@ckb-ccc/udt",
+  "version": "0.1.0",
+  "description": "UDT",
+  "author": "Alive24 <xct24@live.com>",
+  "license": "MIT",
+  "private": false,
+  "homepage": "https://github.com/ckb-devrel/ccc",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/ckb-devrel/ccc.git"
+  },
+  "main": "./dist.commonjs/index.js",
+  "module": "./dist/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "default": "./dist.commonjs/index.js"
+    },
+    "./advanced": {
+      "import": "./dist/advanced.js",
+      "default": "./dist.commonjs/advanced.js"
+    }
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.1.1",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^22.10.2",
+    "copyfiles": "^2.4.1",
+    "eslint": "^9.1.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "jest": "^29.7.0",
+    "prettier": "^3.2.5",
+    "prettier-plugin-organize-imports": "^3.2.4",
+    "rimraf": "^5.0.5",
+    "ts-jest": "^29.1.4",
+    "typescript": "^5.4.5",
+    "typescript-eslint": "^7.7.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@ckb-ccc/core": "1.3.0",
+    "@ckb-ccc/ssri": "0.1.0"
+  },
+  "scripts": {
+    "test": "jest",
+    "build": "rimraf ./dist && rimraf ./dist.commonjs && tsc && tsc --project tsconfig.commonjs.json && copyfiles -u 2 misc/basedirs/**/* .",
+    "lint": "eslint ./src",
+    "format": "prettier --write . && eslint --fix ./src"
+  }
+}

package/src/barrel.ts

@@ -0,0 +1,2 @@
+export * from "./udt/index.js";
+export * from "./udtPausable/index.js";

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./barrel.js";
+export * as udt from "./barrel.js";