@midnight-ntwrk/wallet-sdk-prover-client 1.0.0-beta.10

package/dist/effect/HttpProverClient.d.ts

@@ -0,0 +1,11 @@
+import { Layer } from 'effect';
+import { ProverClient } from './ProverClient.js';
+import { InvalidProtocolSchemeError } from '@midnight-ntwrk/wallet-sdk-utilities/networking';
+/**
+ * Creates a layer for a {@link ProverClient} that sends requests to a Proof Server over HTTP.
+ *
+ * @param config The server configuration to use when configuring the HTTP elements of the layer.
+ * @returns A `Layer` for {@link ProverClient} that sends requests to a configured Proof Server over HTTP.
+ * The layer can fail with an `InvalidProtocolSchemeError` if `config` is invalid for a HTTP context.
+ */
+export declare const layer: (config: ProverClient.ServerConfig) => Layer.Layer<ProverClient, InvalidProtocolSchemeError>;

package/dist/effect/HttpProverClient.js

@@ -0,0 +1,73 @@
+// This file is part of MIDNIGHT-WALLET-SDK.
+// Copyright (C) 2025 Midnight Foundation
+// SPDX-License-Identifier: Apache-2.0
+// Licensed under the Apache License, Version 2.0 (the "License");
+// You may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+import { Chunk, Duration, Effect, Either, Layer, pipe, Schedule, Stream } from 'effect';
+import { FetchHttpClient, HttpClient, HttpClientRequest } from '@effect/platform';
+import { SerializedTransaction, SerializedUnprovenTransaction } from '@midnight-ntwrk/wallet-sdk-abstractions';
+import { ProverClient } from './ProverClient.js';
+import { ClientError, ServerError, HttpURL, } from '@midnight-ntwrk/wallet-sdk-utilities/networking';
+import { BlobOps } from '@midnight-ntwrk/wallet-sdk-utilities';
+import * as ledger from '@midnight-ntwrk/ledger-v6';
+const PROVE_TX_PATH = '/prove';
+const CHECK_TX_PATH = '/check';
+/**
+ * Creates a layer for a {@link ProverClient} that sends requests to a Proof Server over HTTP.
+ *
+ * @param config The server configuration to use when configuring the HTTP elements of the layer.
+ * @returns A `Layer` for {@link ProverClient} that sends requests to a configured Proof Server over HTTP.
+ * The layer can fail with an `InvalidProtocolSchemeError` if `config` is invalid for a HTTP context.
+ */
+export const layer = (config) => Layer.effect(ProverClient, HttpURL.make(new URL(config.url)).pipe(Either.map((baseUrl) => new HttpProverClientImpl(baseUrl)), Either.match({
+    onLeft: (l) => Effect.fail(l),
+    onRight: (r) => Effect.succeed(r),
+})));
+class HttpProverClientImpl {
+    constructor(baseUrl) {
+        this.baseUrl = baseUrl;
+    }
+    baseUrl;
+    request(path, transaction, failurePrefix) {
+        const concatBytes = (chunks) => Effect.promise(() => BlobOps.getBytes(new Blob(chunks)));
+        const receiveBody = (response) => pipe(response.stream, Stream.runCollect, Effect.flatMap((chunks) => concatBytes(Chunk.toArray(chunks))));
+        // Build endpoint URL from the already validated base URL
+        const url = HttpURL.HttpURL(new URL(path, this.baseUrl));
+        const proveTxRequest = pipe(Effect.succeed(transaction), Effect.map((body) => HttpClientRequest.post(url).pipe(HttpClientRequest.bodyUint8Array(body))), Effect.flatMap(HttpClient.execute), Effect.flatMap((response) => Effect.gen(function* () {
+            if (response.status !== 200) {
+                const text = yield* response.text;
+                return yield* new ClientError({ message: `${failurePrefix}: ${text}` });
+            }
+            return yield* receiveBody(response);
+        })), Effect.retry({
+            times: 3,
+            while: (error) => 
+            // Retry if we get a Bad Gateway, Service Unavailable, or Gateway Timeout error.
+            error._tag === 'ResponseError' && error.response.status >= 502 && error.response.status <= 504,
+            schedule: Schedule.exponential(Duration.seconds(2), 2),
+        }));
+        return proveTxRequest.pipe(Effect.map(SerializedTransaction), Effect.catchTags({
+            RequestError: (err) => new ClientError({ message: `Failed to connect to Proof Server: ${err.message}` }),
+            ResponseError: (err) => Effect.orElseSucceed(err.response.text, () => 'Unknown server error').pipe(Effect.flatMap((message) => new ServerError({ message }))),
+        }), Effect.provide(FetchHttpClient.layer));
+    }
+    serverProverProvider = () => ({
+        check: async (serializedPreimage, _keyLocation) => pipe(Effect.succeed(ledger.createCheckPayload(serializedPreimage)), Effect.map(SerializedTransaction), Effect.flatMap((tx) => this.request(CHECK_TX_PATH, tx, 'Failed to check')), Effect.map((response) => ledger.parseCheckResult(response)), Effect.runPromise),
+        prove: async (serializedPreimage, _keyLocation, overwriteBindingInput) => pipe(Effect.succeed(ledger.createProvingPayload(serializedPreimage, overwriteBindingInput)), Effect.map(SerializedUnprovenTransaction), Effect.flatMap((tx) => this.request(PROVE_TX_PATH, tx, 'Failed to prove')), Effect.runPromise),
+    });
+    proveTransaction(transaction, costModel) {
+        return pipe(Effect.succeed(this.serverProverProvider()), Effect.flatMap((provider) => Effect.tryPromise({
+            try: () => transaction.prove(provider, costModel),
+            catch: (error) => error instanceof ClientError || error instanceof ServerError
+                ? error
+                : new ClientError({ message: 'Failed to prove transaction', cause: error }),
+        })));
+    }
+}

