@misonetwork/sdk 0.6.0 → 0.8.0

package/src/types.ts

@@ -35,7 +35,10 @@ export interface Composition {
   state: CompositionState;
   /** Primary title of the composition. */
   title: string;
-  /** Royalty rate this composition earns from each recording's revenue (basis points, 0-2000). */
+  /**
+   * Royalty rate this composition earns from each recording's revenue (basis
+   * points, 0-10000). Immutable for the composition's lifetime.
+   */
   royaltyRate: BPS;
 }
 
@@ -48,14 +51,6 @@ export interface CompositionPublishedEvent {
   compositionId: string;
 }
 
-/**
- * Emitted when a composition's royalty rate is set or changed. The composition
- * is identified by the event's `CompositionShare` phantom type, not a field.
- */
-export interface CompositionRoyaltySetEvent {
-  royaltyRateBps: number;
-}
-
 /**
  * Admin cap for a Composition, derived deterministically from the Composition object ID.
  *
@@ -96,6 +91,12 @@ export interface Recording {
   id: string;
   /** Current lifecycle state. */
   state: RecordingState;
+  /**
+   * Object ID of the parent composition. An identity/membership handle — not a
+   * revenue routing target: the composition is paid via its recording-share
+   * ownership, settled at recording creation. Immutable.
+   */
+  compositionId: string;
 }
 
 /**
@@ -107,6 +108,20 @@ export interface RecordingPublishedEvent {
   recordingId: string;
 }
 
+/**
+ * Emitted when recording creation grants the composition its immutable royalty
+ * rate's share of the new recording currency.
+ */
+export interface CompositionSharesGrantedEvent {
+  recordingId: string;
+  compositionId: string;
+  /** Recording-share base units sent to the composition address. */
+  value: string;
+  /** The immutable composition royalty rate applied at recording creation. */
+  rateBps: number;
+  grantedBy: string;
+}
+
 /**
  * Admin cap for a Recording, derived deterministically from the Recording object ID.
  *
@@ -135,6 +150,13 @@ export type TrackState = "Unassigned" | "Assigned";
 export interface Track {
   /** Current state of the track (Unassigned until the release claims it, then Assigned). */
   state: TrackState;
+  /**
+   * ID of the composition underlying this track's recording. An identity/
+   * membership handle — not a revenue routing target: the composition is paid
+   * via its recording-share ownership, and a track routes its full split to the
+   * recording.
+   */
+  compositionId: string;
   /** ID of the recording on this track. */
   recordingId: string;
   /** Revenue split for this track within the release (in basis points). */
@@ -180,6 +202,12 @@ export interface ReleasePublishedEvent {
   releaseId: string;
 }
 
+/** Emitted when package initialization shares the canonical release registry. */
+export interface ReleaseRegistryCreatedEvent {
+  registryId: string;
+  createdBy: string;
+}
+
 /**
  * Admin cap for a Release, derived deterministically from the Release object ID.
  *

package/src/view.ts

@@ -10,6 +10,7 @@ import { Transaction } from "@mysten/sui/transactions";
 import { bcs } from "@mysten/sui/bcs";
 import type { ClientWithCoreApi } from "@mysten/sui/client";
 import * as release from "./contracts/miso/release.ts";
+import { asU256, asU64, type UnsignedInput } from "./numeric.ts";
 
 export interface DeriveTargetReleaseIdParams {
   /** Sender for the simulation (any address; not charged). */
@@ -17,18 +18,18 @@ export interface DeriveTargetReleaseIdParams {
   /** Recording object ids, in track order. */
   recordingIds: string[];
   /** Per-track split basis points, aligned to `recordingIds`. */
-  splitBps: number[];
+  splitBps: UnsignedInput[];
   /** The release nonce (u256 as a decimal string). */
-  nonce: string;
-  /** The derivation parent's object ID, e.g. an extension's shared ReleaseRegistry. */
-  parentId: string;
+  nonce: UnsignedInput;
+  /** Shared canonical core `miso::release::ReleaseRegistry` object ID. */
+  releaseRegistryId: string;
 }
 
 /**
  * Derives the release id the on-chain `release::new` will produce for these
  * inputs, via a `simulateTransaction` call to `release::derive_target_release_id`.
  * Tracks embedded in a release must reference this exact ID, so it is computed
- * up front and threaded into the extension-layer release builder.
+ * up front and threaded into the core release builder.
  */
 export async function deriveTargetReleaseId(
   client: ClientWithCoreApi,
@@ -44,7 +45,12 @@ export async function deriveTargetReleaseId(
   tx.add(
     release.deriveTargetReleaseId({
       package: misoPackageId,
-      arguments: [params.recordingIds, params.splitBps.map((v) => BigInt(v)), BigInt(params.nonce), params.parentId],
+      arguments: [
+        params.releaseRegistryId,
+        params.recordingIds,
+        params.splitBps.map((v) => asU64("track split bps", v)),
+        asU256("release nonce", params.nonce),
+      ],
     }),
   );