@misonetwork/sdk 0.1.0

package/dist/credits.d.ts

@@ -0,0 +1,171 @@
+import type { ClientWithCoreApi } from "@mysten/sui/client";
+import type { TxThunk } from "./transactions.ts";
+/** A composition writing role. `Custom` carries a free-form (validated) name. */
+export type CompositionRole = {
+    type: "Adapter" | "Arranger" | "Composer" | "Lyricist" | "Songwriter" | "Translator";
+} | {
+    type: "Custom";
+    name: string;
+};
+/** Seniority/prominence level for a recording role. */
+export type RecordingRoleLevel = "Additional" | "Assistant" | "Associate" | "Backing" | "Executive" | "Featured" | "Lead" | "Primary" | "Principal";
+/** Recording role base names that carry an optional level. */
+export type RecordingLeveledRoleType = "Actor" | "Arranger" | "BandLeader" | "Choir" | "ChoirMaster" | "ConcertMaster" | "Conductor" | "Contractor" | "DJ" | "Editor" | "Engineer" | "Ensemble" | "MasteringEngineer" | "MixingEngineer" | "MusicDirector" | "MusicSupervisor" | "Narrator" | "Orchestra" | "Orchestrator" | "Performer" | "Producer" | "Programmer" | "RecordingEngineer" | "RemixingEngineer" | "Soloist" | "SoundDesigner" | "Speaker" | "Vocalist";
+/**
+ * A recording production/performance role. Most roles take an optional `level`;
+ * `Instrumentalist` also carries the instrument name; `Custom` carries a free-form
+ * (validated) name; `ArtistsAndRepertoire` and `Copyist` are clerical and take no
+ * level.
+ */
+export type RecordingRole = {
+    type: RecordingLeveledRoleType;
+    level?: RecordingRoleLevel;
+} | {
+    type: "Instrumentalist";
+    instrument: string;
+    level?: RecordingRoleLevel;
+} | {
+    type: "Custom";
+    name: string;
+    level?: RecordingRoleLevel;
+} | {
+    type: "ArtistsAndRepertoire";
+} | {
+    type: "Copyist";
+};
+/** A release billing role — a release credit carries exactly one of these. */
+export type ReleaseRole = "Primary" | "Featured";
+export interface AttachCompositionCreditParams {
+    /** The `Composition` object to credit on. */
+    compositionId: string;
+    /** The composition's `CompositionAdminCap`. */
+    compositionAdminCapId: string;
+    /** The `Party` being credited. */
+    partyId: string;
+    /** Human-readable name for the credit (≤200 bytes, non-empty). */
+    displayName: string;
+    /** 1–5 writing roles; duplicates are rejected on-chain. */
+    roles: CompositionRole[];
+    /** The composition's share coin type (the `CompositionShare` phantom). */
+    compositionShareType: string;
+    /** `composition_credits` package id (roles + `add_credit`). */
+    compositionCreditsPackageId: string;
+    /** `miso_credit` package id (home of `credit::new`). */
+    misoCreditPackageId: string;
+}
+/**
+ * Adds a writing credit for a party on a composition. Throws (client-side,
+ * mirroring the Move aborts) when `displayName` is empty or over 200 UTF-8
+ * bytes, or `roles` is empty, has more than 5 entries, or contains duplicates.
+ */
+export declare function attachCompositionCredit(p: AttachCompositionCreditParams): TxThunk;
+export interface AttachRecordingCreditParams {
+    /** The `Recording` object to credit on. */
+    recordingId: string;
+    /** The recording's `RecordingAdminCap`. */
+    recordingAdminCapId: string;
+    /** The `Party` being credited. */
+    partyId: string;
+    /** Human-readable name for the credit (≤200 bytes, non-empty). */
+    displayName: string;
+    /** 1–10 production/performance roles; duplicates are rejected on-chain. */
+    roles: RecordingRole[];
+    /** The recording's own share coin type (the `RecordingShare` phantom). */
+    recordingShareType: string;
+    /** The parent composition's share coin type (the `CompositionShare` phantom). */
+    compositionShareType: string;
+    /** `recording_credits` package id (roles + `add_credit`). */
+    recordingCreditsPackageId: string;
+    /** `miso_credit` package id (home of `credit::new`). */
+    misoCreditPackageId: string;
+}
+/**
+ * Adds a production/performance credit for a party on a recording. Throws
+ * (client-side, mirroring the Move aborts) when `displayName` is empty or over
+ * 200 UTF-8 bytes, or `roles` is empty, has more than 10 entries, or contains
+ * duplicates (same type + instrument + custom name + level).
+ */
+export declare function attachRecordingCredit(p: AttachRecordingCreditParams): TxThunk;
+export interface AddRecordingArtistParams {
+    /** The `Recording` object. */
+    recordingId: string;
+    /** The recording's `RecordingAdminCap`. */
+    recordingAdminCapId: string;
+    /** The `Party` to designate. Must already be credited on the recording. */
+    partyId: string;
+    /** The recording's own share coin type (the `RecordingShare` phantom). */
+    recordingShareType: string;
+    /** The parent composition's share coin type (the `CompositionShare` phantom). */
+    compositionShareType: string;
+    /** `recording_credits` package id. */
+    recordingCreditsPackageId: string;
+}
+/**
+ * Designates an already-credited party as a primary artist on a recording. The
+ * party must be credited first (via `attachRecordingCredit`) and not already a
+ * primary or featured artist.
+ */
+export declare function addRecordingPrimaryArtist(p: AddRecordingArtistParams): TxThunk;
+/**
+ * Designates an already-credited party as a featured artist on a recording. The
+ * party must be credited first (via `attachRecordingCredit`) and not already a
+ * primary or featured artist.
+ */
+export declare function addRecordingFeaturedArtist(p: AddRecordingArtistParams): TxThunk;
+export interface AddReleaseCreditParams {
+    /** The `Release` object to credit on. */
+    releaseId: string;
+    /** The release's `ReleaseAdminCap`. */
+    releaseAdminCapId: string;
+    /** The `Party` being credited. */
+    partyId: string;
+    /** Human-readable name for the credit (≤200 bytes, non-empty). */
+    displayName: string;
+    /** The single billing role: `"Primary"` or `"Featured"`. */
+    role: ReleaseRole;
+    /** `release_credits` package id (roles + `add_credit`). */
+    releaseCreditsPackageId: string;
+    /** `miso_credit` package id (home of `credit::new`). */
+    misoCreditPackageId: string;
+}
+/**
+ * Adds a top-line billing credit (a single role) for a party on a release.
+ * Throws (client-side, mirroring the Move aborts) when `displayName` is empty
+ * or over 200 UTF-8 bytes. The single role is structural, so no role checks.
+ */
+export declare function addReleaseCredit(p: AddReleaseCreditParams): TxThunk;
+/** A normalized credit: the party, its display name, and its role labels. */
+export interface CreditView {
+    /** Object id of the credited `Party`. */
+    partyId: string;
+    /** Human-readable name for the credit. */
+    displayName: string;
+    /**
+     * Role labels (the `name()` semantics). For a recording `Instrumentalist` the
+     * instrument is included (`"Instrumentalist: Guitar"`); a recording role's level
+     * is appended in parentheses (`"Producer (Lead)"`).
+     */
+    roles: string[];
+}
+/** A recording's credits, plus its primary/featured artist party ids. */
+export interface RecordingCreditsView {
+    credits: CreditView[];
+    primaryArtistIds: string[];
+    featuredArtistIds: string[];
+}
+/**
+ * Reads a composition's writing credits (the `composition_credits` extension), or
+ * `null` if no credits field is attached.
+ */
+export declare function getCompositionCredits(client: ClientWithCoreApi, compositionId: string, compositionCreditsPackageId: string): Promise<CreditView[] | null>;
+/**
+ * Reads a recording's credits plus its primary/featured artist party ids (the
+ * `recording_credits` extension), or `null` if no credits field is attached.
+ */
+export declare function getRecordingCredits(client: ClientWithCoreApi, recordingId: string, recordingCreditsPackageId: string): Promise<RecordingCreditsView | null>;
+/**
+ * Reads a release's top-line billing credits (the `release_credits` extension), or
+ * `null` if no credits field is attached. Each credit has exactly one role.
+ */
+export declare function getReleaseCredits(client: ClientWithCoreApi, releaseId: string, releaseCreditsPackageId: string): Promise<CreditView[] | null>;
+//# sourceMappingURL=credits.d.ts.map

