@misofm/effect 0.1.0

package/dist/reads.d.ts

@@ -0,0 +1,39 @@
+import { Effect, Option, Schema, Stream } from "effect";
+import type { SuiClientTypes } from "@mysten/sui/client";
+import { BcsDecodeError, ObjectNotFoundError, ObjectTypeMismatchError, SuiRpcError } from "./errors.ts";
+import { SuiClient } from "./sui-client.ts";
+/** One object's BCS content, on-chain type, and version. */
+export interface ObjectContent {
+    readonly content: Uint8Array;
+    readonly type: string;
+    readonly version: string;
+}
+/** A dynamic field entry as returned by `listDynamicFields` (name + value type, not the decoded value). */
+export type DynamicField = SuiClientTypes.DynamicFieldEntry;
+/** Any generated BCS codec with a `parse` method — the shape every `src/contracts/**` struct exports. */
+export interface BcsParser<T> {
+    parse(bytes: Uint8Array): T;
+}
+/** Identifies the object/type a `decodeBcs` failure is reported against. */
+export interface DecodeBcsContext {
+    /** Fully-qualified Move type (or domain type name) being decoded. */
+    readonly type: string;
+    /** Object id being decoded, when decoding a specific object's content. */
+    readonly objectId?: string;
+}
+/** Fetches one object's BCS content by id; fails with `ObjectNotFoundError` if it does not exist. */
+export declare const getObjectContent: (objectId: string) => Effect.Effect<ObjectContent, ObjectNotFoundError | SuiRpcError, SuiClient>;
+/** Like {@link getObjectContent}, but a missing object resolves to `Option.none()` instead of failing. */
+export declare const getOptionalObjectContent: (objectId: string) => Effect.Effect<Option.Option<ObjectContent>, SuiRpcError, SuiClient>;
+/** Fetches many objects' BCS content in one Core request; ids that are missing or errored are omitted from the map. */
+export declare const getObjectsContent: (objectIds: readonly string[]) => Effect.Effect<ReadonlyMap<string, {
+    content: Uint8Array;
+    type: string;
+}>, SuiRpcError, SuiClient>;
+/** Pages every dynamic field under `parentId` through `client.core.listDynamicFields`, following the cursor. */
+export declare function listDynamicFields(parentId: string): Stream.Stream<DynamicField, SuiRpcError, SuiClient>;
+/** Runs a generated BCS codec's `.parse`, then decodes the result into a domain `Schema` type; both failure paths become `BcsDecodeError`. */
+export declare const decodeBcs: <A>(codec: BcsParser<unknown>, schema: Schema.Codec<A, any, never, never>, bytes: Uint8Array<ArrayBufferLike>, context: DecodeBcsContext) => Effect.Effect<A, BcsDecodeError, never>;
+/** Fails with `ObjectTypeMismatchError` unless `actual` is exactly `expected`. */
+export declare const assertObjectType: (objectId: string, actual: string, expected: string) => Effect.Effect<void, ObjectTypeMismatchError, never>;
+//# sourceMappingURL=reads.d.ts.map

package/dist/reads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reads.d.ts","sourceRoot":"","sources":["../src/reads.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AACxD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEzD,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AACxG,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,4DAA4D;AAC5D,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED,2GAA2G;AAC3G,MAAM,MAAM,YAAY,GAAG,cAAc,CAAC,iBAAiB,CAAC;AAE5D,yGAAyG;AACzG,MAAM,WAAW,SAAS,CAAC,CAAC;IAC1B,KAAK,CAAC,KAAK,EAAE,UAAU,GAAG,CAAC,CAAC;CAC7B;AAED,4EAA4E;AAC5E,MAAM,WAAW,gBAAgB;IAC/B,qEAAqE;IACrE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,0EAA0E;IAC1E,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,qGAAqG;AACrG,eAAO,MAAM,gBAAgB,kGAY3B,CAAC;AAEH,0GAA0G;AAC1G,eAAO,MAAM,wBAAwB,2FAOnC,CAAC;AAEH,uHAAuH;AACvH,eAAO,MAAM,iBAAiB;aAEqB,UAAU;UAAQ,MAAM;2BAczE,CAAC;AAEH,gHAAgH;AAChH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,WAAW,EAAE,SAAS,CAAC,CAYvG;AAED,8IAA8I;AAC9I,eAAO,MAAM,SAAS,GAAqC,CAAC,kLAa1D,CAAC;AAEH,kFAAkF;AAClF,eAAO,MAAM,gBAAgB,6GAQ3B,CAAC"}

