@misofm/platform 0.23.0 → 0.25.0

package/src/contracts/recording_language/recording_language.ts

@@ -0,0 +1,238 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+
+/**
+ * The languages sung or spoken on a recording, stored as a dynamic field on the
+ * recording's UID and written through its cap-gated `uid_mut`.
+ *
+ * Its own package, for the same reason the advisory rating is: language is set by
+ * different people, at different times, and governed by a standard (ISO 639) that
+ * has nothing to do with any other fact about the recording. A consumer
+ * implementing a metadata profile picks this extension up or leaves it, and
+ * replacing it never disturbs anything else attached to the work.
+ *
+ * A `vector`, not a single code — bilingual and code-switching recordings are
+ * ordinary, and forcing one language would mean choosing which of them to erase.
+ * Order is the caller's: first is conventionally the predominant one.
+ *
+ * **An empty vector means instrumental** — attached, and asserting there is no
+ * sung or spoken content at all. That is a genuine claim about the recording and
+ * is deliberately distinct from attaching nothing, which says only that nobody has
+ * looked. `set_instrumental` exists so that claim reads as intent at the call site
+ * rather than as an empty argument someone might mistake for an oversight.
+ *
+ * `LanguageCode` is a valid ISO 639-1 code by construction, so this package checks
+ * only what construction cannot: how many, and whether any repeat.
+ */
+
+import { MoveTuple, MoveStruct, normalizeMoveArguments, type RawTransactionArgument } from '../utils/index.ts';
+import { bcs } from '@mysten/sui/bcs';
+import type {} from "@mysten/bcs";
+import { type Transaction, type TransactionArgument } from '@mysten/sui/transactions';
+import * as language_code from './deps/language_code/language_code.ts';
+const $moduleName = '@local-pkg/recording_language::recording_language';
+export const ExtensionKey = new MoveTuple({ name: `${$moduleName}::ExtensionKey`, fields: [bcs.bool()] });
+export const LanguagesSetEvent = new MoveStruct({ name: `${$moduleName}::LanguagesSetEvent`, fields: {
+        recording_id: bcs.Address,
+        languages: bcs.vector(language_code.LanguageCode)
+    } });
+export const LanguagesUnsetEvent = new MoveStruct({ name: `${$moduleName}::LanguagesUnsetEvent`, fields: {
+        recording_id: bcs.Address
+    } });
+export interface SetLanguagesArguments {
+    self: RawTransactionArgument<string>;
+    cap: RawTransactionArgument<string>;
+    languages: TransactionArgument;
+}
+export interface SetLanguagesOptions {
+    package?: string;
+    arguments: SetLanguagesArguments | [
+        self: RawTransactionArgument<string>,
+        cap: RawTransactionArgument<string>,
+        languages: TransactionArgument
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+/**
+ * Sets (or replaces) the languages sung or spoken on the recording.
+ *
+ * Passing an empty vector asserts the recording is instrumental; prefer
+ * `set_instrumental`, which says so at the call site.
+ */
+export function setLanguages(options: SetLanguagesOptions) {
+    const packageAddress = options.package ?? '@local-pkg/recording_language';
+    const argumentsTypes = [
+        null,
+        null,
+        'vector<null>'
+    ] satisfies (string | null)[];
+    const parameterNames = ["self", "cap", "languages"];
+    return (tx: Transaction) => tx.moveCall({
+        package: packageAddress,
+        module: 'recording_language',
+        function: 'set_languages',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+        typeArguments: options.typeArguments
+    });
+}
+export interface SetInstrumentalArguments {
+    self: RawTransactionArgument<string>;
+    cap: RawTransactionArgument<string>;
+}
+export interface SetInstrumentalOptions {
+    package?: string;
+    arguments: SetInstrumentalArguments | [
+        self: RawTransactionArgument<string>,
+        cap: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+/** Asserts the recording has no sung or spoken content. */
+export function setInstrumental(options: SetInstrumentalOptions) {
+    const packageAddress = options.package ?? '@local-pkg/recording_language';
+    const argumentsTypes = [
+        null,
+        null
+    ] satisfies (string | null)[];
+    const parameterNames = ["self", "cap"];
+    return (tx: Transaction) => tx.moveCall({
+        package: packageAddress,
+        module: 'recording_language',
+        function: 'set_instrumental',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+        typeArguments: options.typeArguments
+    });
+}
+export interface UnsetLanguagesArguments {
+    self: RawTransactionArgument<string>;
+    cap: RawTransactionArgument<string>;
+}
+export interface UnsetLanguagesOptions {
+    package?: string;
+    arguments: UnsetLanguagesArguments | [
+        self: RawTransactionArgument<string>,
+        cap: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+/**
+ * Removes the language record, if any. Idempotent. Leaves the recording having
+ * said nothing — which is not the same as asserting it is instrumental.
+ */
+export function unsetLanguages(options: UnsetLanguagesOptions) {
+    const packageAddress = options.package ?? '@local-pkg/recording_language';
+    const argumentsTypes = [
+        null,
+        null
+    ] satisfies (string | null)[];
+    const parameterNames = ["self", "cap"];
+    return (tx: Transaction) => tx.moveCall({
+        package: packageAddress,
+        module: 'recording_language',
+        function: 'unset_languages',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+        typeArguments: options.typeArguments
+    });
+}
+export interface HasLanguagesArguments {
+    self: RawTransactionArgument<string>;
+}
+export interface HasLanguagesOptions {
+    package?: string;
+    arguments: HasLanguagesArguments | [
+        self: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+/** Whether a language record is attached to this recording. */
+export function hasLanguages(options: HasLanguagesOptions) {
+    const packageAddress = options.package ?? '@local-pkg/recording_language';
+    const argumentsTypes = [
+        null
+    ] satisfies (string | null)[];
+    const parameterNames = ["self"];
+    return (tx: Transaction) => tx.moveCall({
+        package: packageAddress,
+        module: 'recording_language',
+        function: 'has_languages',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+        typeArguments: options.typeArguments
+    });
+}
+export interface LanguagesArguments {
+    self: RawTransactionArgument<string>;
+}
+export interface LanguagesOptions {
+    package?: string;
+    arguments: LanguagesArguments | [
+        self: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+/**
+ * The recording's languages, in the order given. Empty means instrumental. Aborts
+ * if nothing is attached — absence is a distinct state from an empty vector and
+ * must not collapse into it.
+ */
+export function languages(options: LanguagesOptions) {
+    const packageAddress = options.package ?? '@local-pkg/recording_language';
+    const argumentsTypes = [
+        null
+    ] satisfies (string | null)[];
+    const parameterNames = ["self"];
+    return (tx: Transaction) => tx.moveCall({
+        package: packageAddress,
+        module: 'recording_language',
+        function: 'languages',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+        typeArguments: options.typeArguments
+    });
+}
+export interface IsInstrumentalArguments {
+    self: RawTransactionArgument<string>;
+}
+export interface IsInstrumentalOptions {
+    package?: string;
+    arguments: IsInstrumentalArguments | [
+        self: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+/**
+ * Whether the recording asserts it is instrumental: attached, and empty. False
+ * when nothing is attached, because that asserts nothing.
+ */
+export function isInstrumental(options: IsInstrumentalOptions) {
+    const packageAddress = options.package ?? '@local-pkg/recording_language';
+    const argumentsTypes = [
+        null
+    ] satisfies (string | null)[];
+    const parameterNames = ["self"];
+    return (tx: Transaction) => tx.moveCall({
+        package: packageAddress,
+        module: 'recording_language',
+        function: 'is_instrumental',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+        typeArguments: options.typeArguments
+    });
+}

package/src/contracts/recording_master_reference/deps/ori/confidentiality.ts

@@ -0,0 +1,24 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+import { MoveEnum, MoveStruct } from '../../../utils/index.ts';
+import { bcs } from '@mysten/sui/bcs';
+import type {} from "@mysten/bcs";
+const $moduleName = 'ori::confidentiality';
+/**
+ * Confidentiality metadata for referenced data.
+ *
+ * Variants can only be constructed in this module, so encrypted values always
+ * carry a non-empty Seal-sealed data-encryption key.
+ */
+export const Confidentiality = new MoveEnum({ name: `${$moduleName}::Confidentiality`, fields: {
+        /** The referenced data is stored in the clear. */
+        Unencrypted: null,
+        /**
+         * The referenced data is encrypted. `sealed_dek` is its Seal-sealed
+         * data-encryption key, not the plaintext key.
+         */
+        Encrypted: new MoveStruct({ name: `Confidentiality.Encrypted`, fields: {
+                sealed_dek: bcs.vector(bcs.u8())
+            } })
+    } });

package/src/contracts/recording_master_reference/deps/ori/data.ts

@@ -0,0 +1,12 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+import { MoveStruct } from '../../../utils/index.ts';
+import { bcs } from '@mysten/sui/bcs';
+import type {} from "@mysten/bcs";
+import * as confidentiality from './confidentiality.ts';
+const $moduleName = 'ori::data';
+export const WalrusBlob = new MoveStruct({ name: `${$moduleName}::WalrusBlob`, fields: {
+        blob_id: bcs.u256(),
+        confidentiality: confidentiality.Confidentiality
+    } });

package/src/contracts/recording_master_reference/recording_master_reference.ts

@@ -0,0 +1,180 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+
+/**
+ * A pointer to a recording's master audio — nothing more.
+ *
+ * The value is a bare `ori::data::WalrusBlob` reference. This extension makes no
+ * claim about what the blob contains: not its codec, not its sample rate, not its
+ * duration, not that it is even audio. The only assertion is that the holder of
+ * the recording's admin cap says this blob is the master. Everything else is
+ * client-side convention.
+ *
+ * That thinness is the point. Miso's attested path — the Nautilus-verified master
+ * flow (`audio_ingester` producing a `audio::Audio`), deferred — carries channel
+ * count, bit depth, sample rate, sample count and a PCM digest, and every one of
+ * those is backed by a Nautilus enclave signature over the measured audio. Until
+ * that path is running, stating the same fields _unverified_ would dress an
+ * assertion up as a measurement. A pointer cannot be mistaken for a measurement.
+ *
+ * # This extension is a holdover
+ *
+ * It exists to carry the catalogue until enclave ingestion is ready, and it is
+ * meant to be removed rather than grown. When a recording's master is ingested for
+ * real, attach the attested master via the ingester's master flow and call
+ * `unset_master_reference` here. The two never need to coexist, and this package
+ * deliberately holds nothing the attested path cannot restate.
+ *
+ * Resist adding fields. Anything worth asserting about the audio is worth
+ * attesting, and belongs in the ingested `Audio` rather than here.
+ */
+
+import { MoveTuple, MoveStruct, normalizeMoveArguments, type RawTransactionArgument } from '../utils/index.ts';
+import { bcs } from '@mysten/sui/bcs';
+import type {} from "@mysten/bcs";
+import { type Transaction, type TransactionArgument } from '@mysten/sui/transactions';
+import * as data from './deps/ori/data.ts';
+const $moduleName = '@local-pkg/recording_master_reference::recording_master_reference';
+export const ExtensionKey = new MoveTuple({ name: `${$moduleName}::ExtensionKey`, fields: [bcs.bool()] });
+export const MasterReferenceSetEvent = new MoveStruct({ name: `${$moduleName}::MasterReferenceSetEvent`, fields: {
+        recording_id: bcs.Address,
+        reference: data.WalrusBlob
+    } });
+export const MasterReferenceUnsetEvent = new MoveStruct({ name: `${$moduleName}::MasterReferenceUnsetEvent`, fields: {
+        recording_id: bcs.Address
+    } });
+export interface SetMasterReferenceArguments {
+    self: RawTransactionArgument<string>;
+    cap: RawTransactionArgument<string>;
+    reference: TransactionArgument;
+}
+export interface SetMasterReferenceOptions {
+    package?: string;
+    arguments: SetMasterReferenceArguments | [
+        self: RawTransactionArgument<string>,
+        cap: RawTransactionArgument<string>,
+        reference: TransactionArgument
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+/**
+ * Sets (or replaces) the recording's master reference.
+ *
+ * The reference is a standalone blob by type. Encrypted blobs are accepted — a
+ * sealed master is the expected shape once access control lands, and the reference
+ * is the same either way.
+ */
+export function setMasterReference(options: SetMasterReferenceOptions) {
+    const packageAddress = options.package ?? '@local-pkg/recording_master_reference';
+    const argumentsTypes = [
+        null,
+        null,
+        null
+    ] satisfies (string | null)[];
+    const parameterNames = ["self", "cap", "reference"];
+    return (tx: Transaction) => tx.moveCall({
+        package: packageAddress,
+        module: 'recording_master_reference',
+        function: 'set_master_reference',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+        typeArguments: options.typeArguments
+    });
+}
+export interface UnsetMasterReferenceArguments {
+    self: RawTransactionArgument<string>;
+    cap: RawTransactionArgument<string>;
+}
+export interface UnsetMasterReferenceOptions {
+    package?: string;
+    arguments: UnsetMasterReferenceArguments | [
+        self: RawTransactionArgument<string>,
+        cap: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+/**
+ * Removes the master reference, if any. Idempotent.
+ *
+ * The intended use is migration: once an attested master is attached via the
+ * Nautilus-verified master flow (deferred), this reference has nothing left to say
+ * and should go.
+ */
+export function unsetMasterReference(options: UnsetMasterReferenceOptions) {
+    const packageAddress = options.package ?? '@local-pkg/recording_master_reference';
+    const argumentsTypes = [
+        null,
+        null
+    ] satisfies (string | null)[];
+    const parameterNames = ["self", "cap"];
+    return (tx: Transaction) => tx.moveCall({
+        package: packageAddress,
+        module: 'recording_master_reference',
+        function: 'unset_master_reference',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+        typeArguments: options.typeArguments
+    });
+}
+export interface HasMasterReferenceArguments {
+    self: RawTransactionArgument<string>;
+}
+export interface HasMasterReferenceOptions {
+    package?: string;
+    arguments: HasMasterReferenceArguments | [
+        self: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+/** Whether a master reference is attached to this recording. */
+export function hasMasterReference(options: HasMasterReferenceOptions) {
+    const packageAddress = options.package ?? '@local-pkg/recording_master_reference';
+    const argumentsTypes = [
+        null
+    ] satisfies (string | null)[];
+    const parameterNames = ["self"];
+    return (tx: Transaction) => tx.moveCall({
+        package: packageAddress,
+        module: 'recording_master_reference',
+        function: 'has_master_reference',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+        typeArguments: options.typeArguments
+    });
+}
+export interface MasterReferenceArguments {
+    self: RawTransactionArgument<string>;
+}
+export interface MasterReferenceOptions {
+    package?: string;
+    arguments: MasterReferenceArguments | [
+        self: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+/** The recording's master reference. Aborts if none is attached. */
+export function masterReference(options: MasterReferenceOptions) {
+    const packageAddress = options.package ?? '@local-pkg/recording_master_reference';
+    const argumentsTypes = [
+        null
+    ] satisfies (string | null)[];
+    const parameterNames = ["self"];
+    return (tx: Transaction) => tx.moveCall({
+        package: packageAddress,
+        module: 'recording_master_reference',
+        function: 'master_reference',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+        typeArguments: options.typeArguments
+    });
+}

package/src/contracts/recording_royalty_pool/recording_royalty_pool.ts

@@ -0,0 +1,157 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+
+/**
+ * Raw-cap, custody-agnostic royalty-pool actions for musicos Recordings.
+ *
+ * Every mutating action requires the Recording's own admin capability. The
+ * canonical pool remains derived from the Recording and is returned unshared.
+ */
+
+import { type Transaction, type TransactionArgument } from '@mysten/sui/transactions';
+import { normalizeMoveArguments, type RawTransactionArgument } from '../utils/index.ts';
+export interface NewPoolArguments {
+    recording: RawTransactionArgument<string>;
+    adminCap: RawTransactionArgument<string>;
+}
+export interface NewPoolOptions {
+    package?: string;
+    arguments: NewPoolArguments | [
+        recording: RawTransactionArgument<string>,
+        adminCap: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string,
+        string
+    ];
+}
+/** Create and return the canonical unshared pool derived from `recording`. */
+export function newPool(options: NewPoolOptions) {
+    const packageAddress = options.package ?? '@local-pkg/recording_royalty_pool';
+    const argumentsTypes = [
+        null,
+        null
+    ] satisfies (string | null)[];
+    const parameterNames = ["recording", "adminCap"];
+    return (tx: Transaction) => tx.moveCall({
+        package: packageAddress,
+        module: 'recording_royalty_pool',
+        function: 'new_pool',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+        typeArguments: options.typeArguments
+    });
+}
+export interface ReceiveAndDepositArguments {
+    recording: RawTransactionArgument<string>;
+    adminCap: RawTransactionArgument<string>;
+    pool: RawTransactionArgument<string>;
+    coins: TransactionArgument;
+}
+export interface ReceiveAndDepositOptions {
+    package?: string;
+    arguments: ReceiveAndDepositArguments | [
+        recording: RawTransactionArgument<string>,
+        adminCap: RawTransactionArgument<string>,
+        pool: RawTransactionArgument<string>,
+        coins: TransactionArgument
+    ];
+    typeArguments: [
+        string,
+        string,
+        string
+    ];
+}
+/**
+ * Receive selected coins sent to the Recording and deposit their balance into the
+ * canonical pool derived from that same Recording.
+ */
+export function receiveAndDeposit(options: ReceiveAndDepositOptions) {
+    const packageAddress = options.package ?? '@local-pkg/recording_royalty_pool';
+    const argumentsTypes = [
+        null,
+        null,
+        null,
+        'vector<null>'
+    ] satisfies (string | null)[];
+    const parameterNames = ["recording", "adminCap", "pool", "coins"];
+    return (tx: Transaction) => tx.moveCall({
+        package: packageAddress,
+        module: 'recording_royalty_pool',
+        function: 'receive_and_deposit',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+        typeArguments: options.typeArguments
+    });
+}
+export interface RedeemAndDepositArguments {
+    recording: RawTransactionArgument<string>;
+    adminCap: RawTransactionArgument<string>;
+    pool: RawTransactionArgument<string>;
+    value: RawTransactionArgument<number | bigint>;
+}
+export interface RedeemAndDepositOptions {
+    package?: string;
+    arguments: RedeemAndDepositArguments | [
+        recording: RawTransactionArgument<string>,
+        adminCap: RawTransactionArgument<string>,
+        pool: RawTransactionArgument<string>,
+        value: RawTransactionArgument<number | bigint>
+    ];
+    typeArguments: [
+        string,
+        string,
+        string
+    ];
+}
+/**
+ * Redeem `value` from the Recording's funds accumulator and deposit it into the
+ * canonical pool derived from that same Recording.
+ */
+export function redeemAndDeposit(options: RedeemAndDepositOptions) {
+    const packageAddress = options.package ?? '@local-pkg/recording_royalty_pool';
+    const argumentsTypes = [
+        null,
+        null,
+        null,
+        'u64'
+    ] satisfies (string | null)[];
+    const parameterNames = ["recording", "adminCap", "pool", "value"];
+    return (tx: Transaction) => tx.moveCall({
+        package: packageAddress,
+        module: 'recording_royalty_pool',
+        function: 'redeem_and_deposit',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+        typeArguments: options.typeArguments
+    });
+}
+export interface PoolAddressArguments {
+    recording: RawTransactionArgument<string>;
+}
+export interface PoolAddressOptions {
+    package?: string;
+    arguments: PoolAddressArguments | [
+        recording: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string,
+        string
+    ];
+}
+/** Canonical pool address for this Recording, share type, and Currency. */
+export function poolAddress(options: PoolAddressOptions) {
+    const packageAddress = options.package ?? '@local-pkg/recording_royalty_pool';
+    const argumentsTypes = [
+        null
+    ] satisfies (string | null)[];
+    const parameterNames = ["recording"];
+    return (tx: Transaction) => tx.moveCall({
+        package: packageAddress,
+        module: 'recording_royalty_pool',
+        function: 'pool_address',
+        arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+        typeArguments: options.typeArguments
+    });
+}