@misofm/sdk 0.15.11 → 0.17.0

package/src/contracts/composition_credits/composition_credits.ts

@@ -5,14 +5,14 @@
 
 /**
  * First-party credits extension for compositions.
- * 
+ *
  * Attribution (writing credits) is display-oriented and varies across platforms,
  * so it lives here as a dynamic field on the composition rather than in immutable
  * core. The data is attached under `ExtensionKey()` via the composition's
  * cap-gated `uid_mut`, so every mutation is authorized by the composition's admin
  * and credits survive into any lifecycle state (they may be attached before or
  * after the composition is published).
- * 
+ *
  * This is Miso's canonical credits standard; because it is an extension, other
  * parties may publish their own composition-credits standard against the same
  * `Composition`. Credits are NOT read by the economics — they are attribution.
@@ -20,6 +20,7 @@
 
 import { MoveTuple, MoveStruct, normalizeMoveArguments, type RawTransactionArgument } from '../utils/index.js';
 import { bcs } from '@mysten/sui/bcs';
+import type {} from "@mysten/bcs";
 import { type Transaction, type TransactionArgument } from '@mysten/sui/transactions';
 import * as vec_map from './deps/sui/vec_map.js';
 import * as credit from './deps/miso_credit/credit.js';

package/src/contracts/composition_credits/composition_party_role.ts

@@ -7,13 +7,13 @@
  * Defines the roles that parties can hold on a composition. Compositions are the
  * underlying musical works (melody + lyrics), and these roles represent the
  * writing and adaptation contributions to them.
- * 
+ *
  * ### Design
- * 
+ *
  * `CompositionPartyRole` is a closed enum: variants can only be constructed and
  * matched inside this module, so the `new_*_role` constructors are the external
  * write-API and `name()` is the external read-API.
- * 
+ *
  * - **No seniority axis.** Unlike recording roles, composition roles carry no
  *   level — a writer either contributed in a given capacity or did not.
  * - **`Custom` is the escape hatch.** The canonical variants cover the common
@@ -22,13 +22,14 @@
  * - **`name()` is the canonical identifier**, returned as a stable PascalCase
  *   token (e.g. `"Songwriter"`). For `Custom`, `name()` returns the user-supplied
  *   string.
- * 
+ *
  * These identifiers are Miso's own canonical vocabulary; any overlap with an
  * external standard (e.g. DDEX) is coincidental, not a reproduction of it.
  */
 
 import { MoveEnum, normalizeMoveArguments, type RawTransactionArgument } from '../utils/index.js';
 import { bcs } from '@mysten/sui/bcs';
+import type {} from "@mysten/bcs";
 import { type Transaction, type TransactionArgument } from '@mysten/sui/transactions';
 const $moduleName = '@local-pkg/composition_credits::composition_party_role';
 /** Represents a party's role on a composition. */

package/src/contracts/composition_credits/deps/miso_credit/credit.ts

@@ -9,6 +9,7 @@
  */
 
 import { type BcsType, bcs } from '@mysten/sui/bcs';
+import type {} from "@mysten/bcs";
 import { MoveStruct } from '../../../utils/index.js';
 const $moduleName = 'miso_credit::credit';
 /**

package/src/contracts/composition_credits/deps/sui/vec_map.ts

@@ -2,6 +2,7 @@
  * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
  **************************************************************/
 import { type BcsType, bcs } from '@mysten/sui/bcs';
+import type {} from "@mysten/bcs";
 import { MoveStruct } from '../../../utils/index.js';
 const $moduleName = '0x2::vec_map';
 /** An entry in the map */

package/src/contracts/composition_routed_stake/composition_routed_stake.ts

@@ -4,91 +4,27 @@
 
 
 /**
- * Vault-authorized control over Recording shares owned by a Composition.
- * 
- * The plugin redeems Recording shares held at the Composition address and places
- * them in a generic `routed_stake::RoutedStake`. The independently shared wrapper
- * prevents rewards from surfacing as freely claimable funds: its permissionless
- * `sweep` operation can route them only into the royalty pool derived from the
- * same Composition.
+ * Raw-cap lifecycle actions for Recording shares owned by a Composition.
+ *
+ * The returned routed stake is unshared so callers can register it before sharing.
+ * Reward sweeping remains the permissionless operation provided by `routed_stake`;
+ * this package adds only protocol-specific parent checks.
  */
 