package/dist/reads.js

@@ -0,0 +1,107 @@
+// Copyright (c) Miso Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+// The shared read primitives every `@misofm/*` package's queries are built
+// from. Every primitive requires the `SuiClient` service instead of taking a
+// client parameter, and every not-found path is classified into a typed
+// `ObjectNotFoundError` rather than a bare thrown error — see `isNotFound`
+// below, ported from the transport-sniffing heuristic each package used to
+// hand-roll.
+import { Effect, Option, Schema, Stream } from "effect";
+import { BcsDecodeError, ObjectNotFoundError, ObjectTypeMismatchError, SuiRpcError } from "./errors.js";
+import { SuiClient } from "./sui-client.js";
+/** Fetches one object's BCS content by id; fails with `ObjectNotFoundError` if it does not exist. */
+export const getObjectContent = Effect.fn("getObjectContent")(function* (objectId) {
+    const client = yield* SuiClient;
+    const { object } = yield* Effect.tryPromise({
+        try: (signal) => client.core.getObject({ objectId, include: { content: true }, signal }),
+        catch: (cause) => classifyObjectError(objectId, "getObject", cause),
+    });
+    if (!object.content) {
+        return yield* new ObjectNotFoundError({ objectId });
+    }
+    return { content: object.content, type: object.type, version: object.version };
+});
+/** Like {@link getObjectContent}, but a missing object resolves to `Option.none()` instead of failing. */
+export const getOptionalObjectContent = Effect.fn("getOptionalObjectContent")(function* (objectId) {
+    return yield* getObjectContent(objectId).pipe(Effect.map(Option.some), Effect.catchTag("ObjectNotFoundError", () => Effect.succeed(Option.none())));
+});
+/** Fetches many objects' BCS content in one Core request; ids that are missing or errored are omitted from the map. */
+export const getObjectsContent = Effect.fn("getObjectsContent")(function* (objectIds) {
+    const out = new Map();
+    if (objectIds.length === 0)
+        return out;
+    const client = yield* SuiClient;
+    const { objects } = yield* Effect.tryPromise({
+        try: (signal) => client.core.getObjects({ objectIds: [...objectIds], include: { content: true }, signal }),
+        catch: (cause) => new SuiRpcError({ operation: "getObjects", cause }),
+    });
+    for (const obj of objects) {
+        if (obj instanceof Error || !obj.content)
+            continue;
+        out.set(obj.objectId, { content: obj.content, type: obj.type });
+    }
+    return out;
+});
+/** Pages every dynamic field under `parentId` through `client.core.listDynamicFields`, following the cursor. */
+export function listDynamicFields(parentId) {
+    return Stream.paginate(null, (cursor) => Effect.gen(function* () {
+        const client = yield* SuiClient;
+        const page = yield* Effect.tryPromise({
+            try: (signal) => client.core.listDynamicFields({ parentId, cursor, signal }),
+            catch: (cause) => new SuiRpcError({ operation: "listDynamicFields", cause }),
+        });
+        const next = page.hasNextPage ? Option.some(page.cursor) : Option.none();
+        return [page.dynamicFields, next];
+    }));
+}
+/** Runs a generated BCS codec's `.parse`, then decodes the result into a domain `Schema` type; both failure paths become `BcsDecodeError`. */
+export const decodeBcs = Effect.fn("decodeBcs")(function* (codec, schema, bytes, context) {
+    const parsed = yield* Effect.try({
+        try: () => codec.parse(bytes),
+        catch: (cause) => new BcsDecodeError({ type: context.type, objectId: context.objectId, cause }),
+    });
+    return yield* Schema.decodeUnknownEffect(schema)(parsed).pipe(Effect.mapError((cause) => new BcsDecodeError({ type: context.type, objectId: context.objectId, cause })));
+});
+/** Fails with `ObjectTypeMismatchError` unless `actual` is exactly `expected`. */
+export const assertObjectType = Effect.fn("assertObjectType")(function* (objectId, actual, expected) {
+    if (actual !== expected) {
+        return yield* new ObjectTypeMismatchError({ objectId, expected, actual });
+    }
+});
+// ── Private ──────────────────────────────────────────────────────────────────
+/** Classifies a Core API rejection: a missing object becomes `ObjectNotFoundError`, anything else `SuiRpcError`. */
+function classifyObjectError(objectId, operation, cause) {
+    return isNotFound(cause) ? new ObjectNotFoundError({ objectId }) : new SuiRpcError({ operation, cause });
+}
+/**
+ * True when `e` is a "this object does not exist" error from any of the Sui
+ * client transports. Matches, in order of preference:
+ *
+ *   1. Structured `ObjectError.code` values thrown by the JSON-RPC core client
+ *      (`notExists`, `deleted`, `dynamicFieldNotFound`) and the GraphQL core
+ *      client (`notFound`). The class itself is not exported by `@mysten/sui`,
+ *      so we duck-type on `code`.
+ *   2. The message shapes those clients (and the gRPC core client, which wraps
+ *      the server's per-object status message in a plain `Error`) produce:
+ *      "Object 0x… does not exist" / "Object 0x… not found" / "Object 0x… has
+ *      been deleted" / "Dynamic field not found for object 0x…" / "No object
+ *      found for id 0x…".
+ *
+ * Transport/protocol errors must NOT match: every message pattern requires
+ * object-ish context ("object" / "dynamic field"), so e.g. a JSON-RPC
+ * "Method not found" or a gRPC "peer not found" is never treated as a missing
+ * object and is reported as a `SuiRpcError` instead.
+ */
+function isNotFound(e) {
+    if (typeof e === "object" && e !== null && "code" in e) {
+        const code = e.code;
+        if (code === "notExists" || code === "deleted" || code === "dynamicFieldNotFound" || code === "notFound") {
+            return true;
+        }
+    }
+    const msg = e instanceof Error ? e.message : String(e);
+    return (/\bobject\b[\s\S]*\b(?:not\s?found|does not exist|has been deleted)\b/i.test(msg) ||
+        /\bdynamic field\b[\s\S]*\bnot\s?found\b/i.test(msg) ||
+        /\bno object\b/i.test(msg));
+}
+//# sourceMappingURL=reads.js.map

