@interest-protocol/blast-coin-sdk 0.0.0-stage → 0.2.0

package/README.md

@@ -1,3 +1,9 @@
-# Temporary Holding Version
+# @interest-protocol/blast-coin-sdk
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The coin package in the [Blast SDK monorepo](https://github.com/interest-protocol/blast-v2-sdk).
+
+```sh
+npm install @interest-protocol/blast-coin-sdk
+```
+
+See the repository README and docs for usage, development, and release guidance.

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./template.ts";
+export * from "./transactions.ts";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export * from "./template.js";
+export * from "./transactions.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC"}

package/dist/template.d.ts

@@ -0,0 +1,59 @@
+import type { BytecodeTemplateInitOptions } from "@interest-protocol/blast-core/bytecode-template";
+/**
+ * How the coin's supply may change after publication.
+ * - `mintable`: the `TreasuryCap` goes to `treasuryCapRecipient`, who may mint and burn.
+ * - `fixed`: the `TreasuryCap` is consumed; the supply never changes.
+ * - `burnOnly`: the `TreasuryCap` is consumed; any holder may burn through the `Currency`.
+ */
+export type CoinSupplyMode = {
+    kind: "mintable";
+    treasuryCapRecipient: string;
+} | {
+    kind: "fixed";
+} | {
+    kind: "burnOnly";
+};
+export type CoinTemplateOptions = {
+    /** ASCII printable; the Coin Registry rejects anything else. */
+    symbol: string;
+    name: string;
+    description: string;
+    iconUrl: string;
+    decimals: number;
+    /** Atomic units minted at publication; `0n` mints nothing (mintable only). */
+    initialSupply: bigint;
+    /** Receives the initial supply as one `Coin`. */
+    supplyRecipient: string;
+    supply: CoinSupplyMode;
+    /**
+     * Receives the `MetadataCap`; null deletes it, freezing the metadata for
+     * good.
+     */
+    metadataCapRecipient: string | null;
+    /** Defaults to the lowercased symbol; the witness is the uppercased module name. */
+    moduleName?: string;
+};
+export type CoinTemplateIdentifiers = {
+    moduleName: string;
+    witnessName: string;
+};
+/**
+ * Initializes the bytecode-template WASM helper, shared with the Meme template.
+ * A browser can supply its WASM URL when the bundler cannot discover the
+ * package asset automatically.
+ */
+export declare function initializeCoinTemplate(options?: BytecodeTemplateInitOptions): Promise<void>;
+/**
+ * Builds the one-module standalone coin package of contracts ADR 0108. Its
+ * initializer creates the currency through the Coin Registry, mints
+ * `initialSupply` to `supplyRecipient`, settles the `TreasuryCap` by the
+ * supply mode, and delivers or deletes the `MetadataCap`. It depends only on
+ * the Move standard library and the Sui framework: Blast holds no authority
+ * over the coin, and it can never launch on Blast.
+ */
+export declare function buildCoinPackageBytecode(options: CoinTemplateOptions): Promise<Uint8Array>;
+/** The coin module name and its uppercase one-time-witness name. */
+export declare function deriveCoinTemplateIdentifiers(symbol: string, requestedModuleName?: string): CoinTemplateIdentifiers;
+/** The packages a coin package links: the Move standard library and the Sui framework. */
+export declare const COIN_PACKAGE_DEPENDENCIES: readonly ["0x0000000000000000000000000000000000000000000000000000000000000001", "0x0000000000000000000000000000000000000000000000000000000000000002"];
+//# sourceMappingURL=template.d.ts.map

package/dist/template.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"template.d.ts","sourceRoot":"","sources":["../src/template.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,iDAAiD,CAAC;AAkDnG;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GACtB;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,oBAAoB,EAAE,MAAM,CAAA;CAAE,GAClD;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GACjB;IAAE,IAAI,EAAE,UAAU,CAAA;CAAE,CAAC;AAEzB,MAAM,MAAM,mBAAmB,GAAG;IAChC,gEAAgE;IAChE,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,8EAA8E;IAC9E,aAAa,EAAE,MAAM,CAAC;IACtB,iDAAiD;IACjD,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,cAAc,CAAC;IACvB;;;OAGG;IACH,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,oFAAoF;IACpF,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,sBAAsB,CACpC,OAAO,CAAC,EAAE,2BAA2B,GACpC,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;;;;;GAOG;AACH,wBAAsB,wBAAwB,CAC5C,OAAO,EAAE,mBAAmB,GAC3B,OAAO,CAAC,UAAU,CAAC,CA4FrB;AAED,oEAAoE;AACpE,wBAAgB,6BAA6B,CAC3C,MAAM,EAAE,MAAM,EACd,mBAAmB,CAAC,EAAE,MAAM,GAC3B,uBAAuB,CAEzB;AAED,0FAA0F;AAC1F,eAAO,MAAM,yBAAyB,uJAG5B,CAAC"}

package/dist/template.js

