@misonetwork/sdk 0.6.0 → 0.8.0

package/dist/contracts/release_description/release_description.js

@@ -0,0 +1,123 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+/**
+ * What a release says about itself — the paragraph that runs under the title,
+ * written by whoever holds the release's admin cap, and believed.
+ *
+ * A free string, deliberately. Nothing on-chain reads it and nothing derives from
+ * it: this is editorial prose, not a fact the protocol can check. The facts a
+ * release carries that _are_ checkable — its tracklist, its splits, its state —
+ * live on the core object, and the claims two releases have to agree about to be
+ * comparable (genre, credits, languages) each get their own typed extension so
+ * they can be queried rather than read. What is left over is what a person wants
+ * to say, and the only useful thing to do with it is store it and attribute it to
+ * the cap holder.
+ *
+ * One slot, not a set. A release has one thing to say about itself; per-track
+ * notes and per-language translations are different concerns and would be
+ * different extensions. Folding either in here would turn a paragraph into a
+ * schema, and a schema is exactly what prose is not.
+ *
+ * The 8 KB ceiling is storage hygiene, not an editorial opinion — a backstop
+ * against pathological bloat in a shared object, deliberately set well above any
+ * description anyone is expected to write. It is the most generous free-text bound
+ * in the stack, and that is the intended asymmetry: this package publishes
+ * immutable, so a ceiling that turns out to be too low can never be raised, while
+ * one that is too high costs only the gas of the writer who fills it. A
+ * description is also edited rarely, so the cost of rewriting the field in full
+ * lands on almost nobody.
+ *
+ * Genuinely long-form writing — an essay, a full set of liner notes — still
+ * belongs where the artwork goes, in a Walrus blob referenced by an extension.
+ * Nothing here stops someone using the whole 8 KB; the bound is a limit, not a
+ * recommendation.
+ *
+ * Attaching nothing and attaching a description are distinct states: absence means
+ * nobody has written one, which is why an empty string is rejected rather than
+ * stored. There is no such thing as an empty description.
+ */
+import { MoveTuple, MoveStruct, normalizeMoveArguments } from "../utils/index.js";
+import { bcs } from '@mysten/sui/bcs';
+import {} from '@mysten/sui/transactions';
+const $moduleName = '@local-pkg/release_description::release_description';
+export const ExtensionKey = new MoveTuple({ name: `${$moduleName}::ExtensionKey`, fields: [bcs.bool()] });
+export const DescriptionSetEvent = new MoveStruct({ name: `${$moduleName}::DescriptionSetEvent`, fields: {
+        release_id: bcs.Address,
+        description: bcs.string()
+    } });
+export const DescriptionClearedEvent = new MoveStruct({ name: `${$moduleName}::DescriptionClearedEvent`, fields: {
+        release_id: bcs.Address
+    } });
+/**
+ * Sets (or replaces) what the release says about itself.
+ *
+ * Stored exactly as given — whitespace, line breaks and case included. It is the
+ * release's own words, and normalising them here would be the protocol editing
+ * prose it has already declined to interpret.
+ */
+export function setDescription(options) {
+    const packageAddress = options.package ?? '@local-pkg/release_description';
+    const argumentsTypes = [
+        null,
+        null,
+        '0x1::string::String'
+    ];
+    const parameterNames = ["self", "cap", "description"];
+    return (tx) => tx.moveCall({
+        package: packageAddress,
+        module: 'release_description',
+        function: 'set_description',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+    });
+}
+/**
+ * Removes the description, if any. Idempotent. Leaves the release having said
+ * nothing about itself, which is where every release starts.
+ */
+export function clearDescription(options) {
+    const packageAddress = options.package ?? '@local-pkg/release_description';
+    const argumentsTypes = [
+        null,
+        null
+    ];
+    const parameterNames = ["self", "cap"];
+    return (tx) => tx.moveCall({
+        package: packageAddress,
+        module: 'release_description',
+        function: 'clear_description',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+    });
+}
+/** Whether a description is attached to this release. */
+export function hasDescription(options) {
+    const packageAddress = options.package ?? '@local-pkg/release_description';
+    const argumentsTypes = [
+        null
+    ];
+    const parameterNames = ["self"];
+    return (tx) => tx.moveCall({
+        package: packageAddress,
+        module: 'release_description',
+        function: 'has_description',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+    });
+}
+/**
+ * What the release says about itself. Aborts if nothing is attached — absence is a
+ * distinct state and must not collapse into an empty string.
+ */
+export function description(options) {
+    const packageAddress = options.package ?? '@local-pkg/release_description';
+    const argumentsTypes = [
+        null
+    ];
+    const parameterNames = ["self"];
+    return (tx) => tx.moveCall({
+        package: packageAddress,
+        module: 'release_description',
+        function: 'description',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+    });
+}
+//# sourceMappingURL=release_description.js.map