package/dist/reads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reads.js","sourceRoot":"","sources":["../src/reads.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,sCAAsC;AAEtC,2EAA2E;AAC3E,6EAA6E;AAC7E,wEAAwE;AACxE,2EAA2E;AAC3E,2EAA2E;AAC3E,aAAa;AAEb,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAGxD,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AACxG,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAyB5C,qGAAqG;AACrG,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAM,CAAC,EAAE,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC,EACrE,QAAgB;IAEhB,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,SAAS,CAAC;IAChC,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC;QAC1C,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC;QACxF,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,mBAAmB,CAAC,QAAQ,EAAE,WAAW,EAAE,KAAK,CAAC;KACpE,CAAC,CAAC;IACH,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,OAAO,KAAK,CAAC,CAAC,IAAI,mBAAmB,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IACtD,CAAC;IACD,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;AACjF,CAAC,CAAC,CAAC;AAEH,0GAA0G;AAC1G,MAAM,CAAC,MAAM,wBAAwB,GAAG,MAAM,CAAC,EAAE,CAAC,0BAA0B,CAAC,CAAC,QAAQ,CAAC,EACrF,QAAgB;IAEhB,OAAO,KAAK,CAAC,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,IAAI,CAC3C,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EACvB,MAAM,CAAC,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAC5E,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,uHAAuH;AACvH,MAAM,CAAC,MAAM,iBAAiB,GAAG,MAAM,CAAC,EAAE,CAAC,mBAAmB,CAAC,CAAC,QAAQ,CAAC,EACvE,SAA4B;IAE5B,MAAM,GAAG,GAAG,IAAI,GAAG,EAAiD,CAAC;IACrE,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,GAAG,CAAC;IAEvC,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,SAAS,CAAC;IAChC,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC;QAC3C,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC;QAC1G,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,WAAW,CAAC,EAAE,SAAS,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC;KACtE,CAAC,CAAC;IACH,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;QAC1B,IAAI,GAAG,YAAY,KAAK,IAAI,CAAC,GAAG,CAAC,OAAO;YAAE,SAAS;QACnD,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IAClE,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC,CAAC,CAAC;AAEH,gHAAgH;AAChH,MAAM,UAAU,iBAAiB,CAAC,QAAgB;IAChD,OAAO,MAAM,CAAC,QAAQ,CAAsD,IAAI,EAAE,CAAC,MAAM,EAAE,EAAE,CAC3F,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;QAClB,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,SAAS,CAAC;QAChC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC;YACpC,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;YAC5E,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,WAAW,CAAC,EAAE,SAAS,EAAE,mBAAmB,EAAE,KAAK,EAAE,CAAC;SAC7E,CAAC,CAAC;QACH,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QACzE,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAU,CAAC;IAC7C,CAAC,CAAC,CACH,CAAC;AACJ,CAAC;AAED,8IAA8I;AAC9I,MAAM,CAAC,MAAM,SAAS,GAAG,MAAM,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,EACvD,KAAyB,EACzB,MAA0C,EAC1C,KAAiB,EACjB,OAAyB;IAEzB,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;QAC/B,GAAG,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC;QAC7B,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,cAAc,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,KAAK,EAAE,CAAC;KAChG,CAAC,CAAC;IACH,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAC3D,MAAM,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,cAAc,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,CAC1G,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,kFAAkF;AAClF,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAM,CAAC,EAAE,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC,EACrE,QAAgB,EAChB,MAAc,EACd,QAAgB;IAEhB,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;QACxB,OAAO,KAAK,CAAC,CAAC,IAAI,uBAAuB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;IAC5E,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,gFAAgF;AAEhF,oHAAoH;AACpH,SAAS,mBAAmB,CAAC,QAAgB,EAAE,SAAiB,EAAE,KAAc;IAC9E,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,mBAAmB,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,WAAW,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;AAC3G,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAS,UAAU,CAAC,CAAU;IAC5B,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,IAAI,MAAM,IAAI,CAAC,EAAE,CAAC;QACvD,MAAM,IAAI,GAAI,CAAuB,CAAC,IAAI,CAAC;QAC3C,IAAI,IAAI,KAAK,WAAW,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,sBAAsB,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;YACzG,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IACD,MAAM,GAAG,GAAG,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACvD,OAAO,CACL,uEAAuE,CAAC,IAAI,CAAC,GAAG,CAAC;QACjF,0CAA0C,CAAC,IAAI,CAAC,GAAG,CAAC;QACpD,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAC3B,CAAC;AACJ,CAAC"}