@@ -0,0 +1,207 @@
+import { assertIdentifierSlots, deriveTemplateIdentifiers, deserializeTemplate, initializeBytecodeTemplate, patchConstantSlots, requireNonEmptyString, requireString, } from "@interest-protocol/blast-core/bytecode-template";
+import { requireU64 } from "@interest-protocol/blast-core/integers";
+import { serialize, update_identifiers } from "@mysten/move-bytecode-template";
+import { bcs } from "@mysten/sui/bcs";
+import { fromBase64, isValidSuiAddress, MOVE_STDLIB_ADDRESS, normalizeSuiAddress, SUI_FRAMEWORK_ADDRESS, } from "@mysten/sui/utils";
+// Built from contracts/sui/coin_template/sources/my_coin.move at contracts
+// commit a1a8f6c9 with Sui CLI 1.77.2-51d177ad7d65; since 86d29e1 (ADR 0108)
+// the source only moved its error constant, which reorders the pool. SHA-256:
+// cdfdd72a9b0026afdbd9876a2d69f375ef02b5d39986b2e0c541413ac4de70cd
+const TEMPLATE_BYTECODE_BASE64 = "oRzrCwcAAAUKAQAMAgwkAzA5BGkSBXuPAQeKArkCCMMEYAajBaECCsQHBQzJB78BABEBFAIHAggCFQIWAAICAAEEBwACAAwBAAECBQwBAAEDAQABAAEDAwwBAAEFBgIAAA0AAQAACQIBAAEXAwQAAhAJCgEAAwsPEAEAAwwPAQEAAw4OAQEAAw8OAQEAAxIHCAECBBMMAQEMCAYDBgkLCQ0HBgYGBAYJEQUGAggABwgGAA0IAAIIAQgBCAEIAQMFAgUBBQcIBgEKAgEIAQQGAgILBAEIAAsDAQgAAQgABwkAAggBCAEIAQgBBwgGAgsEAQkACwMBCQADBwsDAQkAAwcIBgELAgEJAAELAgEIAAIJAAUBCwMBCAACBwsEAQkACwMBCQACCwQBCQAHCAYBCwUBCQABCwUBCAAEQ29pbhNDdXJyZW5jeUluaXRpYWxpemVyB01ZX0NPSU4LTWV0YWRhdGFDYXAGU3RyaW5nC1RyZWFzdXJ5Q2FwCVR4Q29udGV4dARjb2luDWNvaW5fcmVnaXN0cnkbY3JlYXRlX2FuZF9kZWxpdmVyX2N1cnJlbmN5C2R1bW15X2ZpZWxkCGZpbmFsaXplIGZpbmFsaXplX2FuZF9kZWxldGVfbWV0YWRhdGFfY2FwBGluaXQabWFrZV9zdXBwbHlfYnVybl9vbmx5X2luaXQWbWFrZV9zdXBwbHlfZml4ZWRfaW5pdARtaW50B215X2NvaW4VbmV3X2N1cnJlbmN5X3dpdGhfb3R3D3B1YmxpY190cmFuc2ZlcgZzdHJpbmcIdHJhbnNmZXIKdHhfY29udGV4dAR1dGY4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACCgIFBENPSU4KAggHTXkgQ29pbgoCGBdBIGNvaW4gY3JlYXRlZCBvbiBCbGFzdAoCGxpodHRwczovL2JsYXN0LmZ1bi9jb2luLnBuZwIBCQMIAABkp7O24A0FIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAF7hAgEBBSAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAB8qQEBAQUgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAPnoKAhMSRUludmFsaWRTdXBwbHlNb2RlCgJDQlRoZSBzdXBwbHkgbW9kZSBtdXN0IGJlIDAgKG1pbnRhYmxlKSwgMSAoZml4ZWQpLCBvciAyIChidXJuLW9ubHkpLgACAQoBAAAAAAETCwAHBAcAEQIHARECBwIRAgcDEQIHBQcGBwcHCAcJBwoLAREBAgABAAAABUQKCDECJQQFBQkLDAEGDAALAFIAAMAnCwALAQsCCwMLBAsFCgw4AAwQDA8KBgYAAAAAAAAAACQEHQ0QCwYKDDgBCwc4AgsIDA4ODgwNCg0UMQAhBCwLDQELEAsJOAMFOAsNFDEBIQQ1DQ8LEDgEBTgNDwsQOAULCgRACw8LDDgGCws4BwVDCw8LDDgIAgAA";
+const LABEL = "coin template";
+/** The template's placeholder module and one-time-witness names. */
+const PLACEHOLDERS = ["MY_COIN", "my_coin"];
+const defaults = {
+    symbol: bcs.string().serialize("COIN").toBytes(),
+    name: bcs.string().serialize("My Coin").toBytes(),
+    description: bcs.string().serialize("A coin created on Blast").toBytes(),
+    iconUrl: bcs.string().serialize("https://blast.fun/coin.png").toBytes(),
+    decimals: bcs.u8().serialize(9).toBytes(),
+    initialSupply: bcs.u64().serialize(1000000000000000000n).toBytes(),
+    supplyRecipient: bcs.Address.serialize("0x5ee1").toBytes(),
+    supplyMode: bcs.u8().serialize(1).toBytes(),
+    treasuryCapRecipient: bcs.Address.serialize("0x7ca9").toBytes(),
+    metadataMutable: bcs.bool().serialize(true).toBytes(),
+    metadataCapRecipient: bcs.Address.serialize("0x3e7a").toBytes(),
+};
+/** `SUPPLY_MODE` values the template's initializer accepts. */
+const SUPPLY_MODES = { mintable: 0, fixed: 1, burnOnly: 2 };
+/**
+ * Initializes the bytecode-template WASM helper, shared with the Meme template.
+ * A browser can supply its WASM URL when the bundler cannot discover the
+ * package asset automatically.
+ */
+export function initializeCoinTemplate(options) {
+    return initializeBytecodeTemplate(options);
+}
+/**
+ * Builds the one-module standalone coin package of contracts ADR 0108. Its
+ * initializer creates the currency through the Coin Registry, mints
+ * `initialSupply` to `supplyRecipient`, settles the `TreasuryCap` by the
+ * supply mode, and delivers or deletes the `MetadataCap`. It depends only on
+ * the Move standard library and the Sui framework: Blast holds no authority
+ * over the coin, and it can never launch on Blast.
+ */
+export async function buildCoinPackageBytecode(options) {
+    const settings = validateCoinOptions(options);
+    const identifiers = deriveCoinTemplateIdentifiers(settings.symbol, options.moduleName);
+    await initializeCoinTemplate();
+    const compiled = deserializeTemplate(LABEL, fromBase64(TEMPLATE_BYTECODE_BASE64));
+    assertIdentifierSlots(LABEL, compiled, PLACEHOLDERS, identifiers);
+    patchConstantSlots(LABEL, compiled, [
+        {
+            name: "symbol",
+            type: "Vector(U8)",
+            expected: defaults.symbol,
+            replacement: bcs.string().serialize(settings.symbol).toBytes(),
+        },
+        {
+            name: "name",
+            type: "Vector(U8)",
+            expected: defaults.name,
+            replacement: bcs.string().serialize(settings.name).toBytes(),
+        },
+        {
+            name: "description",
+            type: "Vector(U8)",
+            expected: defaults.description,
+            replacement: bcs.string().serialize(settings.description).toBytes(),
+        },
+        {
+            name: "iconUrl",
+            type: "Vector(U8)",
+            expected: defaults.iconUrl,
+            replacement: bcs.string().serialize(settings.iconUrl).toBytes(),
+        },
+        {
+            name: "decimals",
+            type: "U8",
+            expected: defaults.decimals,
+            replacement: bcs.u8().serialize(settings.decimals).toBytes(),
+        },
+        {
+            name: "initialSupply",
+            type: "U64",
+            expected: defaults.initialSupply,
+            replacement: bcs.u64().serialize(settings.initialSupply).toBytes(),
+        },
+        {
+            name: "supplyRecipient",
+            type: "Address",
+            expected: defaults.supplyRecipient,
+            replacement: bcs.Address.serialize(settings.supplyRecipient).toBytes(),
+        },
+        {
+            name: "supplyMode",
+            type: "U8",
+            expected: defaults.supplyMode,
+            replacement: bcs.u8().serialize(settings.supplyMode).toBytes(),
+        },
+        {
+            name: "treasuryCapRecipient",
+            type: "Address",
+            expected: defaults.treasuryCapRecipient,
+            replacement: bcs.Address.serialize(settings.treasuryCapRecipient).toBytes(),
+        },
+        {
+            name: "metadataMutable",
+            type: "Bool",
+            expected: defaults.metadataMutable,
+            replacement: bcs.bool().serialize(settings.metadataMutable).toBytes(),
+        },
+        {
+            name: "metadataCapRecipient",
+            type: "Address",
+            expected: defaults.metadataCapRecipient,
+            replacement: bcs.Address.serialize(settings.metadataCapRecipient).toBytes(),
+        },
+    ]);
+    const bytecode = update_identifiers(serialize(compiled), {
+        MY_COIN: identifiers.witnessName,
+        my_coin: identifiers.moduleName,
+    });
+    assertCoinTemplateWiring(bytecode, identifiers);
+    return bytecode;
+}
+/** The coin module name and its uppercase one-time-witness name. */
+export function deriveCoinTemplateIdentifiers(symbol, requestedModuleName) {
+    return deriveTemplateIdentifiers(symbol, requestedModuleName);
+}
+/** The packages a coin package links: the Move standard library and the Sui framework. */
+export const COIN_PACKAGE_DEPENDENCIES = [
+    MOVE_STDLIB_ADDRESS,
+    SUI_FRAMEWORK_ADDRESS,
+];
+/**
+ * Checks every option before patching, so the initializer cannot abort at
+ * publication: a printable symbol, a `u8` precision, a `u64` supply that is
+ * nonzero unless mintable, and nonzero recipients. A recipient the mode
+ * leaves unused keeps the template default.
+ */
+function validateCoinOptions(options) {
+    if (typeof options !== "object" || options === null) {
+        throw new TypeError("coin template options are required");
+    }
+    const symbol = requireNonEmptyString("symbol", options.symbol);
+    if (!/^[\x20-\x7e]+$/.test(symbol)) {
+        throw new RangeError("symbol must be ASCII printable");
+    }
+    const { decimals } = options;
+    if (!Number.isInteger(decimals) || decimals < 0 || decimals > 255) {
+        throw new RangeError("decimals must be a u8");
+    }
+    if (typeof options.initialSupply !== "bigint") {
+        throw new TypeError("initialSupply must be a bigint");
+    }
+    const initialSupply = requireU64("initialSupply", options.initialSupply);
+    const { supply } = options;
+    const supplyMode = SUPPLY_MODES[supply?.kind];
+    if (supplyMode === undefined) {
+        throw new TypeError("supply.kind must be mintable, fixed, or burnOnly");
+    }
+    if (supply.kind !== "mintable" && initialSupply === 0n) {
+        throw new RangeError("a fixed or burn-only supply must mint a nonzero initial supply");
+    }
+    const metadataMutable = options.metadataCapRecipient !== null;
+    return {
+        symbol,
+        name: requireNonEmptyString("name", options.name),
+        description: requireString("description", options.description),
+        iconUrl: requireString("iconUrl", options.iconUrl),
+        decimals,
+        initialSupply,
+        supplyRecipient: initialSupply
+            ? recipient("supplyRecipient", options.supplyRecipient)
+            : normalizeSuiAddress("0x5ee1"),
+        supplyMode,
+        treasuryCapRecipient: supply.kind === "mintable"
+            ? recipient("supply.treasuryCapRecipient", supply.treasuryCapRecipient)
+            : normalizeSuiAddress("0x7ca9"),
+        metadataMutable,
+        metadataCapRecipient: metadataMutable
+            ? recipient("metadataCapRecipient", options.metadataCapRecipient ?? "")
+            : normalizeSuiAddress("0x3e7a"),
+    };
+}
+function recipient(name, address) {
+    if (typeof address !== "string") {
+        throw new TypeError(`${name} must be a string`);
+    }
+    const normalized = normalizeSuiAddress(address);
+    if (!isValidSuiAddress(normalized) || BigInt(normalized) === 0n) {
+        throw new RangeError(`${name} must be a nonzero Sui address`);
+    }
+    return normalized;
+}
+function assertCoinTemplateWiring(bytecode, identifiers) {
+    const compiled = deserializeTemplate(LABEL, bytecode);
+    if (!compiled.identifiers.includes(identifiers.moduleName) ||
+        !compiled.identifiers.includes(identifiers.witnessName)) {
+        throw new TypeError("coin template identifiers were not patched");
+    }
+    const systemAddresses = new Set([normalizeSuiAddress("0x0"), ...COIN_PACKAGE_DEPENDENCIES].map((address) => normalizeSuiAddress(address).slice(2)));
+    if (!compiled.address_identifiers.every((address) => systemAddresses.has(address))) {
+        throw new TypeError("coin template must link only 0x1 and 0x2");
+    }
+}
+//# sourceMappingURL=template.js.map