package/dist/credits.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"credits.d.ts","sourceRoot":"","sources":["../src/credits.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAI5D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAYjD,iFAAiF;AACjF,MAAM,MAAM,eAAe,GACvB;IAAE,IAAI,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,UAAU,GAAG,YAAY,GAAG,YAAY,CAAA;CAAE,GACxF;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAErC,uDAAuD;AACvD,MAAM,MAAM,kBAAkB,GAC1B,YAAY,GACZ,WAAW,GACX,WAAW,GACX,SAAS,GACT,WAAW,GACX,UAAU,GACV,MAAM,GACN,SAAS,GACT,WAAW,CAAC;AAEhB,8DAA8D;AAC9D,MAAM,MAAM,wBAAwB,GAChC,OAAO,GACP,UAAU,GACV,YAAY,GACZ,OAAO,GACP,aAAa,GACb,eAAe,GACf,WAAW,GACX,YAAY,GACZ,IAAI,GACJ,QAAQ,GACR,UAAU,GACV,UAAU,GACV,mBAAmB,GACnB,gBAAgB,GAChB,eAAe,GACf,iBAAiB,GACjB,UAAU,GACV,WAAW,GACX,cAAc,GACd,WAAW,GACX,UAAU,GACV,YAAY,GACZ,mBAAmB,GACnB,kBAAkB,GAClB,SAAS,GACT,eAAe,GACf,SAAS,GACT,UAAU,CAAC;AAEf;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GACrB;IAAE,IAAI,EAAE,wBAAwB,CAAC;IAAC,KAAK,CAAC,EAAE,kBAAkB,CAAA;CAAE,GAC9D;IAAE,IAAI,EAAE,iBAAiB,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,kBAAkB,CAAA;CAAE,GAC3E;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,kBAAkB,CAAA;CAAE,GAC5D;IAAE,IAAI,EAAE,sBAAsB,CAAA;CAAE,GAChC;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,CAAC;AAExB,8EAA8E;AAC9E,MAAM,MAAM,WAAW,GAAG,SAAS,GAAG,UAAU,CAAC;AAkLjD,MAAM,WAAW,6BAA6B;IAC5C,6CAA6C;IAC7C,aAAa,EAAE,MAAM,CAAC;IACtB,+CAA+C;IAC/C,qBAAqB,EAAE,MAAM,CAAC;IAC9B,kCAAkC;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,kEAAkE;IAClE,WAAW,EAAE,MAAM,CAAC;IACpB,2DAA2D;IAC3D,KAAK,EAAE,eAAe,EAAE,CAAC;IACzB,0EAA0E;IAC1E,oBAAoB,EAAE,MAAM,CAAC;IAC7B,+DAA+D;IAC/D,2BAA2B,EAAE,MAAM,CAAC;IACpC,wDAAwD;IACxD,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,CAAC,EAAE,6BAA6B,GAAG,OAAO,CAejF;AAED,MAAM,WAAW,2BAA2B;IAC1C,2CAA2C;IAC3C,WAAW,EAAE,MAAM,CAAC;IACpB,2CAA2C;IAC3C,mBAAmB,EAAE,MAAM,CAAC;IAC5B,kCAAkC;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,kEAAkE;IAClE,WAAW,EAAE,MAAM,CAAC;IACpB,2EAA2E;IAC3E,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,0EAA0E;IAC1E,kBAAkB,EAAE,MAAM,CAAC;IAC3B,iFAAiF;IACjF,oBAAoB,EAAE,MAAM,CAAC;IAC7B,6DAA6D;IAC7D,yBAAyB,EAAE,MAAM,CAAC;IAClC,wDAAwD;IACxD,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAe7E;AAED,MAAM,WAAW,wBAAwB;IACvC,8BAA8B;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,2CAA2C;IAC3C,mBAAmB,EAAE,MAAM,CAAC;IAC5B,2EAA2E;IAC3E,OAAO,EAAE,MAAM,CAAC;IAChB,0EAA0E;IAC1E,kBAAkB,EAAE,MAAM,CAAC;IAC3B,iFAAiF;IACjF,oBAAoB,EAAE,MAAM,CAAC;IAC7B,sCAAsC;IACtC,yBAAyB,EAAE,MAAM,CAAC;CACnC;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAC,CAAC,EAAE,wBAAwB,GAAG,OAAO,CAU9E;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CAAC,CAAC,EAAE,wBAAwB,GAAG,OAAO,CAU/E;AAED,MAAM,WAAW,sBAAsB;IACrC,yCAAyC;IACzC,SAAS,EAAE,MAAM,CAAC;IAClB,uCAAuC;IACvC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,kCAAkC;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,kEAAkE;IAClE,WAAW,EAAE,MAAM,CAAC;IACpB,4DAA4D;IAC5D,IAAI,EAAE,WAAW,CAAC;IAClB,2DAA2D;IAC3D,uBAAuB,EAAE,MAAM,CAAC;IAChC,wDAAwD;IACxD,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAanE;AAID,6EAA6E;AAC7E,MAAM,WAAW,UAAU;IACzB,yCAAyC;IACzC,OAAO,EAAE,MAAM,CAAC;IAChB,0CAA0C;IAC1C,WAAW,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,yEAAyE;AACzE,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,iBAAiB,EAAE,MAAM,EAAE,CAAC;CAC7B;AAgHD;;;GAGG;AACH,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,iBAAiB,EACzB,aAAa,EAAE,MAAM,EACrB,2BAA2B,EAAE,MAAM,GAClC,OAAO,CAAC,UAAU,EAAE,GAAG,IAAI,CAAC,CAS9B;AAED;;;GAGG;AACH,wBAAsB,mBAAmB,CACvC,MAAM,EAAE,iBAAiB,EACzB,WAAW,EAAE,MAAM,EACnB,yBAAyB,EAAE,MAAM,GAChC,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC,CActC;AAED;;;GAGG;AACH,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,iBAAiB,EACzB,SAAS,EAAE,MAAM,EACjB,uBAAuB,EAAE,MAAM,GAC9B,OAAO,CAAC,UAAU,EAAE,GAAG,IAAI,CAAC,CAS9B"}

