Fix Kupmios quantity decoding

Author: colll78

.changeset/kupmios-quantity-decoding.md

@@ -0,0 +1,6 @@
+---
+"@lucid-evolution/lucid": patch
+"@lucid-evolution/provider": patch
+---
+
+Fix Kupmios Kupo quantity decoding and harden Ogmios response handling.

docs/next-env.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="next" />
 /// <reference types="next/image-types/global" />
+/// <reference path="./.next/types/routes.d.ts" />
 
 // NOTE: This file should not be edited
-// see https://nextjs.org/docs/pages/building-your-application/configuring/typescript for more information.
+// see https://nextjs.org/docs/pages/api-reference/config/typescript for more information.

docs/tsconfig.tsbuildinfo

@@ -23,5 +23,73 @@
   "engines": {
     "node": ">=18"
   },
-  "packageManager": "pnpm@9.12.3"
+  "packageManager": "pnpm@9.12.3",
+  "pnpm": {
+    "overrides": {
+      "esbuild@<=0.24.2": ">=0.25.0",
+      "estree-util-value-to-estree@<3.3.3": ">=3.3.3",
+      "@babel/runtime@<7.26.10": ">=7.26.10",
+      "cross-spawn@<6.0.6": ">=6.0.6",
+      "brace-expansion@>=1.0.0 <=1.1.11": ">=1.1.12",
+      "brace-expansion@>=2.0.0 <=2.0.1": ">=2.0.2",
+      "next@>=13.0 <14.2.30": ">=14.2.30",
+      "dompurify@<3.2.4": ">=3.2.4",
+      "@eslint/plugin-kit@<0.3.4": ">=0.3.4",
+      "next@>=0.9.9 <14.2.31": ">=14.2.31",
+      "mermaid@>=10.9.0-rc.1 <10.9.4": ">=10.9.4",
+      "vite@<=5.4.19": "5.4.21",
+      "vite@>=6.0.0 <=6.3.5": "6.4.2",
+      "next@>=0.9.9 <14.2.32": ">=14.2.32",
+      "vite@>=5.2.6 <=5.4.20": "5.4.21",
+      "vite@>=6.0.0 <=6.4.0": "6.4.2",
+      "tar-fs@>=2.0.0 <2.1.4": ">=2.1.4",
+      "sha.js@<=2.4.11": ">=2.4.12",
+      "tmp@<=0.2.3": ">=0.2.4",
+      "glob@>=10.2.0 <10.5.0": ">=10.5.0",
+      "next@>=13.3.0 <14.2.34": ">=14.2.34",
+      "next@>=13.3.1-canary.0 <14.2.35": ">=14.2.35",
+      "lodash-es@>=4.0.0 <=4.17.22": ">=4.17.23",
+      "lodash@>=4.0.0 <=4.17.22": ">=4.17.23",
+      "undici@>=7.0.0 <7.18.2": ">=7.18.2",
+      "next@>=10.0.0 <15.5.10": ">=15.5.10",
+      "next@>=13.0.0 <15.0.8": ">=15.0.8",
+      "diff@>=5.0.0 <5.2.2": ">=5.2.2",
+      "js-yaml@<3.14.2": "3.14.2",
+      "js-yaml@>=4.0.0 <4.1.1": ">=4.1.1",
+      "mdast-util-to-hast@>=13.0.0 <13.2.1": ">=13.2.1",
+      "next-mdx-remote@>=4.3.0 <6.0.0": ">=6.0.0",
+      "minimatch@<3.1.3": ">=3.1.3",
+      "minimatch@>=9.0.0 <9.0.6": ">=9.0.6",
+      "rollup@>=4.0.0 <4.59.0": ">=4.59.0",
+      "minimatch@>=9.0.0 <9.0.7": ">=9.0.7",
+      "minimatch@<3.1.4": ">=3.1.4",
+      "ajv@<6.14.0": ">=6.14.0",
+      "ajv@>=7.0.0-alpha.0 <8.18.0": ">=8.18.0",
+      "dompurify@>=3.1.3 <3.2.7": ">=3.2.7",
+      "flatted@<3.4.0": ">=3.4.0",
+      "undici@>=7.0.0 <7.24.0": ">=7.24.0",
+      "next@>=9.5.0 <15.5.13": ">=15.5.13",
+      "next@>=10.0.0 <15.5.14": ">=15.5.14",
+      "effect@<3.20.0": ">=3.20.0",
+      "flatted@<=3.4.1": ">=3.4.2",
+      "dompurify@<3.3.2": ">=3.3.2",
+      "brace-expansion@<1.1.13": ">=1.1.13",
+      "brace-expansion@>=2.0.0 <2.0.3": ">=2.0.3",
+      "picomatch@<2.3.2": ">=2.3.2",
+      "picomatch@>=4.0.0 <4.0.4": ">=4.0.4",
+      "yaml@>=2.0.0 <2.8.3": ">=2.8.3",
+      "dompurify@>=3.1.3 <=3.3.1": ">=3.3.2",
+      "lodash.template@>=4.0.0 <4.18.0": ">=4.18.0",
+      "lodash-es@>=4.0.0 <=4.17.23": ">=4.18.0",
+      "lodash@>=4.0.0 <=4.17.23": ">=4.18.0",
+      "lodash-es@<=4.17.23": ">=4.18.0",
+      "lodash@<=4.17.23": ">=4.18.0",
+      "dompurify@<=3.3.1": ">=3.3.2",
+      "vite@<=6.4.1": "6.4.2",
+      "vite@>=6.0.0 <=6.4.1": "6.4.2",
+      "next@>=13.0.0 <15.5.15": ">=15.5.15",
+      "dompurify@<=3.3.3": ">=3.4.0",
+      "protobufjs@<7.5.5": ">=7.5.5"
+    }
+  }
 }