package/dist/effect/ProverClient.d.ts

@@ -0,0 +1,29 @@
+import { Effect, Context } from 'effect';
+import * as ledger from '@midnight-ntwrk/ledger-v6';
+import { ClientError, ServerError } from '@midnight-ntwrk/wallet-sdk-utilities/networking';
+declare const ProverClient_base: Context.TagClass<ProverClient, "@midnight-ntwrk/prover-client#ProverClient", ProverClient.Service>;
+/**
+ * A client that provides proof services for unproven transactions.
+ */
+export declare class ProverClient extends ProverClient_base {
+}
+export declare namespace ProverClient {
+    /**
+     * Provides server related configuration for {@link ProverClient} implementations.
+     */
+    interface ServerConfig {
+        /** The base URL to the Proof Server. */
+        readonly url: URL | string;
+    }
+    interface Service {
+        /**
+         * Proves an unproven transaction by submitting it to an associated Proof Server.
+         *
+         * @param transaction A serialized unproven transaction.
+         * @returns An `Effect` that yields with a serialized transaction representing the proven version of `transaction`;
+         * or fails with a client or server side error.
+         */
+        proveTransaction<S extends ledger.Signaturish, B extends ledger.Bindingish>(tx: ledger.Transaction<S, ledger.PreProof, B>, costModel?: ledger.CostModel): Effect.Effect<ledger.Transaction<S, ledger.Proof, B>, ClientError | ServerError>;
+    }
+}
+export {};

package/dist/effect/ProverClient.js

@@ -0,0 +1,18 @@
+// This file is part of MIDNIGHT-WALLET-SDK.
+// Copyright (C) 2025 Midnight Foundation
+// SPDX-License-Identifier: Apache-2.0
+// Licensed under the Apache License, Version 2.0 (the "License");
+// You may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+import { Context } from 'effect';
+/**
+ * A client that provides proof services for unproven transactions.
+ */
+export class ProverClient extends Context.Tag('@midnight-ntwrk/prover-client#ProverClient')() {
+}

package/dist/effect/index.d.ts

@@ -0,0 +1,2 @@
+export * as ProverClient from './ProverClient.js';
+export * as HttpProverClient from './HttpProverClient.js';

package/dist/effect/index.js

@@ -0,0 +1,14 @@
+// This file is part of MIDNIGHT-WALLET-SDK.
+// Copyright (C) 2025 Midnight Foundation
+// SPDX-License-Identifier: Apache-2.0
+// Licensed under the Apache License, Version 2.0 (the "License");
+// You may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+export * as ProverClient from './ProverClient.js';
+export * as HttpProverClient from './HttpProverClient.js';

package/dist/index.d.ts