package/dist/credits.js

@@ -0,0 +1,360 @@
+// Copyright (c) Miso Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+import { bcs } from "@mysten/sui/bcs";
+import { deriveDynamicFieldID } from "@mysten/sui/utils";
+import { OPTION_NONE, OPTION_SOME } from "./internal.js";
+import { isNotFound } from "./queries.js";
+import * as compositionCredits from "./contracts/composition_credits/composition_credits.js";
+import * as compositionPartyRole from "./contracts/composition_credits/composition_party_role.js";
+import * as recordingCredits from "./contracts/recording_credits/recording_credits.js";
+import * as recordingPartyRole from "./contracts/recording_credits/recording_party_role.js";
+import * as releaseCredits from "./contracts/release_credits/release_credits.js";
+import * as releasePartyRole from "./contracts/release_credits/release_party_role.js";
+const COMPOSITION_ROLE_CTOR = {
+    Adapter: compositionPartyRole.newAdapterRole,
+    Arranger: compositionPartyRole.newArrangerRole,
+    Composer: compositionPartyRole.newComposerRole,
+    Lyricist: compositionPartyRole.newLyricistRole,
+    Songwriter: compositionPartyRole.newSongwriterRole,
+    Translator: compositionPartyRole.newTranslatorRole,
+};
+const RECORDING_LEVEL_CTOR = {
+    Additional: recordingPartyRole.newAdditionalRoleLevel,
+    Assistant: recordingPartyRole.newAssistantRoleLevel,
+    Associate: recordingPartyRole.newAssociateRoleLevel,
+    Backing: recordingPartyRole.newBackingRoleLevel,
+    Executive: recordingPartyRole.newExecutiveRoleLevel,
+    Featured: recordingPartyRole.newFeaturedRoleLevel,
+    Lead: recordingPartyRole.newLeadRoleLevel,
+    Primary: recordingPartyRole.newPrimaryRoleLevel,
+    Principal: recordingPartyRole.newPrincipalRoleLevel,
+};
+const RECORDING_LEVELED_ROLE_CTOR = {
+    Actor: recordingPartyRole.newActorRole,
+    Arranger: recordingPartyRole.newArrangerRole,
+    BandLeader: recordingPartyRole.newBandLeaderRole,
+    Choir: recordingPartyRole.newChoirRole,
+    ChoirMaster: recordingPartyRole.newChoirMasterRole,
+    ConcertMaster: recordingPartyRole.newConcertMasterRole,
+    Conductor: recordingPartyRole.newConductorRole,
+    Contractor: recordingPartyRole.newContractorRole,
+    DJ: recordingPartyRole.newDjRole,
+    Editor: recordingPartyRole.newEditorRole,
+    Engineer: recordingPartyRole.newEngineerRole,
+    Ensemble: recordingPartyRole.newEnsembleRole,
+    MasteringEngineer: recordingPartyRole.newMasteringEngineerRole,
+    MixingEngineer: recordingPartyRole.newMixingEngineerRole,
+    MusicDirector: recordingPartyRole.newMusicDirectorRole,
+    MusicSupervisor: recordingPartyRole.newMusicSupervisorRole,
+    Narrator: recordingPartyRole.newNarratorRole,
+    Orchestra: recordingPartyRole.newOrchestraRole,
+    Orchestrator: recordingPartyRole.newOrchestratorRole,
+    Performer: recordingPartyRole.newPerformerRole,
+    Producer: recordingPartyRole.newProducerRole,
+    Programmer: recordingPartyRole.newProgrammerRole,
+    RecordingEngineer: recordingPartyRole.newRecordingEngineerRole,
+    RemixingEngineer: recordingPartyRole.newRemixingEngineerRole,
+    Soloist: recordingPartyRole.newSoloistRole,
+    SoundDesigner: recordingPartyRole.newSoundDesignerRole,
+    Speaker: recordingPartyRole.newSpeakerRole,
+    Vocalist: recordingPartyRole.newVocalistRole,
+};
+/** Builds an `Option<RecordingPartyRoleLevel>` argument for a role constructor. */
+function levelOption(tx, pkg, level) {
+    const levelType = `${pkg}::recording_party_role::RecordingPartyRoleLevel`;
+    if (!level)
+        return tx.moveCall({ target: OPTION_NONE, typeArguments: [levelType] });
+    const lvl = tx.add(RECORDING_LEVEL_CTOR[level]({ package: pkg }));
+    return tx.moveCall({ target: OPTION_SOME, typeArguments: [levelType], arguments: [lvl] });
+}
+/** Builds one `CompositionPartyRole` value in the PTB. */
+function buildCompositionRole(tx, pkg, role) {
+    if (role.type === "Custom") {
+        return tx.add(compositionPartyRole.newCustomRole({ package: pkg, arguments: [role.name] }));
+    }
+    return tx.add(COMPOSITION_ROLE_CTOR[role.type]({ package: pkg }));
+}
+/** Builds one `RecordingPartyRole` value in the PTB. */
+function buildRecordingRole(tx, pkg, role) {
+    switch (role.type) {
+        case "ArtistsAndRepertoire":
+            return tx.add(recordingPartyRole.newArtistsAndRepertoireRole({ package: pkg }));
+        case "Copyist":
+            return tx.add(recordingPartyRole.newCopyistRole({ package: pkg }));
+        case "Instrumentalist":
+            return tx.add(recordingPartyRole.newInstrumentalistRole({
+                package: pkg,
+                arguments: [role.instrument, levelOption(tx, pkg, role.level)],
+            }));
+        case "Custom":
+            return tx.add(recordingPartyRole.newCustomRole({
+                package: pkg,
+                arguments: [role.name, levelOption(tx, pkg, role.level)],
+            }));
+        default:
+            return tx.add(RECORDING_LEVELED_ROLE_CTOR[role.type]({
+                package: pkg,
+                arguments: [levelOption(tx, pkg, role.level)],
+            }));
+    }
+}
+/** Builds one `ReleasePartyRole` value in the PTB. */
+function buildReleaseRole(tx, pkg, role) {
+    const ctor = role === "Primary" ? releasePartyRole.newPrimaryRole : releasePartyRole.newFeaturedRole;
+    return tx.add(ctor({ package: pkg }));
+}
+// ── Client-side validation ────────────────────────────────────────────────────
+//
+// Mirrors the Move aborts so bad params fail fast (and readably) at the writer
+// call site instead of as an on-chain abort code:
+//   - miso_credit::credit::new — EEmptyString / EMaxDisplayNameLengthExceeded
+//     (display name non-empty, ≤200 BYTES of UTF-8) and ENoRoles / EDuplicateRoles.
+//   - composition_credits::add_credit — EMinRolesNotMet / EExceedsMaxRoles (1–5).
+//   - recording_credits::add_credit — EMinRolesNotMet / EExceedsMaxRoles (1–10).
+const MAX_DISPLAY_NAME_BYTES = 200;
+const MAX_COMPOSITION_ROLES = 5;
+const MAX_RECORDING_ROLES = 10;
+function assertDisplayName(fn, displayName) {
+    if (displayName.length === 0)
+        throw new Error(`${fn}: displayName must not be empty`);
+    const byteLength = new TextEncoder().encode(displayName).length;
+    if (byteLength > MAX_DISPLAY_NAME_BYTES) {
+        throw new Error(`${fn}: displayName must be at most ${MAX_DISPLAY_NAME_BYTES} bytes of UTF-8 (got ${byteLength})`);
+    }
+}
+// Move rejects duplicates by full struct equality, so the duplicate key is the
+// role's complete identity: type + instrument + custom name + level.
+function roleKey(role) {
+    return JSON.stringify([
+        role.type,
+        "instrument" in role ? role.instrument : null,
+        "name" in role ? role.name : null,
+        "level" in role && role.level !== undefined ? role.level : null,
+    ]);
+}
+function assertRoles(fn, roles, max) {
+    if (roles.length < 1)
+        throw new Error(`${fn}: at least one role is required`);
+    if (roles.length > max)
+        throw new Error(`${fn}: at most ${max} roles are allowed (got ${roles.length})`);
+    const seen = new Set();
+    for (const role of roles) {
+        const key = roleKey(role);
+        if (seen.has(key))
+            throw new Error(`${fn}: duplicate role ${key}`);
+        seen.add(key);
+    }
+}
+/** Wraps built role values in a `miso_credit::credit::Credit<Role>`. */
+function buildCredit(tx, misoCreditPackageId, roleType, displayName, roleArgs) {
+    const roles = tx.makeMoveVec({ type: roleType, elements: roleArgs });
+    return tx.moveCall({
+        target: `${misoCreditPackageId}::credit::new`,
+        typeArguments: [roleType],
+        arguments: [tx.pure.string(displayName), roles],
+    });
+}
+/**
+ * Adds a writing credit for a party on a composition. Throws (client-side,
+ * mirroring the Move aborts) when `displayName` is empty or over 200 UTF-8
+ * bytes, or `roles` is empty, has more than 5 entries, or contains duplicates.
+ */
+export function attachCompositionCredit(p) {
+    assertDisplayName("attachCompositionCredit", p.displayName);
+    assertRoles("attachCompositionCredit", p.roles, MAX_COMPOSITION_ROLES);
+    return (tx) => {
+        const roleType = `${p.compositionCreditsPackageId}::composition_party_role::CompositionPartyRole`;
+        const roleArgs = p.roles.map((r) => buildCompositionRole(tx, p.compositionCreditsPackageId, r));
+        const credit = buildCredit(tx, p.misoCreditPackageId, roleType, p.displayName, roleArgs);
+        tx.add(compositionCredits.addCredit({
+            package: p.compositionCreditsPackageId,
+            typeArguments: [p.compositionShareType],
+            arguments: [p.compositionId, p.compositionAdminCapId, p.partyId, credit],
+        }));
+    };
+}
+/**
+ * Adds a production/performance credit for a party on a recording. Throws
+ * (client-side, mirroring the Move aborts) when `displayName` is empty or over
+ * 200 UTF-8 bytes, or `roles` is empty, has more than 10 entries, or contains
+ * duplicates (same type + instrument + custom name + level).
+ */
+export function attachRecordingCredit(p) {
+    assertDisplayName("attachRecordingCredit", p.displayName);
+    assertRoles("attachRecordingCredit", p.roles, MAX_RECORDING_ROLES);
+    return (tx) => {
+        const roleType = `${p.recordingCreditsPackageId}::recording_party_role::RecordingPartyRole`;
+        const roleArgs = p.roles.map((r) => buildRecordingRole(tx, p.recordingCreditsPackageId, r));
+        const credit = buildCredit(tx, p.misoCreditPackageId, roleType, p.displayName, roleArgs);
+        tx.add(recordingCredits.addCredit({
+            package: p.recordingCreditsPackageId,
+            typeArguments: [p.recordingShareType, p.compositionShareType],
+            arguments: [p.recordingId, p.recordingAdminCapId, p.partyId, credit],
+        }));
+    };
+}
+/**
+ * Designates an already-credited party as a primary artist on a recording. The
+ * party must be credited first (via `attachRecordingCredit`) and not already a
+ * primary or featured artist.
+ */
+export function addRecordingPrimaryArtist(p) {
+    return (tx) => {
+        tx.add(recordingCredits.addPrimaryArtist({
+            package: p.recordingCreditsPackageId,
+            typeArguments: [p.recordingShareType, p.compositionShareType],
+            arguments: [p.recordingId, p.recordingAdminCapId, p.partyId],
+        }));
+    };
+}
+/**
+ * Designates an already-credited party as a featured artist on a recording. The
+ * party must be credited first (via `attachRecordingCredit`) and not already a
+ * primary or featured artist.
+ */
+export function addRecordingFeaturedArtist(p) {
+    return (tx) => {
+        tx.add(recordingCredits.addFeaturedArtist({
+            package: p.recordingCreditsPackageId,
+            typeArguments: [p.recordingShareType, p.compositionShareType],
+            arguments: [p.recordingId, p.recordingAdminCapId, p.partyId],
+        }));
+    };
+}
+/**
+ * Adds a top-line billing credit (a single role) for a party on a release.
+ * Throws (client-side, mirroring the Move aborts) when `displayName` is empty
+ * or over 200 UTF-8 bytes. The single role is structural, so no role checks.
+ */
+export function addReleaseCredit(p) {
+    assertDisplayName("addReleaseCredit", p.displayName);
+    return (tx) => {
+        const roleType = `${p.releaseCreditsPackageId}::release_party_role::ReleasePartyRole`;
+        const roleArg = buildReleaseRole(tx, p.releaseCreditsPackageId, p.role);
+        const credit = buildCredit(tx, p.misoCreditPackageId, roleType, p.displayName, [roleArg]);
+        tx.add(releaseCredits.addCredit({
+            package: p.releaseCreditsPackageId,
+            arguments: [p.releaseId, p.releaseAdminCapId, p.partyId, credit],
+        }));
+    };
+}
+// Credits are stored as a dynamic field on the work's UID under the extension's
+// `ExtensionKey()` — a positional struct with no fields, so Move's implicit
+// `dummy_field: bool` serializes to a single `false` byte. The stored object is a
+// `Field { id, name: <Key>, value: <Credits> }`.
+const CompositionCreditsField = bcs.struct("Field", {
+    id: bcs.Address,
+    name: compositionCredits.ExtensionKey,
+    value: compositionCredits.CompositionCredits,
+});
+const RecordingCreditsField = bcs.struct("Field", {
+    id: bcs.Address,
+    name: recordingCredits.ExtensionKey,
+    value: recordingCredits.RecordingCredits,
+});
+const ReleaseCreditsField = bcs.struct("Field", {
+    id: bcs.Address,
+    name: releaseCredits.ExtensionKey,
+    value: releaseCredits.ReleaseCredits,
+});
+const COMPOSITION_CREDITS_KEY_BYTES = compositionCredits.ExtensionKey.serialize([false]).toBytes();
+const RECORDING_CREDITS_KEY_BYTES = recordingCredits.ExtensionKey.serialize([false]).toBytes();
+const RELEASE_CREDITS_KEY_BYTES = releaseCredits.ExtensionKey.serialize([false]).toBytes();
+/** Fetches the BCS content of a work's credits dynamic field, or `null` if none. */
+async function fetchCreditsField(client, workId, keyType, keyBytes) {
+    const fieldId = deriveDynamicFieldID(workId, keyType, keyBytes);
+    try {
+        const { object } = await client.core.getObject({ objectId: fieldId, include: { content: true } });
+        return object?.content ?? null;
+    }
+    catch (e) {
+        if (isNotFound(e))
+            return null;
+        throw e;
+    }
+}
+function creditViews(credits, roleLabel) {
+    return credits.contents.map((entry) => ({
+        partyId: entry.key,
+        displayName: entry.value.display_name,
+        roles: entry.value.roles.map(roleLabel),
+    }));
+}
+// `name()` semantics: the `$kind` is the canonical PascalCase token; `Custom`
+// carries the user-supplied name in its payload.
+function compositionRoleLabel(role) {
+    return role.$kind === "Custom" ? role.Custom : role.$kind;
+}
+function releaseRoleLabel(role) {
+    return role.$kind;
+}
+// `name()` semantics plus the recording extras: the instrument (for
+// `Instrumentalist`) and the optional level, both surfaced into the label.
+function recordingRoleLabel(role) {
+    let base;
+    let level = null;
+    switch (role.$kind) {
+        case "Instrumentalist": {
+            const [instrument, lvl] = role.Instrumentalist;
+            base = `Instrumentalist: ${instrument}`;
+            level = lvl;
+            break;
+        }
+        case "Custom": {
+            const [name, lvl] = role.Custom;
+            base = name;
+            level = lvl;
+            break;
+        }
+        case "ArtistsAndRepertoire":
+        case "Copyist":
+            base = role.$kind;
+            break;
+        default: {
+            // A leveled variant's payload is `Option<Level>`: `None` parses to `true`
+            // (the unit-payload convention), `Some(level)` to the level enum object.
+            base = role.$kind;
+            const payload = role[role.$kind];
+            level =
+                payload && typeof payload === "object" && "$kind" in payload ? payload : null;
+            break;
+        }
+    }
+    return level ? `${base} (${level.$kind})` : base;
+}
+/**
+ * Reads a composition's writing credits (the `composition_credits` extension), or
+ * `null` if no credits field is attached.
+ */
+export async function getCompositionCredits(client, compositionId, compositionCreditsPackageId) {
+    const content = await fetchCreditsField(client, compositionId, `${compositionCreditsPackageId}::composition_credits::ExtensionKey`, COMPOSITION_CREDITS_KEY_BYTES);
+    if (!content)
+        return null;
+    return creditViews(CompositionCreditsField.parse(content).value.credits, compositionRoleLabel);
+}
+/**
+ * Reads a recording's credits plus its primary/featured artist party ids (the
+ * `recording_credits` extension), or `null` if no credits field is attached.
+ */
+export async function getRecordingCredits(client, recordingId, recordingCreditsPackageId) {
+    const content = await fetchCreditsField(client, recordingId, `${recordingCreditsPackageId}::recording_credits::ExtensionKey`, RECORDING_CREDITS_KEY_BYTES);
+    if (!content)
+        return null;
+    const value = RecordingCreditsField.parse(content).value;
+    return {
+        credits: creditViews(value.credits, recordingRoleLabel),
+        primaryArtistIds: value.primary_artist_ids.contents,
+        featuredArtistIds: value.featured_artist_ids.contents,
+    };
+}
+/**
+ * Reads a release's top-line billing credits (the `release_credits` extension), or
+ * `null` if no credits field is attached. Each credit has exactly one role.
+ */
+export async function getReleaseCredits(client, releaseId, releaseCreditsPackageId) {
+    const content = await fetchCreditsField(client, releaseId, `${releaseCreditsPackageId}::release_credits::ExtensionKey`, RELEASE_CREDITS_KEY_BYTES);
+    if (!content)
+        return null;
+    return creditViews(ReleaseCreditsField.parse(content).value.credits, releaseRoleLabel);
+}
+//# sourceMappingURL=credits.js.map