package/dist/sui-client.d.ts

@@ -0,0 +1,17 @@
+import { Context, Layer } from "effect";
+import type { ClientWithCoreApi } from "@mysten/sui/client";
+import type { SuiGraphQLClient } from "@mysten/sui/graphql";
+declare const SuiClient_base: Context.ServiceClass<SuiClient, "@misofm/effect/SuiClient", ClientWithCoreApi>;
+/** The unified Core API client (gRPC / JSON-RPC / GraphQL transports all satisfy it). */
+export declare class SuiClient extends SuiClient_base {
+    /** Provides a concrete `ClientWithCoreApi` as the `SuiClient` service. */
+    static layer(client: ClientWithCoreApi): Layer.Layer<SuiClient>;
+}
+declare const SuiGraphQL_base: Context.ServiceClass<SuiGraphQL, "@misofm/effect/SuiGraphQL", SuiGraphQLClient<{}>>;
+/** The optional GraphQL client, required only by type-discovery reads. */
+export declare class SuiGraphQL extends SuiGraphQL_base {
+    /** Provides a concrete `SuiGraphQLClient` as the `SuiGraphQL` service. */
+    static layer(client: SuiGraphQLClient): Layer.Layer<SuiGraphQL>;
+}
+export {};
+//# sourceMappingURL=sui-client.d.ts.map