@@ -0,0 +1,30 @@
+import { ProverClient } from './effect/index.js';
+import * as ledger from '@midnight-ntwrk/ledger-v6';
+/**
+ * Sends serialized unproven transactions to a Proof Server over HTTP.
+ */
+export declare class HttpProverClient {
+    #private;
+    /**
+     * Initializes a new {@link HttpProverClient}.
+     *
+     * @param config The server configuration to use when configuring the HTTP elements of the Proof Server.
+     * @throws {@link ProverClient.InvalidProtocolSchemeError}
+     * The `config` is invalid for a HTTP context. E.g., expecting 'http:' or 'https:' URLs but something other
+     * was provided.
+     */
+    constructor(config: ProverClient.ProverClient.ServerConfig);
+    /**
+     * Proves an unproven transaction by submitting it over HTTP to an associated Proof Server.
+     *
+     * @param transaction An unproven ledger transaction.
+     * @returns A `Promise` that resolves with a proven transaction or fails with a client or server side error.
+     * @throws {@link ClientError}
+     * There was an issue with the provided `transaction`, or a connection with the configured Proof
+     * Server could not be initiated.
+     * @throws {@link ServerError}
+     * Unable to establish a connection with the configured Proof Server, or there was an internal error that
+     * prevented the proof request from being executed.
+     */
+    proveTransaction<S extends ledger.Signaturish, B extends ledger.Bindingish>(transaction: ledger.Transaction<S, ledger.PreProof, B>, costModel?: ledger.CostModel): Promise<ledger.Transaction<S, ledger.Proof, B>>;
+}

package/dist/index.js

@@ -0,0 +1,48 @@
+// This file is part of MIDNIGHT-WALLET-SDK.
+// Copyright (C) 2025 Midnight Foundation
+// SPDX-License-Identifier: Apache-2.0
+// Licensed under the Apache License, Version 2.0 (the "License");
+// You may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+import { Effect } from 'effect';
+import { ProverClient, HttpProverClient as _HttpProverClient } from './effect/index.js';
+/**
+ * Sends serialized unproven transactions to a Proof Server over HTTP.
+ */
+export class HttpProverClient {
+    #innerClient;
+    /**
+     * Initializes a new {@link HttpProverClient}.
+     *
+     * @param config The server configuration to use when configuring the HTTP elements of the Proof Server.
+     * @throws {@link ProverClient.InvalidProtocolSchemeError}
+     * The `config` is invalid for a HTTP context. E.g., expecting 'http:' or 'https:' URLs but something other
+     * was provided.
+     */
+    constructor(config) {
+        this.#innerClient = Effect.gen(function* () {
+            return yield* ProverClient.ProverClient;
+        }).pipe(Effect.provide(_HttpProverClient.layer(config)), Effect.runSync);
+    }
+    /**
+     * Proves an unproven transaction by submitting it over HTTP to an associated Proof Server.
+     *
+     * @param transaction An unproven ledger transaction.
+     * @returns A `Promise` that resolves with a proven transaction or fails with a client or server side error.
+     * @throws {@link ClientError}
+     * There was an issue with the provided `transaction`, or a connection with the configured Proof
+     * Server could not be initiated.
+     * @throws {@link ServerError}
+     * Unable to establish a connection with the configured Proof Server, or there was an internal error that
+     * prevented the proof request from being executed.
+     */
+    proveTransaction(transaction, costModel) {
+        return this.#innerClient.proveTransaction(transaction, costModel).pipe(Effect.runPromise);
+    }
+}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@midnight-ntwrk/wallet-sdk-prover-client",
+  "version": "1.0.0-beta.10",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "author": "Midnight Foundation",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "registry": "https://npm.pkg.github.com/"
+  },
+  "files": [
+    "dist/"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/midnight-ntwrk/artifacts.git"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./effect": {
+      "types": "./dist/effect/index.d.ts",
+      "import": "./dist/effect/index.js"
+    }
+  },
+  "dependencies": {
+    "@effect/platform": "^0.90.0",
+    "@midnight-ntwrk/ledger-v6": "6.1.0-alpha.6",
+    "@midnight-ntwrk/wallet-sdk-abstractions": "1.0.0-beta.9",
+    "@midnight-ntwrk/wallet-sdk-utilities": "1.0.0-beta.7",
+    "effect": "^3.17.3"
+  },
+  "devDependencies": {
+    "eslint": "^9.37.0",
+    "publint": "~0.3.14",
+    "rimraf": "^6.0.1",
+    "testcontainers": "^11.8.1",
+    "typescript": "^5.9.3",
+    "vitest": "^3.2.4"
+  },
+  "scripts": {
+    "typecheck": "tsc -b ./tsconfig.json --noEmit",
+    "test": "vitest run",
+    "lint": "eslint --max-warnings 0",
+    "format": "prettier --write \"**/*.{ts,js,json,yaml,yml}\"",
+    "format:check": "prettier --check \"**/*.{ts,js,json,yaml,yml}\"",
+    "dist": "tsc -b ./tsconfig.build.json",
+    "dist:publish": "tsc -b ./tsconfig.publish.json",
+    "clean": "rimraf --glob dist 'tsconfig.*.tsbuildinfo' && date +%s > .clean-timestamp",
+    "publint": "publint --strict"
+  }
+}