-import { type Transaction } from '@mysten/sui/transactions';
+import { type Transaction, type TransactionArgument } from '@mysten/sui/transactions';
 import { normalizeMoveArguments, type RawTransactionArgument } from '../utils/index.js';
-export interface InstallArguments {
-    vault: RawTransactionArgument<string>;
-    vaultAdminCap: RawTransactionArgument<string>;
-}
-export interface InstallOptions {
-    package?: string;
-    arguments: InstallArguments | [
-        vault: RawTransactionArgument<string>,
-        vaultAdminCap: RawTransactionArgument<string>
-    ];
-    typeArguments: [
-        string
-    ];
-}
-/** Authorize this package on a Composition capability Vault. */
-export function install(options: InstallOptions) {
-    const packageAddress = options.package ?? '@local-pkg/composition_routed_stake';
-    const argumentsTypes = [
-        null,
-        null
-    ] satisfies (string | null)[];
-    const parameterNames = ["vault", "vaultAdminCap"];
-    return (tx: Transaction) => tx.moveCall({
-        package: packageAddress,
-        module: 'composition_routed_stake',
-        function: 'install',
-        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
-        typeArguments: options.typeArguments
-    });
-}
-export interface UninstallArguments {
-    vault: RawTransactionArgument<string>;
-    vaultAdminCap: RawTransactionArgument<string>;
-}
-export interface UninstallOptions {
-    package?: string;
-    arguments: UninstallArguments | [
-        vault: RawTransactionArgument<string>,
-        vaultAdminCap: RawTransactionArgument<string>
-    ];
-    typeArguments: [
-        string
-    ];
-}
-/** Revoke this package from a Composition capability Vault. */
-export function uninstall(options: UninstallOptions) {
-    const packageAddress = options.package ?? '@local-pkg/composition_routed_stake';
-    const argumentsTypes = [
-        null,
-        null
-    ] satisfies (string | null)[];
-    const parameterNames = ["vault", "vaultAdminCap"];
-    return (tx: Transaction) => tx.moveCall({
-        package: packageAddress,
-        module: 'composition_routed_stake',
-        function: 'uninstall',
-        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
-        typeArguments: options.typeArguments
-    });
-}
 export interface CreateStakeArguments {
-    vault: RawTransactionArgument<string>;
     composition: RawTransactionArgument<string>;
+    adminCap: RawTransactionArgument<string>;
     recording: RawTransactionArgument<string>;
-    vaultAdminCap: RawTransactionArgument<string>;
     value: RawTransactionArgument<number | bigint>;
 }
 export interface CreateStakeOptions {
     package?: string;
     arguments: CreateStakeArguments | [
-        vault: RawTransactionArgument<string>,
         composition: RawTransactionArgument<string>,
+        adminCap: RawTransactionArgument<string>,
         recording: RawTransactionArgument<string>,
-        vaultAdminCap: RawTransactionArgument<string>,
         value: RawTransactionArgument<number | bigint>
     ];
     typeArguments: [
@@ -97,9 +33,8 @@ export interface CreateStakeOptions {
     ];
 }
 /**
- * Redeem Composition-owned Recording shares, create the Composition-derived routed
- * stake, and share it. The Recording reference pins both share types to a real
- * Composition/Recording relationship.
+ * Redeem Composition-owned Recording shares and return a new unshared routed stake
+ * derived from the Composition.
  */
 export function createStake(options: CreateStakeOptions) {
     const packageAddress = options.package ?? '@local-pkg/composition_routed_stake';
@@ -107,10 +42,9 @@ export function createStake(options: CreateStakeOptions) {
         null,
         null,
         null,
-        null,
         'u64'
     ] satisfies (string | null)[];
-    const parameterNames = ["vault", "composition", "recording", "vaultAdminCap", "value"];
+    const parameterNames = ["composition", "adminCap", "recording", "value"];
     return (tx: Transaction) => tx.moveCall({
         package: packageAddress,
         module: 'composition_routed_stake',
@@ -120,22 +54,20 @@ export function createStake(options: CreateStakeOptions) {
     });
 }
 export interface RegisterArguments {
-    vault: RawTransactionArgument<string>;
     composition: RawTransactionArgument<string>;
+    adminCap: RawTransactionArgument<string>;
     recording: RawTransactionArgument<string>;
     routed: RawTransactionArgument<string>;
     pool: RawTransactionArgument<string>;
-    vaultAdminCap: RawTransactionArgument<string>;
 }
 export interface RegisterOptions {
     package?: string;
     arguments: RegisterArguments | [
-        vault: RawTransactionArgument<string>,
         composition: RawTransactionArgument<string>,
+        adminCap: RawTransactionArgument<string>,
         recording: RawTransactionArgument<string>,
         routed: RawTransactionArgument<string>,
-        pool: RawTransactionArgument<string>,
-        vaultAdminCap: RawTransactionArgument<string>
+        pool: RawTransactionArgument<string>
     ];
     typeArguments: [
         string,
@@ -143,10 +75,7 @@ export interface RegisterOptions {
         string
     ];
 }
-/**
- * Register the routed stake with the canonical pool derived from the supplied
- * Recording. The Vault administrator controls which currencies are enabled.
- */
+/** Register the routed stake with the canonical pool derived from `recording`. */
 export function register(options: RegisterOptions) {
     const packageAddress = options.package ?? '@local-pkg/composition_routed_stake';
     const argumentsTypes = [
@@ -154,10 +83,9 @@ export function register(options: RegisterOptions) {
         null,
         null,
         null,
-        null,
         null
     ] satisfies (string | null)[];
-    const parameterNames = ["vault", "composition", "recording", "routed", "pool", "vaultAdminCap"];
+    const parameterNames = ["composition", "adminCap", "recording", "routed", "pool"];
     return (tx: Transaction) => tx.moveCall({
         package: packageAddress,
         module: 'composition_routed_stake',
@@ -167,22 +95,20 @@ export function register(options: RegisterOptions) {
     });
 }
 export interface UnregisterArguments {
-    vault: RawTransactionArgument<string>;
     composition: RawTransactionArgument<string>;
+    adminCap: RawTransactionArgument<string>;
     recording: RawTransactionArgument<string>;
     routed: RawTransactionArgument<string>;
     pool: RawTransactionArgument<string>;
-    vaultAdminCap: RawTransactionArgument<string>;
 }
 export interface UnregisterOptions {
     package?: string;
     arguments: UnregisterArguments | [
-        vault: RawTransactionArgument<string>,
         composition: RawTransactionArgument<string>,
+        adminCap: RawTransactionArgument<string>,
         recording: RawTransactionArgument<string>,
         routed: RawTransactionArgument<string>,
-        pool: RawTransactionArgument<string>,
-        vaultAdminCap: RawTransactionArgument<string>
+        pool: RawTransactionArgument<string>
     ];
     typeArguments: [
         string,
@@ -190,7 +116,10 @@ export interface UnregisterOptions {
         string
     ];
 }
-/** Unregister the routed stake after its pending reward has been swept. */
+/**
+ * Unregister the routed stake from the canonical Recording pool after all
+ * claimable rewards have been swept.
+ */
 export function unregister(options: UnregisterOptions) {
     const packageAddress = options.package ?? '@local-pkg/composition_routed_stake';
     const argumentsTypes = [
@@ -198,10 +127,9 @@ export function unregister(options: UnregisterOptions) {
         null,
         null,
         null,
-        null,
         null
     ] satisfies (string | null)[];
-    const parameterNames = ["vault", "composition", "recording", "routed", "pool", "vaultAdminCap"];
+    const parameterNames = ["composition", "adminCap", "recording", "routed", "pool"];
     return (tx: Transaction) => tx.moveCall({
         package: packageAddress,
         module: 'composition_routed_stake',
@@ -211,37 +139,31 @@ export function unregister(options: UnregisterOptions) {
     });
 }
 export interface UnstakeArguments {
-    vault: RawTransactionArgument<string>;
     composition: RawTransactionArgument<string>;
+    adminCap: RawTransactionArgument<string>;
     routed: RawTransactionArgument<string>;
-    vaultAdminCap: RawTransactionArgument<string>;
 }
 export interface UnstakeOptions {
     package?: string;
     arguments: UnstakeArguments | [
-        vault: RawTransactionArgument<string>,
         composition: RawTransactionArgument<string>,
-        routed: RawTransactionArgument<string>,
-        vaultAdminCap: RawTransactionArgument<string>
+        adminCap: RawTransactionArgument<string>,
+        routed: RawTransactionArgument<string>
     ];
     typeArguments: [
         string,
         string
     ];
 }
-/**
- * Remove the routed position and return its principal to the Composition address.
- * Principal never becomes a caller-controlled Coin or Balance.
- */
+/** Remove the routed position and return its Recording-share principal. */
 export function unstake(options: UnstakeOptions) {
     const packageAddress = options.package ?? '@local-pkg/composition_routed_stake';
     const argumentsTypes = [
-        null,
         null,
         null,
         null
     ] satisfies (string | null)[];
-    const parameterNames = ["vault", "composition", "routed", "vaultAdminCap"];
+    const parameterNames = ["composition", "adminCap", "routed"];
     return (tx: Transaction) => tx.moveCall({
         package: packageAddress,
         module: 'composition_routed_stake',
@@ -251,70 +173,38 @@ export function unstake(options: UnstakeOptions) {
     });
 }
 export interface RestakeArguments {
-    vault: RawTransactionArgument<string>;
     composition: RawTransactionArgument<string>;
+    adminCap: RawTransactionArgument<string>;
     routed: RawTransactionArgument<string>;
-    vaultAdminCap: RawTransactionArgument<string>;
-    value: RawTransactionArgument<number | bigint>;
+    shares: TransactionArgument;
 }
 export interface RestakeOptions {
     package?: string;
     arguments: RestakeArguments | [
-        vault: RawTransactionArgument<string>,
         composition: RawTransactionArgument<string>,
+        adminCap: RawTransactionArgument<string>,
         routed: RawTransactionArgument<string>,
-        vaultAdminCap: RawTransactionArgument<string>,
-        value: RawTransactionArgument<number | bigint>
+        shares: TransactionArgument
     ];
     typeArguments: [
         string,
         string
     ];
 }
-/**
- * Refill an empty routed stake from Recording shares held at the Composition
- * address.
- */
+/** Refill an empty routed stake with caller-supplied Recording-share principal. */
 export function restake(options: RestakeOptions) {
     const packageAddress = options.package ?? '@local-pkg/composition_routed_stake';
     const argumentsTypes = [
         null,
         null,
         null,
-        null,
-        'u64'
-    ] satisfies (string | null)[];
-    const parameterNames = ["vault", "composition", "routed", "vaultAdminCap", "value"];
-    return (tx: Transaction) => tx.moveCall({
-        package: packageAddress,
-        module: 'composition_routed_stake',
-        function: 'restake',
-        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
-        typeArguments: options.typeArguments
-    });
-}
-export interface IsInstalledArguments {
-    vault: RawTransactionArgument<string>;
-}
-export interface IsInstalledOptions {
-    package?: string;
-    arguments: IsInstalledArguments | [
-        vault: RawTransactionArgument<string>
-    ];
-    typeArguments: [
-        string
-    ];
-}
-export function isInstalled(options: IsInstalledOptions) {
-    const packageAddress = options.package ?? '@local-pkg/composition_routed_stake';
-    const argumentsTypes = [
         null
     ] satisfies (string | null)[];
-    const parameterNames = ["vault"];
+    const parameterNames = ["composition", "adminCap", "routed", "shares"];
     return (tx: Transaction) => tx.moveCall({
         package: packageAddress,
         module: 'composition_routed_stake',
-        function: 'is_installed',
+        function: 'restake',
         arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
         typeArguments: options.typeArguments
     });