@unconfirmed/sui-effect 0.1.0 → 0.1.2

package/dist/domain/bcs.js

@@ -59,6 +59,63 @@ export const bcs = (bcsType, expectedType) => {
         })
     }))).annotate(normalized === undefined ? {} : { [SUI_TYPE_ANNOTATION]: normalized });
 };
+/**
+ * A BCS layout plus the mapping into a domain value, as one codec.
+ *
+ * This is the shape every extension writes by hand and writes slightly
+ * differently: parse the bytes with a layout, then hand the raw struct to a
+ * constructor or a mapping function that may throw (an id that has to be
+ * branded, a `bigint` that has to be range-checked, a discriminant that has to
+ * become a union). Written out it is `SuiSchema.bcs(...)` piped into a
+ * `Schema.decodeTo` with a `transformOrFail` and an `Effect.try`, and the part
+ * that gets forgotten is turning the thrown value into a schema issue, so the
+ * failure arrives as a defect instead of a `DecodeError`.
+ *
+ * `map` is called with whatever the layout parsed. Returning a value decodes
+ * it; **throwing** fails the decode, and the thrown value's message becomes the
+ * `DecodeError.issue` the caller sees, with the expected type already on it.
+ * The result is a `Schema.Codec<A, Uint8Array>` like any other: pass it as
+ * `sui.getObject(id, { schema })`, and the Move type check still runs first
+ * because the annotation {@link bcs} leaves behind survives the composition.
+ *
+ * Encoding is not supported: a mapping function has no inverse, and inventing
+ * one silently is worse than saying so. Encode with the layout itself when you
+ * need bytes back.
+ *
+ * Fails with: `DecodeError` (through the schema), when the bytes do not parse
+ * or `map` throws.
+ *
+ * @since 0.1.1
+ *
+ * @example
+ * ```ts
+ * import { ObjectId, SuiSchema } from "@unconfirmed/sui-effect"
+ *
+ * class Escrow {
+ *   constructor(readonly id: ObjectId, readonly amount: bigint) {}
+ * }
+ *
+ * const EscrowContent = SuiSchema.decodeWith(
+ *   EscrowLayout,
+ *   `${packageId}::escrow::Escrow`,
+ *   (raw) => new Escrow(ObjectId.normalize(raw.id), BigInt(raw.amount))
+ * )
+ * ```
+ */
+export const decodeWith = (bcsType, expectedType, map) => {
+    const target = Schema.declare((_u) => true);
+    return bcs(bcsType, expectedType).pipe(Schema.decodeTo(target, SchemaTransformation.transformOrFail({
+        decode: (parsed, options) => Effect.try({
+            try: () => map(parsed),
+            catch: (cause) => new SchemaIssue.InvalidValue({
+                message: `Could not map ${expectedType ?? bcsType.name} into its domain value: ${String(cause)}`
+            }, parsed, options)
+        }),
+        encode: (value, options) => Effect.fail(new SchemaIssue.Forbidden({
+            message: `${expectedType ?? bcsType.name} was built with SuiSchema.decodeWith, which has no encoder: serialize with the BCS layout instead`
+        }, value, options))
+    })));
+};
 const MAX_ENCODING_DEPTH = 32;
 /**
  * Walks the encoding chain looking for the annotation {@link bcs} leaves
@@ -171,12 +228,19 @@ export const decodeContent = (schema, content, context) => {
         return Effect.fail(new DecodeError({
             ...withObject,
             ...withExpected,
+            // The type tag did not match, so not a byte was parsed: this is the
+            // decode failure a caller may answer with "not one of mine".
+            kind: "type",
             issue: `${context?.objectId === undefined ? "the bytes have" : `object ${context.objectId} has`} type ${actual}`
         }));
     }
     return Schema.decodeUnknownEffect(schema)(content).pipe(Effect.mapError((error) => new DecodeError({
         ...withObject,
         ...withExpected,
+        // The tag matched (or there was none to check) and the bytes
+        // themselves did not parse: a layout mismatch or a corrupt object,
+        // never something to swallow.
+        kind: "bytes",
         issue: error.message
     })));
 };

package/dist/domain/bcs.js.map

@@ -1 +1 @@
-{"version":3,"file":"bcs.js","sourceRoot":"","sources":["../../src/domain/bcs.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AACtE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,QAAQ,CAAA;AACrF,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAGzC,MAAM,mBAAmB,GAAG,oBAAoB,CAAA;AAEhD,MAAM,aAAa,GAAG,CAAC,KAAa,EAAU,EAAE;IAC9C,IAAI,CAAC;QACH,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAA;IAClC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,CACjB,OAA0B,EAC1B,YAAqB,EACQ,EAAE;IAC/B,MAAM,UAAU,GAAG,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC,YAAY,CAAC,CAAA;IACvF,4EAA4E;IAC5E,+EAA+E;IAC/E,MAAM,KAAK,GAAG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAA;IACxC,4EAA4E;IAC5E,2EAA2E;IAC3E,mBAAmB;IACnB,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,EAAW,EAAW,EAAE,CAAC,IAAI,CAAC,CAAA;IAC7D,OAAO,MAAM,CAAC,UAAU,CAAC,IAAI,CAC3B,MAAM,CAAC,QAAQ,CACb,MAAM,EACN,oBAAoB,CAAC,eAAe,CAAgB;QAClD,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,CACzB,MAAM,CAAC,GAAG,CAAC;YACT,GAAG,EAAE,GAAG,EAAE;gBACR,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;gBACnC,8DAA8D;gBAC9D,+DAA+D;gBAC/D,kEAAkE;gBAClE,8CAA8C;gBAC9C,IAAI,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,EAAE,CAAC;oBAChE,MAAM,IAAI,KAAK,CAAC,YAAY,KAAK,CAAC,MAAM,aAAa,KAAK,EAAE,CAAC,CAAA;gBAC/D,CAAC;gBACD,OAAO,MAAM,CAAA;YACf,CAAC;YACD,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CACf,IAAI,WAAW,CAAC,YAAY,CAC1B,EAAE,OAAO,EAAE,mBAAmB,KAAK,sBAAsB,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,EAC1E,KAAK,EACL,OAAO,CACR;SACJ,CAAC;QACJ,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,CACzB,MAAM,CAAC,GAAG,CAAC;YACT,GAAG,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE;YAC7C,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CACf,IAAI,WAAW,CAAC,YAAY,CAC1B,EAAE,OAAO,EAAE,uBAAuB,KAAK,YAAY,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,EACpE,KAAK,EACL,OAAO,CACR;SACJ,CAAC;KACL,CAAC,CACH,CACF,CAAC,QAAQ,CACR,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,CAC5B,CAAA;AAC7C,CAAC,CAAA;AAED,MAAM,kBAAkB,GAAG,EAAE,CAAA;AAE7B;;;;;GAKG;AACH,MAAM,WAAW,GAAG,CAAC,GAAkB,EAAE,KAAa,EAAsB,EAAE;IAC5E,MAAM,UAAU,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC,mBAAmB,CAAC,CAAA;IACzD,IAAI,OAAO,UAAU,KAAK,QAAQ;QAAE,OAAO,UAAU,CAAA;IACrD,IAAI,KAAK,IAAI,kBAAkB;QAAE,OAAO,SAAS,CAAA;IACjD,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAA;IAC7B,IAAI,QAAQ,KAAK,SAAS;QAAE,OAAO,SAAS,CAAA;IAC5C,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;QAC5B,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,GAAG,CAAC,CAAC,CAAA;QAC7C,IAAI,KAAK,KAAK,SAAS;YAAE,OAAO,KAAK,CAAA;IACvC,CAAC;IACD,OAAO,SAAS,CAAA;AAClB,CAAC,CAAA;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAO,MAA0B,EAAsB,EAAE,CACrF,WAAW,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;AAE5B,MAAM,SAAS,GAAG,CAAC,KAAa,EAAiD,EAAE;IACjF,IAAI,CAAC;QACH,OAAO,cAAc,CAAC,KAAK,CAAC,CAAA;IAC9B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAA;IAClB,CAAC;AACH,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,QAAgB,EAAE,MAAc,EAAW,EAAE;IACvE,MAAM,WAAW,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAA;IACvC,IAAI,WAAW,KAAK,SAAS,IAAI,WAAW,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACnE,OAAO,aAAa,CAAC,QAAQ,CAAC,KAAK,aAAa,CAAC,MAAM,CAAC,CAAA;IAC1D,CAAC;IACD,MAAM,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC,CAAA;IACnC,IAAI,SAAS,KAAK,SAAS;QAAE,OAAO,aAAa,CAAC,QAAQ,CAAC,KAAK,aAAa,CAAC,MAAM,CAAC,CAAA;IACrF,OAAO,WAAW,CAAC,OAAO,KAAK,SAAS,CAAC,OAAO;QAC9C,WAAW,CAAC,MAAM,KAAK,SAAS,CAAC,MAAM;QACvC,WAAW,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAA;AACvC,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,MAAmC,EACnC,OAAmB,EACnB,OAIC,EAC8B,EAAE;IACjC,MAAM,QAAQ,GAAG,OAAO,EAAE,YAAY,IAAI,cAAc,CAAC,MAAM,CAAC,CAAA;IAChE,MAAM,YAAY,GAAG,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAA;IAC7E,MAAM,UAAU,GAAG,OAAO,EAAE,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAA;IACxF,MAAM,MAAM,GAAG,OAAO,EAAE,UAAU,CAAA;IAClC,IAAI,QAAQ,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC;QACrF,OAAO,MAAM,CAAC,IAAI,CAChB,IAAI,WAAW,CAAC;YACd,GAAG,UAAU;YACb,GAAG,YAAY;YACf,KAAK,EAAE,GACL,OAAO,EAAE,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,UAAU,OAAO,CAAC,QAAQ,MACjF,SAAS,MAAM,EAAE;SAClB,CAAC,CACH,CAAA;IACH,CAAC;IACD,OAAO,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CACrD,MAAM,CAAC,QAAQ,CACb,CAAC,KAAK,EAAE,EAAE,CACR,IAAI,WAAW,CAAC;QACd,GAAG,UAAU;QACb,GAAG,YAAY;QACf,KAAK,EAAE,KAAK,CAAC,OAAO;KACrB,CAAC,CACL,CACF,CAAA;AACH,CAAC,CAAA"}
+{"version":3,"file":"bcs.js","sourceRoot":"","sources":["../../src/domain/bcs.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AACtE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,QAAQ,CAAA;AACrF,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAGzC,MAAM,mBAAmB,GAAG,oBAAoB,CAAA;AAEhD,MAAM,aAAa,GAAG,CAAC,KAAa,EAAU,EAAE;IAC9C,IAAI,CAAC;QACH,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAA;IAClC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,CACjB,OAA0B,EAC1B,YAAqB,EACQ,EAAE;IAC/B,MAAM,UAAU,GAAG,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC,YAAY,CAAC,CAAA;IACvF,4EAA4E;IAC5E,+EAA+E;IAC/E,MAAM,KAAK,GAAG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAA;IACxC,4EAA4E;IAC5E,2EAA2E;IAC3E,mBAAmB;IACnB,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,EAAW,EAAW,EAAE,CAAC,IAAI,CAAC,CAAA;IAC7D,OAAO,MAAM,CAAC,UAAU,CAAC,IAAI,CAC3B,MAAM,CAAC,QAAQ,CACb,MAAM,EACN,oBAAoB,CAAC,eAAe,CAAgB;QAClD,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,CACzB,MAAM,CAAC,GAAG,CAAC;YACT,GAAG,EAAE,GAAG,EAAE;gBACR,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;gBACnC,8DAA8D;gBAC9D,+DAA+D;gBAC/D,kEAAkE;gBAClE,8CAA8C;gBAC9C,IAAI,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,EAAE,CAAC;oBAChE,MAAM,IAAI,KAAK,CAAC,YAAY,KAAK,CAAC,MAAM,aAAa,KAAK,EAAE,CAAC,CAAA;gBAC/D,CAAC;gBACD,OAAO,MAAM,CAAA;YACf,CAAC;YACD,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CACf,IAAI,WAAW,CAAC,YAAY,CAC1B,EAAE,OAAO,EAAE,mBAAmB,KAAK,sBAAsB,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,EAC1E,KAAK,EACL,OAAO,CACR;SACJ,CAAC;QACJ,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,CACzB,MAAM,CAAC,GAAG,CAAC;YACT,GAAG,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE;YAC7C,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CACf,IAAI,WAAW,CAAC,YAAY,CAC1B,EAAE,OAAO,EAAE,uBAAuB,KAAK,YAAY,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,EACpE,KAAK,EACL,OAAO,CACR;SACJ,CAAC;KACL,CAAC,CACH,CACF,CAAC,QAAQ,CACR,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,CAC5B,CAAA;AAC7C,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,OAA0B,EAC1B,YAAgC,EAChC,GAAqB,EACQ,EAAE;IAC/B,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,EAAW,EAAW,EAAE,CAAC,IAAI,CAAC,CAAA;IAC7D,OAAO,GAAG,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC,IAAI,CACpC,MAAM,CAAC,QAAQ,CACb,MAAM,EACN,oBAAoB,CAAC,eAAe,CAAO;QACzC,MAAM,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,CAC1B,MAAM,CAAC,GAAG,CAAC;YACT,GAAG,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC;YACtB,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CACf,IAAI,WAAW,CAAC,YAAY,CAC1B;gBACE,OAAO,EAAE,iBACP,YAAY,IAAI,OAAO,CAAC,IAC1B,2BAA2B,MAAM,CAAC,KAAK,CAAC,EAAE;aAC3C,EACD,MAAM,EACN,OAAO,CACR;SACJ,CAAC;QACJ,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,CACzB,MAAM,CAAC,IAAI,CACT,IAAI,WAAW,CAAC,SAAS,CACvB;YACE,OAAO,EAAE,GACP,YAAY,IAAI,OAAO,CAAC,IAC1B,mGAAmG;SACpG,EACD,KAAK,EACL,OAAO,CACR,CACF;KACJ,CAAC,CACH,CACwC,CAAA;AAC7C,CAAC,CAAA;AAED,MAAM,kBAAkB,GAAG,EAAE,CAAA;AAE7B;;;;;GAKG;AACH,MAAM,WAAW,GAAG,CAAC,GAAkB,EAAE,KAAa,EAAsB,EAAE;IAC5E,MAAM,UAAU,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC,mBAAmB,CAAC,CAAA;IACzD,IAAI,OAAO,UAAU,KAAK,QAAQ;QAAE,OAAO,UAAU,CAAA;IACrD,IAAI,KAAK,IAAI,kBAAkB;QAAE,OAAO,SAAS,CAAA;IACjD,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAA;IAC7B,IAAI,QAAQ,KAAK,SAAS;QAAE,OAAO,SAAS,CAAA;IAC5C,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;QAC5B,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,GAAG,CAAC,CAAC,CAAA;QAC7C,IAAI,KAAK,KAAK,SAAS;YAAE,OAAO,KAAK,CAAA;IACvC,CAAC;IACD,OAAO,SAAS,CAAA;AAClB,CAAC,CAAA;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAO,MAA0B,EAAsB,EAAE,CACrF,WAAW,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;AAE5B,MAAM,SAAS,GAAG,CAAC,KAAa,EAAiD,EAAE;IACjF,IAAI,CAAC;QACH,OAAO,cAAc,CAAC,KAAK,CAAC,CAAA;IAC9B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAA;IAClB,CAAC;AACH,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,QAAgB,EAAE,MAAc,EAAW,EAAE;IACvE,MAAM,WAAW,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAA;IACvC,IAAI,WAAW,KAAK,SAAS,IAAI,WAAW,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACnE,OAAO,aAAa,CAAC,QAAQ,CAAC,KAAK,aAAa,CAAC,MAAM,CAAC,CAAA;IAC1D,CAAC;IACD,MAAM,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC,CAAA;IACnC,IAAI,SAAS,KAAK,SAAS;QAAE,OAAO,aAAa,CAAC,QAAQ,CAAC,KAAK,aAAa,CAAC,MAAM,CAAC,CAAA;IACrF,OAAO,WAAW,CAAC,OAAO,KAAK,SAAS,CAAC,OAAO;QAC9C,WAAW,CAAC,MAAM,KAAK,SAAS,CAAC,MAAM;QACvC,WAAW,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAA;AACvC,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,MAAmC,EACnC,OAAmB,EACnB,OAIC,EAC8B,EAAE;IACjC,MAAM,QAAQ,GAAG,OAAO,EAAE,YAAY,IAAI,cAAc,CAAC,MAAM,CAAC,CAAA;IAChE,MAAM,YAAY,GAAG,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAA;IAC7E,MAAM,UAAU,GAAG,OAAO,EAAE,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAA;IACxF,MAAM,MAAM,GAAG,OAAO,EAAE,UAAU,CAAA;IAClC,IAAI,QAAQ,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC;QACrF,OAAO,MAAM,CAAC,IAAI,CAChB,IAAI,WAAW,CAAC;YACd,GAAG,UAAU;YACb,GAAG,YAAY;YACf,oEAAoE;YACpE,6DAA6D;YAC7D,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,GACL,OAAO,EAAE,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,UAAU,OAAO,CAAC,QAAQ,MACjF,SAAS,MAAM,EAAE;SAClB,CAAC,CACH,CAAA;IACH,CAAC;IACD,OAAO,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CACrD,MAAM,CAAC,QAAQ,CACb,CAAC,KAAK,EAAE,EAAE,CACR,IAAI,WAAW,CAAC;QACd,GAAG,UAAU;QACb,GAAG,YAAY;QACf,6DAA6D;QAC7D,mEAAmE;QACnE,8BAA8B;QAC9B,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,KAAK,CAAC,OAAO;KACrB,CAAC,CACL,CACF,CAAA;AACH,CAAC,CAAA"}

package/dist/domain/errors.d.ts

@@ -55,6 +55,8 @@ export declare class TransportError extends TransportError_base {
      * ```
      */
     static readonly fromUnknown: (method: string, cause: unknown, retryable?: boolean) => TransportError;
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
 /**
  * gRPC status names a read may be retried on, plus HTTP 5xx and 429. Timeouts
@@ -77,31 +79,54 @@ export declare const classifyTransportCause: (cause: unknown) => {
     readonly retryable: boolean;
 };
 declare const ObjectNotFound_base: Schema.Class<ObjectNotFound, Schema.TaggedStruct<"ObjectNotFound", {
-    readonly objectId: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "ObjectId">;
+    readonly objectId: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "ObjectId"> & {
+        normalize: (input: string) => string & import("effect/Brand").Brand<"ObjectId">;
+    };
     readonly version: Schema.optional<Schema.brand<Schema.BigIntFromString, "Version">>;
 }>, import("effect/Cause").YieldableError>;
 /** The object does not exist, or has never existed. */
 export declare class ObjectNotFound extends ObjectNotFound_base {
+    /**
+     * The one actionable line `SuiError.describe` produces for this error.
+     *
+     * `Schema.TaggedError` gives every class the `Error` constructor and no
+     * message of its own, so `error.message` was the empty string — and a
+     * consumer that surfaces `.message` (a log line, a UI, another library's
+     * error formatter) showed nothing at all. A getter rather than a schema
+     * field, so it is always in step with `describe`, costs nothing to
+     * construct, and stays out of `SuiError.toJson`'s encoding.
+     */
+    get message(): string;
 }
 declare const ObjectDeleted_base: Schema.Class<ObjectDeleted, Schema.TaggedStruct<"ObjectDeleted", {
-    readonly objectId: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "ObjectId">;
+    readonly objectId: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "ObjectId"> & {
+        normalize: (input: string) => string & import("effect/Brand").Brand<"ObjectId">;
+    };
     readonly version: Schema.optional<Schema.brand<Schema.BigIntFromString, "Version">>;
 }>, import("effect/Cause").YieldableError>;
 /** The object existed and has been deleted or wrapped. */
 export declare class ObjectDeleted extends ObjectDeleted_base {
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
 declare const ObjectUnavailable_base: Schema.Class<ObjectUnavailable, Schema.TaggedStruct<"ObjectUnavailable", {
-    readonly objectId: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "ObjectId">;
+    readonly objectId: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "ObjectId"> & {
+        normalize: (input: string) => string & import("effect/Brand").Brand<"ObjectId">;
+    };
     readonly version: Schema.optional<Schema.brand<Schema.BigIntFromString, "Version">>;
 }>, import("effect/Cause").YieldableError>;
 /** The node could not say what happened to the object (`ObjectError.reason: "unknown"`). */
 export declare class ObjectUnavailable extends ObjectUnavailable_base {
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
 declare const TransactionNotFound_base: Schema.Class<TransactionNotFound, Schema.TaggedStruct<"TransactionNotFound", {
     readonly digest: Schema.brand<Schema.String, "Digest">;
 }>, import("effect/Cause").YieldableError>;
 /** No transaction with this digest is known to the node. */
 export declare class TransactionNotFound extends TransactionNotFound_base {
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
 declare const NetworkMismatch_base: Schema.Class<NetworkMismatch, Schema.TaggedStruct<"NetworkMismatch", {
     readonly expected: Schema.String;
@@ -109,14 +134,57 @@ declare const NetworkMismatch_base: Schema.Class<NetworkMismatch, Schema.TaggedS
 }>, import("effect/Cause").YieldableError>;
 /** The chain identifier the node reported is not the one the layer was built for. */
 export declare class NetworkMismatch extends NetworkMismatch_base {
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
+/**
+ * Which of the three things that can go wrong at a decode boundary went wrong.
+ *
+ * - `"type"`: the object, the field or the event **is not of the expected Move
+ *   type**. The bytes were never parsed. This is the one a caller answers with
+ *   "that is not one of mine" — a 404 for a foreign object, a `filter` over a
+ *   heterogeneous list — and the one it is safe to swallow.
+ * - `"bytes"`: the type matched and the **BCS parse failed**, or left trailing
+ *   bytes. Either the layout this package was built with is not the layout the
+ *   package on chain writes, or the object is corrupt. Never safe to swallow.
+ * - `"shape"`: a **domain schema** refused a value that was already parsed or
+ *   that came from the node as JSON — a missing field in a node response, a
+ *   number that is not a timestamp, a simulation with no such command. A bug
+ *   here is in this library, the node, or the caller's expectations.
+ *
+ * Branch on this, never on {@link DecodeError}'s `issue`: `issue` is a human
+ * sentence and its wording changes between releases.
+ *
+ * @since 0.1.2
+ */
+export declare const DecodeKind: Schema.Literals<readonly ["type", "bytes", "shape"]>;
+/** The three decode failures {@link DecodeKind} names. */
+export type DecodeKind = typeof DecodeKind.Type;
 declare const DecodeError_base: Schema.Class<DecodeError, Schema.TaggedStruct<"DecodeError", {
-    readonly objectId: Schema.optional<Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "ObjectId">>;
+    readonly objectId: Schema.optional<Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "ObjectId"> & {
+        normalize: (input: string) => string & import("effect/Brand").Brand<"ObjectId">;
+    }>;
     readonly expectedType: Schema.optional<Schema.String>;
+    /**
+     * Which boundary failed. See {@link DecodeKind}.
+     *
+     * @since 0.1.2
+     */
+    readonly kind: Schema.withConstructorDefault<Schema.withDecodingDefaultKey<Schema.Literals<readonly ["type", "bytes", "shape"]>, never>>;
     readonly issue: Schema.String;
 }>, import("effect/Cause").YieldableError>;
-/** BCS content or a schema boundary did not decode. */
+/**
+ * BCS content or a schema boundary did not decode.
+ *
+ * `kind` says which of the three (`"type"`, `"bytes"`, `"shape"`) and is what a
+ * consumer branches on; `issue` is the sentence for a human and is not stable.
+ * It defaults to `"shape"` when neither a constructor nor an encoded value
+ * carries one, so an extension that builds a `DecodeError` with no `kind` still
+ * compiles and still answers the question conservatively.
+ */
 export declare class DecodeError extends DecodeError_base {
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
 declare const SimulationFailed_base: Schema.Class<SimulationFailed, Schema.TaggedStruct<"SimulationFailed", {
     readonly reason: Schema.toTaggedUnion<"$kind", readonly [Schema.Struct<{
@@ -286,16 +354,22 @@ declare const ExecutionFailed_base: Schema.Class<ExecutionFailed, Schema.TaggedS
         }>;
         readonly transactionDigest: Schema.brand<Schema.String, "Digest">;
         readonly gasObject: Schema.NullOr<Schema.Struct<{
-            readonly objectId: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "ObjectId">;
+            readonly objectId: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "ObjectId"> & {
+                normalize: (input: string) => string & import("effect/Brand").Brand<"ObjectId">;
+            };
             readonly inputState: Schema.Literals<readonly ["Unknown", "DoesNotExist", "Exists"]>;
             readonly inputVersion: Schema.NullOr<Schema.brand<Schema.BigIntFromString, "Version">>;
             readonly inputDigest: Schema.NullOr<Schema.String>;
             readonly inputOwner: Schema.NullOr<Schema.toTaggedUnion<"$kind", readonly [Schema.Struct<{
                 readonly $kind: Schema.Literal<"AddressOwner">;
-                readonly AddressOwner: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "SuiAddress">;
+                readonly AddressOwner: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "SuiAddress"> & {
+                    normalize: (input: string) => string & import("effect/Brand").Brand<"SuiAddress">;
+                };
             }>, Schema.Struct<{
                 readonly $kind: Schema.Literal<"ObjectOwner">;
-                readonly ObjectOwner: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "ObjectId">;
+                readonly ObjectOwner: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "ObjectId"> & {
+                    normalize: (input: string) => string & import("effect/Brand").Brand<"ObjectId">;
+                };
             }>, Schema.Struct<{
                 readonly $kind: Schema.Literal<"Shared">;
                 readonly Shared: Schema.Struct<{
@@ -308,7 +382,9 @@ declare const ExecutionFailed_base: Schema.Class<ExecutionFailed, Schema.TaggedS
                 readonly $kind: Schema.Literal<"ConsensusAddressOwner">;
                 readonly ConsensusAddressOwner: Schema.Struct<{
                     readonly startVersion: Schema.brand<Schema.BigIntFromString, "Version">;
-                    readonly owner: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "SuiAddress">;
+                    readonly owner: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "SuiAddress"> & {
+                        normalize: (input: string) => string & import("effect/Brand").Brand<"SuiAddress">;
+                    };
                 }>;
             }>, Schema.Struct<{
                 readonly $kind: Schema.Literal<"Unknown">;
@@ -318,10 +394,14 @@ declare const ExecutionFailed_base: Schema.Class<ExecutionFailed, Schema.TaggedS
             readonly outputDigest: Schema.NullOr<Schema.String>;
             readonly outputOwner: Schema.NullOr<Schema.toTaggedUnion<"$kind", readonly [Schema.Struct<{
                 readonly $kind: Schema.Literal<"AddressOwner">;
-                readonly AddressOwner: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "SuiAddress">;
+                readonly AddressOwner: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "SuiAddress"> & {
+                    normalize: (input: string) => string & import("effect/Brand").Brand<"SuiAddress">;
+                };
             }>, Schema.Struct<{
                 readonly $kind: Schema.Literal<"ObjectOwner">;
-                readonly ObjectOwner: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "ObjectId">;
+                readonly ObjectOwner: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "ObjectId"> & {
+                    normalize: (input: string) => string & import("effect/Brand").Brand<"ObjectId">;
+                };
             }>, Schema.Struct<{
                 readonly $kind: Schema.Literal<"Shared">;
                 readonly Shared: Schema.Struct<{
@@ -334,7 +414,9 @@ declare const ExecutionFailed_base: Schema.Class<ExecutionFailed, Schema.TaggedS
                 readonly $kind: Schema.Literal<"ConsensusAddressOwner">;
                 readonly ConsensusAddressOwner: Schema.Struct<{
                     readonly startVersion: Schema.brand<Schema.BigIntFromString, "Version">;
-                    readonly owner: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "SuiAddress">;
+                    readonly owner: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "SuiAddress"> & {
+                        normalize: (input: string) => string & import("effect/Brand").Brand<"SuiAddress">;
+                    };
                 }>;
             }>, Schema.Struct<{
                 readonly $kind: Schema.Literal<"Unknown">;
@@ -345,16 +427,22 @@ declare const ExecutionFailed_base: Schema.Class<ExecutionFailed, Schema.TaggedS
         readonly dependencies: Schema.$Array<Schema.String>;
         readonly lamportVersion: Schema.NullOr<Schema.brand<Schema.BigIntFromString, "Version">>;
         readonly changedObjects: Schema.$Array<Schema.Struct<{
-            readonly objectId: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "ObjectId">;
+            readonly objectId: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "ObjectId"> & {
+                normalize: (input: string) => string & import("effect/Brand").Brand<"ObjectId">;
+            };
             readonly inputState: Schema.Literals<readonly ["Unknown", "DoesNotExist", "Exists"]>;
             readonly inputVersion: Schema.NullOr<Schema.brand<Schema.BigIntFromString, "Version">>;
             readonly inputDigest: Schema.NullOr<Schema.String>;
             readonly inputOwner: Schema.NullOr<Schema.toTaggedUnion<"$kind", readonly [Schema.Struct<{
                 readonly $kind: Schema.Literal<"AddressOwner">;
-                readonly AddressOwner: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "SuiAddress">;
+                readonly AddressOwner: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "SuiAddress"> & {
+                    normalize: (input: string) => string & import("effect/Brand").Brand<"SuiAddress">;
+                };
             }>, Schema.Struct<{
                 readonly $kind: Schema.Literal<"ObjectOwner">;
-                readonly ObjectOwner: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "ObjectId">;
+                readonly ObjectOwner: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "ObjectId"> & {
+                    normalize: (input: string) => string & import("effect/Brand").Brand<"ObjectId">;
+                };
             }>, Schema.Struct<{
                 readonly $kind: Schema.Literal<"Shared">;
                 readonly Shared: Schema.Struct<{
@@ -367,7 +455,9 @@ declare const ExecutionFailed_base: Schema.Class<ExecutionFailed, Schema.TaggedS
                 readonly $kind: Schema.Literal<"ConsensusAddressOwner">;
                 readonly ConsensusAddressOwner: Schema.Struct<{
                     readonly startVersion: Schema.brand<Schema.BigIntFromString, "Version">;
-                    readonly owner: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "SuiAddress">;
+                    readonly owner: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "SuiAddress"> & {
+                        normalize: (input: string) => string & import("effect/Brand").Brand<"SuiAddress">;
+                    };
                 }>;
             }>, Schema.Struct<{
                 readonly $kind: Schema.Literal<"Unknown">;
@@ -377,10 +467,14 @@ declare const ExecutionFailed_base: Schema.Class<ExecutionFailed, Schema.TaggedS
             readonly outputDigest: Schema.NullOr<Schema.String>;
             readonly outputOwner: Schema.NullOr<Schema.toTaggedUnion<"$kind", readonly [Schema.Struct<{
                 readonly $kind: Schema.Literal<"AddressOwner">;
-                readonly AddressOwner: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "SuiAddress">;
+                readonly AddressOwner: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "SuiAddress"> & {
+                    normalize: (input: string) => string & import("effect/Brand").Brand<"SuiAddress">;
+                };
             }>, Schema.Struct<{
                 readonly $kind: Schema.Literal<"ObjectOwner">;
-                readonly ObjectOwner: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "ObjectId">;
+                readonly ObjectOwner: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "ObjectId"> & {
+                    normalize: (input: string) => string & import("effect/Brand").Brand<"ObjectId">;
+                };
             }>, Schema.Struct<{
                 readonly $kind: Schema.Literal<"Shared">;
                 readonly Shared: Schema.Struct<{
@@ -393,7 +487,9 @@ declare const ExecutionFailed_base: Schema.Class<ExecutionFailed, Schema.TaggedS
                 readonly $kind: Schema.Literal<"ConsensusAddressOwner">;
                 readonly ConsensusAddressOwner: Schema.Struct<{
                     readonly startVersion: Schema.brand<Schema.BigIntFromString, "Version">;
-                    readonly owner: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "SuiAddress">;
+                    readonly owner: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "SuiAddress"> & {
+                        normalize: (input: string) => string & import("effect/Brand").Brand<"SuiAddress">;
+                    };
                 }>;
             }>, Schema.Struct<{
                 readonly $kind: Schema.Literal<"Unknown">;
@@ -402,7 +498,9 @@ declare const ExecutionFailed_base: Schema.Class<ExecutionFailed, Schema.TaggedS
         }>>;
         readonly unchangedConsensusObjects: Schema.$Array<Schema.Struct<{
             readonly kind: Schema.Literals<readonly ["Unknown", "ReadOnlyRoot", "MutateConsensusStreamEnded", "ReadConsensusStreamEnded", "Cancelled", "PerEpochConfig"]>;
-            readonly objectId: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "ObjectId">;
+            readonly objectId: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "ObjectId"> & {
+                normalize: (input: string) => string & import("effect/Brand").Brand<"ObjectId">;
+            };
             readonly version: Schema.NullOr<Schema.brand<Schema.BigIntFromString, "Version">>;
             readonly digest: Schema.NullOr<Schema.String>;
         }>>;
@@ -411,6 +509,8 @@ declare const ExecutionFailed_base: Schema.Class<ExecutionFailed, Schema.TaggedS
 }>, import("effect/Cause").YieldableError>;
 /** The transaction was applied on chain and failed. Gas was charged. */
 export declare class ExecutionFailed extends ExecutionFailed_base {
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
 declare const SubmissionUnknown_base: Schema.Class<SubmissionUnknown, Schema.TaggedStruct<"SubmissionUnknown", {
     readonly digest: Schema.brand<Schema.String, "Digest">;
@@ -418,7 +518,9 @@ declare const SubmissionUnknown_base: Schema.Class<SubmissionUnknown, Schema.Tag
         readonly digest: Schema.brand<Schema.String, "Digest">;
         readonly bytes: Schema.Uint8ArrayFromBase64;
         readonly signatures: Schema.$Array<Schema.brand<Schema.String, "Signature">>;
-        readonly sender: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "SuiAddress">;
+        readonly sender: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "SuiAddress"> & {
+            normalize: (input: string) => string & import("effect/Brand").Brand<"SuiAddress">;
+        };
         readonly expiration: Schema.optional<Schema.toTaggedUnion<"$kind", readonly [Schema.Struct<{
             readonly $kind: Schema.Literal<"None">;
             readonly None: Schema.Literal<true>;
@@ -459,6 +561,8 @@ declare const SubmissionUnknown_base: Schema.Class<SubmissionUnknown, Schema.Tag
  * signed transaction so an operator or a later process can reconcile it.
  */
 export declare class SubmissionUnknown extends SubmissionUnknown_base {
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
 declare const NotApplied_base: Schema.Class<NotApplied, Schema.TaggedStruct<"NotApplied", {
     readonly digest: Schema.brand<Schema.String, "Digest">;
@@ -474,12 +578,16 @@ declare const NotApplied_base: Schema.Class<NotApplied, Schema.TaggedStruct<"Not
  * node will not name are all `SubmissionUnknown`, not this.
  */
 export declare class NotApplied extends NotApplied_base {
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
 declare const SigningError_base: Schema.Class<SigningError, Schema.TaggedStruct<"SigningError", {
     readonly cause: Schema.Defect;
 }>, import("effect/Cause").YieldableError>;
 /** A signer refused or failed to produce a signature. */
 export declare class SigningError extends SigningError_base {
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
 declare const BuildError_base: Schema.Class<BuildError, Schema.TaggedStruct<"BuildError", {
     readonly message: Schema.String;
@@ -500,11 +608,15 @@ declare const JournalError_base: Schema.Class<JournalError, Schema.TaggedStruct<
 }>, import("effect/Cause").YieldableError>;
 /** The submission journal could not be read or written. */
 export declare class JournalError extends JournalError_base {
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
 declare const UnexpectedEffects_base: Schema.Class<UnexpectedEffects, Schema.TaggedStruct<"UnexpectedEffects", {
     readonly digest: Schema.brand<Schema.String, "Digest">;
     readonly expected: Schema.String;
-    readonly found: Schema.$Array<Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "ObjectId">>;
+    readonly found: Schema.$Array<Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "ObjectId"> & {
+        normalize: (input: string) => string & import("effect/Brand").Brand<"ObjectId">;
+    }>;
 }>, import("effect/Cause").YieldableError>;
 /**
  * The effects of an applied transaction did not contain what the caller
@@ -517,6 +629,8 @@ declare const UnexpectedEffects_base: Schema.Class<UnexpectedEffects, Schema.Tag
  * time for a transaction that already ran.
  */
 export declare class UnexpectedEffects extends UnexpectedEffects_base {
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
 declare const GraphQLUnavailable_base: Schema.Class<GraphQLUnavailable, Schema.TaggedStruct<"GraphQLUnavailable", {
     readonly method: Schema.String;
@@ -536,6 +650,8 @@ declare const GraphQLUnavailable_base: Schema.Class<GraphQLUnavailable, Schema.T
  * Outcome `not_applied`: a read that did not happen changed nothing.
  */
 export declare class GraphQLUnavailable extends GraphQLUnavailable_base {
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
 declare const ExtensionNotReady_base: Schema.Class<ExtensionNotReady, Schema.TaggedStruct<"ExtensionNotReady", {
     readonly extension: Schema.String;
@@ -556,6 +672,8 @@ declare const ExtensionNotReady_base: Schema.Class<ExtensionNotReady, Schema.Tag
  * Outcome `not_applied`: nothing was sent.
  */
 export declare class ExtensionNotReady extends ExtensionNotReady_base {
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
 /** Every failure sui-effect can produce. */
 export type SuiError = TransportError | ObjectNotFound | ObjectDeleted | ObjectUnavailable | TransactionNotFound | NetworkMismatch | DecodeError | SimulationFailed | ExecutionFailed | SubmissionUnknown | NotApplied | SigningError | BuildError | PolicyDenied | JournalError | UnexpectedEffects | GraphQLUnavailable | ExtensionNotReady;
@@ -566,6 +684,20 @@ export declare const SuiErrorSchema: Schema.Union<readonly [typeof TransportErro
  * or a wrapper script acts on.
  */
 export type Outcome = "applied" | "not_applied" | "unknown";
+/**
+ * Where in the lifecycle a failure was caught, which is the only thing that
+ * can classify an error the taxonomy does not own.
+ *
+ * `"post-submit"` (the default, and the 0.1.1 behaviour) is "bytes may have
+ * gone out": a tag nobody here recognises proves nothing, so the answer is
+ * `"unknown"`. `"pre-submit"` is a failure caught while **building, simulating
+ * or signing** — an extension's own `PriceTooLow`, a validation error from the
+ * caller's code — where nothing has been sent by construction and the honest
+ * answer is `"not_applied"`.
+ *
+ * @since 0.1.2
+ */
+export type OutcomePhase = "pre-submit" | "post-submit";
 /**
  * An extension error may declare its own `outcome`, and `SuiError.outcome` and
  * `Script.run` honour it before anything else.
@@ -579,13 +711,19 @@ export interface HasOutcome {
     readonly outcome: Outcome;
 }
 /**
- * The four helpers every repo hand-rolls: is this worth retrying, did the
- * transaction land, what does an operator need to read, and what goes in a log.
+ * The helpers every repo hand-rolls: is this worth retrying, did the
+ * transaction land, is it even one of ours, what does an operator need to read,
+ * and what goes in a log.
  */
 export declare const SuiError: {
     readonly isRetryable: (error: SuiError) => boolean;
-    readonly outcome: (error: SuiError | HasOutcome) => Outcome;
-    readonly describe: (error: SuiError) => string;
+    readonly isTaxonomy: (error: unknown) => error is SuiError;
+    readonly outcome: (error: SuiError | HasOutcome, options?: {
+        readonly phase?: OutcomePhase;
+    }) => Outcome;
+    readonly describe: (error: SuiError | {
+        readonly _tag: string;
+    }) => string;
     readonly toJson: (error: SuiError | {
         readonly _tag: string;
     }) => Record<string, unknown>;

package/dist/domain/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/domain/errors.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EAAU,MAAM,EAAE,MAAM,QAAQ,CAAA;AACvC,OAAO,EACL,MAAM,EAOP,MAAM,cAAc,CAAA;AAErB,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;;;;;;;AAEzE;;;;;;;;GAQG;AACH,qBAAa,cAAe,SAAQ,mBAKlC;IACA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,MAAM,CAAC,QAAQ,CAAC,WAAW,GACzB,QAAQ,MAAM,EACd,OAAO,OAAO,EACd,YAAY,OAAO,KAClB,cAAc,CAQhB;CACF;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,uBAAuB,EAAE,WAAW,CAAC,MAAM,CAMtD,CAAA;AAIF;;;GAGG;AACH,eAAO,MAAM,sBAAsB,GACjC,OAAO,OAAO,KACb;IAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAA;CAkBzD,CAAA;;;;;AAED,uDAAuD;AACvD,qBAAa,cAAe,SAAQ,mBAGlC;CAAG;;;;;AAEL,0DAA0D;AAC1D,qBAAa,aAAc,SAAQ,kBAGjC;CAAG;;;;;AAEL,4FAA4F;AAC5F,qBAAa,iBAAkB,SAAQ,sBAGtC;CAAG;;;;AAEJ,4DAA4D;AAC5D,qBAAa,mBAAoB,SAAQ,wBAGxC;CAAG;;;;;AAEJ,qFAAqF;AACrF,qBAAa,eAAgB,SAAQ,oBAGnC;CAAG;;;;;;AAEL,uDAAuD;AACvD,qBAAa,WAAY,SAAQ,gBAI/B;CAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEL,oEAAoE;AACpE,qBAAa,gBAAiB,SAAQ,qBAGpC;CAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEL,wEAAwE;AACxE,qBAAa,eAAgB,SAAQ,oBAKnC;CAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEL;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,sBAGtC;CAAG;;;;;AAEJ;;;;;;;;GAQG;AACH,qBAAa,UAAW,SAAQ,eAG9B;CAAG;;;;AAEL,yDAAyD;AACzD,qBAAa,YAAa,SAAQ,iBAEhC;CAAG;;;;;AAEL,qDAAqD;AACrD,qBAAa,UAAW,SAAQ,eAG9B;CAAG;;;;;AAEL,uEAAuE;AACvE,qBAAa,YAAa,SAAQ,iBAGhC;CAAG;;;;AAEL,2DAA2D;AAC3D,qBAAa,YAAa,SAAQ,iBAEhC;CAAG;;;;;;AAEL;;;;;;;;;GASG;AACH,qBAAa,iBAAkB,SAAQ,sBAGtC;CAAG;;;;;AAEJ;;;;;;;;;;;;GAYG;AACH,qBAAa,kBAAmB,SAAQ,uBAGvC;CAAG;;;;;AAEJ;;;;;;;;;;;;;GAaG;AACH,qBAAa,iBAAkB,SAAQ,sBAGtC;CAAG;AAEJ,4CAA4C;AAC5C,MAAM,MAAM,QAAQ,GAChB,cAAc,GACd,cAAc,GACd,aAAa,GACb,iBAAiB,GACjB,mBAAmB,GACnB,eAAe,GACf,WAAW,GACX,gBAAgB,GAChB,eAAe,GACf,iBAAiB,GACjB,UAAU,GACV,YAAY,GACZ,UAAU,GACV,YAAY,GACZ,YAAY,GACZ,iBAAiB,GACjB,kBAAkB,GAClB,iBAAiB,CAAA;AAErB,gEAAgE;AAChE,eAAO,MAAM,cAAc,8bAmBzB,CAAA;AAEF;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,SAAS,GAAG,aAAa,GAAG,SAAS,CAAA;AAE3D;;;;;;;;GAQG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;CAC1B;AA+MD;;;GAGG;AACH,eAAO,MAAM,QAAQ;kCA3MO,QAAQ,KAAG,OAAO;8BAoCtB,QAAQ,GAAG,UAAU,KAAG,OAAO;+BAqE9B,QAAQ,KAAG,MAAM;6BAmFnB,QAAQ,GAAG;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KAAE,KAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAoB3E,CAAA;AAEV,0EAA0E;AAC1E,eAAO,MAAM,QAAQ,GAAI,OAAO,QAAQ,KAAG,MAAM,GAAG,SAWnD,CAAA"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/domain/errors.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EAAkB,MAAM,EAAE,MAAM,QAAQ,CAAA;AAC/C,OAAO,EACL,MAAM,EAOP,MAAM,cAAc,CAAA;AAErB,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;;;;;;;AAEzE;;;;;;;;GAQG;AACH,qBAAa,cAAe,SAAQ,mBAKlC;IACA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,MAAM,CAAC,QAAQ,CAAC,WAAW,GACzB,QAAQ,MAAM,EACd,OAAO,OAAO,EACd,YAAY,OAAO,KAClB,cAAc,CAQhB;IAED,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,uBAAuB,EAAE,WAAW,CAAC,MAAM,CAMtD,CAAA;AAIF;;;GAGG;AACH,eAAO,MAAM,sBAAsB,GACjC,OAAO,OAAO,KACb;IAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAA;CAkBzD,CAAA;;;;;;;AAED,uDAAuD;AACvD,qBAAa,cAAe,SAAQ,mBAGlC;IACA;;;;;;;;;OASG;IACH,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;;;;;;;AAED,0DAA0D;AAC1D,qBAAa,aAAc,SAAQ,kBAGjC;IACA,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;;;;;;;AAED,4FAA4F;AAC5F,qBAAa,iBAAkB,SAAQ,sBAGtC;IACC,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;;;;AAED,4DAA4D;AAC5D,qBAAa,mBAAoB,SAAQ,wBAGxC;IACC,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;;;;;AAED,qFAAqF;AACrF,qBAAa,eAAgB,SAAQ,oBAGnC;IACA,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,UAAU,sDAA8C,CAAA;AACrE,0DAA0D;AAC1D,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,IAAI,CAAA;;;;;;IAc7C;;;;OAIG;;;;AAhBL;;;;;;;;GAQG;AACH,qBAAa,WAAY,SAAQ,gBAa/B;IACA,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAED,oEAAoE;AACpE,qBAAa,gBAAiB,SAAQ,qBAGpC;CAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEL,wEAAwE;AACxE,qBAAa,eAAgB,SAAQ,oBAKnC;IACA,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAED;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,sBAGtC;IACC,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;;;;;AAED;;;;;;;;GAQG;AACH,qBAAa,UAAW,SAAQ,eAG9B;IACA,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;;;;AAED,yDAAyD;AACzD,qBAAa,YAAa,SAAQ,iBAEhC;IACA,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;;;;;AAED,qDAAqD;AACrD,qBAAa,UAAW,SAAQ,eAG9B;CAAG;;;;;AAEL,uEAAuE;AACvE,qBAAa,YAAa,SAAQ,iBAGhC;CAAG;;;;AAEL,2DAA2D;AAC3D,qBAAa,YAAa,SAAQ,iBAEhC;IACA,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;;;;;;;;AAED;;;;;;;;;GASG;AACH,qBAAa,iBAAkB,SAAQ,sBAGtC;IACC,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;;;;;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,kBAAmB,SAAQ,uBAGvC;IACC,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;;;;;AAED;;;;;;;;;;;;;GAaG;AACH,qBAAa,iBAAkB,SAAQ,sBAGtC;IACC,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;AAED,4CAA4C;AAC5C,MAAM,MAAM,QAAQ,GAChB,cAAc,GACd,cAAc,GACd,aAAa,GACb,iBAAiB,GACjB,mBAAmB,GACnB,eAAe,GACf,WAAW,GACX,gBAAgB,GAChB,eAAe,GACf,iBAAiB,GACjB,UAAU,GACV,YAAY,GACZ,UAAU,GACV,YAAY,GACZ,YAAY,GACZ,iBAAiB,GACjB,kBAAkB,GAClB,iBAAiB,CAAA;AAErB,gEAAgE;AAChE,eAAO,MAAM,cAAc,8bAmBzB,CAAA;AAEF;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,SAAS,GAAG,aAAa,GAAG,SAAS,CAAA;AAE3D;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,YAAY,GAAG,YAAY,GAAG,aAAa,CAAA;AAEvD;;;;;;;;GAQG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;CAC1B;AAiSD;;;;GAIG;AACH,eAAO,MAAM,QAAQ;kCA9RO,QAAQ,KAAG,OAAO;iCAoRnB,OAAO,KAAG,KAAK,IAAI,QAAQ;8BAtO7C,QAAQ,GAAG,UAAU,YAClB;QAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,YAAY,CAAA;KAAE,KAC1C,OAAO;+BAqFe,QAAQ,GAAG;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KAAE,KAAG,MAAM;6BAyH/C,QAAQ,GAAG;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KAAE,KAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAsC3E,CAAA;AAEV,0EAA0E;AAC1E,eAAO,MAAM,QAAQ,GAAI,OAAO,QAAQ,KAAG,MAAM,GAAG,SAWnD,CAAA"}