package/dist/credits.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"credits.js","sourceRoot":"","sources":["../src/credits.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,sCAAsC;AAwBtC,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AACtC,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAGzD,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,KAAK,kBAAkB,MAAM,wDAAwD,CAAC;AAC7F,OAAO,KAAK,oBAAoB,MAAM,2DAA2D,CAAC;AAClG,OAAO,KAAK,gBAAgB,MAAM,oDAAoD,CAAC;AACvF,OAAO,KAAK,kBAAkB,MAAM,uDAAuD,CAAC;AAC5F,OAAO,KAAK,cAAc,MAAM,gDAAgD,CAAC;AACjF,OAAO,KAAK,gBAAgB,MAAM,mDAAmD,CAAC;AA0EtF,MAAM,qBAAqB,GAAkE;IAC3F,OAAO,EAAE,oBAAoB,CAAC,cAAc;IAC5C,QAAQ,EAAE,oBAAoB,CAAC,eAAe;IAC9C,QAAQ,EAAE,oBAAoB,CAAC,eAAe;IAC9C,QAAQ,EAAE,oBAAoB,CAAC,eAAe;IAC9C,UAAU,EAAE,oBAAoB,CAAC,iBAAiB;IAClD,UAAU,EAAE,oBAAoB,CAAC,iBAAiB;CACnD,CAAC;AAEF,MAAM,oBAAoB,GAA0C;IAClE,UAAU,EAAE,kBAAkB,CAAC,sBAAsB;IACrD,SAAS,EAAE,kBAAkB,CAAC,qBAAqB;IACnD,SAAS,EAAE,kBAAkB,CAAC,qBAAqB;IACnD,OAAO,EAAE,kBAAkB,CAAC,mBAAmB;IAC/C,SAAS,EAAE,kBAAkB,CAAC,qBAAqB;IACnD,QAAQ,EAAE,kBAAkB,CAAC,oBAAoB;IACjD,IAAI,EAAE,kBAAkB,CAAC,gBAAgB;IACzC,OAAO,EAAE,kBAAkB,CAAC,mBAAmB;IAC/C,SAAS,EAAE,kBAAkB,CAAC,qBAAqB;CACpD,CAAC;AAEF,MAAM,2BAA2B,GAAsD;IACrF,KAAK,EAAE,kBAAkB,CAAC,YAAY;IACtC,QAAQ,EAAE,kBAAkB,CAAC,eAAe;IAC5C,UAAU,EAAE,kBAAkB,CAAC,iBAAiB;IAChD,KAAK,EAAE,kBAAkB,CAAC,YAAY;IACtC,WAAW,EAAE,kBAAkB,CAAC,kBAAkB;IAClD,aAAa,EAAE,kBAAkB,CAAC,oBAAoB;IACtD,SAAS,EAAE,kBAAkB,CAAC,gBAAgB;IAC9C,UAAU,EAAE,kBAAkB,CAAC,iBAAiB;IAChD,EAAE,EAAE,kBAAkB,CAAC,SAAS;IAChC,MAAM,EAAE,kBAAkB,CAAC,aAAa;IACxC,QAAQ,EAAE,kBAAkB,CAAC,eAAe;IAC5C,QAAQ,EAAE,kBAAkB,CAAC,eAAe;IAC5C,iBAAiB,EAAE,kBAAkB,CAAC,wBAAwB;IAC9D,cAAc,EAAE,kBAAkB,CAAC,qBAAqB;IACxD,aAAa,EAAE,kBAAkB,CAAC,oBAAoB;IACtD,eAAe,EAAE,kBAAkB,CAAC,sBAAsB;IAC1D,QAAQ,EAAE,kBAAkB,CAAC,eAAe;IAC5C,SAAS,EAAE,kBAAkB,CAAC,gBAAgB;IAC9C,YAAY,EAAE,kBAAkB,CAAC,mBAAmB;IACpD,SAAS,EAAE,kBAAkB,CAAC,gBAAgB;IAC9C,QAAQ,EAAE,kBAAkB,CAAC,eAAe;IAC5C,UAAU,EAAE,kBAAkB,CAAC,iBAAiB;IAChD,iBAAiB,EAAE,kBAAkB,CAAC,wBAAwB;IAC9D,gBAAgB,EAAE,kBAAkB,CAAC,uBAAuB;IAC5D,OAAO,EAAE,kBAAkB,CAAC,cAAc;IAC1C,aAAa,EAAE,kBAAkB,CAAC,oBAAoB;IACtD,OAAO,EAAE,kBAAkB,CAAC,cAAc;IAC1C,QAAQ,EAAE,kBAAkB,CAAC,eAAe;CAC7C,CAAC;AAEF,mFAAmF;AACnF,SAAS,WAAW,CAClB,EAAe,EACf,GAAW,EACX,KAAqC;IAErC,MAAM,SAAS,GAAG,GAAG,GAAG,iDAAiD,CAAC;IAC1E,IAAI,CAAC,KAAK;QAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IACpF,MAAM,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IAClE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AAC5F,CAAC;AAED,0DAA0D;AAC1D,SAAS,oBAAoB,CAAC,EAAe,EAAE,GAAW,EAAE,IAAqB;IAC/E,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC3B,OAAO,EAAE,CAAC,GAAG,CAAC,oBAAoB,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9F,CAAC;IACD,OAAO,EAAE,CAAC,GAAG,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;AACpE,CAAC;AAED,wDAAwD;AACxD,SAAS,kBAAkB,CAAC,EAAe,EAAE,GAAW,EAAE,IAAmB;IAC3E,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,sBAAsB;YACzB,OAAO,EAAE,CAAC,GAAG,CAAC,kBAAkB,CAAC,2BAA2B,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;QAClF,KAAK,SAAS;YACZ,OAAO,EAAE,CAAC,GAAG,CAAC,kBAAkB,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;QACrE,KAAK,iBAAiB;YACpB,OAAO,EAAE,CAAC,GAAG,CACX,kBAAkB,CAAC,sBAAsB,CAAC;gBACxC,OAAO,EAAE,GAAG;gBACZ,SAAS,EAAE,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;aAC/D,CAAC,CACH,CAAC;QACJ,KAAK,QAAQ;YACX,OAAO,EAAE,CAAC,GAAG,CACX,kBAAkB,CAAC,aAAa,CAAC;gBAC/B,OAAO,EAAE,GAAG;gBACZ,SAAS,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;aACzD,CAAC,CACH,CAAC;QACJ;YACE,OAAO,EAAE,CAAC,GAAG,CACX,2BAA2B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACrC,OAAO,EAAE,GAAG;gBACZ,SAAS,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;aAC9C,CAAC,CACH,CAAC;IACN,CAAC;AACH,CAAC;AAED,sDAAsD;AACtD,SAAS,gBAAgB,CAAC,EAAe,EAAE,GAAW,EAAE,IAAiB;IACvE,MAAM,IAAI,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC,CAAC,gBAAgB,CAAC,eAAe,CAAC;IACrG,OAAO,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;AACxC,CAAC;AAED,iFAAiF;AACjF,EAAE;AACF,+EAA+E;AAC/E,kDAAkD;AAClD,8EAA8E;AAC9E,oFAAoF;AACpF,kFAAkF;AAClF,iFAAiF;AAEjF,MAAM,sBAAsB,GAAG,GAAG,CAAC;AACnC,MAAM,qBAAqB,GAAG,CAAC,CAAC;AAChC,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAE/B,SAAS,iBAAiB,CAAC,EAAU,EAAE,WAAmB;IACxD,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,GAAG,EAAE,iCAAiC,CAAC,CAAC;IACtF,MAAM,UAAU,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC;IAChE,IAAI,UAAU,GAAG,sBAAsB,EAAE,CAAC;QACxC,MAAM,IAAI,KAAK,CAAC,GAAG,EAAE,iCAAiC,sBAAsB,wBAAwB,UAAU,GAAG,CAAC,CAAC;IACrH,CAAC;AACH,CAAC;AAED,+EAA+E;AAC/E,qEAAqE;AACrE,SAAS,OAAO,CAAC,IAAqC;IACpD,OAAO,IAAI,CAAC,SAAS,CAAC;QACpB,IAAI,CAAC,IAAI;QACT,YAAY,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI;QAC7C,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI;QACjC,OAAO,IAAI,IAAI,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI;KAChE,CAAC,CAAC;AACL,CAAC;AAED,SAAS,WAAW,CAAC,EAAU,EAAE,KAA0C,EAAE,GAAW;IACtF,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,GAAG,EAAE,iCAAiC,CAAC,CAAC;IAC9E,IAAI,KAAK,CAAC,MAAM,GAAG,GAAG;QAAE,MAAM,IAAI,KAAK,CAAC,GAAG,EAAE,aAAa,GAAG,2BAA2B,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;IACzG,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAC1B,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,GAAG,EAAE,oBAAoB,GAAG,EAAE,CAAC,CAAC;QACnE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAChB,CAAC;AACH,CAAC;AAED,wEAAwE;AACxE,SAAS,WAAW,CAClB,EAAe,EACf,mBAA2B,EAC3B,QAAgB,EAChB,WAAmB,EACnB,QAAqC;IAErC,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;IACrE,OAAO,EAAE,CAAC,QAAQ,CAAC;QACjB,MAAM,EAAE,GAAG,mBAAmB,eAAe;QAC7C,aAAa,EAAE,CAAC,QAAQ,CAAC;QACzB,SAAS,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,KAAK,CAAC;KAChD,CAAC,CAAC;AACL,CAAC;AAuBD;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,CAAgC;IACtE,iBAAiB,CAAC,yBAAyB,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC;IAC5D,WAAW,CAAC,yBAAyB,EAAE,CAAC,CAAC,KAAK,EAAE,qBAAqB,CAAC,CAAC;IACvE,OAAO,CAAC,EAAE,EAAE,EAAE;QACZ,MAAM,QAAQ,GAAG,GAAG,CAAC,CAAC,2BAA2B,gDAAgD,CAAC;QAClG,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,oBAAoB,CAAC,EAAE,EAAE,CAAC,CAAC,2BAA2B,EAAE,CAAC,CAAC,CAAC,CAAC;QAChG,MAAM,MAAM,GAAG,WAAW,CAAC,EAAE,EAAE,CAAC,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QACzF,EAAE,CAAC,GAAG,CACJ,kBAAkB,CAAC,SAAS,CAAC;YAC3B,OAAO,EAAE,CAAC,CAAC,2BAA2B;YACtC,aAAa,EAAE,CAAC,CAAC,CAAC,oBAAoB,CAAC;YACvC,SAAS,EAAE,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC,CAAC,qBAAqB,EAAE,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC;SACzE,CAAC,CACH,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAuBD;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CAAC,CAA8B;IAClE,iBAAiB,CAAC,uBAAuB,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC;IAC1D,WAAW,CAAC,uBAAuB,EAAE,CAAC,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAAC;IACnE,OAAO,CAAC,EAAE,EAAE,EAAE;QACZ,MAAM,QAAQ,GAAG,GAAG,CAAC,CAAC,yBAAyB,4CAA4C,CAAC;QAC5F,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,EAAE,EAAE,CAAC,CAAC,yBAAyB,EAAE,CAAC,CAAC,CAAC,CAAC;QAC5F,MAAM,MAAM,GAAG,WAAW,CAAC,EAAE,EAAE,CAAC,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QACzF,EAAE,CAAC,GAAG,CACJ,gBAAgB,CAAC,SAAS,CAAC;YACzB,OAAO,EAAE,CAAC,CAAC,yBAAyB;YACpC,aAAa,EAAE,CAAC,CAAC,CAAC,kBAAkB,EAAE,CAAC,CAAC,oBAAoB,CAAC;YAC7D,SAAS,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,mBAAmB,EAAE,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC;SACrE,CAAC,CACH,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAiBD;;;;GAIG;AACH,MAAM,UAAU,yBAAyB,CAAC,CAA2B;IACnE,OAAO,CAAC,EAAE,EAAE,EAAE;QACZ,EAAE,CAAC,GAAG,CACJ,gBAAgB,CAAC,gBAAgB,CAAC;YAChC,OAAO,EAAE,CAAC,CAAC,yBAAyB;YACpC,aAAa,EAAE,CAAC,CAAC,CAAC,kBAAkB,EAAE,CAAC,CAAC,oBAAoB,CAAC;YAC7D,SAAS,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,mBAAmB,EAAE,CAAC,CAAC,OAAO,CAAC;SAC7D,CAAC,CACH,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,0BAA0B,CAAC,CAA2B;IACpE,OAAO,CAAC,EAAE,EAAE,EAAE;QACZ,EAAE,CAAC,GAAG,CACJ,gBAAgB,CAAC,iBAAiB,CAAC;YACjC,OAAO,EAAE,CAAC,CAAC,yBAAyB;YACpC,aAAa,EAAE,CAAC,CAAC,CAAC,kBAAkB,EAAE,CAAC,CAAC,oBAAoB,CAAC;YAC7D,SAAS,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,mBAAmB,EAAE,CAAC,CAAC,OAAO,CAAC;SAC7D,CAAC,CACH,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAmBD;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,CAAyB;IACxD,iBAAiB,CAAC,kBAAkB,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC;IACrD,OAAO,CAAC,EAAE,EAAE,EAAE;QACZ,MAAM,QAAQ,GAAG,GAAG,CAAC,CAAC,uBAAuB,wCAAwC,CAAC;QACtF,MAAM,OAAO,GAAG,gBAAgB,CAAC,EAAE,EAAE,CAAC,CAAC,uBAAuB,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;QACxE,MAAM,MAAM,GAAG,WAAW,CAAC,EAAE,EAAE,CAAC,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;QAC1F,EAAE,CAAC,GAAG,CACJ,cAAc,CAAC,SAAS,CAAC;YACvB,OAAO,EAAE,CAAC,CAAC,uBAAuB;YAClC,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,iBAAiB,EAAE,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC;SACjE,CAAC,CACH,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AA8BD,gFAAgF;AAChF,4EAA4E;AAC5E,kFAAkF;AAClF,iDAAiD;AACjD,MAAM,uBAAuB,GAAG,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE;IAClD,EAAE,EAAE,GAAG,CAAC,OAAO;IACf,IAAI,EAAE,kBAAkB,CAAC,YAAY;IACrC,KAAK,EAAE,kBAAkB,CAAC,kBAAkB;CAC7C,CAAC,CAAC;AACH,MAAM,qBAAqB,GAAG,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE;IAChD,EAAE,EAAE,GAAG,CAAC,OAAO;IACf,IAAI,EAAE,gBAAgB,CAAC,YAAY;IACnC,KAAK,EAAE,gBAAgB,CAAC,gBAAgB;CACzC,CAAC,CAAC;AACH,MAAM,mBAAmB,GAAG,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE;IAC9C,EAAE,EAAE,GAAG,CAAC,OAAO;IACf,IAAI,EAAE,cAAc,CAAC,YAAY;IACjC,KAAK,EAAE,cAAc,CAAC,cAAc;CACrC,CAAC,CAAC;AAEH,MAAM,6BAA6B,GAAG,kBAAkB,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;AACnG,MAAM,2BAA2B,GAAG,gBAAgB,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;AAC/F,MAAM,yBAAyB,GAAG,cAAc,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;AAE3F,oFAAoF;AACpF,KAAK,UAAU,iBAAiB,CAC9B,MAAyB,EACzB,MAAc,EACd,OAAe,EACf,QAAoB;IAEpB,MAAM,OAAO,GAAG,oBAAoB,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IAChE,IAAI,CAAC;QACH,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;QAClG,OAAO,MAAM,EAAE,OAAO,IAAI,IAAI,CAAC;IACjC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,IAAI,UAAU,CAAC,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;QAC/B,MAAM,CAAC,CAAC;IACV,CAAC;AACH,CAAC;AAUD,SAAS,WAAW,CAClB,OAA+B,EAC/B,SAAiC;IAEjC,OAAO,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACtC,OAAO,EAAE,KAAK,CAAC,GAAG;QAClB,WAAW,EAAE,KAAK,CAAC,KAAK,CAAC,YAAY;QACrC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC;KACxC,CAAC,CAAC,CAAC;AACN,CAAC;AAED,8EAA8E;AAC9E,iDAAiD;AACjD,SAAS,oBAAoB,CAAC,IAAgB;IAC5C,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAE,IAAI,CAAC,MAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;AACxE,CAAC;AAED,SAAS,gBAAgB,CAAC,IAAgB;IACxC,OAAO,IAAI,CAAC,KAAK,CAAC;AACpB,CAAC;AAED,oEAAoE;AACpE,2EAA2E;AAC3E,SAAS,kBAAkB,CAAC,IAAgB;IAC1C,IAAI,IAAY,CAAC;IACjB,IAAI,KAAK,GAAgB,IAAI,CAAC;IAC9B,QAAQ,IAAI,CAAC,KAAK,EAAE,CAAC;QACnB,KAAK,iBAAiB,CAAC,CAAC,CAAC;YACvB,MAAM,CAAC,UAAU,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC,eAAwC,CAAC;YACxE,IAAI,GAAG,oBAAoB,UAAU,EAAE,CAAC;YACxC,KAAK,GAAG,GAAG,CAAC;YACZ,MAAM;QACR,CAAC;QACD,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC,MAA+B,CAAC;YACzD,IAAI,GAAG,IAAI,CAAC;YACZ,KAAK,GAAG,GAAG,CAAC;YACZ,MAAM;QACR,CAAC;QACD,KAAK,sBAAsB,CAAC;QAC5B,KAAK,SAAS;YACZ,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;YAClB,MAAM;QACR,OAAO,CAAC,CAAC,CAAC;YACR,0EAA0E;YAC1E,yEAAyE;YACzE,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;YAClB,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACjC,KAAK;gBACH,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,IAAI,OAAO,CAAC,CAAC,CAAE,OAAsB,CAAC,CAAC,CAAC,IAAI,CAAC;YAChG,MAAM;QACR,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,KAAK,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;AACnD,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,MAAyB,EACzB,aAAqB,EACrB,2BAAmC;IAEnC,MAAM,OAAO,GAAG,MAAM,iBAAiB,CACrC,MAAM,EACN,aAAa,EACb,GAAG,2BAA2B,qCAAqC,EACnE,6BAA6B,CAC9B,CAAC;IACF,IAAI,CAAC,OAAO;QAAE,OAAO,IAAI,CAAC;IAC1B,OAAO,WAAW,CAAC,uBAAuB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;AACjG,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,MAAyB,EACzB,WAAmB,EACnB,yBAAiC;IAEjC,MAAM,OAAO,GAAG,MAAM,iBAAiB,CACrC,MAAM,EACN,WAAW,EACX,GAAG,yBAAyB,mCAAmC,EAC/D,2BAA2B,CAC5B,CAAC;IACF,IAAI,CAAC,OAAO;QAAE,OAAO,IAAI,CAAC;IAC1B,MAAM,KAAK,GAAG,qBAAqB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC;IACzD,OAAO;QACL,OAAO,EAAE,WAAW,CAAC,KAAK,CAAC,OAAO,EAAE,kBAAkB,CAAC;QACvD,gBAAgB,EAAE,KAAK,CAAC,kBAAkB,CAAC,QAAQ;QACnD,iBAAiB,EAAE,KAAK,CAAC,mBAAmB,CAAC,QAAQ;KACtD,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,MAAyB,EACzB,SAAiB,EACjB,uBAA+B;IAE/B,MAAM,OAAO,GAAG,MAAM,iBAAiB,CACrC,MAAM,EACN,SAAS,EACT,GAAG,uBAAuB,iCAAiC,EAC3D,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,OAAO;QAAE,OAAO,IAAI,CAAC;IAC1B,OAAO,WAAW,CAAC,mBAAmB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;AACzF,CAAC"}