package/dist/template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"template.js","sourceRoot":"","sources":["../src/template.ts"],"names":[],"mappings":"AACA,OAAO,EACL,qBAAqB,EACrB,yBAAyB,EACzB,mBAAmB,EACnB,0BAA0B,EAC1B,kBAAkB,EAClB,qBAAqB,EACrB,aAAa,GACd,MAAM,iDAAiD,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,wCAAwC,CAAC;AACpE,OAAO,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAC/E,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AACtC,OAAO,EACL,UAAU,EACV,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,GACtB,MAAM,mBAAmB,CAAC;AAE3B,2EAA2E;AAC3E,6EAA6E;AAC7E,8EAA8E;AAC9E,mEAAmE;AACnE,MAAM,wBAAwB,GAC5B,8kDAA8kD,CAAC;AAEjlD,MAAM,KAAK,GAAG,eAAe,CAAC;AAE9B,oEAAoE;AACpE,MAAM,YAAY,GAAG,CAAC,SAAS,EAAE,SAAS,CAAU,CAAC;AAErD,MAAM,QAAQ,GAAG;IACf,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE;IAChD,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE;IACjD,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,yBAAyB,CAAC,CAAC,OAAO,EAAE;IACxE,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,4BAA4B,CAAC,CAAC,OAAO,EAAE;IACvE,QAAQ,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE;IACzC,aAAa,EAAE,GAAG,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,oBAA0B,CAAC,CAAC,OAAO,EAAE;IACxE,eAAe,EAAE,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE;IAC1D,UAAU,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE;IAC3C,oBAAoB,EAAE,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE;IAC/D,eAAe,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE;IACrD,oBAAoB,EAAE,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE;CACvD,CAAC;AAEX,+DAA+D;AAC/D,MAAM,YAAY,GAAG,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAW,CAAC;AAuCrE;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CACpC,OAAqC;IAErC,OAAO,0BAA0B,CAAC,OAAO,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,OAA4B;IAE5B,MAAM,QAAQ,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAC9C,MAAM,WAAW,GAAG,6BAA6B,CAC/C,QAAQ,CAAC,MAAM,EACf,OAAO,CAAC,UAAU,CACnB,CAAC;IACF,MAAM,sBAAsB,EAAE,CAAC;IAE/B,MAAM,QAAQ,GAAG,mBAAmB,CAClC,KAAK,EACL,UAAU,CAAC,wBAAwB,CAAC,CACrC,CAAC;IACF,qBAAqB,CAAC,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;IAClE,kBAAkB,CAAC,KAAK,EAAE,QAAQ,EAAE;QAClC;YACE,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,YAAY;YAClB,QAAQ,EAAE,QAAQ,CAAC,MAAM;YACzB,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE;SAC/D;QACD;YACE,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,YAAY;YAClB,QAAQ,EAAE,QAAQ,CAAC,IAAI;YACvB,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE;SAC7D;QACD;YACE,IAAI,EAAE,aAAa;YACnB,IAAI,EAAE,YAAY;YAClB,QAAQ,EAAE,QAAQ,CAAC,WAAW;YAC9B,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE;SACpE;QACD;YACE,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,YAAY;YAClB,QAAQ,EAAE,QAAQ,CAAC,OAAO;YAC1B,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE;SAChE;QACD;YACE,IAAI,EAAE,UAAU;YAChB,IAAI,EAAE,IAAI;YACV,QAAQ,EAAE,QAAQ,CAAC,QAAQ;YAC3B,WAAW,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE;SAC7D;QACD;YACE,IAAI,EAAE,eAAe;YACrB,IAAI,EAAE,KAAK;YACX,QAAQ,EAAE,QAAQ,CAAC,aAAa;YAChC,WAAW,EAAE,GAAG,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,OAAO,EAAE;SACnE;QACD;YACE,IAAI,EAAE,iBAAiB;YACvB,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,QAAQ,CAAC,eAAe;YAClC,WAAW,EAAE,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,OAAO,EAAE;SACvE;QACD;YACE,IAAI,EAAE,YAAY;YAClB,IAAI,EAAE,IAAI;YACV,QAAQ,EAAE,QAAQ,CAAC,UAAU;YAC7B,WAAW,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,OAAO,EAAE;SAC/D;QACD;YACE,IAAI,EAAE,sBAAsB;YAC5B,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,QAAQ,CAAC,oBAAoB;YACvC,WAAW,EAAE,GAAG,CAAC,OAAO,CAAC,SAAS,CAChC,QAAQ,CAAC,oBAAoB,CAC9B,CAAC,OAAO,EAAE;SACZ;QACD;YACE,IAAI,EAAE,iBAAiB;YACvB,IAAI,EAAE,MAAM;YACZ,QAAQ,EAAE,QAAQ,CAAC,eAAe;YAClC,WAAW,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,OAAO,EAAE;SACtE;QACD;YACE,IAAI,EAAE,sBAAsB;YAC5B,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,QAAQ,CAAC,oBAAoB;YACvC,WAAW,EAAE,GAAG,CAAC,OAAO,CAAC,SAAS,CAChC,QAAQ,CAAC,oBAAoB,CAC9B,CAAC,OAAO,EAAE;SACZ;KACF,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,kBAAkB,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE;QACvD,OAAO,EAAE,WAAW,CAAC,WAAW;QAChC,OAAO,EAAE,WAAW,CAAC,UAAU;KAChC,CAAC,CAAC;IACH,wBAAwB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IAChD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,oEAAoE;AACpE,MAAM,UAAU,6BAA6B,CAC3C,MAAc,EACd,mBAA4B;IAE5B,OAAO,yBAAyB,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;AAChE,CAAC;AAED,0FAA0F;AAC1F,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACvC,mBAAmB;IACnB,qBAAqB;CACb,CAAC;AAEX;;;;;GAKG;AACH,SAAS,mBAAmB,CAAC,OAA4B;IACvD,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACpD,MAAM,IAAI,SAAS,CAAC,oCAAoC,CAAC,CAAC;IAC5D,CAAC;IACD,MAAM,MAAM,GAAG,qBAAqB,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/D,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,UAAU,CAAC,gCAAgC,CAAC,CAAC;IACzD,CAAC;IACD,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;IAC7B,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,QAAQ,GAAG,CAAC,IAAI,QAAQ,GAAG,GAAG,EAAE,CAAC;QAClE,MAAM,IAAI,UAAU,CAAC,uBAAuB,CAAC,CAAC;IAChD,CAAC;IACD,IAAI,OAAO,OAAO,CAAC,aAAa,KAAK,QAAQ,EAAE,CAAC;QAC9C,MAAM,IAAI,SAAS,CAAC,gCAAgC,CAAC,CAAC;IACxD,CAAC;IACD,MAAM,aAAa,GAAG,UAAU,CAAC,eAAe,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;IACzE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAC3B,MAAM,UAAU,GAAG,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC9C,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,MAAM,IAAI,SAAS,CAAC,kDAAkD,CAAC,CAAC;IAC1E,CAAC;IACD,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU,IAAI,aAAa,KAAK,EAAE,EAAE,CAAC;QACvD,MAAM,IAAI,UAAU,CAClB,gEAAgE,CACjE,CAAC;IACJ,CAAC;IACD,MAAM,eAAe,GAAG,OAAO,CAAC,oBAAoB,KAAK,IAAI,CAAC;IAE9D,OAAO;QACL,MAAM;QACN,IAAI,EAAE,qBAAqB,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC;QACjD,WAAW,EAAE,aAAa,CAAC,aAAa,EAAE,OAAO,CAAC,WAAW,CAAC;QAC9D,OAAO,EAAE,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC;QAClD,QAAQ;QACR,aAAa;QACb,eAAe,EAAE,aAAa;YAC5B,CAAC,CAAC,SAAS,CAAC,iBAAiB,EAAE,OAAO,CAAC,eAAe,CAAC;YACvD,CAAC,CAAC,mBAAmB,CAAC,QAAQ,CAAC;QACjC,UAAU;QACV,oBAAoB,EAClB,MAAM,CAAC,IAAI,KAAK,UAAU;YACxB,CAAC,CAAC,SAAS,CAAC,6BAA6B,EAAE,MAAM,CAAC,oBAAoB,CAAC;YACvE,CAAC,CAAC,mBAAmB,CAAC,QAAQ,CAAC;QACnC,eAAe;QACf,oBAAoB,EAAE,eAAe;YACnC,CAAC,CAAC,SAAS,CAAC,sBAAsB,EAAE,OAAO,CAAC,oBAAoB,IAAI,EAAE,CAAC;YACvE,CAAC,CAAC,mBAAmB,CAAC,QAAQ,CAAC;KAClC,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,IAAY,EAAE,OAAe;IAC9C,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAChC,MAAM,IAAI,SAAS,CAAC,GAAG,IAAI,mBAAmB,CAAC,CAAC;IAClD,CAAC;IACD,MAAM,UAAU,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAChD,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,CAAC;QAChE,MAAM,IAAI,UAAU,CAAC,GAAG,IAAI,gCAAgC,CAAC,CAAC;IAChE,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,SAAS,wBAAwB,CAC/B,QAAoB,EACpB,WAAoC;IAEpC,MAAM,QAAQ,GAAG,mBAAmB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACtD,IACE,CAAC,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC;QACtD,CAAC,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,WAAW,CAAC,EACvD,CAAC;QACD,MAAM,IAAI,SAAS,CAAC,4CAA4C,CAAC,CAAC;IACpE,CAAC;IACD,MAAM,eAAe,GAAG,IAAI,GAAG,CAC7B,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE,GAAG,yBAAyB,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CACzE,mBAAmB,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CACtC,CACF,CAAC;IACF,IACE,CAAC,QAAQ,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,EAAE,CAC9C,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,CAC7B,EACD,CAAC;QACD,MAAM,IAAI,SAAS,CAAC,0CAA0C,CAAC,CAAC;IAClE,CAAC;AACH,CAAC"}

