@misofm/musicos 0.1.0

package/dist/contracts/musicos/track.d.ts

@@ -0,0 +1,193 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+/**
+ * Represents a track on a release, linking a recording to its position in the
+ * tracklist.
+ *
+ * A `Track` is the minimal positioned (recording, revenue-share) pair:
+ *
+ * - `recording_id` — the routing target for the track's revenue, and the handle
+ *   through which all other metadata (title, cover art, and the
+ *   recording/composition share-type identities) is reached.
+ * - `composition_id` — the identity of the recording's underlying work, so the
+ *   composition–recording–release graph is walkable on-chain from the release
+ *   alone. Move cannot chase an ID to an object, so this edge is unreachable in a
+ *   track loop unless embedded here.
+ * - `split_bps` — this track's share of the release's revenue; genuinely
+ *   release-specific and not derivable from the recording.
+ * - `state` — the assign-once lifecycle that carries (then sheds) the recording
+ *   admin's target release commitment, made at creation; see `TrackState`.
+ *
+ * `Track` is intentionally monomorphic: a `Release` holds a `vector<Track>` of
+ * tracks from many different recordings/compositions, so it cannot be generic over
+ * their share types. It stores no title, cover art, or share-type — those are
+ * consumed off-chain and derived from the recording via `recording_id`; a `Track`
+ * embeds exactly the facts on-chain consumers cannot reach any other way.
+ */
+import { MoveEnum, MoveStruct, type RawTransactionArgument } from '../utils/index.ts';
+import { type Transaction, type TransactionArgument } from '@mysten/sui/transactions';
+/**
+ * Lifecycle state of a track within a release. A track is born `Unassigned`,
+ * carrying the target release id the consent committed to at creation (the release
+ * id is a digest of the whole tracklist, so this is the recording owner's consent
+ * to the exact release configuration). At publish the release verifies the match
+ * and transitions the track to `Assigned`, which carries no id — shedding the
+ * 32-byte commitment once it has served its purpose.
+ */
+export declare const TrackState: MoveEnum<{
+    /**
+      * Track has been created but not yet assigned to a release. Carries the target
+      * release id the consent committed to at creation.
+      */
+    Unassigned: import("@mysten/bcs").BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+    /** Track has been assigned to its target release. */
+    Assigned: null;
+}, "@local-pkg/musicos::track::TrackState">;
+export declare const Track: MoveStruct<{
+    /** Current state of the track. */
+    state: MoveEnum<{
+        /**
+          * Track has been created but not yet assigned to a release. Carries the target
+          * release id the consent committed to at creation.
+          */
+        Unassigned: import("@mysten/bcs").BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+        /** Track has been assigned to its target release. */
+        Assigned: null;
+    }, "@local-pkg/musicos::track::TrackState">;
+    /**
+     * ID of the composition underlying this track's recording. An identity and
+     * membership handle — NOT a revenue routing target: the composition is paid
+     * through its recording-share ownership (settled at `recording::new`), so a track
+     * routes its full split to the recording. Immutable and safe to denormalize: the
+     * recording↔composition pairing is fixed at recording creation.
+     */
+    composition_id: import("@mysten/bcs").BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+    /**
+     * ID of the recording on this track. The routing target for the track's revenue;
+     * also the handle a consumer uses to fetch the recording (whose type carries the
+     * recording and composition share-type identities).
+     */
+    recording_id: import("@mysten/bcs").BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+    /**
+     * This track's share of the release's revenue, in basis points. All tracks in a
+     * release sum to 100%. The composition's cut is settled as recording-share
+     * ownership at recording creation, so it is not split out here — a track routes
+     * its full share to the recording.
+     */
+    split_bps: import("../utils/index.ts").MoveTuple<readonly [import("@mysten/bcs").BcsType<number, number, "u16">], "bps::bps::BPS">;
+}, "@local-pkg/musicos::track::Track">;
+export interface NewArguments {
+    _: RawTransactionArgument<string>;
+    recording: RawTransactionArgument<string>;
+    targetReleaseId: RawTransactionArgument<string>;
+    trackSplitBpsValue: RawTransactionArgument<number>;
+}
+export interface NewOptions {
+    package?: string;
+    arguments: NewArguments | [
+        _: RawTransactionArgument<string>,
+        recording: RawTransactionArgument<string>,
+        targetReleaseId: RawTransactionArgument<string>,
+        trackSplitBpsValue: RawTransactionArgument<number>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+/**
+ * Creates a new track: the recording admin's consent to that recording's inclusion
+ * in a specific future release with an agreed split. Requires the recording admin
+ * capability. No event: a `Track` has `drop` and is not an object, so a creation
+ * event could announce a consent that is then silently discarded, and indexers
+ * would be unable to distinguish pending from dead. Pre-publish observability is
+ * the responsibility of whatever wraps the track (see below).
+ *
+ * The recording↔composition pairing is compile-time enforced by the recording's
+ * `CompositionShare` phantom, and its address-level counterpart is embedded on the
+ * recording at creation — so the composition id is copied from the `&Recording`
+ * argument with no `Composition` argument and no runtime check needed.
+ *
+ * ### What creating a track consents to
+ *
+ * `target_release_id` is derived from the release digest, so targeting it consents
+ * to that release's exact economics and membership: the ordered list of
+ * `(recording, split)` pairs and the creator's nonce, nothing more. The release's
+ * title, artwork, credits, and display grouping are chosen by the release creator
+ * — before or after this track is created — and are not bound by the digest.
+ * Presentation is trusted and publicly attributable, not cryptographically
+ * committed.
+ *
+ * The recording need not be `Published`: its admin can create tracks inside the
+ * recording's own creating transaction (an `Initialized` recording cannot escape
+ * that transaction, so across transactions tracks always reference `Published`,
+ * shared recordings).
+ *
+ * A `Track` has `store`, not `key`: it carries no identity of its own, so it may
+ * be exercised synchronously in the same transaction that creates it, or handed to
+ * an offer extension that wraps it in a real object with its own identity.
+ * Withdrawal, expiry, and rejection are then whatever that wrapping extension
+ * encodes — visible in its type, not in core.
+ *
+ * `recording` compile-time-binds the `RecordingShare`/`CompositionShare` phantom
+ * pairing, and is read for its own id and its embedded composition id: the
+ * monomorphic `Track` must store both _addresses_ — the recording's for revenue
+ * routing, the composition's for graph reachability — and an address cannot come
+ * from a phantom.
+ */
+export declare function _new(options: NewOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface RecordingIdArguments {
+    self: TransactionArgument;
+}
+export interface RecordingIdOptions {
+    package?: string;
+    arguments: RecordingIdArguments | [
+        self: TransactionArgument
+    ];
+}
+/** Returns the ID of the recording. */
+export declare function recordingId(options: RecordingIdOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface CompositionIdArguments {
+    self: TransactionArgument;
+}
+export interface CompositionIdOptions {
+    package?: string;
+    arguments: CompositionIdArguments | [
+        self: TransactionArgument
+    ];
+}
+/**
+ * Returns the ID of the composition underlying this track's recording. An
+ * identity/membership handle (e.g. "is this composition on this release?") — not a
+ * revenue routing target: the composition is paid via its recording-share
+ * ownership, and a track routes its full split to the recording.
+ */
+export declare function compositionId(options: CompositionIdOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface SplitBpsArguments {
+    self: TransactionArgument;
+}
+export interface SplitBpsOptions {
+    package?: string;
+    arguments: SplitBpsArguments | [
+        self: TransactionArgument
+    ];
+}
+/** Returns this track's share of the release's revenue (in basis points). */
+export declare function splitBps(options: SplitBpsOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface TargetReleaseIdArguments {
+    self: TransactionArgument;
+}
+export interface TargetReleaseIdOptions {
+    package?: string;
+    arguments: TargetReleaseIdArguments | [
+        self: TransactionArgument
+    ];
+}
+/**
+ * Returns the target release id this track's creator consented to. Aborts if the
+ * track is `Assigned`: an assigned track only exists inside a published release,
+ * so its release is the object you fetched it from.
+ */
+export declare function targetReleaseId(options: TargetReleaseIdOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+//# sourceMappingURL=track.d.ts.map

package/dist/contracts/musicos/track.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"track.d.ts","sourceRoot":"","sources":["../../../src/contracts/musicos/track.ts"],"names":[],"mappings":"AAAA;;gEAEgE;AAGhE;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,OAAO,EAAE,QAAQ,EAAE,UAAU,EAA0B,KAAK,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAG9G,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAGtF;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU;IACf;;;QAGI;;IAEJ,qDAAqD;;2CAErD,CAAC;AACT,eAAO,MAAM,KAAK;IACV,kCAAkC;;QATlC;;;YAGI;;QAEJ,qDAAqD;;;IAMrD;;;;;;OAMG;;IAEH;;;;OAIG;;IAEH;;;;;OAKG;;sCAEH,CAAC;AACT,MAAM,WAAW,YAAY;IACzB,CAAC,EAAE,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAClC,SAAS,EAAE,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAC1C,eAAe,EAAE,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAChD,kBAAkB,EAAE,sBAAsB,CAAC,MAAM,CAAC,CAAC;CACtD;AACD,MAAM,WAAW,UAAU;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,YAAY,GAAG;QACtB,CAAC,EAAE,sBAAsB,CAAC,MAAM,CAAC;QACjC,SAAS,EAAE,sBAAsB,CAAC,MAAM,CAAC;QACzC,eAAe,EAAE,sBAAsB,CAAC,MAAM,CAAC;QAC/C,kBAAkB,EAAE,sBAAsB,CAAC,MAAM,CAAC;KACrD,CAAC;IACF,aAAa,EAAE;QACX,MAAM;QACN,MAAM;KACT,CAAC;CACL;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,wBAAgB,IAAI,CAAC,OAAO,EAAE,UAAU,QASxB,WAAW,0DAO1B;AACD,MAAM,WAAW,oBAAoB;IACjC,IAAI,EAAE,mBAAmB,CAAC;CAC7B;AACD,MAAM,WAAW,kBAAkB;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,oBAAoB,GAAG;QAC9B,IAAI,EAAE,mBAAmB;KAC5B,CAAC;CACL;AACD,uCAAuC;AACvC,wBAAgB,WAAW,CAAC,OAAO,EAAE,kBAAkB,QAMvC,WAAW,0DAM1B;AACD,MAAM,WAAW,sBAAsB;IACnC,IAAI,EAAE,mBAAmB,CAAC;CAC7B;AACD,MAAM,WAAW,oBAAoB;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,sBAAsB,GAAG;QAChC,IAAI,EAAE,mBAAmB;KAC5B,CAAC;CACL;AACD;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,oBAAoB,QAM3C,WAAW,0DAM1B;AACD,MAAM,WAAW,iBAAiB;IAC9B,IAAI,EAAE,mBAAmB,CAAC;CAC7B;AACD,MAAM,WAAW,eAAe;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,iBAAiB,GAAG;QAC3B,IAAI,EAAE,mBAAmB;KAC5B,CAAC;CACL;AACD,6EAA6E;AAC7E,wBAAgB,QAAQ,CAAC,OAAO,EAAE,eAAe,QAMjC,WAAW,0DAM1B;AACD,MAAM,WAAW,wBAAwB;IACrC,IAAI,EAAE,mBAAmB,CAAC;CAC7B;AACD,MAAM,WAAW,sBAAsB;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,wBAAwB,GAAG;QAClC,IAAI,EAAE,mBAAmB;KAC5B,CAAC;CACL;AACD;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,sBAAsB,QAM/C,WAAW,0DAM1B"}

package/dist/contracts/musicos/track.js

@@ -0,0 +1,197 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+/**
+ * Represents a track on a release, linking a recording to its position in the
+ * tracklist.
+ *
+ * A `Track` is the minimal positioned (recording, revenue-share) pair:
+ *
+ * - `recording_id` — the routing target for the track's revenue, and the handle
+ *   through which all other metadata (title, cover art, and the
+ *   recording/composition share-type identities) is reached.
+ * - `composition_id` — the identity of the recording's underlying work, so the
+ *   composition–recording–release graph is walkable on-chain from the release
+ *   alone. Move cannot chase an ID to an object, so this edge is unreachable in a
+ *   track loop unless embedded here.
+ * - `split_bps` — this track's share of the release's revenue; genuinely
+ *   release-specific and not derivable from the recording.
+ * - `state` — the assign-once lifecycle that carries (then sheds) the recording
+ *   admin's target release commitment, made at creation; see `TrackState`.
+ *
+ * `Track` is intentionally monomorphic: a `Release` holds a `vector<Track>` of
+ * tracks from many different recordings/compositions, so it cannot be generic over
+ * their share types. It stores no title, cover art, or share-type — those are
+ * consumed off-chain and derived from the recording via `recording_id`; a `Track`
+ * embeds exactly the facts on-chain consumers cannot reach any other way.
+ */
+import { MoveEnum, MoveStruct, normalizeMoveArguments } from '../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+import {} from '@mysten/sui/transactions';
+import * as bps from './deps/bps/bps.js';
+const $moduleName = '@local-pkg/musicos::track';
+/**
+ * Lifecycle state of a track within a release. A track is born `Unassigned`,
+ * carrying the target release id the consent committed to at creation (the release
+ * id is a digest of the whole tracklist, so this is the recording owner's consent
+ * to the exact release configuration). At publish the release verifies the match
+ * and transitions the track to `Assigned`, which carries no id — shedding the
+ * 32-byte commitment once it has served its purpose.
+ */
+export const TrackState = new MoveEnum({ name: `${$moduleName}::TrackState`, fields: {
+        /**
+          * Track has been created but not yet assigned to a release. Carries the target
+          * release id the consent committed to at creation.
+          */
+        Unassigned: bcs.Address,
+        /** Track has been assigned to its target release. */
+        Assigned: null
+    } });
+export const Track = new MoveStruct({ name: `${$moduleName}::Track`, fields: {
+        /** Current state of the track. */
+        state: TrackState,
+        /**
+         * ID of the composition underlying this track's recording. An identity and
+         * membership handle — NOT a revenue routing target: the composition is paid
+         * through its recording-share ownership (settled at `recording::new`), so a track
+         * routes its full split to the recording. Immutable and safe to denormalize: the
+         * recording↔composition pairing is fixed at recording creation.
+         */
+        composition_id: bcs.Address,
+        /**
+         * ID of the recording on this track. The routing target for the track's revenue;
+         * also the handle a consumer uses to fetch the recording (whose type carries the
+         * recording and composition share-type identities).
+         */
+        recording_id: bcs.Address,
+        /**
+         * This track's share of the release's revenue, in basis points. All tracks in a
+         * release sum to 100%. The composition's cut is settled as recording-share
+         * ownership at recording creation, so it is not split out here — a track routes
+         * its full share to the recording.
+         */
+        split_bps: bps.BPS
+    } });
+/**
+ * Creates a new track: the recording admin's consent to that recording's inclusion
+ * in a specific future release with an agreed split. Requires the recording admin
+ * capability. No event: a `Track` has `drop` and is not an object, so a creation
+ * event could announce a consent that is then silently discarded, and indexers
+ * would be unable to distinguish pending from dead. Pre-publish observability is
+ * the responsibility of whatever wraps the track (see below).
+ *
+ * The recording↔composition pairing is compile-time enforced by the recording's
+ * `CompositionShare` phantom, and its address-level counterpart is embedded on the
+ * recording at creation — so the composition id is copied from the `&Recording`
+ * argument with no `Composition` argument and no runtime check needed.
+ *
+ * ### What creating a track consents to
+ *
+ * `target_release_id` is derived from the release digest, so targeting it consents
+ * to that release's exact economics and membership: the ordered list of
+ * `(recording, split)` pairs and the creator's nonce, nothing more. The release's
+ * title, artwork, credits, and display grouping are chosen by the release creator
+ * — before or after this track is created — and are not bound by the digest.
+ * Presentation is trusted and publicly attributable, not cryptographically
+ * committed.
+ *
+ * The recording need not be `Published`: its admin can create tracks inside the
+ * recording's own creating transaction (an `Initialized` recording cannot escape
+ * that transaction, so across transactions tracks always reference `Published`,
+ * shared recordings).
+ *
+ * A `Track` has `store`, not `key`: it carries no identity of its own, so it may
+ * be exercised synchronously in the same transaction that creates it, or handed to
+ * an offer extension that wraps it in a real object with its own identity.
+ * Withdrawal, expiry, and rejection are then whatever that wrapping extension
+ * encodes — visible in its type, not in core.
+ *
+ * `recording` compile-time-binds the `RecordingShare`/`CompositionShare` phantom
+ * pairing, and is read for its own id and its embedded composition id: the
+ * monomorphic `Track` must store both _addresses_ — the recording's for revenue
+ * routing, the composition's for graph reachability — and an address cannot come
+ * from a phantom.
+ */
+export function _new(options) {
+    const packageAddress = options.package ?? '@local-pkg/musicos';
+    const argumentsTypes = [
+        null,
+        null,
+        '0x2::object::ID',
+        'u16'
+    ];
+    const parameterNames = ["_", "recording", "targetReleaseId", "trackSplitBpsValue"];
+    return (tx) => tx.moveCall({
+        package: packageAddress,
+        module: 'track',
+        function: 'new',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+        typeArguments: options.typeArguments
+    });
+}
+/** Returns the ID of the recording. */
+export function recordingId(options) {
+    const packageAddress = options.package ?? '@local-pkg/musicos';
+    const argumentsTypes = [
+        null
+    ];
+    const parameterNames = ["self"];
+    return (tx) => tx.moveCall({
+        package: packageAddress,
+        module: 'track',
+        function: 'recording_id',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+    });
+}
+/**
+ * Returns the ID of the composition underlying this track's recording. An
+ * identity/membership handle (e.g. "is this composition on this release?") — not a
+ * revenue routing target: the composition is paid via its recording-share
+ * ownership, and a track routes its full split to the recording.
+ */
+export function compositionId(options) {
+    const packageAddress = options.package ?? '@local-pkg/musicos';
+    const argumentsTypes = [
+        null
+    ];
+    const parameterNames = ["self"];
+    return (tx) => tx.moveCall({
+        package: packageAddress,
+        module: 'track',
+        function: 'composition_id',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+    });
+}
+/** Returns this track's share of the release's revenue (in basis points). */
+export function splitBps(options) {
+    const packageAddress = options.package ?? '@local-pkg/musicos';
+    const argumentsTypes = [
+        null
+    ];
+    const parameterNames = ["self"];
+    return (tx) => tx.moveCall({
+        package: packageAddress,
+        module: 'track',
+        function: 'split_bps',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+    });
+}
+/**
+ * Returns the target release id this track's creator consented to. Aborts if the
+ * track is `Assigned`: an assigned track only exists inside a published release,
+ * so its release is the object you fetched it from.
+ */
+export function targetReleaseId(options) {
+    const packageAddress = options.package ?? '@local-pkg/musicos';
+    const argumentsTypes = [
+        null
+    ];
+    const parameterNames = ["self"];
+    return (tx) => tx.moveCall({
+        package: packageAddress,
+        module: 'track',
+        function: 'target_release_id',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+    });
+}
+//# sourceMappingURL=track.js.map

package/dist/contracts/musicos/track.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"track.js","sourceRoot":"","sources":["../../../src/contracts/musicos/track.ts"],"names":[],"mappings":"AAAA;;gEAEgE;AAGhE;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,sBAAsB,EAA+B,MAAM,mBAAmB,CAAC;AAC9G,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAEtC,OAAO,EAA8C,MAAM,0BAA0B,CAAC;AACtF,OAAO,KAAK,GAAG,MAAM,mBAAmB,CAAC;AACzC,MAAM,WAAW,GAAG,2BAA2B,CAAC;AAChD;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,IAAI,QAAQ,CAAC,EAAE,IAAI,EAAE,GAAG,WAAW,cAAc,EAAE,MAAM,EAAE;QAC7E;;;YAGI;QACJ,UAAU,EAAE,GAAG,CAAC,OAAO;QACvB,qDAAqD;QACrD,QAAQ,EAAE,IAAI;KACjB,EAAE,CAAC,CAAC;AACT,MAAM,CAAC,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,EAAE,IAAI,EAAE,GAAG,WAAW,SAAS,EAAE,MAAM,EAAE;QACrE,kCAAkC;QAClC,KAAK,EAAE,UAAU;QACjB;;;;;;WAMG;QACH,cAAc,EAAE,GAAG,CAAC,OAAO;QAC3B;;;;WAIG;QACH,YAAY,EAAE,GAAG,CAAC,OAAO;QACzB;;;;;WAKG;QACH,SAAS,EAAE,GAAG,CAAC,GAAG;KACrB,EAAE,CAAC,CAAC;AAoBT;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,UAAU,IAAI,CAAC,OAAmB;IACpC,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,IAAI,oBAAoB,CAAC;IAC/D,MAAM,cAAc,GAAG;QACnB,IAAI;QACJ,IAAI;QACJ,iBAAiB;QACjB,KAAK;KACoB,CAAC;IAC9B,MAAM,cAAc,GAAG,CAAC,GAAG,EAAE,WAAW,EAAE,iBAAiB,EAAE,oBAAoB,CAAC,CAAC;IACnF,OAAO,CAAC,EAAe,EAAE,EAAE,CAAC,EAAE,CAAC,QAAQ,CAAC;QACpC,OAAO,EAAE,cAAc;QACvB,MAAM,EAAE,OAAO;QACf,QAAQ,EAAE,KAAK;QACf,SAAS,EAAE,sBAAsB,CAAC,OAAO,CAAC,SAAS,EAAE,cAAc,EAAE,cAAc,CAAC;QACpF,aAAa,EAAE,OAAO,CAAC,aAAa;KACvC,CAAC,CAAC;AACP,CAAC;AAUD,uCAAuC;AACvC,MAAM,UAAU,WAAW,CAAC,OAA2B;IACnD,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,IAAI,oBAAoB,CAAC;IAC/D,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,OAAO;QACf,QAAQ,EAAE,cAAc;QACxB,SAAS,EAAE,sBAAsB,CAAC,OAAO,CAAC,SAAS,EAAE,cAAc,EAAE,cAAc,CAAC;KACvF,CAAC,CAAC;AACP,CAAC;AAUD;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,OAA6B;IACvD,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,IAAI,oBAAoB,CAAC;IAC/D,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,OAAO;QACf,QAAQ,EAAE,gBAAgB;QAC1B,SAAS,EAAE,sBAAsB,CAAC,OAAO,CAAC,SAAS,EAAE,cAAc,EAAE,cAAc,CAAC;KACvF,CAAC,CAAC;AACP,CAAC;AAUD,6EAA6E;AAC7E,MAAM,UAAU,QAAQ,CAAC,OAAwB;IAC7C,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,IAAI,oBAAoB,CAAC;IAC/D,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,OAAO;QACf,QAAQ,EAAE,WAAW;QACrB,SAAS,EAAE,sBAAsB,CAAC,OAAO,CAAC,SAAS,EAAE,cAAc,EAAE,cAAc,CAAC;KACvF,CAAC,CAAC;AACP,CAAC;AAUD;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,OAA+B;IAC3D,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,IAAI,oBAAoB,CAAC;IAC/D,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,OAAO;QACf,QAAQ,EAAE,mBAAmB;QAC7B,SAAS,EAAE,sBAAsB,CAAC,OAAO,CAAC,SAAS,EAAE,cAAc,EAAE,cAAc,CAAC;KACvF,CAAC,CAAC;AACP,CAAC"}

package/dist/contracts/utils/index.d.ts

@@ -0,0 +1,104 @@
+import { type BcsType, type TypeTag, BcsStruct, BcsEnum, BcsTuple } from '@mysten/sui/bcs';
+import { type TransactionArgument, type TransactionObjectArgument } from '@mysten/sui/transactions';
+import { type ClientWithCoreApi, type SuiClientTypes } from '@mysten/sui/client';
+export type RawTransactionArgument<T> = T | TransactionArgument;
+export type GetOptions<Include extends Omit<SuiClientTypes.ObjectInclude, 'content'> = {}> = SuiClientTypes.GetObjectOptions<Include> & {
+    client: ClientWithCoreApi;
+};
+export type GetManyOptions<Include extends Omit<SuiClientTypes.ObjectInclude, 'content'> = {}> = SuiClientTypes.GetObjectsOptions<Include> & {
+    client: ClientWithCoreApi;
+};
+export declare function getPureBcsSchema(typeTag: string | TypeTag): BcsType<any> | null;
+export declare function normalizeMoveArguments(args: unknown[] | object, argTypes: readonly (string | null)[], parameterNames?: string[]): TransactionArgument[];
+/** Context passed to config resolver functions. */
+export interface ConfigResolverContext {
+    /**
+     * The matched parameter's own instantiated type arguments (not the whole function's type
+     * argument tuple). Concrete instantiations are canonical type tags; generic positions pass
+     * the caller's `typeArguments` strings through as provided.
+     */
+    typeArguments: string[];
+    /** The package address the generated call will be sent to. */
+    packageAddress: string;
+    /** The Move module of the generated call. */
+    moduleName: string;
+    /** The Move function of the generated call. */
+    functionName: string;
+    /** The Move name of the matched parameter, when the summary includes parameter names. */
+    parameterName?: string;
+    /** The matched parameter's position in the generated function's arguments. */
+    parameterIndex: number;
+}
+/**
+ * A non-callback transaction argument in a generated config object, used for keys whose matched
+ * parameter can't be supplied as an object id string.
+ */
+export type ConfigObjectValue = Exclude<TransactionObjectArgument, (...args: never[]) => unknown>;
+/**
+ * A plain value in a generated config object: an object id or a non-callback transaction
+ * argument. Keys that can resolve multiple bindings are typed as resolver functions instead.
+ */
+export type ConfigValue = string | ConfigObjectValue;
+/** A type argument: a type tag string, or a BCS type whose name is a Move type. */
+export type TypeArgument = string | BcsType<any>;
+export interface TypeTagOptions {
+    package?: string;
+    typeArguments?: readonly TypeArgument[];
+}
+/**
+ * `typeArguments` is required when the type's name contains unfilled
+ * `phantom X` parameters (at any depth). Everything else — argument arity,
+ * position contents, and tag validity — is validated at runtime.
+ */
+type TypeTagParams<Name extends string> = Name extends `${string}phantom ${string}` ? [options: TypeTagOptions & {
+    typeArguments: readonly TypeArgument[];
+}] : [options?: TypeTagOptions];
+type ResolveTypeTagOptions<Name extends string> = {
+    client: ClientWithCoreApi;
+} & (Name extends `${string}phantom ${string}` ? TypeTagOptions & {
+    typeArguments: readonly TypeArgument[];
+} : TypeTagOptions);
+export declare class MoveStruct<T extends Record<string, BcsType<any>>, const Name extends string = string> extends BcsStruct<T, Name> {
+    /**
+     * Build the type tag for this struct.
+     *
+     * `typeArguments` is the full positional list, in Move declaration order, and
+     * is required when the struct has unfilled phantom parameters. The result may
+     * contain MVR names: those are valid in transaction `typeArguments`, but for
+     * queries or comparisons against on-chain data use `resolveTypeTag` instead.
+     */
+    typeTag(...args: TypeTagParams<Name>): string;
+    /**
+     * Build the type tag for this struct, then resolve any MVR names through the
+     * client (using its configured overrides and the MVR API) and return the
+     * normalized, address-only form suitable for queries and comparisons against
+     * on-chain data.
+     */
+    resolveTypeTag(options: ResolveTypeTagOptions<Name>): Promise<string>;
+    get<Include extends Omit<SuiClientTypes.ObjectInclude, 'content' | 'json'> = {}>({ objectId, ...options }: GetOptions<Include>): Promise<SuiClientTypes.Object<Include & {
+        content: true;
+        json: true;
+    }> & {
+        json: BcsStruct<T>['$inferType'];
+    }>;
+    getMany<Include extends Omit<SuiClientTypes.ObjectInclude, 'content' | 'json'> = {}>({ client, ...options }: GetManyOptions<Include>): Promise<Array<SuiClientTypes.Object<Include & {
+        content: true;
+        json: true;
+    }> & {
+        json: BcsStruct<T>['$inferType'];
+    }>>;
+}
+export declare class MoveEnum<T extends Record<string, BcsType<any> | null>, const Name extends string> extends BcsEnum<T, Name> {
+    /** Build the type tag for this enum. See `MoveStruct.typeTag` for semantics. */
+    typeTag(...args: TypeTagParams<Name>): string;
+    /** Build and resolve the type tag for this enum. See `MoveStruct.resolveTypeTag`. */
+    resolveTypeTag(options: ResolveTypeTagOptions<Name>): Promise<string>;
+}
+export declare class MoveTuple<const T extends readonly BcsType<any>[], const Name extends string> extends BcsTuple<T, Name> {
+    /** Build the type tag for this struct. See `MoveStruct.typeTag` for semantics. */
+    typeTag(...args: TypeTagParams<Name>): string;
+    /** Build and resolve the type tag for this struct. See `MoveStruct.resolveTypeTag`. */
+    resolveTypeTag(options: ResolveTypeTagOptions<Name>): Promise<string>;
+}
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/contracts/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/contracts/utils/index.ts"],"names":[],"mappings":"AACA,OAAO,EAEN,KAAK,OAAO,EACZ,KAAK,OAAO,EAEZ,SAAS,EACT,OAAO,EACP,QAAQ,EACR,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACN,KAAK,mBAAmB,EACxB,KAAK,yBAAyB,EAE9B,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,KAAK,iBAAiB,EAAE,KAAK,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAKjF,MAAM,MAAM,sBAAsB,CAAC,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC;AAEhE,MAAM,MAAM,UAAU,CAAC,OAAO,SAAS,IAAI,CAAC,cAAc,CAAC,aAAa,EAAE,SAAS,CAAC,GAAG,EAAE,IACxF,cAAc,CAAC,gBAAgB,CAAC,OAAO,CAAC,GAAG;IAAE,MAAM,EAAE,iBAAiB,CAAA;CAAE,CAAC;AAE1E,MAAM,MAAM,cAAc,CAAC,OAAO,SAAS,IAAI,CAAC,cAAc,CAAC,aAAa,EAAE,SAAS,CAAC,GAAG,EAAE,IAC5F,cAAc,CAAC,iBAAiB,CAAC,OAAO,CAAC,GAAG;IAAE,MAAM,EAAE,iBAAiB,CAAA;CAAE,CAAC;AAE3E,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAmD/E;AAED,wBAAgB,sBAAsB,CACrC,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,EACxB,QAAQ,EAAE,SAAS,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,EACpC,cAAc,CAAC,EAAE,MAAM,EAAE,yBAsFzB;AAID,mDAAmD;AACnD,MAAM,WAAW,qBAAqB;IACrC;;;;OAIG;IACH,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,8DAA8D;IAC9D,cAAc,EAAE,MAAM,CAAC;IACvB,6CAA6C;IAC7C,UAAU,EAAE,MAAM,CAAC;IACnB,+CAA+C;IAC/C,YAAY,EAAE,MAAM,CAAC;IACrB,yFAAyF;IACzF,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,8EAA8E;IAC9E,cAAc,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,yBAAyB,EAAE,CAAC,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK,OAAO,CAAC,CAAC;AAElG;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,iBAAiB,CAAC;AAIrD,mFAAmF;AACnF,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;AAEjD,MAAM,WAAW,cAAc;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,SAAS,YAAY,EAAE,CAAC;CACxC;AAED;;;;GAIG;AACH,KAAK,aAAa,CAAC,IAAI,SAAS,MAAM,IAAI,IAAI,SAAS,GAAG,MAAM,WAAW,MAAM,EAAE,GAChF,CAAC,OAAO,EAAE,cAAc,GAAG;IAAE,aAAa,EAAE,SAAS,YAAY,EAAE,CAAA;CAAE,CAAC,GACtE,CAAC,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC;AAE9B,KAAK,qBAAqB,CAAC,IAAI,SAAS,MAAM,IAAI;IAAE,MAAM,EAAE,iBAAiB,CAAA;CAAE,GAAG,CACjF,IAAI,SAAS,GAAG,MAAM,WAAW,MAAM,EAAE,GACtC,cAAc,GAAG;IAAE,aAAa,EAAE,SAAS,YAAY,EAAE,CAAA;CAAE,GAC3D,cAAc,CACjB,CAAC;AAqFF,qBAAa,UAAU,CACtB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,EACtC,KAAK,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,CACjC,SAAQ,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC;IAC3B;;;;;;;OAOG;IACH,OAAO,CAAC,GAAG,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,GAAG,MAAM,CAE5C;IAED;;;;;OAKG;IACG,cAAc,CAAC,OAAO,EAAE,qBAAqB,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAE1E;IAEK,GAAG,CAAC,OAAO,SAAS,IAAI,CAAC,cAAc,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,CAAC,GAAG,EAAE,EAAE,EACtF,QAAQ,EACR,GAAG,OAAO,EACV,EAAE,UAAU,CAAC,OAAO,CAAC,GAAG,OAAO,CAC/B,cAAc,CAAC,MAAM,CAAC,OAAO,GAAG;QAAE,OAAO,EAAE,IAAI,CAAC;QAAC,IAAI,EAAE,IAAI,CAAA;KAAE,CAAC,GAAG;QAAE,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAA;KAAE,CACrG,CAWA;IAEK,OAAO,CAAC,OAAO,SAAS,IAAI,CAAC,cAAc,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,CAAC,GAAG,EAAE,EAAE,EAC1F,MAAM,EACN,GAAG,OAAO,EACV,EAAE,cAAc,CAAC,OAAO,CAAC,GAAG,OAAO,CACnC,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,OAAO,GAAG;QAAE,OAAO,EAAE,IAAI,CAAC;QAAC,IAAI,EAAE,IAAI,CAAA;KAAE,CAAC,GAAG;QAAE,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAA;KAAE,CAAC,CAC5G,CAmBA;CACD;AAED,qBAAa,QAAQ,CACpB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,EAC7C,KAAK,CAAC,IAAI,SAAS,MAAM,CACxB,SAAQ,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC;IACzB,gFAAgF;IAChF,OAAO,CAAC,GAAG,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,GAAG,MAAM,CAE5C;IAED,qFAAqF;IAC/E,cAAc,CAAC,OAAO,EAAE,qBAAqB,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAE1E;CACD;AAED,qBAAa,SAAS,CACrB,KAAK,CAAC,CAAC,SAAS,SAAS,OAAO,CAAC,GAAG,CAAC,EAAE,EACvC,KAAK,CAAC,IAAI,SAAS,MAAM,CACxB,SAAQ,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC;IAC1B,kFAAkF;IAClF,OAAO,CAAC,GAAG,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,GAAG,MAAM,CAE5C;IAED,uFAAuF;IACjF,cAAc,CAAC,OAAO,EAAE,qBAAqB,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAE1E;CACD"}