package/dist/contracts/release_description/release_description.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"release_description.js","sourceRoot":"","sources":["../../../src/contracts/release_description/release_description.ts"],"names":[],"mappings":"AAAA;;gEAEgE;AAGhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AAEH,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,sBAAsB,EAA+B,MAAM,mBAAmB,CAAC;AAC/G,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AACtC,OAAO,EAAoB,MAAM,0BAA0B,CAAC;AAC5D,MAAM,WAAW,GAAG,qDAAqD,CAAC;AAC1E,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,SAAS,CAAC,EAAE,IAAI,EAAE,GAAG,WAAW,gBAAgB,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;AAC1G,MAAM,CAAC,MAAM,mBAAmB,GAAG,IAAI,UAAU,CAAC,EAAE,IAAI,EAAE,GAAG,WAAW,uBAAuB,EAAE,MAAM,EAAE;QACjG,UAAU,EAAE,GAAG,CAAC,OAAO;QACvB,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE;KAC5B,EAAE,CAAC,CAAC;AACT,MAAM,CAAC,MAAM,uBAAuB,GAAG,IAAI,UAAU,CAAC,EAAE,IAAI,EAAE,GAAG,WAAW,2BAA2B,EAAE,MAAM,EAAE;QACzG,UAAU,EAAE,GAAG,CAAC,OAAO;KAC1B,EAAE,CAAC,CAAC;AAcT;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAAC,OAA8B;IACzD,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,IAAI,gCAAgC,CAAC;IAC3E,MAAM,cAAc,GAAG;QACnB,IAAI;QACJ,IAAI;QACJ,qBAAqB;KACI,CAAC;IAC9B,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;IACtD,OAAO,CAAC,EAAe,EAAE,EAAE,CAAC,EAAE,CAAC,QAAQ,CAAC;QACpC,OAAO,EAAE,cAAc;QACvB,MAAM,EAAE,qBAAqB;QAC7B,QAAQ,EAAE,iBAAiB;QAC3B,SAAS,EAAE,sBAAsB,CAAC,OAAO,CAAC,SAAS,EAAE,cAAc,EAAE,cAAc,CAAC;KACvF,CAAC,CAAC;AACP,CAAC;AAYD;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,OAAgC;IAC7D,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,IAAI,gCAAgC,CAAC;IAC3E,MAAM,cAAc,GAAG;QACnB,IAAI;QACJ,IAAI;KACqB,CAAC;IAC9B,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACvC,OAAO,CAAC,EAAe,EAAE,EAAE,CAAC,EAAE,CAAC,QAAQ,CAAC;QACpC,OAAO,EAAE,cAAc;QACvB,MAAM,EAAE,qBAAqB;QAC7B,QAAQ,EAAE,mBAAmB;QAC7B,SAAS,EAAE,sBAAsB,CAAC,OAAO,CAAC,SAAS,EAAE,cAAc,EAAE,cAAc,CAAC;KACvF,CAAC,CAAC;AACP,CAAC;AAUD,yDAAyD;AACzD,MAAM,UAAU,cAAc,CAAC,OAA8B;IACzD,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,IAAI,gCAAgC,CAAC;IAC3E,MAAM,cAAc,GAAG;QACnB,IAAI;KACqB,CAAC;IAC9B,MAAM,cAAc,GAAG,CAAC,MAAM,CAAC,CAAC;IAChC,OAAO,CAAC,EAAe,EAAE,EAAE,CAAC,EAAE,CAAC,QAAQ,CAAC;QACpC,OAAO,EAAE,cAAc;QACvB,MAAM,EAAE,qBAAqB;QAC7B,QAAQ,EAAE,iBAAiB;QAC3B,SAAS,EAAE,sBAAsB,CAAC,OAAO,CAAC,SAAS,EAAE,cAAc,EAAE,cAAc,CAAC;KACvF,CAAC,CAAC;AACP,CAAC;AAUD;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,OAA2B;IACnD,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,IAAI,gCAAgC,CAAC;IAC3E,MAAM,cAAc,GAAG;QACnB,IAAI;KACqB,CAAC;IAC9B,MAAM,cAAc,GAAG,CAAC,MAAM,CAAC,CAAC;IAChC,OAAO,CAAC,EAAe,EAAE,EAAE,CAAC,EAAE,CAAC,QAAQ,CAAC;QACpC,OAAO,EAAE,cAAc;QACvB,MAAM,EAAE,qBAAqB;QAC7B,QAAQ,EAAE,aAAa;QACvB,SAAS,EAAE,sBAAsB,CAAC,OAAO,CAAC,SAAS,EAAE,cAAc,EAAE,cAAc,CAAC;KACvF,CAAC,CAAC;AACP,CAAC"}