package/dist/transactions.d.ts

@@ -0,0 +1,24 @@
+import type { TransactionObjectInput } from "@mysten/sui/transactions";
+import { Transaction } from "@mysten/sui/transactions";
+import type { CoinTemplateOptions } from "./template.ts";
+export type CoinPublication = CoinTemplateOptions & {
+    /**
+     * Receives the package's `UpgradeCap`; null makes the package immutable in
+     * the same transaction, so nobody can ever change the coin's module.
+     */
+    upgradeCapRecipient: string | null;
+};
+/**
+ * Publishes a standalone coin from the coin template (contracts ADR 0108).
+ * The initializer runs at publication and delivers the supply and the
+ * capabilities to the recipients `options` names; its `Currency` goes to the
+ * Coin Registry address, where anyone may share it with
+ * `coin_registry::finalize_registration` in a later transaction.
+ */
+export declare function publishCoin(options: CoinPublication): Transaction;
+/** Shares a published coin's pending Currency from the Coin Registry address. */
+export declare function finalizeCoinRegistration(tx: Transaction, options: {
+    coinType: string;
+    currency: TransactionObjectInput;
+}): void;
+//# sourceMappingURL=transactions.d.ts.map

package/dist/transactions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactions.d.ts","sourceRoot":"","sources":["../src/transactions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAOvD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAMzD,MAAM,MAAM,eAAe,GAAG,mBAAmB,GAAG;IAClD;;;OAGG;IACH,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,eAAe,GAAG,WAAW,CAqBjE;AAED,iFAAiF;AACjF,wBAAgB,wBAAwB,CACtC,EAAE,EAAE,WAAW,EACf,OAAO,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,sBAAsB,CAAA;CAAE,GAC9D,IAAI,CAMN"}

