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

package/README.md

@@ -0,0 +1,77 @@
+# @midnight-ntwrk/wallet-sdk-prover-client
+
+Client for interacting with the Midnight ZK proof generation service.
+
+## Installation
+
+```bash
+npm install @midnight-ntwrk/wallet-sdk-prover-client
+```
+
+## Overview
+
+This package provides a client for submitting transactions to a Proof Server that generates zero-knowledge proofs. It is
+used to finalize shielded transactions by converting unproven transactions into proven ones.
+
+## Usage
+
+### Basic Usage
+
+```typescript
+import { HttpProverClient } from '@midnight-ntwrk/wallet-sdk-prover-client';
+
+// Initialize the client with the Proof Server URL
+const proverClient = new HttpProverClient({
+  serverUrl: 'http://localhost:6300',
+});
+
+// Prove an unproven transaction
+const provenTransaction = await proverClient.proveTransaction(unprovenTransaction);
+```
+
+### With Custom Cost Model
+
+```typescript
+const provenTransaction = await proverClient.proveTransaction(unprovenTransaction, customCostModel);
+```
+
+## API
+
+### HttpProverClient
+
+```typescript
+class HttpProverClient {
+  constructor(config: { serverUrl: string });
+
+  proveTransaction<S extends Signaturish, B extends Bindingish>(
+    transaction: Transaction<S, PreProof, B>,
+    costModel?: CostModel,
+  ): Promise<Transaction<S, Proof, B>>;
+}
+```
+
+## Exports
+
+### Default Export
+
+- `HttpProverClient` - HTTP client for the Proof Server
+
+### Effect Submodule (`/effect`)
+
+Effect.ts-based implementation:
+
+```typescript
+import { ProverClient, HttpProverClient } from '@midnight-ntwrk/wallet-sdk-prover-client/effect';
+```
+
+## Error Handling
+
+The client may throw the following errors:
+
+- `ClientError` - Issues with the provided transaction or connection problems
+- `ServerError` - Internal server errors or connection failures
+- `InvalidProtocolSchemeError` - Invalid URL scheme in configuration
+
+## License
+
+Apache-2.0

package/dist/effect/HttpProverClient.js

@@ -1,10 +1,22 @@
+// 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';
+import * as ledger from '@midnight-ntwrk/ledger-v7';
 const PROVE_TX_PATH = '/prove';
 const CHECK_TX_PATH = '/check';
 /**

package/dist/effect/ProverClient.d.ts

@@ -1,5 +1,5 @@
 import { Effect, Context } from 'effect';
-import * as ledger from '@midnight-ntwrk/ledger-v6';
+import * as ledger from '@midnight-ntwrk/ledger-v7';
 import { ClientError, ServerError } from '@midnight-ntwrk/wallet-sdk-utilities/networking';
 declare const ProverClient_base: Context.TagClass<ProverClient, "@midnight-ntwrk/prover-client#ProverClient", ProverClient.Service>;
 /**

package/dist/effect/ProverClient.js

@@ -1,3 +1,15 @@
+// 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.

package/dist/effect/index.js

@@ -1,2 +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

@@ -1,5 +1,5 @@
 import { ProverClient } from './effect/index.js';
-import * as ledger from '@midnight-ntwrk/ledger-v6';
+import * as ledger from '@midnight-ntwrk/ledger-v7';
 /**
  * Sends serialized unproven transactions to a Proof Server over HTTP.
  */

package/dist/index.js

@@ -1,3 +1,15 @@
+// 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';
 /**

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@midnight-ntwrk/wallet-sdk-prover-client",
-  "version": "1.0.0-beta.8",
+  "version": "1.0.0",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
-  "author": "IOHK",
+  "author": "Midnight Foundation",
   "license": "Apache-2.0",
   "publishConfig": {
     "registry": "https://npm.pkg.github.com/"
@@ -29,24 +29,26 @@
   },
   "dependencies": {
     "@effect/platform": "^0.90.0",
-    "@midnight-ntwrk/ledger-v6": "6.1.0-alpha.5",
-    "@midnight-ntwrk/wallet-sdk-abstractions": "1.0.0-beta.8",
-    "@midnight-ntwrk/wallet-sdk-utilities": "1.0.0-beta.7",
-    "effect": "^3.17.3"
+    "@midnight-ntwrk/ledger-v7": "7.0.0",
+    "@midnight-ntwrk/wallet-sdk-abstractions": "1.0.0",
+    "@midnight-ntwrk/wallet-sdk-utilities": "1.0.0",
+    "effect": "^3.19.14"
   },
   "devDependencies": {
     "eslint": "^9.37.0",
+    "prettier": "^3.7.0",
     "publint": "~0.3.14",
     "rimraf": "^6.0.1",
-    "testcontainers": "^11.4.0",
+    "testcontainers": "^11.10.0",
     "typescript": "^5.9.3",
-    "vitest": "^3.2.4"
+    "vitest": "^4.0.16"
   },
   "scripts": {
     "typecheck": "tsc -b ./tsconfig.json --noEmit",
     "test": "vitest run",
     "lint": "eslint --max-warnings 0",
-    "format": "prettier --write \"**/*.{ts,js,json,yaml,yml}\"",
+    "format": "prettier --write \"**/*.{ts,js,json,yaml,yml,md}\"",
+    "format:check": "prettier --check \"**/*.{ts,js,json,yaml,yml,md}\"",
     "dist": "tsc -b ./tsconfig.build.json",
     "dist:publish": "tsc -b ./tsconfig.publish.json",
     "clean": "rimraf --glob dist 'tsconfig.*.tsbuildinfo' && date +%s > .clean-timestamp",