@lucid-evolution/provider 0.2.0 → 0.2.2

package/dist/index.cjs

@@ -144,7 +144,7 @@ var import_utils2 = require("@lucid-evolution/utils");
 // package.json
 var package_default = {
   name: "@lucid-evolution/provider",
-  version: "0.2.0",
+  version: "0.2.2",
   description: "",
   main: "./dist/index.js",
   types: "./dist/index.d.ts",
@@ -882,7 +882,17 @@ var ValueSchema = import_effect3.Schema.Struct({
   coins: QuantitySchema,
   assets: import_effect3.Schema.Record({ key: import_effect3.Schema.String, value: QuantitySchema })
 });
-var UTxOSchema = import_effect3.Schema.Struct({
+var PointSchema = import_effect3.Schema.Struct({
+  slot_no: import_effect3.Schema.Number,
+  header_hash: import_effect3.Schema.String
+});
+var ScriptSchema = import_effect3.Schema.NullOr(
+  import_effect3.Schema.Struct({
+    language: import_effect3.Schema.Literal("native", "plutus:v1", "plutus:v2", "plutus:v3"),
+    script: import_effect3.Schema.String
+  })
+);
+var UTxOFields = {
   transaction_index: import_effect3.Schema.Number,
   transaction_id: import_effect3.Schema.String,
   output_index: import_effect3.Schema.Number,
@@ -891,23 +901,15 @@ var UTxOSchema = import_effect3.Schema.Struct({
   datum_hash: import_effect3.Schema.NullOr(import_effect3.Schema.String),
   datum_type: import_effect3.Schema.optional(import_effect3.Schema.Literal("hash", "inline")),
   script_hash: import_effect3.Schema.NullOr(import_effect3.Schema.String),
-  created_at: import_effect3.Schema.Struct({
-    slot_no: import_effect3.Schema.Number,
-    header_hash: import_effect3.Schema.String
-  }),
-  spent_at: import_effect3.Schema.NullOr(
-    import_effect3.Schema.Struct({
-      slot_no: import_effect3.Schema.Number,
-      header_hash: import_effect3.Schema.String
-    })
-  )
+  created_at: PointSchema,
+  spent_at: import_effect3.Schema.NullOr(PointSchema)
+};
+var UTxOSchema = import_effect3.Schema.Struct(UTxOFields);
+var ResolvedUTxOSchema = import_effect3.Schema.Struct({
+  ...UTxOFields,
+  datum: import_effect3.Schema.NullOr(import_effect3.Schema.String),
+  script: ScriptSchema
 });
-var ScriptSchema = import_effect3.Schema.NullOr(
-  import_effect3.Schema.Struct({
-    language: import_effect3.Schema.Literal("native", "plutus:v1", "plutus:v2", "plutus:v3"),
-    script: import_effect3.Schema.String
-  })
-);
 var DatumSchema = import_effect3.Schema.NullOr(import_effect3.Schema.Struct({ datum: import_effect3.Schema.String }));
 var DelegationSchema = import_effect3.Schema.NullOr(
   import_effect3.Schema.Record({
@@ -1017,6 +1019,14 @@ var makePostAsUint8Array = (url, data, schema, headers) => (0, import_effect4.pi
 
 // src/kupmios.ts
 var import_platform2 = require("@effect/platform");
+var DEFAULT_REQUEST_TIMEOUT_MS = 3e4;
+var DEFAULT_AWAIT_TX_TIMEOUT_MS = 16e4;
+var validateTimeout = (name, timeout) => {
+  if (!Number.isFinite(timeout) || timeout <= 0) {
+    throw new TypeError(`${name} must be a positive finite number.`);
+  }
+  return timeout;
+};
 var catchProviderError = (protocol, operation) => (effect) => import_effect6.Effect.catchAll(
   effect,
   (cause) => import_effect6.Effect.fail(toKupmiosError(cause, protocol, operation))
@@ -1038,11 +1048,21 @@ var runProviderEffect = async (effect, protocol, operation, signal) => {
 var Kupmios = class {
   kupoUrl;
   ogmiosUrl;
-  headers;
-  constructor(kupoUrl, ogmiosUrl, headers) {
+  options;
+  requestTimeoutMs;
+  awaitTxTimeoutMs;
+  constructor(kupoUrl, ogmiosUrl, options = {}) {
     this.kupoUrl = kupoUrl;
     this.ogmiosUrl = ogmiosUrl;
-    this.headers = headers;
+    this.options = options;
+    this.requestTimeoutMs = validateTimeout(
+      "requestTimeoutMs",
+      options.requestTimeoutMs ?? DEFAULT_REQUEST_TIMEOUT_MS
+    );
+    this.awaitTxTimeoutMs = validateTimeout(
+      "awaitTxTimeoutMs",
+      options.awaitTxTimeoutMs ?? DEFAULT_AWAIT_TX_TIMEOUT_MS
+    );
   }
   async getProtocolParameters() {
     const data = {
@@ -1060,9 +1080,9 @@ var Kupmios = class {
           this.ogmiosUrl,
           data,
           schema,
-          this.headers?.ogmiosHeader
+          this.options.ogmiosHeader
         ),
-        import_effect6.Effect.timeout(1e4),
+        import_effect6.Effect.timeout(this.requestTimeoutMs),
         catchProviderError("ogmios", "queryLedgerState/protocolParameters"),
         import_effect6.Effect.provide(import_platform2.FetchHttpClient.layer)
       ),
@@ -1095,9 +1115,9 @@ var Kupmios = class {
           this.ogmiosUrl,
           data,
           schema,
-          this.headers?.ogmiosHeader
+          this.options.ogmiosHeader
         ),
-        import_effect6.Effect.timeout(1e4),
+        import_effect6.Effect.timeout(this.requestTimeoutMs),
         catchProviderError("ogmios", "queryLedgerState/treasuryAndReserves"),
         import_effect6.Effect.provide(import_platform2.FetchHttpClient.layer)
       ),
@@ -1114,15 +1134,13 @@ var Kupmios = class {
   async getUtxos(addressOrCredential) {
     const isAddress = typeof addressOrCredential === "string";
     const queryPredicate = isAddress ? addressOrCredential : addressOrCredential.hash;
-    const pattern = `${this.kupoUrl}/matches/${queryPredicate}${isAddress ? "" : "/*"}?unspent`;
-    const schema = import_effect5.Schema.Array(UTxOSchema);
+    const pattern = `${this.kupoUrl}/matches/${queryPredicate}${isAddress ? "" : "/*"}?unspent&resolve_hashes`;
+    const schema = import_effect5.Schema.Array(ResolvedUTxOSchema);
     const utxos = await runProviderEffect(
       (0, import_effect6.pipe)(
-        makeGet(pattern, schema, this.headers?.kupoHeader),
-        import_effect6.Effect.flatMap(
-          (u) => kupmiosUtxosToUtxos(this.kupoUrl, u, this.headers?.kupoHeader)
-        ),
-        import_effect6.Effect.timeout(1e4),
+        makeGet(pattern, schema, this.options.kupoHeader),
+        import_effect6.Effect.map(kupmiosUtxosToUtxos),
+        import_effect6.Effect.timeout(this.requestTimeoutMs),
         catchProviderError("kupo", "getUtxos"),
         import_effect6.Effect.provide(import_platform2.FetchHttpClient.layer)
       ),
@@ -1135,15 +1153,13 @@ var Kupmios = class {
     const isAddress = typeof addressOrCredential === "string";
     const queryPredicate = isAddress ? addressOrCredential : addressOrCredential.hash;
     const { policyId, assetName } = (0, import_utils4.fromUnit)(unit);
-    const pattern = `${this.kupoUrl}/matches/${queryPredicate}${isAddress ? "" : "/*"}?unspent&policy_id=${policyId}${assetName ? `&asset_name=${assetName}` : ""}`;
-    const schema = import_effect5.Schema.Array(UTxOSchema);
+    const pattern = `${this.kupoUrl}/matches/${queryPredicate}${isAddress ? "" : "/*"}?unspent&resolve_hashes&policy_id=${policyId}${assetName ? `&asset_name=${assetName}` : ""}`;
+    const schema = import_effect5.Schema.Array(ResolvedUTxOSchema);
     const utxos = await runProviderEffect(
       (0, import_effect6.pipe)(
-        makeGet(pattern, schema, this.headers?.kupoHeader),
-        import_effect6.Effect.flatMap(
-          (u) => kupmiosUtxosToUtxos(this.kupoUrl, u, this.headers?.kupoHeader)
-        ),
-        import_effect6.Effect.timeout(1e4),
+        makeGet(pattern, schema, this.options.kupoHeader),
+        import_effect6.Effect.map(kupmiosUtxosToUtxos),
+        import_effect6.Effect.timeout(this.requestTimeoutMs),
         catchProviderError("kupo", "getUtxosWithUnit"),
         import_effect6.Effect.provide(import_platform2.FetchHttpClient.layer)
       ),
@@ -1161,15 +1177,13 @@ var Kupmios = class {
     const normalizedPolicyId = policyId.toLowerCase();
     const isAddress = typeof addressOrCredential === "string";
     const queryPredicate = isAddress ? addressOrCredential : addressOrCredential.hash;
-    const pattern = `${this.kupoUrl}/matches/${queryPredicate}${isAddress ? "" : "/*"}?unspent&policy_id=${normalizedPolicyId}`;
-    const schema = import_effect5.Schema.Array(UTxOSchema);
+    const pattern = `${this.kupoUrl}/matches/${queryPredicate}${isAddress ? "" : "/*"}?unspent&resolve_hashes&policy_id=${normalizedPolicyId}`;
+    const schema = import_effect5.Schema.Array(ResolvedUTxOSchema);
     return runProviderEffect(
       (0, import_effect6.pipe)(
-        makeGet(pattern, schema, this.headers?.kupoHeader),
-        import_effect6.Effect.flatMap(
-          (utxos) => kupmiosUtxosToUtxos(this.kupoUrl, utxos, this.headers?.kupoHeader)
-        ),
-        import_effect6.Effect.timeout(1e4),
+        makeGet(pattern, schema, this.options.kupoHeader),
+        import_effect6.Effect.map(kupmiosUtxosToUtxos),
+        import_effect6.Effect.timeout(this.requestTimeoutMs),
         catchProviderError("kupo", "getUtxosWithPolicy"),
         import_effect6.Effect.provide(import_platform2.FetchHttpClient.layer)
       ),
@@ -1179,15 +1193,13 @@ var Kupmios = class {
   }
   async getUtxoByUnit(unit) {
     const { policyId, assetName } = (0, import_utils4.fromUnit)(unit);
-    const pattern = `${this.kupoUrl}/matches/${policyId}.${assetName ?? ""}?unspent`;
-    const schema = import_effect5.Schema.Array(UTxOSchema);
+    const pattern = `${this.kupoUrl}/matches/${policyId}.${assetName ?? ""}?unspent&resolve_hashes`;
+    const schema = import_effect5.Schema.Array(ResolvedUTxOSchema);
     const utxos = await runProviderEffect(
       (0, import_effect6.pipe)(
-        makeGet(pattern, schema, this.headers?.kupoHeader),
-        import_effect6.Effect.flatMap(
-          (u) => kupmiosUtxosToUtxos(this.kupoUrl, u, this.headers?.kupoHeader)
-        ),
-        import_effect6.Effect.timeout(1e4),
+        makeGet(pattern, schema, this.options.kupoHeader),
+        import_effect6.Effect.map(kupmiosUtxosToUtxos),
+        import_effect6.Effect.timeout(this.requestTimeoutMs),
         catchProviderError("kupo", "getUtxoByUnit"),
         import_effect6.Effect.provide(import_platform2.FetchHttpClient.layer)
       ),
@@ -1206,16 +1218,14 @@ var Kupmios = class {
     const queryHashes = [
       ...new Set(outRefs.map((outRef) => outRef.txHash))
     ];
-    const mkPattern = (txHash) => `${this.kupoUrl}/matches/*@${txHash}?unspent`;
-    const schema = import_effect5.Schema.Array(UTxOSchema);
+    const mkPattern = (txHash) => `${this.kupoUrl}/matches/*@${txHash}?unspent&resolve_hashes`;
+    const schema = import_effect5.Schema.Array(ResolvedUTxOSchema);
     const program = import_effect6.Effect.forEach(
       queryHashes,
       (txHash) => (0, import_effect6.pipe)(
-        makeGet(mkPattern(txHash), schema, this.headers?.kupoHeader),
-        import_effect6.Effect.flatMap(
-          (u) => kupmiosUtxosToUtxos(this.kupoUrl, u, this.headers?.kupoHeader)
-        ),
-        import_effect6.Effect.timeout(1e4),
+        makeGet(mkPattern(txHash), schema, this.options.kupoHeader),
+        import_effect6.Effect.map(kupmiosUtxosToUtxos),
+        import_effect6.Effect.timeout(this.requestTimeoutMs),
         catchProviderError("kupo", "getUtxosByOutRef")
       )
     );
@@ -1244,10 +1254,10 @@ var Kupmios = class {
           this.ogmiosUrl,
           data,
           schema,
-          this.headers?.ogmiosHeader
+          this.options.ogmiosHeader
         ),
         import_effect6.Effect.provide(import_platform2.FetchHttpClient.layer),
-        import_effect6.Effect.timeout(1e4),
+        import_effect6.Effect.timeout(this.requestTimeoutMs),
         catchProviderError("ogmios", "queryLedgerState/rewardAccountSummaries")
       ),
       "ogmios",
@@ -1269,9 +1279,9 @@ var Kupmios = class {
     const schema = DatumSchema;
     const result = await runProviderEffect(
       (0, import_effect6.pipe)(
-        makeGet(pattern, schema, this.headers?.kupoHeader),
+        makeGet(pattern, schema, this.options.kupoHeader),
         import_effect6.Effect.provide(import_platform2.FetchHttpClient.layer),
-        import_effect6.Effect.timeout(1e4),
+        import_effect6.Effect.timeout(this.requestTimeoutMs),
         import_effect6.Effect.flatMap(import_effect6.Effect.fromNullable),
         catchProviderError("kupo", "getDatum")
       ),
@@ -1287,8 +1297,8 @@ var Kupmios = class {
     });
     const matches = await runProviderEffect(
       (0, import_effect6.pipe)(
-        makeGet(pattern, schema, this.headers?.kupoHeader),
-        import_effect6.Effect.timeout(1e4),
+        makeGet(pattern, schema, this.options.kupoHeader),
+        import_effect6.Effect.timeout(this.requestTimeoutMs),
         catchProviderError("kupo", "getTransactionStatus"),
         import_effect6.Effect.provide(import_platform2.FetchHttpClient.layer)
       ),
@@ -1315,13 +1325,13 @@ var Kupmios = class {
     });
     const result = await runProviderEffect(
       (0, import_effect6.pipe)(
-        makeGet(pattern, schema, this.headers?.kupoHeader),
+        makeGet(pattern, schema, this.options.kupoHeader),
         import_effect6.Effect.provide(import_platform2.FetchHttpClient.layer),
         import_effect6.Effect.repeat({
           schedule: import_effect6.Schedule.exponential(checkInterval),
           until: (result2) => result2.length > 0
         }),
-        import_effect6.Effect.timeout(16e4),
+        import_effect6.Effect.timeout(this.awaitTxTimeoutMs),
         catchProviderError("kupo", "awaitTx"),
         import_effect6.Effect.as(true)
       ),
@@ -1352,10 +1362,10 @@ var Kupmios = class {
           this.ogmiosUrl,
           data,
           schema,
-          this.headers?.ogmiosHeader
+          this.options.ogmiosHeader
         ),
         import_effect6.Effect.provide(import_platform2.FetchHttpClient.layer),
-        import_effect6.Effect.timeout(1e4),
+        import_effect6.Effect.timeout(this.requestTimeoutMs),
         catchProviderError("ogmios", "submitTransaction")
       ),
       "ogmios",
@@ -1385,10 +1395,10 @@ var Kupmios = class {
           this.ogmiosUrl,
           data,
           schema,
-          this.headers?.ogmiosHeader
+          this.options.ogmiosHeader
         ),
         import_effect6.Effect.provide(import_platform2.FetchHttpClient.layer),
-        import_effect6.Effect.timeout(1e4),
+        import_effect6.Effect.timeout(this.requestTimeoutMs),
         catchProviderError("ogmios", "evaluateTransaction")
       ),
       "ogmios",
@@ -1410,59 +1420,6 @@ var Kupmios = class {
     return evalRedeemers;
   }
 };
-var getDatumEffect = (kupoUrl, datum_type, datum_hash, kupoHeader) => import_effect6.Effect.gen(function* () {
-  if (datum_type === "inline" && datum_hash) {
-    const pattern = `${kupoUrl}/datums/${datum_hash}`;
-    const schema = DatumSchema;
-    return yield* (0, import_effect6.pipe)(
-      makeGet(pattern, schema, kupoHeader),
-      import_effect6.Effect.flatMap(import_effect6.Effect.fromNullable),
-      import_effect6.Effect.map((result) => result.datum),
-      import_effect6.Effect.retry(
-        import_effect6.Schedule.compose(import_effect6.Schedule.exponential(50), import_effect6.Schedule.recurs(5))
-      ),
-      import_effect6.Effect.timeout(5e3)
-    );
-  } else return void 0;
-});
-var getScriptEffect = (kupoUrl, script_hash, kupoHeader) => import_effect6.Effect.gen(function* () {
-  if (script_hash) {
-    const pattern = `${kupoUrl}/scripts/${script_hash}`;
-    const schema = ScriptSchema;
-    return yield* (0, import_effect6.pipe)(
-      makeGet(pattern, schema, kupoHeader),
-      import_effect6.Effect.flatMap(import_effect6.Effect.fromNullable),
-      import_effect6.Effect.retry(
-        import_effect6.Schedule.compose(import_effect6.Schedule.exponential(50), import_effect6.Schedule.recurs(5))
-      ),
-      import_effect6.Effect.timeout(5e3),
-      import_effect6.Effect.map(({ language, script }) => {
-        switch (language) {
-          case "native":
-            return {
-              type: "Native",
-              script
-            };
-          case "plutus:v1":
-            return {
-              type: "PlutusV1",
-              script: (0, import_utils4.applyDoubleCborEncoding)(script)
-            };
-          case "plutus:v2":
-            return {
-              type: "PlutusV2",
-              script: (0, import_utils4.applyDoubleCborEncoding)(script)
-            };
-          case "plutus:v3":
-            return {
-              type: "PlutusV3",
-              script: (0, import_utils4.applyDoubleCborEncoding)(script)
-            };
-        }
-      })
-    );
-  } else return void 0;
-});
 var toAssets = (value) => {
   const assets = { lovelace: BigInt(value.coins) };
   for (const unit of Object.keys(value.assets)) {
@@ -1511,29 +1468,37 @@ var toRewardAccountState = (result) => {
     rewards: BigInt(delegation.rewards.ada.lovelace)
   };
 };
-var kupmiosUtxosToUtxos = (kupoURL, utxos, kupoHeader) => import_effect6.Effect.forEach(
-  utxos,
-  (utxo) => {
-    return (0, import_effect6.pipe)(
-      import_effect6.Effect.all([
-        getDatumEffect(kupoURL, utxo.datum_type, utxo.datum_hash, kupoHeader),
-        getScriptEffect(kupoURL, utxo.script_hash, kupoHeader)
-      ]),
-      import_effect6.Effect.map(
-        ([datum, script]) => ({
-          txHash: utxo.transaction_id,
-          outputIndex: utxo.output_index,
-          address: utxo.address,
-          assets: toAssets(utxo.value),
-          datumHash: utxo.datum_type === "hash" ? utxo.datum_hash : void 0,
-          datum,
-          scriptRef: script
-        })
-      )
-    );
-  },
-  { concurrency: "unbounded" }
-);
+var toScriptRef = (script) => {
+  if (!script) return void 0;
+  switch (script.language) {
+    case "native":
+      return { type: "Native", script: script.script };
+    case "plutus:v1":
+      return {
+        type: "PlutusV1",
+        script: (0, import_utils4.applyDoubleCborEncoding)(script.script)
+      };
+    case "plutus:v2":
+      return {
+        type: "PlutusV2",
+        script: (0, import_utils4.applyDoubleCborEncoding)(script.script)
+      };
+    case "plutus:v3":
+      return {
+        type: "PlutusV3",
+        script: (0, import_utils4.applyDoubleCborEncoding)(script.script)
+      };
+  }
+};
+var kupmiosUtxosToUtxos = (utxos) => utxos.map((utxo) => ({
+  txHash: utxo.transaction_id,
+  outputIndex: utxo.output_index,
+  address: utxo.address,
+  assets: toAssets(utxo.value),
+  datumHash: utxo.datum_type === "hash" ? utxo.datum_hash : void 0,
+  datum: utxo.datum_type === "inline" ? utxo.datum : void 0,
+  scriptRef: toScriptRef(utxo.script)
+}));
 
 // src/emulator.ts
 var import_utils5 = require("@lucid-evolution/utils");
@@ -2841,7 +2806,7 @@ var Maestro = class {
       address: result.address,
       datumHash: result.datum ? result.datum.type == "inline" ? void 0 : result.datum.hash : void 0,
       datum: result.datum?.bytes,
-      scriptRef: toScriptRef(result.reference_script)
+      scriptRef: toScriptRef2(result.reference_script)
     };
   }
   async getAllPagesData(getResponse, qry, paramsGiven, errorMsg) {
@@ -2892,7 +2857,7 @@ var Maestro = class {
     return result;
   }
 };
-var toScriptRef = (reference_script) => {
+var toScriptRef2 = (reference_script) => {
   if (reference_script && reference_script.bytes) {
     switch (reference_script.type) {
       case "native":
@@ -3174,9 +3139,9 @@ var toUTxO = (koiosUTxO, address) => ({
   address,
   datumHash: koiosUTxO.inline_datum ? void 0 : koiosUTxO.datum_hash || void 0,
   datum: koiosUTxO.inline_datum ? koiosUTxO.inline_datum.bytes : void 0,
-  scriptRef: toScriptRef2(koiosUTxO.reference_script)
+  scriptRef: toScriptRef3(koiosUTxO.reference_script)
 });
-var toScriptRef2 = (reference_script) => {
+var toScriptRef3 = (reference_script) => {
   if (reference_script && reference_script.bytes && reference_script.type) {
     switch (reference_script.type) {
       case "plutusV1":

package/dist/index.d.cts

@@ -68,9 +68,19 @@ declare class Blockfrost implements Provider {
     evaluateTx(tx: Transaction, additionalUTxOs?: UTxO[]): Promise<EvalRedeemer[]>;
 }
 
+interface KupmiosOptions {
+    readonly ogmiosHeader?: Record<string, string>;
+    readonly kupoHeader?: Record<string, string>;
+    /** One-shot Kupo and Ogmios request deadline in milliseconds. @default 30000 */
+    readonly requestTimeoutMs?: number;
+    /** Overall transaction confirmation deadline in milliseconds. @default 160000 */
+    readonly awaitTxTimeoutMs?: number;
+}
 /**
  * Provides support for interacting with both Kupo and Ogmios APIs.
  *
+ * Requires Kupo v2.10.0 or later.
+ *
  * @example Using Local URLs (No Authentication):
  * ```typescript
  * const kupmios = new Kupmios(
@@ -101,11 +111,10 @@ declare class Blockfrost implements Provider {
 declare class Kupmios implements Provider {
     private readonly kupoUrl;
     private readonly ogmiosUrl;
-    private readonly headers?;
-    constructor(kupoUrl: string, ogmiosUrl: string, headers?: {
-        ogmiosHeader?: Record<string, string>;
-        kupoHeader?: Record<string, string>;
-    });
+    private readonly options;
+    private readonly requestTimeoutMs;
+    private readonly awaitTxTimeoutMs;
+    constructor(kupoUrl: string, ogmiosUrl: string, options?: KupmiosOptions);
     getProtocolParameters(): Promise<ProtocolParameters>;
     getTreasury(): Promise<bigint>;
     getUtxos(addressOrCredential: Address | Credential): Promise<UTxO[]>;
@@ -278,4 +287,4 @@ declare class Koios implements Provider {
     evaluateTx(tx: Transaction, additionalUTxOs?: UTxO[]): Promise<EvalRedeemer[]>;
 }
 
-export { Blockfrost, Emulator, type EmulatorAccount, Koios, KoiosError, Kupmios, KupmiosError, type KupmiosErrorOptions, Maestro, type MaestroConfig, type MaestroSupportedNetworks, OgmiosJsonRpcError, type OgmiosJsonRpcErrorOptions, type ProviderErrorKind, type ProviderTransportProtocol, generateEmulatorAccount, generateEmulatorAccountFromPrivateKey, isEmulatorProvider };
+export { Blockfrost, Emulator, type EmulatorAccount, Koios, KoiosError, Kupmios, KupmiosError, type KupmiosErrorOptions, type KupmiosOptions, Maestro, type MaestroConfig, type MaestroSupportedNetworks, OgmiosJsonRpcError, type OgmiosJsonRpcErrorOptions, type ProviderErrorKind, type ProviderTransportProtocol, generateEmulatorAccount, generateEmulatorAccountFromPrivateKey, isEmulatorProvider };

package/dist/index.d.ts

@@ -68,9 +68,19 @@ declare class Blockfrost implements Provider {
     evaluateTx(tx: Transaction, additionalUTxOs?: UTxO[]): Promise<EvalRedeemer[]>;
 }
 
+interface KupmiosOptions {
+    readonly ogmiosHeader?: Record<string, string>;
+    readonly kupoHeader?: Record<string, string>;
+    /** One-shot Kupo and Ogmios request deadline in milliseconds. @default 30000 */
+    readonly requestTimeoutMs?: number;
+    /** Overall transaction confirmation deadline in milliseconds. @default 160000 */
+    readonly awaitTxTimeoutMs?: number;
+}
 /**
  * Provides support for interacting with both Kupo and Ogmios APIs.
  *
+ * Requires Kupo v2.10.0 or later.
+ *
  * @example Using Local URLs (No Authentication):
  * ```typescript
  * const kupmios = new Kupmios(
@@ -101,11 +111,10 @@ declare class Blockfrost implements Provider {
 declare class Kupmios implements Provider {
     private readonly kupoUrl;
     private readonly ogmiosUrl;
-    private readonly headers?;
-    constructor(kupoUrl: string, ogmiosUrl: string, headers?: {
-        ogmiosHeader?: Record<string, string>;
-        kupoHeader?: Record<string, string>;
-    });
+    private readonly options;
+    private readonly requestTimeoutMs;
+    private readonly awaitTxTimeoutMs;
+    constructor(kupoUrl: string, ogmiosUrl: string, options?: KupmiosOptions);
     getProtocolParameters(): Promise<ProtocolParameters>;
     getTreasury(): Promise<bigint>;
     getUtxos(addressOrCredential: Address | Credential): Promise<UTxO[]>;
@@ -278,4 +287,4 @@ declare class Koios implements Provider {
     evaluateTx(tx: Transaction, additionalUTxOs?: UTxO[]): Promise<EvalRedeemer[]>;
 }
 
-export { Blockfrost, Emulator, type EmulatorAccount, Koios, KoiosError, Kupmios, KupmiosError, type KupmiosErrorOptions, Maestro, type MaestroConfig, type MaestroSupportedNetworks, OgmiosJsonRpcError, type OgmiosJsonRpcErrorOptions, type ProviderErrorKind, type ProviderTransportProtocol, generateEmulatorAccount, generateEmulatorAccountFromPrivateKey, isEmulatorProvider };
+export { Blockfrost, Emulator, type EmulatorAccount, Koios, KoiosError, Kupmios, KupmiosError, type KupmiosErrorOptions, type KupmiosOptions, Maestro, type MaestroConfig, type MaestroSupportedNetworks, OgmiosJsonRpcError, type OgmiosJsonRpcErrorOptions, type ProviderErrorKind, type ProviderTransportProtocol, generateEmulatorAccount, generateEmulatorAccountFromPrivateKey, isEmulatorProvider };

package/dist/index.js

@@ -101,7 +101,7 @@ import {
 // package.json
 var package_default = {
   name: "@lucid-evolution/provider",
-  version: "0.2.0",
+  version: "0.2.2",
   description: "",
   main: "./dist/index.js",
   types: "./dist/index.d.ts",
@@ -839,7 +839,17 @@ var ValueSchema = S2.Struct({
   coins: QuantitySchema,
   assets: S2.Record({ key: S2.String, value: QuantitySchema })
 });
-var UTxOSchema = S2.Struct({
+var PointSchema = S2.Struct({
+  slot_no: S2.Number,
+  header_hash: S2.String
+});
+var ScriptSchema = S2.NullOr(
+  S2.Struct({
+    language: S2.Literal("native", "plutus:v1", "plutus:v2", "plutus:v3"),
+    script: S2.String
+  })
+);
+var UTxOFields = {
   transaction_index: S2.Number,
   transaction_id: S2.String,
   output_index: S2.Number,
@@ -848,23 +858,15 @@ var UTxOSchema = S2.Struct({
   datum_hash: S2.NullOr(S2.String),
   datum_type: S2.optional(S2.Literal("hash", "inline")),
   script_hash: S2.NullOr(S2.String),
-  created_at: S2.Struct({
-    slot_no: S2.Number,
-    header_hash: S2.String
-  }),
-  spent_at: S2.NullOr(
-    S2.Struct({
-      slot_no: S2.Number,
-      header_hash: S2.String
-    })
-  )
+  created_at: PointSchema,
+  spent_at: S2.NullOr(PointSchema)
+};
+var UTxOSchema = S2.Struct(UTxOFields);
+var ResolvedUTxOSchema = S2.Struct({
+  ...UTxOFields,
+  datum: S2.NullOr(S2.String),
+  script: ScriptSchema
 });
-var ScriptSchema = S2.NullOr(
-  S2.Struct({
-    language: S2.Literal("native", "plutus:v1", "plutus:v2", "plutus:v3"),
-    script: S2.String
-  })
-);
 var DatumSchema = S2.NullOr(S2.Struct({ datum: S2.String }));
 var DelegationSchema = S2.NullOr(
   S2.Record({
@@ -979,6 +981,14 @@ var makePostAsUint8Array = (url, data, schema, headers) => pipe2(
 
 // src/kupmios.ts
 import { FetchHttpClient } from "@effect/platform";
+var DEFAULT_REQUEST_TIMEOUT_MS = 3e4;
+var DEFAULT_AWAIT_TX_TIMEOUT_MS = 16e4;
+var validateTimeout = (name, timeout) => {
+  if (!Number.isFinite(timeout) || timeout <= 0) {
+    throw new TypeError(`${name} must be a positive finite number.`);
+  }
+  return timeout;
+};
 var catchProviderError = (protocol, operation) => (effect) => Effect2.catchAll(
   effect,
   (cause) => Effect2.fail(toKupmiosError(cause, protocol, operation))
@@ -1000,11 +1010,21 @@ var runProviderEffect = async (effect, protocol, operation, signal) => {
 var Kupmios = class {
   kupoUrl;
   ogmiosUrl;
-  headers;
-  constructor(kupoUrl, ogmiosUrl, headers) {
+  options;
+  requestTimeoutMs;
+  awaitTxTimeoutMs;
+  constructor(kupoUrl, ogmiosUrl, options = {}) {
     this.kupoUrl = kupoUrl;
     this.ogmiosUrl = ogmiosUrl;
-    this.headers = headers;
+    this.options = options;
+    this.requestTimeoutMs = validateTimeout(
+      "requestTimeoutMs",
+      options.requestTimeoutMs ?? DEFAULT_REQUEST_TIMEOUT_MS
+    );
+    this.awaitTxTimeoutMs = validateTimeout(
+      "awaitTxTimeoutMs",
+      options.awaitTxTimeoutMs ?? DEFAULT_AWAIT_TX_TIMEOUT_MS
+    );
   }
   async getProtocolParameters() {
     const data = {
@@ -1022,9 +1042,9 @@ var Kupmios = class {
           this.ogmiosUrl,
           data,
           schema,
-          this.headers?.ogmiosHeader
+          this.options.ogmiosHeader
         ),
-        Effect2.timeout(1e4),
+        Effect2.timeout(this.requestTimeoutMs),
         catchProviderError("ogmios", "queryLedgerState/protocolParameters"),
         Effect2.provide(FetchHttpClient.layer)
       ),
@@ -1057,9 +1077,9 @@ var Kupmios = class {
           this.ogmiosUrl,
           data,
           schema,
-          this.headers?.ogmiosHeader
+          this.options.ogmiosHeader
         ),
-        Effect2.timeout(1e4),
+        Effect2.timeout(this.requestTimeoutMs),
         catchProviderError("ogmios", "queryLedgerState/treasuryAndReserves"),
         Effect2.provide(FetchHttpClient.layer)
       ),
@@ -1076,15 +1096,13 @@ var Kupmios = class {
   async getUtxos(addressOrCredential) {
     const isAddress = typeof addressOrCredential === "string";
     const queryPredicate = isAddress ? addressOrCredential : addressOrCredential.hash;
-    const pattern = `${this.kupoUrl}/matches/${queryPredicate}${isAddress ? "" : "/*"}?unspent`;
-    const schema = S3.Array(UTxOSchema);
+    const pattern = `${this.kupoUrl}/matches/${queryPredicate}${isAddress ? "" : "/*"}?unspent&resolve_hashes`;
+    const schema = S3.Array(ResolvedUTxOSchema);
     const utxos = await runProviderEffect(
       pipe3(
-        makeGet(pattern, schema, this.headers?.kupoHeader),
-        Effect2.flatMap(
-          (u) => kupmiosUtxosToUtxos(this.kupoUrl, u, this.headers?.kupoHeader)
-        ),
-        Effect2.timeout(1e4),
+        makeGet(pattern, schema, this.options.kupoHeader),
+        Effect2.map(kupmiosUtxosToUtxos),
+        Effect2.timeout(this.requestTimeoutMs),
         catchProviderError("kupo", "getUtxos"),
         Effect2.provide(FetchHttpClient.layer)
       ),
@@ -1097,15 +1115,13 @@ var Kupmios = class {
     const isAddress = typeof addressOrCredential === "string";
     const queryPredicate = isAddress ? addressOrCredential : addressOrCredential.hash;
     const { policyId, assetName } = fromUnit2(unit);
-    const pattern = `${this.kupoUrl}/matches/${queryPredicate}${isAddress ? "" : "/*"}?unspent&policy_id=${policyId}${assetName ? `&asset_name=${assetName}` : ""}`;
-    const schema = S3.Array(UTxOSchema);
+    const pattern = `${this.kupoUrl}/matches/${queryPredicate}${isAddress ? "" : "/*"}?unspent&resolve_hashes&policy_id=${policyId}${assetName ? `&asset_name=${assetName}` : ""}`;
+    const schema = S3.Array(ResolvedUTxOSchema);
     const utxos = await runProviderEffect(
       pipe3(
-        makeGet(pattern, schema, this.headers?.kupoHeader),
-        Effect2.flatMap(
-          (u) => kupmiosUtxosToUtxos(this.kupoUrl, u, this.headers?.kupoHeader)
-        ),
-        Effect2.timeout(1e4),
+        makeGet(pattern, schema, this.options.kupoHeader),
+        Effect2.map(kupmiosUtxosToUtxos),
+        Effect2.timeout(this.requestTimeoutMs),
         catchProviderError("kupo", "getUtxosWithUnit"),
         Effect2.provide(FetchHttpClient.layer)
       ),
@@ -1123,15 +1139,13 @@ var Kupmios = class {
     const normalizedPolicyId = policyId.toLowerCase();
     const isAddress = typeof addressOrCredential === "string";
     const queryPredicate = isAddress ? addressOrCredential : addressOrCredential.hash;
-    const pattern = `${this.kupoUrl}/matches/${queryPredicate}${isAddress ? "" : "/*"}?unspent&policy_id=${normalizedPolicyId}`;
-    const schema = S3.Array(UTxOSchema);
+    const pattern = `${this.kupoUrl}/matches/${queryPredicate}${isAddress ? "" : "/*"}?unspent&resolve_hashes&policy_id=${normalizedPolicyId}`;
+    const schema = S3.Array(ResolvedUTxOSchema);
     return runProviderEffect(
       pipe3(
-        makeGet(pattern, schema, this.headers?.kupoHeader),
-        Effect2.flatMap(
-          (utxos) => kupmiosUtxosToUtxos(this.kupoUrl, utxos, this.headers?.kupoHeader)
-        ),
-        Effect2.timeout(1e4),
+        makeGet(pattern, schema, this.options.kupoHeader),
+        Effect2.map(kupmiosUtxosToUtxos),
+        Effect2.timeout(this.requestTimeoutMs),
         catchProviderError("kupo", "getUtxosWithPolicy"),
         Effect2.provide(FetchHttpClient.layer)
       ),
@@ -1141,15 +1155,13 @@ var Kupmios = class {
   }
   async getUtxoByUnit(unit) {
     const { policyId, assetName } = fromUnit2(unit);
-    const pattern = `${this.kupoUrl}/matches/${policyId}.${assetName ?? ""}?unspent`;
-    const schema = S3.Array(UTxOSchema);
+    const pattern = `${this.kupoUrl}/matches/${policyId}.${assetName ?? ""}?unspent&resolve_hashes`;
+    const schema = S3.Array(ResolvedUTxOSchema);
     const utxos = await runProviderEffect(
       pipe3(
-        makeGet(pattern, schema, this.headers?.kupoHeader),
-        Effect2.flatMap(
-          (u) => kupmiosUtxosToUtxos(this.kupoUrl, u, this.headers?.kupoHeader)
-        ),
-        Effect2.timeout(1e4),
+        makeGet(pattern, schema, this.options.kupoHeader),
+        Effect2.map(kupmiosUtxosToUtxos),
+        Effect2.timeout(this.requestTimeoutMs),
         catchProviderError("kupo", "getUtxoByUnit"),
         Effect2.provide(FetchHttpClient.layer)
       ),
@@ -1168,16 +1180,14 @@ var Kupmios = class {
     const queryHashes = [
       ...new Set(outRefs.map((outRef) => outRef.txHash))
     ];
-    const mkPattern = (txHash) => `${this.kupoUrl}/matches/*@${txHash}?unspent`;
-    const schema = S3.Array(UTxOSchema);
+    const mkPattern = (txHash) => `${this.kupoUrl}/matches/*@${txHash}?unspent&resolve_hashes`;
+    const schema = S3.Array(ResolvedUTxOSchema);
     const program = Effect2.forEach(
       queryHashes,
       (txHash) => pipe3(
-        makeGet(mkPattern(txHash), schema, this.headers?.kupoHeader),
-        Effect2.flatMap(
-          (u) => kupmiosUtxosToUtxos(this.kupoUrl, u, this.headers?.kupoHeader)
-        ),
-        Effect2.timeout(1e4),
+        makeGet(mkPattern(txHash), schema, this.options.kupoHeader),
+        Effect2.map(kupmiosUtxosToUtxos),
+        Effect2.timeout(this.requestTimeoutMs),
         catchProviderError("kupo", "getUtxosByOutRef")
       )
     );
@@ -1206,10 +1216,10 @@ var Kupmios = class {
           this.ogmiosUrl,
           data,
           schema,
-          this.headers?.ogmiosHeader
+          this.options.ogmiosHeader
         ),
         Effect2.provide(FetchHttpClient.layer),
-        Effect2.timeout(1e4),
+        Effect2.timeout(this.requestTimeoutMs),
         catchProviderError("ogmios", "queryLedgerState/rewardAccountSummaries")
       ),
       "ogmios",
@@ -1231,9 +1241,9 @@ var Kupmios = class {
     const schema = DatumSchema;
     const result = await runProviderEffect(
       pipe3(
-        makeGet(pattern, schema, this.headers?.kupoHeader),
+        makeGet(pattern, schema, this.options.kupoHeader),
         Effect2.provide(FetchHttpClient.layer),
-        Effect2.timeout(1e4),
+        Effect2.timeout(this.requestTimeoutMs),
         Effect2.flatMap(Effect2.fromNullable),
         catchProviderError("kupo", "getDatum")
       ),
@@ -1249,8 +1259,8 @@ var Kupmios = class {
     });
     const matches = await runProviderEffect(
       pipe3(
-        makeGet(pattern, schema, this.headers?.kupoHeader),
-        Effect2.timeout(1e4),
+        makeGet(pattern, schema, this.options.kupoHeader),
+        Effect2.timeout(this.requestTimeoutMs),
         catchProviderError("kupo", "getTransactionStatus"),
         Effect2.provide(FetchHttpClient.layer)
       ),
@@ -1277,13 +1287,13 @@ var Kupmios = class {
     });
     const result = await runProviderEffect(
       pipe3(
-        makeGet(pattern, schema, this.headers?.kupoHeader),
+        makeGet(pattern, schema, this.options.kupoHeader),
         Effect2.provide(FetchHttpClient.layer),
         Effect2.repeat({
           schedule: Schedule.exponential(checkInterval),
           until: (result2) => result2.length > 0
         }),
-        Effect2.timeout(16e4),
+        Effect2.timeout(this.awaitTxTimeoutMs),
         catchProviderError("kupo", "awaitTx"),
         Effect2.as(true)
       ),
@@ -1314,10 +1324,10 @@ var Kupmios = class {
           this.ogmiosUrl,
           data,
           schema,
-          this.headers?.ogmiosHeader
+          this.options.ogmiosHeader
         ),
         Effect2.provide(FetchHttpClient.layer),
-        Effect2.timeout(1e4),
+        Effect2.timeout(this.requestTimeoutMs),
         catchProviderError("ogmios", "submitTransaction")
       ),
       "ogmios",
@@ -1347,10 +1357,10 @@ var Kupmios = class {
           this.ogmiosUrl,
           data,
           schema,
-          this.headers?.ogmiosHeader
+          this.options.ogmiosHeader
         ),
         Effect2.provide(FetchHttpClient.layer),
-        Effect2.timeout(1e4),
+        Effect2.timeout(this.requestTimeoutMs),
         catchProviderError("ogmios", "evaluateTransaction")
       ),
       "ogmios",
@@ -1372,59 +1382,6 @@ var Kupmios = class {
     return evalRedeemers;
   }
 };
-var getDatumEffect = (kupoUrl, datum_type, datum_hash, kupoHeader) => Effect2.gen(function* () {
-  if (datum_type === "inline" && datum_hash) {
-    const pattern = `${kupoUrl}/datums/${datum_hash}`;
-    const schema = DatumSchema;
-    return yield* pipe3(
-      makeGet(pattern, schema, kupoHeader),
-      Effect2.flatMap(Effect2.fromNullable),
-      Effect2.map((result) => result.datum),
-      Effect2.retry(
-        Schedule.compose(Schedule.exponential(50), Schedule.recurs(5))
-      ),
-      Effect2.timeout(5e3)
-    );
-  } else return void 0;
-});
-var getScriptEffect = (kupoUrl, script_hash, kupoHeader) => Effect2.gen(function* () {
-  if (script_hash) {
-    const pattern = `${kupoUrl}/scripts/${script_hash}`;
-    const schema = ScriptSchema;
-    return yield* pipe3(
-      makeGet(pattern, schema, kupoHeader),
-      Effect2.flatMap(Effect2.fromNullable),
-      Effect2.retry(
-        Schedule.compose(Schedule.exponential(50), Schedule.recurs(5))
-      ),
-      Effect2.timeout(5e3),
-      Effect2.map(({ language, script }) => {
-        switch (language) {
-          case "native":
-            return {
-              type: "Native",
-              script
-            };
-          case "plutus:v1":
-            return {
-              type: "PlutusV1",
-              script: applyDoubleCborEncoding2(script)
-            };
-          case "plutus:v2":
-            return {
-              type: "PlutusV2",
-              script: applyDoubleCborEncoding2(script)
-            };
-          case "plutus:v3":
-            return {
-              type: "PlutusV3",
-              script: applyDoubleCborEncoding2(script)
-            };
-        }
-      })
-    );
-  } else return void 0;
-});
 var toAssets = (value) => {
   const assets = { lovelace: BigInt(value.coins) };
   for (const unit of Object.keys(value.assets)) {
@@ -1473,29 +1430,37 @@ var toRewardAccountState = (result) => {
     rewards: BigInt(delegation.rewards.ada.lovelace)
   };
 };
-var kupmiosUtxosToUtxos = (kupoURL, utxos, kupoHeader) => Effect2.forEach(
-  utxos,
-  (utxo) => {
-    return pipe3(
-      Effect2.all([
-        getDatumEffect(kupoURL, utxo.datum_type, utxo.datum_hash, kupoHeader),
-        getScriptEffect(kupoURL, utxo.script_hash, kupoHeader)
-      ]),
-      Effect2.map(
-        ([datum, script]) => ({
-          txHash: utxo.transaction_id,
-          outputIndex: utxo.output_index,
-          address: utxo.address,
-          assets: toAssets(utxo.value),
-          datumHash: utxo.datum_type === "hash" ? utxo.datum_hash : void 0,
-          datum,
-          scriptRef: script
-        })
-      )
-    );
-  },
-  { concurrency: "unbounded" }
-);
+var toScriptRef = (script) => {
+  if (!script) return void 0;
+  switch (script.language) {
+    case "native":
+      return { type: "Native", script: script.script };
+    case "plutus:v1":
+      return {
+        type: "PlutusV1",
+        script: applyDoubleCborEncoding2(script.script)
+      };
+    case "plutus:v2":
+      return {
+        type: "PlutusV2",
+        script: applyDoubleCborEncoding2(script.script)
+      };
+    case "plutus:v3":
+      return {
+        type: "PlutusV3",
+        script: applyDoubleCborEncoding2(script.script)
+      };
+  }
+};
+var kupmiosUtxosToUtxos = (utxos) => utxos.map((utxo) => ({
+  txHash: utxo.transaction_id,
+  outputIndex: utxo.output_index,
+  address: utxo.address,
+  assets: toAssets(utxo.value),
+  datumHash: utxo.datum_type === "hash" ? utxo.datum_hash : void 0,
+  datum: utxo.datum_type === "inline" ? utxo.datum : void 0,
+  scriptRef: toScriptRef(utxo.script)
+}));
 
 // src/emulator.ts
 import {
@@ -2811,7 +2776,7 @@ var Maestro = class {
       address: result.address,
       datumHash: result.datum ? result.datum.type == "inline" ? void 0 : result.datum.hash : void 0,
       datum: result.datum?.bytes,
-      scriptRef: toScriptRef(result.reference_script)
+      scriptRef: toScriptRef2(result.reference_script)
     };
   }
   async getAllPagesData(getResponse, qry, paramsGiven, errorMsg) {
@@ -2862,7 +2827,7 @@ var Maestro = class {
     return result;
   }
 };
-var toScriptRef = (reference_script) => {
+var toScriptRef2 = (reference_script) => {
   if (reference_script && reference_script.bytes) {
     switch (reference_script.type) {
       case "native":
@@ -3144,9 +3109,9 @@ var toUTxO = (koiosUTxO, address) => ({
   address,
   datumHash: koiosUTxO.inline_datum ? void 0 : koiosUTxO.datum_hash || void 0,
   datum: koiosUTxO.inline_datum ? koiosUTxO.inline_datum.bytes : void 0,
-  scriptRef: toScriptRef2(koiosUTxO.reference_script)
+  scriptRef: toScriptRef3(koiosUTxO.reference_script)
 });
-var toScriptRef2 = (reference_script) => {
+var toScriptRef3 = (reference_script) => {
   if (reference_script && reference_script.bytes && reference_script.type) {
     switch (reference_script.type) {
       case "plutusV1":

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lucid-evolution/provider",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -32,8 +32,8 @@
     "effect": "^3.11.7",
     "@lucid-evolution/core-types": "0.3.0",
     "@lucid-evolution/core-utils": "0.1.16",
-    "@lucid-evolution/utils": "0.1.72",
-    "@lucid-evolution/wallet": "0.2.0"
+    "@lucid-evolution/utils": "0.1.73",
+    "@lucid-evolution/wallet": "0.2.1"
   },
   "devDependencies": {
     "@types/node": "^20.12.8",