package/dist/transactions.js

@@ -0,0 +1,39 @@
+import { Transaction } from "@mysten/sui/transactions";
+import { normalizeStructTag, normalizeSuiAddress, SUI_FRAMEWORK_ADDRESS, } from "@mysten/sui/utils";
+import { buildCoinPackageBytecode, COIN_PACKAGE_DEPENDENCIES, } from "./template.js";
+/**
+ * Publishes a standalone coin from the coin template (contracts ADR 0108).
+ * The initializer runs at publication and delivers the supply and the
+ * capabilities to the recipients `options` names; its `Currency` goes to the
+ * Coin Registry address, where anyone may share it with
+ * `coin_registry::finalize_registration` in a later transaction.
+ */
+export function publishCoin(options) {
+    const tx = new Transaction();
+    const upgradeCap = tx.add(async (innerTx) => {
+        const module = await buildCoinPackageBytecode(options);
+        return innerTx.publish({
+            modules: [Array.from(module)],
+            dependencies: [...COIN_PACKAGE_DEPENDENCIES],
+        });
+    });
+    if (options.upgradeCapRecipient === null) {
+        tx.moveCall({
+            target: `${SUI_FRAMEWORK_ADDRESS}::package::make_immutable`,
+            arguments: [upgradeCap],
+        });
+    }
+    else {
+        tx.transferObjects([upgradeCap], normalizeSuiAddress(options.upgradeCapRecipient));
+    }
+    return tx;
+}
+/** Shares a published coin's pending Currency from the Coin Registry address. */
+export function finalizeCoinRegistration(tx, options) {
+    tx.moveCall({
+        target: `${SUI_FRAMEWORK_ADDRESS}::coin_registry::finalize_registration`,
+        typeArguments: [normalizeStructTag(options.coinType)],
+        arguments: [tx.object("0xc"), tx.object(options.currency)],
+    });
+}
+//# sourceMappingURL=transactions.js.map

package/dist/transactions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactions.js","sourceRoot":"","sources":["../src/transactions.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EACL,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,GACtB,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EACL,wBAAwB,EACxB,yBAAyB,GAC1B,MAAM,eAAe,CAAC;AAUvB;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,OAAwB;IAClD,MAAM,EAAE,GAAG,IAAI,WAAW,EAAE,CAAC;IAC7B,MAAM,UAAU,GAAG,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;QAC1C,MAAM,MAAM,GAAG,MAAM,wBAAwB,CAAC,OAAO,CAAC,CAAC;QACvD,OAAO,OAAO,CAAC,OAAO,CAAC;YACrB,OAAO,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC7B,YAAY,EAAE,CAAC,GAAG,yBAAyB,CAAC;SAC7C,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,IAAI,OAAO,CAAC,mBAAmB,KAAK,IAAI,EAAE,CAAC;QACzC,EAAE,CAAC,QAAQ,CAAC;YACV,MAAM,EAAE,GAAG,qBAAqB,2BAA2B;YAC3D,SAAS,EAAE,CAAC,UAAU,CAAC;SACxB,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,EAAE,CAAC,eAAe,CAChB,CAAC,UAAU,CAAC,EACZ,mBAAmB,CAAC,OAAO,CAAC,mBAAmB,CAAC,CACjD,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,iFAAiF;AACjF,MAAM,UAAU,wBAAwB,CACtC,EAAe,EACf,OAA+D;IAE/D,EAAE,CAAC,QAAQ,CAAC;QACV,MAAM,EAAE,GAAG,qBAAqB,wCAAwC;QACxE,aAAa,EAAE,CAAC,kBAAkB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACrD,SAAS,EAAE,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;KAC3D,CAAC,CAAC;AACL,CAAC"}