package.json

@@ -74,7 +74,7 @@
     "tsup": "^8.3.6",
     "tsx": "^4.19.2",
     "typescript": "5.5.0-dev.20240430",
-    "vite-plugin-wasm": "^3.4.1",
+    "vite-plugin-wasm": "^3.6.0",
     "vitest": "^2.1.8"
   }
 }

packages/lucid/package.json

@@ -1,8 +1,13 @@
 import { Schema as S } from "effect";
 
+const QuantitySchema = S.Union(
+  S.Number.pipe(S.filter(Number.isSafeInteger)),
+  S.String.pipe(S.pattern(/^\d+$/)),
+);
+
 export const ValueSchema = S.Struct({
-  coins: S.Number,
-  assets: S.Record({ key: S.String, value: S.Number }),
+  coins: QuantitySchema,
+  assets: S.Record({ key: S.String, value: QuantitySchema }),
 });
 export interface Value extends S.Schema.Type<typeof ValueSchema> {}
 

packages/provider/src/internal/kupo.ts

@@ -11,6 +11,50 @@ export const JSONRPCSchema = <A, I, R>(schema: S.Schema<A, I, R>) =>
     result: schema,
   }).annotations({ identifier: "JSONRPCSchema" });
 
+export const JSONRPCErrorSchema = S.Struct({
+  code: S.Number,
+  message: S.String,
+  data: S.optional(S.Unknown),
+});
+export type JSONRPCError = S.Schema.Type<typeof JSONRPCErrorSchema>;
+
+const JSONRPCErrorResponseSchema = S.Struct({
+  jsonrpc: S.String,
+  method: S.optional(S.String),
+  id: S.NullOr(S.Number),
+  error: JSONRPCErrorSchema,
+});
+export type JSONRPCErrorResponse = S.Schema.Type<
+  typeof JSONRPCErrorResponseSchema
+>;
+
+export type JSONRPCResponse<A> =
+  | {
+      jsonrpc: string;
+      method?: string;
+      id: number | null;
+      result: A;
+    }
+  | JSONRPCErrorResponse;
+
+export const JSONRPCResponseSchema = <A, I, R>(schema: S.Schema<A, I, R>) =>
+  S.Union(JSONRPCSchema(schema), JSONRPCErrorResponseSchema).annotations({
+    identifier: "JSONRPCResponseSchema",
+  });
+
+export const getJSONRPCResult = <A>(response: JSONRPCResponse<A>): A => {
+  if ("error" in response) {
+    const data =
+      response.error.data === undefined
+        ? ""
+        : `: ${JSON.stringify(response.error.data)}`;
+    throw new Error(
+      `Ogmios JSON-RPC error ${response.error.code}: ${response.error.message}${data}`,
+    );
+  }
+  return response.result;
+};
+
 const LovelaceAsset = S.Struct({
   lovelace: S.Number,
 });