package/dist/execute.d.ts

@@ -0,0 +1,49 @@
+import { Transaction } from "@mysten/sui/transactions";
+import type { ClientWithCoreApi, SuiClientTypes } from "@mysten/sui/client";
+import type { Signer } from "@mysten/sui/cryptography";
+import type { TxThunk } from "./transactions.ts";
+/** The effect fields every submit path requests, so extraction is uniform. */
+export declare const FULL_INCLUDE: {
+    readonly effects: true;
+    readonly objectTypes: true;
+    readonly balanceChanges: true;
+};
+type FullInclude = typeof FULL_INCLUDE;
+export interface ExecResult {
+    digest: string;
+    /** Objects created/mutated/deleted by the transaction. */
+    changedObjects: SuiClientTypes.ChangedObject[];
+    /** Map of changed objectId → fully-qualified type. */
+    objectTypes: Record<string, string>;
+    /** Net coin balance deltas by address. */
+    balanceChanges: SuiClientTypes.BalanceChange[];
+    /** Net gas cost in MIST (computation + storage − rebate). */
+    gasUsed: number;
+}
+/** Builds a fresh Transaction from one or more thunks (awaiting async ones). */
+export declare function buildTx(...thunks: TxThunk[]): Promise<Transaction>;
+/** Normalizes the `{ $kind }` transaction-result envelope into an {@link ExecResult}. */
+export declare function toExecResult(res: SuiClientTypes.TransactionResult<FullInclude>): ExecResult;
+/** Signs, executes, and waits for a transaction; returns changes, types, gas. */
+export declare function signAndExecute(client: ClientWithCoreApi, signer: Signer, tx: Transaction): Promise<ExecResult>;
+/** Convenience: build from thunks, then sign+execute in one call. */
+export declare function execThunks(client: ClientWithCoreApi, signer: Signer, ...thunks: TxThunk[]): Promise<ExecResult>;
+/** The package id from the (single) newly-published package. */
+export declare function publishedPackageId(r: ExecResult): string;
+/** All package ids newly published by the transaction (up to 5 per PTB). */
+export declare function allPublishedPackageIds(r: ExecResult): string[];
+/** The first newly-created object whose type contains `substr`. */
+export declare function createdByType(r: ExecResult, substr: string): string;
+/** Like {@link createdByType} but returns undefined instead of throwing. */
+export declare function maybeCreatedByType(r: ExecResult, substr: string): string | undefined;
+/** The first newly-created object whose type is EXACTLY `type` (for non-generic types). */
+export declare function createdByExactType(r: ExecResult, type: string): string;
+/** All newly-created objects whose type contains `substr`. */
+export declare function allCreatedByType(r: ExecResult, substr: string): {
+    objectId: string;
+    objectType: string;
+}[];
+/** The signed balance delta for `address` in `coinType`, or "0" if absent. */
+export declare function balanceDelta(r: ExecResult, address: string, coinType: string): string;
+export {};
+//# sourceMappingURL=execute.d.ts.map