package/dist/sui-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sui-client.d.ts","sourceRoot":"","sources":["../src/sui-client.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AACxC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;;AAE5D,yFAAyF;AACzF,qBAAa,SAAU,SAAQ,cAA2E;IACxG,0EAA0E;IAC1E,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,iBAAiB,GAAG,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAE9D;CACF;;AAED,0EAA0E;AAC1E,qBAAa,UAAW,SAAQ,eAA4E;IAC1G,0EAA0E;IAC1E,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,gBAAgB,GAAG,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAE9D;CACF"}

package/dist/sui-client.js

@@ -0,0 +1,22 @@
+// Copyright (c) Miso Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+// The Sui client services every `@misofm/*` SDK reaches through the Requirements
+// channel instead of a `client` parameter. There is exactly one `SuiClient`
+// service tag (and one `SuiGraphQL` tag) across the SDKs, so a program built
+// from primitives in different packages still needs only one `Layer.provide`.
+import { Context, Layer } from "effect";
+/** The unified Core API client (gRPC / JSON-RPC / GraphQL transports all satisfy it). */
+export class SuiClient extends Context.Service()("@misofm/effect/SuiClient") {
+    /** Provides a concrete `ClientWithCoreApi` as the `SuiClient` service. */
+    static layer(client) {
+        return Layer.succeed(SuiClient, client);
+    }
+}
+/** The optional GraphQL client, required only by type-discovery reads. */
+export class SuiGraphQL extends Context.Service()("@misofm/effect/SuiGraphQL") {
+    /** Provides a concrete `SuiGraphQLClient` as the `SuiGraphQL` service. */
+    static layer(client) {
+        return Layer.succeed(SuiGraphQL, client);
+    }
+}
+//# sourceMappingURL=sui-client.js.map

package/dist/sui-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sui-client.js","sourceRoot":"","sources":["../src/sui-client.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,sCAAsC;AAEtC,iFAAiF;AACjF,4EAA4E;AAC5E,6EAA6E;AAC7E,8EAA8E;AAE9E,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAIxC,yFAAyF;AACzF,MAAM,OAAO,SAAU,SAAQ,OAAO,CAAC,OAAO,EAAgC,CAAC,0BAA0B,CAAC;IACxG,0EAA0E;IAC1E,MAAM,CAAC,KAAK,CAAC,MAAyB;QACpC,OAAO,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IAC1C,CAAC;CACF;AAED,0EAA0E;AAC1E,MAAM,OAAO,UAAW,SAAQ,OAAO,CAAC,OAAO,EAAgC,CAAC,2BAA2B,CAAC;IAC1G,0EAA0E;IAC1E,MAAM,CAAC,KAAK,CAAC,MAAwB;QACnC,OAAO,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAC3C,CAAC;CACF"}

package/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "@misofm/effect",
+  "version": "0.1.0",
+  "packageManager": "bun@1.4.0",
+  "description": "Shared Effect foundation for the Miso SDKs: one SuiClient service, one error vocabulary, and the read/execute primitives every package builds on.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/misofm/sdks.git",
+    "directory": "packages/effect"
+  },
+  "homepage": "https://github.com/misofm/sdks#readme",
+  "bugs": {
+    "url": "https://github.com/misofm/sdks/issues"
+  },
+  "keywords": [
+    "sui",
+    "effect",
+    "miso",
+    "blockchain",
+    "sdk"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "sideEffects": false,
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "test": "bun test",
+    "docs": "typedoc",
+    "build": "rm -rf dist && tsc -p tsconfig.build.json",
+    "prepack": "rm -rf dist && tsc -p tsconfig.build.json",
+    "prepare": "rm -rf dist && tsc -p tsconfig.build.json --noCheck"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./errors": {
+      "types": "./dist/errors.d.ts",
+      "default": "./dist/errors.js"
+    },
+    "./sui-client": {
+      "types": "./dist/sui-client.d.ts",
+      "default": "./dist/sui-client.js"
+    },
+    "./reads": {
+      "types": "./dist/reads.d.ts",
+      "default": "./dist/reads.js"
+    },
+    "./execute": {
+      "types": "./dist/execute.d.ts",
+      "default": "./dist/execute.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "src",
+    "README.md",
+    "LICENSE",
+    "package.json"
+  ],
+  "devDependencies": {
+    "@mysten/sui": "2.29.0",
+    "@types/bun": "^1.4.0",
+    "effect": "4.0.0-rc.112",
+    "typedoc": "^0.28.20",
+    "typedoc-plugin-markdown": "^4.13.0",
+    "typescript": "^7.0.2"
+  },
+  "peerDependencies": {
+    "@mysten/sui": "2.29.0",
+    "effect": "4.0.0-rc.112",
+    "typescript": "^5.7 || ^6 || ^7"
+  },
+  "main": "./dist/index.js"
+}