package/package.json

@@ -1,6 +1,50 @@
 {
   "name": "@interest-protocol/blast-coin-sdk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.0",
+  "description": "Blast coin SDK",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/interest-protocol/blast-v2-sdk.git",
+    "directory": "packages/coin"
+  },
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "src"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./template": {
+      "types": "./dist/template.d.ts",
+      "default": "./dist/template.js"
+    },
+    "./transactions": {
+      "types": "./dist/transactions.d.ts",
+      "default": "./dist/transactions.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "scripts": {
+    "build": "node --eval \"fs.rmSync('dist', { recursive: true, force: true })\" && tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "check:package": "publint --strict && attw --pack . --profile esm-only",
+    "prepack": "npm run build"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@interest-protocol/blast-core": "0.2.0"
+  },
+  "peerDependencies": {
+    "@mysten/move-bytecode-template": "^0.4.1",
+    "@mysten/sui": "^2.26.2"
+  }
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./template.ts";
+export * from "./transactions.ts";

package/src/template.ts

@@ -0,0 +1,307 @@
+import type { BytecodeTemplateInitOptions } from "@interest-protocol/blast-core/bytecode-template";
+import {
+  assertIdentifierSlots,
+  deriveTemplateIdentifiers,
+  deserializeTemplate,
+  initializeBytecodeTemplate,
+  patchConstantSlots,
+  requireNonEmptyString,
+  requireString,
+} from "@interest-protocol/blast-core/bytecode-template";
+import { requireU64 } from "@interest-protocol/blast-core/integers";
+import { serialize, update_identifiers } from "@mysten/move-bytecode-template";
+import { bcs } from "@mysten/sui/bcs";
+import {
+  fromBase64,
+  isValidSuiAddress,
+  MOVE_STDLIB_ADDRESS,
+  normalizeSuiAddress,
+  SUI_FRAMEWORK_ADDRESS,
+} from "@mysten/sui/utils";
+
+// Built from contracts/sui/coin_template/sources/my_coin.move at contracts
+// commit a1a8f6c9 with Sui CLI 1.77.2-51d177ad7d65; since 86d29e1 (ADR 0108)
+// the source only moved its error constant, which reorders the pool. SHA-256:
+// cdfdd72a9b0026afdbd9876a2d69f375ef02b5d39986b2e0c541413ac4de70cd
+const TEMPLATE_BYTECODE_BASE64 =
+  "oRzrCwcAAAUKAQAMAgwkAzA5BGkSBXuPAQeKArkCCMMEYAajBaECCsQHBQzJB78BABEBFAIHAggCFQIWAAICAAEEBwACAAwBAAECBQwBAAEDAQABAAEDAwwBAAEFBgIAAA0AAQAACQIBAAEXAwQAAhAJCgEAAwsPEAEAAwwPAQEAAw4OAQEAAw8OAQEAAxIHCAECBBMMAQEMCAYDBgkLCQ0HBgYGBAYJEQUGAggABwgGAA0IAAIIAQgBCAEIAQMFAgUBBQcIBgEKAgEIAQQGAgILBAEIAAsDAQgAAQgABwkAAggBCAEIAQgBBwgGAgsEAQkACwMBCQADBwsDAQkAAwcIBgELAgEJAAELAgEIAAIJAAUBCwMBCAACBwsEAQkACwMBCQACCwQBCQAHCAYBCwUBCQABCwUBCAAEQ29pbhNDdXJyZW5jeUluaXRpYWxpemVyB01ZX0NPSU4LTWV0YWRhdGFDYXAGU3RyaW5nC1RyZWFzdXJ5Q2FwCVR4Q29udGV4dARjb2luDWNvaW5fcmVnaXN0cnkbY3JlYXRlX2FuZF9kZWxpdmVyX2N1cnJlbmN5C2R1bW15X2ZpZWxkCGZpbmFsaXplIGZpbmFsaXplX2FuZF9kZWxldGVfbWV0YWRhdGFfY2FwBGluaXQabWFrZV9zdXBwbHlfYnVybl9vbmx5X2luaXQWbWFrZV9zdXBwbHlfZml4ZWRfaW5pdARtaW50B215X2NvaW4VbmV3X2N1cnJlbmN5X3dpdGhfb3R3D3B1YmxpY190cmFuc2ZlcgZzdHJpbmcIdHJhbnNmZXIKdHhfY29udGV4dAR1dGY4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACCgIFBENPSU4KAggHTXkgQ29pbgoCGBdBIGNvaW4gY3JlYXRlZCBvbiBCbGFzdAoCGxpodHRwczovL2JsYXN0LmZ1bi9jb2luLnBuZwIBCQMIAABkp7O24A0FIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAF7hAgEBBSAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAB8qQEBAQUgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAPnoKAhMSRUludmFsaWRTdXBwbHlNb2RlCgJDQlRoZSBzdXBwbHkgbW9kZSBtdXN0IGJlIDAgKG1pbnRhYmxlKSwgMSAoZml4ZWQpLCBvciAyIChidXJuLW9ubHkpLgACAQoBAAAAAAETCwAHBAcAEQIHARECBwIRAgcDEQIHBQcGBwcHCAcJBwoLAREBAgABAAAABUQKCDECJQQFBQkLDAEGDAALAFIAAMAnCwALAQsCCwMLBAsFCgw4AAwQDA8KBgYAAAAAAAAAACQEHQ0QCwYKDDgBCwc4AgsIDA4ODgwNCg0UMQAhBCwLDQELEAsJOAMFOAsNFDEBIQQ1DQ8LEDgEBTgNDwsQOAULCgRACw8LDDgGCws4BwVDCw8LDDgIAgAA";
+
+const LABEL = "coin template";
+
+/** The template's placeholder module and one-time-witness names. */
+const PLACEHOLDERS = ["MY_COIN", "my_coin"] as const;
+
+const defaults = {
+  symbol: bcs.string().serialize("COIN").toBytes(),
+  name: bcs.string().serialize("My Coin").toBytes(),
+  description: bcs.string().serialize("A coin created on Blast").toBytes(),
+  iconUrl: bcs.string().serialize("https://blast.fun/coin.png").toBytes(),
+  decimals: bcs.u8().serialize(9).toBytes(),
+  initialSupply: bcs.u64().serialize(1_000_000_000_000_000_000n).toBytes(),
+  supplyRecipient: bcs.Address.serialize("0x5ee1").toBytes(),
+  supplyMode: bcs.u8().serialize(1).toBytes(),
+  treasuryCapRecipient: bcs.Address.serialize("0x7ca9").toBytes(),
+  metadataMutable: bcs.bool().serialize(true).toBytes(),
+  metadataCapRecipient: bcs.Address.serialize("0x3e7a").toBytes(),
+} as const;
+
+/** `SUPPLY_MODE` values the template's initializer accepts. */
+const SUPPLY_MODES = { mintable: 0, fixed: 1, burnOnly: 2 } as const;
+
+/**
+ * How the coin's supply may change after publication.
+ * - `mintable`: the `TreasuryCap` goes to `treasuryCapRecipient`, who may mint and burn.
+ * - `fixed`: the `TreasuryCap` is consumed; the supply never changes.
+ * - `burnOnly`: the `TreasuryCap` is consumed; any holder may burn through the `Currency`.
+ */
+export type CoinSupplyMode =
+  | { kind: "mintable"; treasuryCapRecipient: string }
+  | { kind: "fixed" }
+  | { kind: "burnOnly" };
+
+export type CoinTemplateOptions = {
+  /** ASCII printable; the Coin Registry rejects anything else. */
+  symbol: string;
+  name: string;
+  description: string;
+  iconUrl: string;
+  decimals: number;
+  /** Atomic units minted at publication; `0n` mints nothing (mintable only). */
+  initialSupply: bigint;
+  /** Receives the initial supply as one `Coin`. */
+  supplyRecipient: string;
+  supply: CoinSupplyMode;
+  /**
+   * Receives the `MetadataCap`; null deletes it, freezing the metadata for
+   * good.
+   */
+  metadataCapRecipient: string | null;
+  /** Defaults to the lowercased symbol; the witness is the uppercased module name. */
+  moduleName?: string;
+};
+
+export type CoinTemplateIdentifiers = {
+  moduleName: string;
+  witnessName: string;
+};
+
+/**
+ * Initializes the bytecode-template WASM helper, shared with the Meme template.
+ * A browser can supply its WASM URL when the bundler cannot discover the
+ * package asset automatically.
+ */
+export function initializeCoinTemplate(
+  options?: BytecodeTemplateInitOptions,
+): Promise<void> {
+  return initializeBytecodeTemplate(options);
+}
+
+/**
+ * Builds the one-module standalone coin package of contracts ADR 0108. Its
+ * initializer creates the currency through the Coin Registry, mints
+ * `initialSupply` to `supplyRecipient`, settles the `TreasuryCap` by the
+ * supply mode, and delivers or deletes the `MetadataCap`. It depends only on
+ * the Move standard library and the Sui framework: Blast holds no authority
+ * over the coin, and it can never launch on Blast.
+ */
+export async function buildCoinPackageBytecode(
+  options: CoinTemplateOptions,
+): Promise<Uint8Array> {
+  const settings = validateCoinOptions(options);
+  const identifiers = deriveCoinTemplateIdentifiers(
+    settings.symbol,
+    options.moduleName,
+  );
+  await initializeCoinTemplate();
+
+  const compiled = deserializeTemplate(
+    LABEL,
+    fromBase64(TEMPLATE_BYTECODE_BASE64),
+  );
+  assertIdentifierSlots(LABEL, compiled, PLACEHOLDERS, identifiers);
+  patchConstantSlots(LABEL, compiled, [
+    {
+      name: "symbol",
+      type: "Vector(U8)",
+      expected: defaults.symbol,
+      replacement: bcs.string().serialize(settings.symbol).toBytes(),
+    },
+    {
+      name: "name",
+      type: "Vector(U8)",
+      expected: defaults.name,
+      replacement: bcs.string().serialize(settings.name).toBytes(),
+    },
+    {
+      name: "description",
+      type: "Vector(U8)",
+      expected: defaults.description,
+      replacement: bcs.string().serialize(settings.description).toBytes(),
+    },
+    {
+      name: "iconUrl",
+      type: "Vector(U8)",
+      expected: defaults.iconUrl,
+      replacement: bcs.string().serialize(settings.iconUrl).toBytes(),
+    },
+    {
+      name: "decimals",
+      type: "U8",
+      expected: defaults.decimals,
+      replacement: bcs.u8().serialize(settings.decimals).toBytes(),
+    },
+    {
+      name: "initialSupply",
+      type: "U64",
+      expected: defaults.initialSupply,
+      replacement: bcs.u64().serialize(settings.initialSupply).toBytes(),
+    },
+    {
+      name: "supplyRecipient",
+      type: "Address",
+      expected: defaults.supplyRecipient,
+      replacement: bcs.Address.serialize(settings.supplyRecipient).toBytes(),
+    },
+    {
+      name: "supplyMode",
+      type: "U8",
+      expected: defaults.supplyMode,
+      replacement: bcs.u8().serialize(settings.supplyMode).toBytes(),
+    },
+    {
+      name: "treasuryCapRecipient",
+      type: "Address",
+      expected: defaults.treasuryCapRecipient,
+      replacement: bcs.Address.serialize(
+        settings.treasuryCapRecipient,
+      ).toBytes(),
+    },
+    {
+      name: "metadataMutable",
+      type: "Bool",
+      expected: defaults.metadataMutable,
+      replacement: bcs.bool().serialize(settings.metadataMutable).toBytes(),
+    },
+    {
+      name: "metadataCapRecipient",
+      type: "Address",
+      expected: defaults.metadataCapRecipient,
+      replacement: bcs.Address.serialize(
+        settings.metadataCapRecipient,
+      ).toBytes(),
+    },
+  ]);
+
+  const bytecode = update_identifiers(serialize(compiled), {
+    MY_COIN: identifiers.witnessName,
+    my_coin: identifiers.moduleName,
+  });
+  assertCoinTemplateWiring(bytecode, identifiers);
+  return bytecode;
+}
+
+/** The coin module name and its uppercase one-time-witness name. */
+export function deriveCoinTemplateIdentifiers(
+  symbol: string,
+  requestedModuleName?: string,
+): CoinTemplateIdentifiers {
+  return deriveTemplateIdentifiers(symbol, requestedModuleName);
+}
+
+/** The packages a coin package links: the Move standard library and the Sui framework. */
+export const COIN_PACKAGE_DEPENDENCIES = [
+  MOVE_STDLIB_ADDRESS,
+  SUI_FRAMEWORK_ADDRESS,
+] as const;
+
+/**
+ * Checks every option before patching, so the initializer cannot abort at
+ * publication: a printable symbol, a `u8` precision, a `u64` supply that is
+ * nonzero unless mintable, and nonzero recipients. A recipient the mode
+ * leaves unused keeps the template default.
+ */
+function validateCoinOptions(options: CoinTemplateOptions) {
+  if (typeof options !== "object" || options === null) {
+    throw new TypeError("coin template options are required");
+  }
+  const symbol = requireNonEmptyString("symbol", options.symbol);
+  if (!/^[\x20-\x7e]+$/.test(symbol)) {
+    throw new RangeError("symbol must be ASCII printable");
+  }
+  const { decimals } = options;
+  if (!Number.isInteger(decimals) || decimals < 0 || decimals > 255) {
+    throw new RangeError("decimals must be a u8");
+  }
+  if (typeof options.initialSupply !== "bigint") {
+    throw new TypeError("initialSupply must be a bigint");
+  }
+  const initialSupply = requireU64("initialSupply", options.initialSupply);
+  const { supply } = options;
+  const supplyMode = SUPPLY_MODES[supply?.kind];
+  if (supplyMode === undefined) {
+    throw new TypeError("supply.kind must be mintable, fixed, or burnOnly");
+  }
+  if (supply.kind !== "mintable" && initialSupply === 0n) {
+    throw new RangeError(
+      "a fixed or burn-only supply must mint a nonzero initial supply",
+    );
+  }
+  const metadataMutable = options.metadataCapRecipient !== null;
+
+  return {
+    symbol,
+    name: requireNonEmptyString("name", options.name),
+    description: requireString("description", options.description),
+    iconUrl: requireString("iconUrl", options.iconUrl),
+    decimals,
+    initialSupply,
+    supplyRecipient: initialSupply
+      ? recipient("supplyRecipient", options.supplyRecipient)
+      : normalizeSuiAddress("0x5ee1"),
+    supplyMode,
+    treasuryCapRecipient:
+      supply.kind === "mintable"
+        ? recipient("supply.treasuryCapRecipient", supply.treasuryCapRecipient)
+        : normalizeSuiAddress("0x7ca9"),
+    metadataMutable,
+    metadataCapRecipient: metadataMutable
+      ? recipient("metadataCapRecipient", options.metadataCapRecipient ?? "")
+      : normalizeSuiAddress("0x3e7a"),
+  };
+}
+
+function recipient(name: string, address: string): string {
+  if (typeof address !== "string") {
+    throw new TypeError(`${name} must be a string`);
+  }
+  const normalized = normalizeSuiAddress(address);
+  if (!isValidSuiAddress(normalized) || BigInt(normalized) === 0n) {
+    throw new RangeError(`${name} must be a nonzero Sui address`);
+  }
+  return normalized;
+}
+
+function assertCoinTemplateWiring(
+  bytecode: Uint8Array,
+  identifiers: CoinTemplateIdentifiers,
+): void {
+  const compiled = deserializeTemplate(LABEL, bytecode);
+  if (
+    !compiled.identifiers.includes(identifiers.moduleName) ||
+    !compiled.identifiers.includes(identifiers.witnessName)
+  ) {
+    throw new TypeError("coin template identifiers were not patched");
+  }
+  const systemAddresses = new Set(
+    [normalizeSuiAddress("0x0"), ...COIN_PACKAGE_DEPENDENCIES].map((address) =>
+      normalizeSuiAddress(address).slice(2),
+    ),
+  );
+  if (
+    !compiled.address_identifiers.every((address) =>
+      systemAddresses.has(address),
+    )
+  ) {
+    throw new TypeError("coin template must link only 0x1 and 0x2");
+  }
+}

