@misofm/sdk 0.9.0 → 0.11.0

package/src/contracts/composition_routed_stake/composition_routed_stake.ts

@@ -0,0 +1,346 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+
+/**
+ * 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.
+ */
+
+import { type Transaction } 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>;
+    Recording: RawTransactionArgument<string>;
+    vaultAdminCap: RawTransactionArgument<string>;
+    value: RawTransactionArgument<number | bigint>;
+}
+export interface CreateStakeOptions {
+    package?: string;
+    arguments: CreateStakeArguments | [
+        vault: RawTransactionArgument<string>,
+        composition: RawTransactionArgument<string>,
+        Recording: RawTransactionArgument<string>,
+        vaultAdminCap: RawTransactionArgument<string>,
+        value: RawTransactionArgument<number | bigint>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+/**
+ * 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.
+ */
+export function createStake(options: CreateStakeOptions) {
+    const packageAddress = options.package ?? '@local-pkg/composition_routed_stake';
+    const argumentsTypes = [
+        null,
+        null,
+        null,
+        null,
+        'u64'
+    ] satisfies (string | null)[];
+    const parameterNames = ["vault", "composition", "Recording", "vaultAdminCap", "value"];
+    return (tx: Transaction) => tx.moveCall({
+        package: packageAddress,
+        module: 'composition_routed_stake',
+        function: 'create_stake',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+        typeArguments: options.typeArguments
+    });
+}
+export interface RegisterArguments {
+    vault: RawTransactionArgument<string>;
+    composition: 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>,
+        recording: RawTransactionArgument<string>,
+        routed: RawTransactionArgument<string>,
+        pool: RawTransactionArgument<string>,
+        vaultAdminCap: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string,
+        string
+    ];
+}
+/**
+ * Register the routed stake with the canonical pool derived from the supplied
+ * Recording. The Vault administrator controls which currencies are enabled.
+ */
+export function register(options: RegisterOptions) {
+    const packageAddress = options.package ?? '@local-pkg/composition_routed_stake';
+    const argumentsTypes = [
+        null,
+        null,
+        null,
+        null,
+        null,
+        null
+    ] satisfies (string | null)[];
+    const parameterNames = ["vault", "composition", "recording", "routed", "pool", "vaultAdminCap"];
+    return (tx: Transaction) => tx.moveCall({
+        package: packageAddress,
+        module: 'composition_routed_stake',
+        function: 'register',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+        typeArguments: options.typeArguments
+    });
+}
+export interface UnregisterArguments {
+    vault: RawTransactionArgument<string>;
+    composition: RawTransactionArgument<string>;
+    routed: RawTransactionArgument<string>;
+    pool: RawTransactionArgument<string>;
+    vaultAdminCap: RawTransactionArgument<string>;
+}
+export interface UnregisterOptions {
+    package?: string;
+    arguments: UnregisterArguments | [
+        vault: RawTransactionArgument<string>,
+        composition: RawTransactionArgument<string>,
+        routed: RawTransactionArgument<string>,
+        pool: RawTransactionArgument<string>,
+        vaultAdminCap: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string,
+        string
+    ];
+}
+/** Unregister the routed stake after its pending reward has been swept. */
+export function unregister(options: UnregisterOptions) {
+    const packageAddress = options.package ?? '@local-pkg/composition_routed_stake';
+    const argumentsTypes = [
+        null,
+        null,
+        null,
+        null,
+        null
+    ] satisfies (string | null)[];
+    const parameterNames = ["vault", "composition", "routed", "pool", "vaultAdminCap"];
+    return (tx: Transaction) => tx.moveCall({
+        package: packageAddress,
+        module: 'composition_routed_stake',
+        function: 'unregister',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+        typeArguments: options.typeArguments
+    });
+}
+export interface UnstakeArguments {
+    vault: RawTransactionArgument<string>;
+    composition: 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>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+/**
+ * Remove the routed position and return its principal to the Composition address.
+ * Principal never becomes a caller-controlled Coin or Balance.
+ */
+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"];
+    return (tx: Transaction) => tx.moveCall({
+        package: packageAddress,
+        module: 'composition_routed_stake',
+        function: 'unstake',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+        typeArguments: options.typeArguments
+    });
+}
+export interface RestakeArguments {
+    vault: RawTransactionArgument<string>;
+    composition: RawTransactionArgument<string>;
+    routed: RawTransactionArgument<string>;
+    vaultAdminCap: RawTransactionArgument<string>;
+    value: RawTransactionArgument<number | bigint>;
+}
+export interface RestakeOptions {
+    package?: string;
+    arguments: RestakeArguments | [
+        vault: RawTransactionArgument<string>,
+        composition: RawTransactionArgument<string>,
+        routed: RawTransactionArgument<string>,
+        vaultAdminCap: RawTransactionArgument<string>,
+        value: RawTransactionArgument<number | bigint>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+/**
+ * Refill an empty routed stake from Recording shares held at the Composition
+ * address.
+ */
+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"];
+    return (tx: Transaction) => tx.moveCall({
+        package: packageAddress,
+        module: 'composition_routed_stake',
+        function: 'is_installed',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+        typeArguments: options.typeArguments
+    });
+}
+export interface StakeAddressArguments {
+    composition: RawTransactionArgument<string>;
+}
+export interface StakeAddressOptions {
+    package?: string;
+    arguments: StakeAddressArguments | [
+        composition: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+/** Canonical routed-stake address for this Composition and RecordingShare. */
+export function stakeAddress(options: StakeAddressOptions) {
+    const packageAddress = options.package ?? '@local-pkg/composition_routed_stake';
+    const argumentsTypes = [
+        null
+    ] satisfies (string | null)[];
+    const parameterNames = ["composition"];
+    return (tx: Transaction) => tx.moveCall({
+        package: packageAddress,
+        module: 'composition_routed_stake',
+        function: 'stake_address',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+        typeArguments: options.typeArguments
+    });
+}

package/src/contracts/composition_routed_stake/witness.ts

@@ -0,0 +1,11 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+
+/** Canonical installation identity for the Composition routed-stake plugin. */
+
+import { MoveTuple } from '../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+const $moduleName = '@local-pkg/composition_routed_stake::witness';
+export const Witness = new MoveTuple({ name: `${$moduleName}::Witness`, fields: [bcs.bool()] });

package/src/contracts/composition_royalty_pool/composition_royalty_pool.ts

@@ -4,29 +4,87 @@
 
 
 /**
- * Cap-gated royalty-pool extension for `Composition`.
+ * Vault-authorized royalty-pool business logic for Miso Compositions.
  * 
- * Royalty payers send `Coin<Currency>` directly to the composition's address — a
- * stable, well-known inbox available from the composition's creation. The
- * composition admin (cap holder) folds those funds into the underlying
- * `royalty_pool::pool::RoyaltyPool` via `receive_and_deposit` (for direct coin
- * transfers) or `redeem_and_deposit` (for funds-accumulator balances).
- * 
- * All three entry points require `&CompositionAdminCap`, so timing of fold
- * operations stays under admin control.
+ * The plugin temporarily leases the CompositionAdminCap from its Vault, uses it
+ * only to reach the matching Composition UID, and returns it before calling
+ * external pool logic. Pools remain derived from the Composition, not the Vault,
+ * so their canonical identity survives vault replacement.
  */
 
 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_royalty_pool';
+    const argumentsTypes = [
+        null,
+        null
+    ] satisfies (string | null)[];
+    const parameterNames = ["vault", "vaultAdminCap"];
+    return (tx: Transaction) => tx.moveCall({
+        package: packageAddress,
+        module: 'composition_royalty_pool',
+        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_royalty_pool';
+    const argumentsTypes = [
+        null,
+        null
+    ] satisfies (string | null)[];
+    const parameterNames = ["vault", "vaultAdminCap"];
+    return (tx: Transaction) => tx.moveCall({
+        package: packageAddress,
+        module: 'composition_royalty_pool',
+        function: 'uninstall',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+        typeArguments: options.typeArguments
+    });
+}
 export interface InitializePoolArguments {
+    vault: RawTransactionArgument<string>;
     composition: RawTransactionArgument<string>;
-    cap: RawTransactionArgument<string>;
+    vaultAdminCap: RawTransactionArgument<string>;
 }
 export interface InitializePoolOptions {
     package?: string;
     arguments: InitializePoolArguments | [
+        vault: RawTransactionArgument<string>,
         composition: RawTransactionArgument<string>,
-        cap: RawTransactionArgument<string>
+        vaultAdminCap: RawTransactionArgument<string>
     ];
     typeArguments: [
         string,
@@ -34,17 +92,20 @@ export interface InitializePoolOptions {
     ];
 }
 /**
- * Create a royalty pool for a composition. Pool address derives from
- * `(composition_id, Currency)` — calling twice with the same Currency aborts
- * because the address is already claimed.
+ * Create and share the canonical pool derived from this Composition.
+ *
+ * The matching VaultAdminCap chooses which Currency pools may be created. The
+ * result cannot be redirected: the pool ID is claimed from the Composition UID and
+ * is typed by both CompositionShare and Currency.
  */
 export function initializePool(options: InitializePoolOptions) {
     const packageAddress = options.package ?? '@local-pkg/composition_royalty_pool';
     const argumentsTypes = [
+        null,
         null,
         null
     ] satisfies (string | null)[];
-    const parameterNames = ["composition", "cap"];
+    const parameterNames = ["vault", "composition", "vaultAdminCap"];
     return (tx: Transaction) => tx.moveCall({
         package: packageAddress,
         module: 'composition_royalty_pool',
@@ -54,18 +115,18 @@ export function initializePool(options: InitializePoolOptions) {
     });
 }
 export interface ReceiveAndDepositArguments {
+    vault: RawTransactionArgument<string>;
     composition: RawTransactionArgument<string>;
-    cap: RawTransactionArgument<string>;
-    coins: TransactionArgument;
     pool: RawTransactionArgument<string>;
+    coins: TransactionArgument;
 }
 export interface ReceiveAndDepositOptions {
     package?: string;
     arguments: ReceiveAndDepositArguments | [
+        vault: RawTransactionArgument<string>,
         composition: RawTransactionArgument<string>,
-        cap: RawTransactionArgument<string>,
-        coins: TransactionArgument,
-        pool: RawTransactionArgument<string>
+        pool: RawTransactionArgument<string>,
+        coins: TransactionArgument
     ];
     typeArguments: [
         string,
@@ -73,18 +134,19 @@ export interface ReceiveAndDepositOptions {
     ];
 }
 /**
- * Receive `Coin<Currency>` objects sent to the composition's address and fold them
- * into the pool's accumulator.
+ * Receive coins sent to the Composition and deposit them into its canonical pool.
+ * Anyone may crank this after the plugin is installed, but the funds can only
+ * reach the pool derived from this Composition.
  */
 export function receiveAndDeposit(options: ReceiveAndDepositOptions) {
     const packageAddress = options.package ?? '@local-pkg/composition_royalty_pool';
     const argumentsTypes = [
         null,
         null,
-        'vector<null>',
-        null
+        null,
+        'vector<null>'
     ] satisfies (string | null)[];
-    const parameterNames = ["composition", "cap", "coins", "pool"];
+    const parameterNames = ["vault", "composition", "pool", "coins"];
     return (tx: Transaction) => tx.moveCall({
         package: packageAddress,
         module: 'composition_royalty_pool',
@@ -94,18 +156,18 @@ export function receiveAndDeposit(options: ReceiveAndDepositOptions) {
     });
 }
 export interface RedeemAndDepositArguments {
+    vault: RawTransactionArgument<string>;
     composition: RawTransactionArgument<string>;
-    cap: RawTransactionArgument<string>;
-    value: RawTransactionArgument<number | bigint>;
     pool: RawTransactionArgument<string>;
+    value: RawTransactionArgument<number | bigint>;
 }
 export interface RedeemAndDepositOptions {
     package?: string;
     arguments: RedeemAndDepositArguments | [
+        vault: RawTransactionArgument<string>,
         composition: RawTransactionArgument<string>,
-        cap: RawTransactionArgument<string>,
-        value: RawTransactionArgument<number | bigint>,
-        pool: RawTransactionArgument<string>
+        pool: RawTransactionArgument<string>,
+        value: RawTransactionArgument<number | bigint>
     ];
     typeArguments: [
         string,
@@ -113,18 +175,18 @@ export interface RedeemAndDepositOptions {
     ];
 }
 /**
- * Redeem `value` base units from the composition's funds accumulator and fold the
- * resulting balance into the pool's accumulator.
+ * Redeem funds accumulated at the Composition address and deposit them into its
+ * canonical pool. Anyone may crank this after installation.
  */
 export function redeemAndDeposit(options: RedeemAndDepositOptions) {
     const packageAddress = options.package ?? '@local-pkg/composition_royalty_pool';
     const argumentsTypes = [
         null,
         null,
-        'u64',
-        null
+        null,
+        'u64'
     ] satisfies (string | null)[];
-    const parameterNames = ["composition", "cap", "value", "pool"];
+    const parameterNames = ["vault", "composition", "pool", "value"];
     return (tx: Transaction) => tx.moveCall({
         package: packageAddress,
         module: 'composition_royalty_pool',
@@ -132,4 +194,58 @@ export function redeemAndDeposit(options: RedeemAndDepositOptions) {
         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_royalty_pool';
+    const argumentsTypes = [
+        null
+    ] satisfies (string | null)[];
+    const parameterNames = ["vault"];
+    return (tx: Transaction) => tx.moveCall({
+        package: packageAddress,
+        module: 'composition_royalty_pool',
+        function: 'is_installed',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+        typeArguments: options.typeArguments
+    });
+}
+export interface PoolAddressArguments {
+    composition: RawTransactionArgument<string>;
+}
+export interface PoolAddressOptions {
+    package?: string;
+    arguments: PoolAddressArguments | [
+        composition: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+/** The canonical pool address for this Composition, share type, and Currency. */
+export function poolAddress(options: PoolAddressOptions) {
+    const packageAddress = options.package ?? '@local-pkg/composition_royalty_pool';
+    const argumentsTypes = [
+        null
+    ] satisfies (string | null)[];
+    const parameterNames = ["composition"];
+    return (tx: Transaction) => tx.moveCall({
+        package: packageAddress,
+        module: 'composition_royalty_pool',
+        function: 'pool_address',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+        typeArguments: options.typeArguments
+    });
 }

package/src/contracts/composition_royalty_pool/witness.ts

@@ -0,0 +1,7 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+import { MoveTuple } from '../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+const $moduleName = '@local-pkg/composition_royalty_pool::witness';
+export const Witness = new MoveTuple({ name: `${$moduleName}::Witness`, fields: [bcs.bool()] });