package/src/errors.ts

@@ -0,0 +1,59 @@
+// Copyright (c) Miso Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+// The shared error vocabulary for every `@misofm/*` SDK. Every failure a caller
+// might need to act on is a `Schema.TaggedError`, carrying the fields needed to
+// act (object id, type, package, cause) rather than a bare message. Foreign
+// failures (RPC rejections, thrown parsers) are wrapped with `cause: Schema.Defect()`
+// so the original error is preserved but not part of the typed contract.
+
+import { Schema } from "effect";
+import type { SuiClientTypes } from "@mysten/sui/client";
+
+/** The requested object does not exist on-chain (never existed, was deleted, or has no such dynamic field). */
+export class ObjectNotFoundError extends Schema.TaggedError<ObjectNotFoundError>()("ObjectNotFoundError", {
+  objectId: Schema.String,
+}) {}
+
+/** An object's on-chain type does not match the type the caller expected. */
+export class ObjectTypeMismatchError extends Schema.TaggedError<ObjectTypeMismatchError>()(
+  "ObjectTypeMismatchError",
+  {
+    objectId: Schema.String,
+    expected: Schema.String,
+    actual: Schema.String,
+  },
+) {}
+
+/** A Core API call threw or rejected for a reason other than a missing object. */
+export class SuiRpcError extends Schema.TaggedError<SuiRpcError>()("SuiRpcError", {
+  operation: Schema.String,
+  cause: Schema.Defect(),
+}) {}
+
+/** A generated BCS codec's `.parse` threw, or the parsed value failed `Schema.decodeUnknown` into the domain type. */
+export class BcsDecodeError extends Schema.TaggedError<BcsDecodeError>()("BcsDecodeError", {
+  type: Schema.String,
+  objectId: Schema.optional(Schema.String),
+  cause: Schema.Defect(),
+}) {}
+
+/** A submitted transaction executed but its on-chain effects reported failure. */
+export class TransactionFailedError extends Schema.TaggedError<TransactionFailedError>()("TransactionFailedError", {
+  digest: Schema.String,
+  status: Schema.declare((u): u is SuiClientTypes.ExecutionStatus => true),
+}) {}
+
+/** A `SuiGraphQL` read was requested but no GraphQL client is configured for this context. */
+export class GraphQLUnavailableError extends Schema.TaggedError<GraphQLUnavailableError>()(
+  "GraphQLUnavailableError",
+  {},
+) {}
+
+/** A deployment manifest failed validation (wrong shape, missing package id, unverified network, ...). */
+export class DeploymentError extends Schema.TaggedError<DeploymentError>()("DeploymentError", {
+  message: Schema.String,
+}) {}
+
+/** The error union every `reads.ts` primitive can fail with. */
+export type SuiReadError = ObjectNotFoundError | ObjectTypeMismatchError | SuiRpcError | BcsDecodeError;

package/src/execute.ts