package/dist/execute.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"execute.d.ts","sourceRoot":"","sources":["../src/execute.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,KAAK,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAC5E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAEjD,8EAA8E;AAC9E,eAAO,MAAM,YAAY;;;;CAAsE,CAAC;AAChG,KAAK,WAAW,GAAG,OAAO,YAAY,CAAC;AAEvC,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,0DAA0D;IAC1D,cAAc,EAAE,cAAc,CAAC,aAAa,EAAE,CAAC;IAC/C,sDAAsD;IACtD,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,0CAA0C;IAC1C,cAAc,EAAE,cAAc,CAAC,aAAa,EAAE,CAAC;IAC/C,6DAA6D;IAC7D,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,gFAAgF;AAChF,wBAAsB,OAAO,CAAC,GAAG,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,WAAW,CAAC,CAIxE;AAED,yFAAyF;AACzF,wBAAgB,YAAY,CAAC,GAAG,EAAE,cAAc,CAAC,iBAAiB,CAAC,WAAW,CAAC,GAAG,UAAU,CAqB3F;AAED,iFAAiF;AACjF,wBAAsB,cAAc,CAAC,MAAM,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,CAKpH;AAED,qEAAqE;AACrE,wBAAsB,UAAU,CAAC,MAAM,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC,CAErH;AAID,gEAAgE;AAChE,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,UAAU,GAAG,MAAM,CAIxD;AAED,4EAA4E;AAC5E,wBAAgB,sBAAsB,CAAC,CAAC,EAAE,UAAU,GAAG,MAAM,EAAE,CAI9D;AAED,mEAAmE;AACnE,wBAAgB,aAAa,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAInE;AAED,4EAA4E;AAC5E,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAKpF;AAED,2FAA2F;AAC3F,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAKtE;AAED,8DAA8D;AAC9D,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,EAAE,CAO1G;AAED,8EAA8E;AAC9E,wBAAgB,YAAY,CAAC,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAGrF"}