@@ -104,16 +148,33 @@ export const ProtocolParametersSchema = S.Struct({
 export interface ProtocolParameters
   extends S.Schema.Type<typeof ProtocolParametersSchema> {}
 
-export const Delegation = S.NullOr(
+const RewardAccountAdaSchema = S.Struct({
+  ada: LovelaceAsset,
+});
+
+const LegacyDelegationSummarySchema = S.Struct({
+  delegate: S.optional(S.NullOr(S.Struct({ id: S.String }))),
+  rewards: RewardAccountAdaSchema,
+  deposit: RewardAccountAdaSchema,
+});
+
+const RewardAccountSummarySchema = S.Struct({
+  from: S.optional(S.Literal("key", "script")),
+  credential: S.optional(S.String),
+  stakePool: S.optional(S.NullOr(S.Struct({ id: S.String }))),
+  rewards: RewardAccountAdaSchema,
+  deposit: RewardAccountAdaSchema,
+});
+
+export const Delegation = S.Union(
+  S.Null,
   S.Record({
     key: S.String,
-    value: S.Struct({
-      delegate: S.Struct({ id: S.String }),
-      rewards: S.Struct({ ada: S.Struct({ lovelace: S.Number }) }),
-      deposit: S.Struct({ ada: S.Struct({ lovelace: S.Number }) }),
-    }),
+    value: LegacyDelegationSummarySchema,
   }),
+  S.Array(RewardAccountSummarySchema),
 );
+export type Delegation = S.Schema.Type<typeof Delegation>;
 
 type Script = {
   language: "plutus:v1" | "plutus:v2" | "plutus:v3";
@@ -136,6 +197,16 @@ export type UTxO = {
   script?: Script | null;
 };
 
+const toOgmiosQuantity = (amount: bigint): number => {
+  const quantity = Number(amount);
+  if (amount < 0n || !Number.isSafeInteger(quantity)) {
+    throw new Error(
+      `Cannot encode Ogmios quantity ${amount.toString()}. Ogmios expects JSON numbers, so quantities must be non-negative safe integers.`,
+    );
+  }
+  return quantity;
+};
+
 export const RedeemerSchema = S.Struct({
   validator: S.Struct({
     purpose: S.Literal(
@@ -193,7 +264,8 @@ export const toOgmiosUTxOs = (utxos: CoreType.UTxO[] | undefined): UTxO[] => {
       if (!newAssets[policyId]) {
         newAssets[policyId] = {};
       }
-      return (newAssets[policyId][assetName ? assetName : ""] = Number(amount));
+      return (newAssets[policyId][assetName ? assetName : ""] =
+        toOgmiosQuantity(amount));
     });
     return newAssets;
   };
@@ -206,7 +278,7 @@ export const toOgmiosUTxOs = (utxos: CoreType.UTxO[] | undefined): UTxO[] => {
       index: utxo.outputIndex,
       address: utxo.address,
       value: {
-        ada: { lovelace: Number(utxo.assets["lovelace"]) },
+        ada: { lovelace: toOgmiosQuantity(utxo.assets["lovelace"]) },
         ...toOgmiosAssets(utxo.assets),
       },
       datumHash: utxo.datumHash,