package/src/transactions.ts

@@ -0,0 +1,63 @@
+import type { TransactionObjectInput } from "@mysten/sui/transactions";
+import { Transaction } from "@mysten/sui/transactions";
+import {
+  normalizeStructTag,
+  normalizeSuiAddress,
+  SUI_FRAMEWORK_ADDRESS,
+} from "@mysten/sui/utils";
+
+import type { CoinTemplateOptions } from "./template.ts";
+import {
+  buildCoinPackageBytecode,
+  COIN_PACKAGE_DEPENDENCIES,
+} from "./template.ts";
+
+export type CoinPublication = CoinTemplateOptions & {
+  /**
+   * Receives the package's `UpgradeCap`; null makes the package immutable in
+   * the same transaction, so nobody can ever change the coin's module.
+   */
+  upgradeCapRecipient: string | null;
+};
+
+/**
+ * Publishes a standalone coin from the coin template (contracts ADR 0108).
+ * The initializer runs at publication and delivers the supply and the
+ * capabilities to the recipients `options` names; its `Currency` goes to the
+ * Coin Registry address, where anyone may share it with
+ * `coin_registry::finalize_registration` in a later transaction.
+ */
+export function publishCoin(options: CoinPublication): Transaction {
+  const tx = new Transaction();
+  const upgradeCap = tx.add(async (innerTx) => {
+    const module = await buildCoinPackageBytecode(options);
+    return innerTx.publish({
+      modules: [Array.from(module)],
+      dependencies: [...COIN_PACKAGE_DEPENDENCIES],
+    });
+  });
+  if (options.upgradeCapRecipient === null) {
+    tx.moveCall({
+      target: `${SUI_FRAMEWORK_ADDRESS}::package::make_immutable`,
+      arguments: [upgradeCap],
+    });
+  } else {
+    tx.transferObjects(
+      [upgradeCap],
+      normalizeSuiAddress(options.upgradeCapRecipient),
+    );
+  }
+  return tx;
+}
+
+/** Shares a published coin's pending Currency from the Coin Registry address. */
+export function finalizeCoinRegistration(
+  tx: Transaction,
+  options: { coinType: string; currency: TransactionObjectInput },
+): void {
+  tx.moveCall({
+    target: `${SUI_FRAMEWORK_ADDRESS}::coin_registry::finalize_registration`,
+    typeArguments: [normalizeStructTag(options.coinType)],
+    arguments: [tx.object("0xc"), tx.object(options.currency)],
+  });
+}