@@ -0,0 +1,177 @@
+// Copyright (c) Miso Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+// Transaction building + execution + effect extraction (the Signer-parameter
+// pattern). Builders elsewhere only *append* to a caller-owned Transaction;
+// this module is where a transaction is actually built and submitted.
+// `signAndExecute` submits over the unified Core API, unwraps the
+// `{ $kind: "Transaction", Transaction }` envelope, waits for finality, and
+// returns changed objects, the objectId→type map, balance changes, and net gas
+// for downstream extraction. Everything here is transport-agnostic — it
+// requires only the `SuiClient` service, so gRPC / JSON-RPC / GraphQL clients
+// all work.
+
+import { Effect } from "effect";
+import { Transaction } from "@mysten/sui/transactions";
+import type { SuiClientTypes } from "@mysten/sui/client";
+import type { Signer } from "@mysten/sui/cryptography";
+
+import { SuiRpcError, TransactionFailedError } from "./errors.ts";
+import { SuiClient } from "./sui-client.ts";
+
+/** A function that appends commands to a caller-owned `Transaction`; may be async. */
+export type TxThunk = (tx: Transaction) => void | Promise<void>;
+
+/** The effect fields every submit path requests, so extraction is uniform. */
+export const FULL_INCLUDE = { effects: true, objectTypes: true, balanceChanges: true } as const;
+type FullInclude = typeof FULL_INCLUDE;
+
+/** The normalized outcome of a successfully-executed transaction. */
+export interface ExecResult {
+  digest: string;
+  /** Objects created/mutated/deleted by the transaction. */
+  changedObjects: SuiClientTypes.ChangedObject[];
+  /** Map of changed objectId → fully-qualified type. */
+  objectTypes: Record<string, string>;
+  /** Net coin balance deltas by address. */
+  balanceChanges: SuiClientTypes.BalanceChange[];
+  /** Net gas cost in MIST (computation + storage − rebate). */
+  gasUsed: number;
+}
+
+/** Builds a fresh `Transaction` from one or more thunks (awaiting async ones); never fails. */
+export const buildTx = Effect.fn("buildTx")(function* (...thunks: readonly TxThunk[]): Effect.fn.Return<Transaction> {
+  const tx = new Transaction();
+  for (const thunk of thunks) {
+    yield* Effect.promise(() => Promise.resolve(thunk(tx)));
+  }
+  return tx;
+});
+
+/** Normalizes the `{ $kind }` transaction-result envelope into an {@link ExecResult}; throws on a failed status. */
+export function toExecResult(res: SuiClientTypes.TransactionResult<FullInclude>): ExecResult {
+  if (res.$kind !== "Transaction") {
+    const failed = res.FailedTransaction;
+    const status = failed.effects?.status;
+    const err = status && !status.success ? JSON.stringify(status.error) : "unknown error";
+    throw new Error(`Transaction failed: ${err} (digest ${failed.digest})`);
+  }
+
+  const t = res.Transaction;
+  const effects = t.effects as SuiClientTypes.TransactionEffects;
+  if (!effects.status.success) {
+    throw new Error(`Transaction reverted: ${JSON.stringify(effects.status.error)} (digest ${t.digest})`);
+  }
+
+  return {
+    digest: t.digest,
+    changedObjects: effects.changedObjects,
+    objectTypes: (t.objectTypes as Record<string, string>) ?? {},
+    balanceChanges: (t.balanceChanges as SuiClientTypes.BalanceChange[]) ?? [],
+    gasUsed: netGas(effects.gasUsed),
+  };
+}
+
+/** Signs, executes, and waits for a transaction; fails with `TransactionFailedError` if its effects report failure. */
+export const signAndExecute = Effect.fn("signAndExecute")(function* (
+  signer: Signer,
+  tx: Transaction,
+): Effect.fn.Return<ExecResult, TransactionFailedError | SuiRpcError, SuiClient> {
+  const client = yield* SuiClient;
+  const res = yield* Effect.tryPromise({
+    try: (signal) => client.core.signAndExecuteTransaction({ transaction: tx, signer, include: FULL_INCLUDE, signal }),
+    catch: (cause) => new SuiRpcError({ operation: "signAndExecuteTransaction", cause }),
+  });
+
+  const { digest, status } = statusOf(res);
+  if (!status.success) {
+    return yield* new TransactionFailedError({ digest, status });
+  }
+
+  const result = toExecResult(res);
+
+  yield* Effect.tryPromise({
+    try: (signal) => client.core.waitForTransaction({ digest: result.digest, signal }),
+    catch: (cause) => new SuiRpcError({ operation: "waitForTransaction", cause }),
+  });
+
+  return result;
+});
+
+/** Convenience: build from thunks, then sign+execute in one call. */
+export const execThunks = Effect.fn("execThunks")(function* (
+  signer: Signer,
+  ...thunks: readonly TxThunk[]
+): Effect.fn.Return<ExecResult, TransactionFailedError | SuiRpcError, SuiClient> {
+  const tx = yield* buildTx(...thunks);
+  return yield* signAndExecute(signer, tx);
+});
+
+// ── Object-change extractors (pure) ─────────────────────────────────────────
+
+/** The package id from the (single) newly-published package. */
+export function publishedPackageId(r: ExecResult): string {
+  const pkg = r.changedObjects.find((c) => c.idOperation === "Created" && c.outputState === "PackageWrite");
+  if (!pkg) throw new Error("No published package found in object changes.");
+  return pkg.objectId;
+}
+
+/** All package ids newly published by the transaction (up to 5 per PTB). */
+export function allPublishedPackageIds(r: ExecResult): string[] {
+  return r.changedObjects
+    .filter((c) => c.idOperation === "Created" && c.outputState === "PackageWrite")
+    .map((c) => c.objectId);
+}
+
+/** The first newly-created object whose type contains `substr`. */
+export function createdByType(r: ExecResult, substr: string): string {
+  const id = maybeCreatedByType(r, substr);
+  if (!id) throw new Error(`No created object with type containing "${substr}" found in object changes.`);
+  return id;
+}
+
+/** Like {@link createdByType} but returns undefined instead of throwing. */
+export function maybeCreatedByType(r: ExecResult, substr: string): string | undefined {
+  for (const c of r.changedObjects) {
+    if (c.idOperation === "Created" && (r.objectTypes[c.objectId] ?? "").includes(substr)) return c.objectId;
+  }
+  return undefined;
+}
+
+/** The first newly-created object whose type is EXACTLY `type` (for non-generic types). */
+export function createdByExactType(r: ExecResult, type: string): string {
+  for (const c of r.changedObjects) {
+    if (c.idOperation === "Created" && r.objectTypes[c.objectId] === type) return c.objectId;
+  }
+  throw new Error(`No created object of exact type "${type}" found in object changes.`);
+}
+
+/** All newly-created objects whose type contains `substr`. */
+export function allCreatedByType(r: ExecResult, substr: string): { objectId: string; objectType: string }[] {
+  const out: { objectId: string; objectType: string }[] = [];
+  for (const c of r.changedObjects) {
+    const type = r.objectTypes[c.objectId] ?? "";
+    if (c.idOperation === "Created" && type.includes(substr)) out.push({ objectId: c.objectId, objectType: type });
+  }
+  return out;
+}
+
+/** The signed balance delta for `address` in `coinType`, or "0" if absent. */
+export function balanceDelta(r: ExecResult, address: string, coinType: string): string {
+  const change = r.balanceChanges.find((b) => b.address === address && b.coinType === coinType);
+  return change?.amount ?? "0";
+}
+
+// ── Private ──────────────────────────────────────────────────────────────────
+
+/** The digest and top-level execution status of a `TransactionResult`, whichever `$kind` it is. */
+function statusOf(
+  res: SuiClientTypes.TransactionResult<FullInclude>,
+): { digest: string; status: SuiClientTypes.ExecutionStatus } {
+  const t = res.$kind === "Transaction" ? res.Transaction : res.FailedTransaction;
+  return { digest: t.digest, status: t.status };
+}
+
+function netGas(gasUsed: SuiClientTypes.GasCostSummary): number {
+  return Number(gasUsed.computationCost) + Number(gasUsed.storageCost) - Number(gasUsed.storageRebate);
+}

package/src/index.ts

@@ -0,0 +1,10 @@
+// Copyright (c) Miso Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+// `@misofm/effect` — the shared Effect foundation for the Miso SDKs: one
+// `SuiClient` service, one error vocabulary, and the read/execute primitives
+// every package's queries and transaction builders are composed from.
+export * from "./errors.ts";
+export * from "./sui-client.ts";
+export * from "./reads.ts";
+export * from "./execute.ts";