@misofm/platform 0.26.2 → 0.28.0

package/src/cover.ts

@@ -17,9 +17,8 @@
 import { bcs } from "@mysten/sui/bcs";
 import { deriveDynamicFieldID } from "@mysten/sui/utils";
 import type { Transaction, TransactionObjectArgument } from "@mysten/sui/transactions";
-import { Effect } from "effect";
-import { getObjectsContent, type SuiClient, type SuiRpcError } from "@misofm/effect";
-import type { TxThunk } from "./transactions.ts";
+import { Effect, Result } from "effect";
+import { ObjectId, Sui, type TransportError, type Recipe } from "@unconfirmed/sui-effect";
 import { asU64, directAdminCap, invokeWithAdminCap, type AdminCapAuthority, type ObjectInput, type U64Input } from "./vault.ts";
 import { OPTION_NONE, OPTION_SOME, unencryptedWalrusBlob } from "./internal.ts";
 import * as coverArt from "./contracts/cover_art/cover_art.ts";
@@ -59,7 +58,7 @@ export type SetReleaseTrackCoverParams = SetReleaseCoverParams & {
   trackIndex: U64Input;
 };
 
-function buildCover(tx: Parameters<TxThunk>[0], p: SetReleaseCoverParams) {
+function buildCover(tx: Parameters<Recipe>[0], p: SetReleaseCoverParams) {
   const walrusType = `${p.oriPackageId}::data::WalrusBlob`;
   const blob = (id: bigint | string) => unencryptedWalrusBlob(tx, p.oriPackageId, id);
 
@@ -82,7 +81,7 @@ function buildCover(tx: Parameters<TxThunk>[0], p: SetReleaseCoverParams) {
 }
 
 /** Sets (or replaces) a release's album-level cover from Walrus blob ids. */
-export function setReleaseCover(p: SetReleaseCoverParams): TxThunk {
+export function setReleaseCover(p: SetReleaseCoverParams): Recipe {
   return (tx) => {
     const cover = buildCover(tx, p);
     invokeWithAdminCap(tx, releaseAuthorityOf(p), {
@@ -94,7 +93,7 @@ export function setReleaseCover(p: SetReleaseCoverParams): TxThunk {
 }
 
 /** Sets (or replaces) one track's cover from Walrus blob ids. */
-export function setReleaseTrackCover(p: SetReleaseTrackCoverParams): TxThunk {
+export function setReleaseTrackCover(p: SetReleaseTrackCoverParams): Recipe {
   return (tx) => {
     const cover = buildCover(tx, p);
     invokeWithAdminCap(tx, releaseAuthorityOf(p), {
@@ -153,7 +152,7 @@ function toCoverImageRef(blob: ParsedWalrusBlob): CoverImageRef {
 export const getReleaseCover = Effect.fn("getReleaseCover")(function* (
   releaseId: string,
   releaseCoverArtPackageId: string,
-): Effect.fn.Return<ReleaseCoverView | null, SuiRpcError, SuiClient> {
+): Effect.fn.Return<ReleaseCoverView | null, TransportError, Sui> {
   const found = yield* getReleaseCoversByIds([releaseId], releaseCoverArtPackageId);
   return found[releaseId] ?? null;
 });
@@ -191,7 +190,7 @@ export function releaseCoverFieldId(
 export const getReleaseCoversByIds = Effect.fn("getReleaseCoversByIds")(function* (
   releaseIdsInput: readonly string[],
   releaseCoverArtPackageId: string,
-): Effect.fn.Return<Partial<Record<string, ReleaseCoverView>>, SuiRpcError, SuiClient> {
+): Effect.fn.Return<Partial<Record<string, ReleaseCoverView>>, TransportError, Sui> {
   const releaseIds = [...new Set(releaseIdsInput)];
   const targets = releaseIds.map((releaseId) => ({
     releaseId,
@@ -199,13 +198,13 @@ export const getReleaseCoversByIds = Effect.fn("getReleaseCoversByIds")(function
   }));
   if (targets.length === 0) return {};
 
-  const contentById = yield* getObjectsContent(targets.map((target) => target.fieldId));
+  const sui = yield* Sui;
+  const results = yield* sui.getObjects(targets.map((target) => ObjectId.make(target.fieldId)));
   const out: Partial<Record<string, ReleaseCoverView>> = {};
-  for (const target of targets) {
-    const found = contentById.get(target.fieldId);
-    if (!found) continue;
-    const cover = parseReleaseCoverContent(found.content);
-    if (cover) out[target.releaseId] = cover;
-  }
+  results.forEach((result, index) => {
+    if (!Result.isSuccess(result)) return;
+    const cover = parseReleaseCoverContent(result.success.content);
+    if (cover) out[targets[index]!.releaseId] = cover;
+  });
   return out;
 });

package/src/credits.ts

@@ -17,7 +17,7 @@
 // in `credit::new(display_name, roles)`, then attached with the extension's
 // `add_credit` (which borrows the work `&mut` via its cap-gated `uid_mut`).
 //
-// Writers mirror `cover.ts`: they return a `TxThunk` and take explicit on-chain
+// Writers mirror `cover.ts`: they return a `Recipe` and take explicit on-chain
 // package ids. Generic works (Composition, Recording) additionally require the
 // share coin type argument(s) so the `&mut Work<Share>` / `&AdminCap<Share>` calls
 // resolve.
@@ -28,16 +28,15 @@
 // about any of it — it only provides the cap-gated `uid_mut` hook these attach
 // through.
 
-import { Effect, Option } from "effect";
+import { Effect, Option, Result } from "effect";
 import { bcs } from "@mysten/sui/bcs";
 import { deriveDynamicFieldID } from "@mysten/sui/utils";
-import { getObjectsContent, SuiClient, type SuiRpcError } from "@misofm/effect";
+import { ObjectId, Sui, type TransportError, type Recipe } from "@unconfirmed/sui-effect";
 import type {
   Transaction,
   TransactionArgument,
   TransactionObjectArgument,
 } from "@mysten/sui/transactions";
-import type { TxThunk } from "./transactions.ts";
 import { OPTION_NONE, OPTION_SOME } from "./internal.ts";
 import * as compositionCredits from "./contracts/composition_credits/composition_credits.ts";
 import * as compositionPartyRole from "./contracts/composition_credits/composition_party_role.ts";
@@ -396,7 +395,7 @@ export type AttachCompositionCreditParams =
  */
 export function attachCompositionCredit(
   p: AttachCompositionCreditParams,
-): TxThunk {
+): Recipe {
   assertDisplayName("attachCompositionCredit", p.displayName);
   assertRoles("attachCompositionCredit", p.roles, MAX_COMPOSITION_ROLES);
   return (tx) => {
@@ -447,7 +446,7 @@ export type AttachRecordingCreditParams =
  * 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: AttachRecordingCreditParams): TxThunk {
+export function attachRecordingCredit(p: AttachRecordingCreditParams): Recipe {
   assertDisplayName("attachRecordingCredit", p.displayName);
   assertRoles("attachRecordingCredit", p.roles, MAX_RECORDING_ROLES);
   return (tx) => {
@@ -493,7 +492,7 @@ export type AddRecordingArtistParams =
  */
 export function addRecordingPrimaryArtist(
   p: AddRecordingArtistParams,
-): TxThunk {
+): Recipe {
   return (tx) => {
     invokeWithAdminCap(tx, recordingAuthorityOf(p), {
       target: `${p.recordingCreditsPackageId}::recording_credits::add_primary_artist`,
@@ -511,7 +510,7 @@ export function addRecordingPrimaryArtist(
  */
 export function addRecordingFeaturedArtist(
   p: AddRecordingArtistParams,
-): TxThunk {
+): Recipe {
   return (tx) => {
     invokeWithAdminCap(tx, recordingAuthorityOf(p), {
       target: `${p.recordingCreditsPackageId}::recording_credits::add_featured_artist`,
@@ -543,7 +542,7 @@ export type AddReleaseCreditParams = AddReleaseCreditParamsBase & ReleaseAuthori
  * 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: AddReleaseCreditParams): TxThunk {
+export function addReleaseCredit(p: AddReleaseCreditParams): Recipe {
   assertDisplayName("addReleaseCredit", p.displayName);
   return (tx) => {
     const roleType = `${p.releaseCreditsPackageId}::release_party_role::ReleasePartyRole`;
@@ -632,17 +631,23 @@ interface CreditFieldTarget {
   fieldId: string;
 }
 
-/** Fetch many derived credit fields through one Core bulk request. */
+/**
+ * Fetch many derived credit fields through one chunked `sui.getObjects`.
+ * Soft read: an id that fails to read (missing, deleted, unreachable) is
+ * dropped from the returned map rather than failing the whole batch — the
+ * predecessor `@misofm/effect`-era `getObjectsContent`'s behaviour, now via
+ * `sui.getObjects`' per-item `Result` instead of a silently-dropping map.
+ */
 const fetchCreditFields = Effect.fn("fetchCreditFields")(function* (
   targets: readonly CreditFieldTarget[],
-): Effect.fn.Return<Map<string, Uint8Array>, SuiRpcError, SuiClient> {
+): Effect.fn.Return<Map<string, Uint8Array>, TransportError, Sui> {
   if (targets.length === 0) return new Map();
-  const objects = yield* getObjectsContent(targets.map((target) => target.fieldId));
+  const sui = yield* Sui;
+  const results = yield* sui.getObjects(targets.map((target) => ObjectId.make(target.fieldId)));
   const contents = new Map<string, Uint8Array>();
-  for (const target of targets) {
-    const object = objects.get(target.fieldId);
-    if (object) contents.set(target.fieldId, object.content);
-  }
+  results.forEach((result, index) => {
+    if (Result.isSuccess(result)) contents.set(targets[index]!.fieldId, result.success.content);
+  });
   return contents;
 });
 
@@ -783,7 +788,7 @@ function recordingRoleLabel(role: ParsedEnum): string {
 export const getCompositionCredits = Effect.fn("getCompositionCredits")(function* (
   compositionId: string,
   compositionCreditsPackageId: string,
-): Effect.fn.Return<Option.Option<CreditView[]>, SuiRpcError, SuiClient> {
+): Effect.fn.Return<Option.Option<CreditView[]>, TransportError, Sui> {
   const byId = yield* getCompositionCreditsByIds([compositionId], compositionCreditsPackageId);
   return Option.fromNullishOr(byId[compositionId]);
 });
@@ -792,7 +797,7 @@ export const getCompositionCredits = Effect.fn("getCompositionCredits")(function
 export const getCompositionCreditsByIds = Effect.fn("getCompositionCreditsByIds")(function* (
   compositionIdsInput: readonly string[],
   compositionCreditsPackageId: string,
-): Effect.fn.Return<Partial<Record<string, CreditView[]>>, SuiRpcError, SuiClient> {
+): Effect.fn.Return<Partial<Record<string, CreditView[]>>, TransportError, Sui> {
   const compositionIds = [...new Set(compositionIdsInput)];
   const targets = compositionCreditTargets(compositionIds, compositionCreditsPackageId);
   const contents = yield* fetchCreditFields(targets);
@@ -816,7 +821,7 @@ export const getCompositionCreditsByIds = Effect.fn("getCompositionCreditsByIds"
 export const getRecordingCredits = Effect.fn("getRecordingCredits")(function* (
   recordingId: string,
   recordingCreditsPackageId: string,
-): Effect.fn.Return<Option.Option<RecordingCreditsView>, SuiRpcError, SuiClient> {
+): Effect.fn.Return<Option.Option<RecordingCreditsView>, TransportError, Sui> {
   const byId = yield* getRecordingCreditsByIds([recordingId], recordingCreditsPackageId);
   return Option.fromNullishOr(byId[recordingId]);
 });
@@ -825,7 +830,7 @@ export const getRecordingCredits = Effect.fn("getRecordingCredits")(function* (
 export const getRecordingCreditsByIds = Effect.fn("getRecordingCreditsByIds")(function* (
   recordingIdsInput: readonly string[],
   recordingCreditsPackageId: string,
-): Effect.fn.Return<Partial<Record<string, RecordingCreditsView>>, SuiRpcError, SuiClient> {
+): Effect.fn.Return<Partial<Record<string, RecordingCreditsView>>, TransportError, Sui> {
   const recordingIds = [...new Set(recordingIdsInput)];
   const targets = recordingCreditTargets(recordingIds, recordingCreditsPackageId);
   const contents = yield* fetchCreditFields(targets);
@@ -850,7 +855,7 @@ export const getRecordingCreditsByIds = Effect.fn("getRecordingCreditsByIds")(fu
 export const getReleaseCredits = Effect.fn("getReleaseCredits")(function* (
   releaseId: string,
   releaseCreditsPackageId: string,
-): Effect.fn.Return<Option.Option<CreditView[]>, SuiRpcError, SuiClient> {
+): Effect.fn.Return<Option.Option<CreditView[]>, TransportError, Sui> {
   const byId = yield* getReleaseCreditsByIds([releaseId], releaseCreditsPackageId);
   return Option.fromNullishOr(byId[releaseId]);
 });
@@ -859,7 +864,7 @@ export const getReleaseCredits = Effect.fn("getReleaseCredits")(function* (
 export const getReleaseCreditsByIds = Effect.fn("getReleaseCreditsByIds")(function* (
   releaseIdsInput: readonly string[],
   releaseCreditsPackageId: string,
-): Effect.fn.Return<Partial<Record<string, CreditView[]>>, SuiRpcError, SuiClient> {
+): Effect.fn.Return<Partial<Record<string, CreditView[]>>, TransportError, Sui> {
   const releaseIds = [...new Set(releaseIdsInput)];
   const targets = releaseCreditTargets(releaseIds, releaseCreditsPackageId);
   const contents = yield* fetchCreditFields(targets);

package/src/deployments.ts

@@ -7,7 +7,6 @@ import type { PartyDeployment } from "@misofm/partyos/deployments";
 import { PARTYOS_DEPLOYMENTS } from "@misofm/partyos/deployments";
 import { normalizeSuiAddress, normalizeSuiObjectId } from "@mysten/sui/utils";
 import { Context, Effect, Layer } from "effect";
-import { DeploymentError } from "@misofm/effect/errors";
 import { immutableSnapshot } from "./internal.ts";
 import {
   MisoPlatformDeploymentInvalidError,
@@ -571,14 +570,14 @@ export function getMisoPlatformDeployment(
   return deployment;
 }
 
-/** Effect-returning `assertMisoPlatformDeployment`: validation failure becomes a typed `DeploymentError`. */
+/** Effect-returning `assertMisoPlatformDeployment`: validation failure becomes a typed `MisoPlatformDeploymentInvalidError`. */
 export function validateMisoPlatformDeployment(
   deployment: unknown,
-): Effect.Effect<MisoPlatformDeployment, DeploymentError> {
+): Effect.Effect<MisoPlatformDeployment, MisoPlatformDeploymentInvalidError> {
   return Effect.try({
     try: () => normalizeMisoPlatformDeployment(deployment),
     catch: (cause) =>
-      new DeploymentError({
+      new MisoPlatformDeploymentInvalidError({
         message: cause instanceof Error ? cause.message : String(cause),
       }),
   });

package/src/errors.ts

@@ -1,25 +1,41 @@
 // Copyright (c) Miso Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-// The platform-specific error vocabulary, built on the shared foundation
-// (`@misofm/effect/errors`). Every failure a caller might need to act on is a
-// `Schema.TaggedError` carrying the fields needed to act; `isNotFound`-style
-// message sniffing is replaced by `Effect.catchTag` against these tags.
+// The platform-specific error vocabulary, now built on sui-effect's own
+// taxonomy instead of the deprecated `@misofm/effect/errors` foundation
+// (misofm/sdks#35, WP1). Every failure a caller might need to act on is a
+// `Schema.TaggedError` carrying the fields needed to act, and every one of
+// THIS package's own classes declares `outcome` per sui-effect's
+// `docs/extensions.md` §2 — `SuiError.outcome` and `Script.exitCode` read
+// that field, and an error that omits it is "unclassified". Tags keep their
+// exact predecessor strings so a consumer's existing `catchTag`/`Effect.catch`
+// keeps matching.
 
 import { Schema } from "effect";
-
-// Re-export the foundation vocabulary so a platform consumer never needs a
-// second import for the errors platform reads/executes surface directly.
+import type { Outcome } from "@unconfirmed/sui-effect";
+
+// Re-export sui-effect's own taxonomy so a platform consumer never needs a
+// second import for the errors platform reads/writes surface directly. This
+// package no longer maintains its own copies of these — see the migration
+// table in sui-effect's `docs/extensions.md` ("Migrating from
+// `@misofm/effect`"): `BcsDecodeError`/`ObjectTypeMismatchError` merge into
+// `DecodeError`; `ObjectNotFoundError` becomes `ObjectNotFound` (plus
+// `ObjectDeleted`/`ObjectUnavailable`); `SuiRpcError` becomes `TransportError`;
+// `TransactionFailedError` becomes `ExecutionFailed`; `GraphQLUnavailableError`
+// becomes sui-effect's own `GraphQLUnavailable`, produced by the bare
+// `SuiGraphQL` tag this package now reads through directly (the same one
+// `@misofm/musicos` reads through — no second, platform-owned GraphQL tag).
 export {
-  BcsDecodeError,
-  DeploymentError,
-  GraphQLUnavailableError,
-  ObjectNotFoundError,
-  ObjectTypeMismatchError,
-  SuiRpcError,
-  TransactionFailedError,
-  type SuiReadError,
-} from "@misofm/effect/errors";
+  DecodeError,
+  ExecutionFailed,
+  GraphQLUnavailable,
+  ObjectDeleted,
+  ObjectNotFound,
+  ObjectUnavailable,
+  TransportError,
+  type BatchItemError,
+  type GetObjectError,
+} from "@unconfirmed/sui-effect";
 
 /** Record sales (Record + Record Shop) are unavailable on this deployment. */
 export class RecordSalesUnavailableError extends Schema.TaggedError<RecordSalesUnavailableError>()(
@@ -28,6 +44,8 @@ export class RecordSalesUnavailableError extends Schema.TaggedError<RecordSalesU
     reason: Schema.String,
   },
 ) {
+  /** Nothing was submitted — the deployment was rejected before any Move target was built. */
+  readonly outcome: Outcome = "not_applied";
   override get message(): string {
     return `@misofm/platform: Record sales are unavailable: ${this.reason}`;
   }
@@ -40,6 +58,8 @@ export class OperationsUnavailableError extends Schema.TaggedError<OperationsUna
     reason: Schema.String,
   },
 ) {
+  /** Nothing was submitted — the deployment was rejected before any Move target was built. */
+  readonly outcome: Outcome = "not_applied";
   override get message(): string {
     return `@misofm/platform: Vault operations are unavailable: ${this.reason}`;
   }
@@ -51,7 +71,10 @@ export class MisoPlatformDeploymentInvalidError extends Schema.TaggedError<MisoP
   {
     message: Schema.String,
   },
-) {}
+) {
+  /** Nothing was submitted — nothing was even built. Replaces the predecessor `@misofm/effect`-era `DeploymentError`. */
+  readonly outcome: Outcome = "not_applied";
+}
 
 /** The connected client's network does not match the configured deployment's network. */
 export class MisoNetworkMismatchError extends Schema.TaggedError<MisoNetworkMismatchError>()(
@@ -61,12 +84,18 @@ export class MisoNetworkMismatchError extends Schema.TaggedError<MisoNetworkMism
     deploymentNetwork: Schema.String,
   },
 ) {
+  readonly outcome: Outcome = "not_applied";
   override get message(): string {
     return `@misofm/platform: client network "${this.clientNetwork}" does not match deployment network "${this.deploymentNetwork}"`;
   }
 }
 
-/** The connected endpoint's chain identifier does not match the configured deployment's. */
+/**
+ * The connected endpoint's chain identifier does not match the configured
+ * deployment's. Raised at `Miso.layer` build (the same exact-ledger check
+ * the predecessor `MisoPlatformClient#ready()` performed at first use),
+ * per misofm/sdks#35's target shape.
+ */
 export class MisoChainIdentifierMismatchError extends Schema.TaggedError<MisoChainIdentifierMismatchError>()(
   "MisoChainIdentifierMismatchError",
   {
@@ -74,23 +103,12 @@ export class MisoChainIdentifierMismatchError extends Schema.TaggedError<MisoCha
     expected: Schema.String,
   },
 ) {
+  readonly outcome: Outcome = "not_applied";
   override get message(): string {
     return `@misofm/platform: endpoint chain identifier "${this.actual}" does not match deployment chain identifier "${this.expected}"`;
   }
 }
 
-/** A method that requires the exact-chain validation lifecycle was called before `ready()`. */
-export class MisoClientNotReadyError extends Schema.TaggedError<MisoClientNotReadyError>()(
-  "MisoClientNotReadyError",
-  {
-    operation: Schema.String,
-  },
-) {
-  override get message(): string {
-    return `@misofm/platform: ${this.operation} requires an exact-chain validation lifecycle; call and await client.miso.ready() first`;
-  }
-}
-
 /** An on-chain `RecordSoldEvent` could not be decoded into a `RecordSale`. */
 export class MalformedRecordSoldEventError extends Schema.TaggedError<MalformedRecordSoldEventError>()(
   "MalformedRecordSoldEventError",
@@ -98,7 +116,9 @@ export class MalformedRecordSoldEventError extends Schema.TaggedError<MalformedR
     digest: Schema.optional(Schema.String),
     reason: Schema.optional(Schema.String),
   },
-) {}
+) {
+  readonly outcome: Outcome = "not_applied";
+}
 
 /** Authenticated-fetch / API-authorization signing or verification failure. */
 export const MisoAuthErrorCode = Schema.Literals([
@@ -115,6 +135,8 @@ export class MisoAuthError extends Schema.TaggedError<MisoAuthError>()("MisoAuth
   status: Schema.optional(Schema.Number),
   cause: Schema.optional(Schema.Defect()),
 }) {
+  /** An HTTP authorization failure never submits a transaction. */
+  readonly outcome: Outcome = "not_applied";
   override get message(): string {
     return this.reason;
   }
@@ -130,12 +152,16 @@ export class MisoAuthError extends Schema.TaggedError<MisoAuthError>()("MisoAuth
 /** No Release exists at the requested id (or it is not a Release from the configured deployment). */
 export class ReleaseNotFoundError extends Schema.TaggedError<ReleaseNotFoundError>()("ReleaseNotFoundError", {
   releaseId: Schema.String,
-}) {}
+}) {
+  readonly outcome: Outcome = "not_applied";
+}
 
 /** The fullnode and the indexer both have no record of this transaction digest. */
 export class ReceiptNotFoundError extends Schema.TaggedError<ReceiptNotFoundError>()("ReceiptNotFoundError", {
   digest: Schema.String,
-}) {}
+}) {
+  readonly outcome: Outcome = "not_applied";
+}
 
 /** The transaction exists, but its effects contain no `record_shop::listing::RecordSoldEvent`. */
 export class RecordPurchaseNotFoundError extends Schema.TaggedError<RecordPurchaseNotFoundError>()(
@@ -143,14 +169,31 @@ export class RecordPurchaseNotFoundError extends Schema.TaggedError<RecordPurcha
   {
     digest: Schema.String,
   },
-) {}
+) {
+  readonly outcome: Outcome = "not_applied";
+}
 
 /** An object exists at the requested Pressing id, but is not a Pressing from the configured Record package. */
 export class ForeignPressingError extends Schema.TaggedError<ForeignPressingError>()("ForeignPressingError", {
   pressingId: Schema.String,
   actualType: Schema.optional(Schema.String),
 }) {
+  readonly outcome: Outcome = "not_applied";
   override get message(): string {
     return `@misofm/platform: object ${this.pressingId} is not a Pressing from the configured Record package.`;
   }
 }
+
+/** A `royalty_pool::pool::RoyaltyClaimedEvent` the indexer returned does not carry the fields this package expects. */
+export class MalformedRoyaltyClaimedEventError extends Schema.TaggedError<MalformedRoyaltyClaimedEventError>()(
+  "MalformedRoyaltyClaimedEventError",
+  {
+    digest: Schema.String,
+    reason: Schema.String,
+  },
+) {
+  readonly outcome: Outcome = "not_applied";
+  override get message(): string {
+    return `@misofm/platform: ${this.reason} (transaction ${this.digest}).`;
+  }
+}