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

package/README.md

@@ -0,0 +1,88 @@
+# @midnight-ntwrk/wallet-sdk-node-client
+
+Client for communicating with the Midnight blockchain node.
+
+## Installation
+
+```bash
+npm install @midnight-ntwrk/wallet-sdk-node-client
+```
+
+## Overview
+
+This package provides a client for interacting with the Midnight blockchain node using Polkadot.js APIs. It handles:
+
+- RPC communication with the node
+- Transaction submission and tracking
+- Blockchain state queries
+- Type-safe interactions via generated types
+
+## Usage
+
+### Basic Usage
+
+```typescript
+import { PolkadotNodeClient, makeConfig } from '@midnight-ntwrk/wallet-sdk-node-client';
+
+// Initialize the client
+const config = makeConfig({ endpoint: 'ws://localhost:9944' });
+const client = await PolkadotNodeClient.init(config);
+
+// Submit a transaction and wait for finalization
+const result = await client.sendMidnightTransactionAndWait(serializedTransaction, 'Finalized');
+
+// Clean up
+await client.close();
+```
+
+### Tracking Submission Events
+
+```typescript
+// Get an observable of submission events
+const events$ = client.sendMidnightTransaction(serializedTransaction);
+
+events$.subscribe({
+  next: (event) => {
+    switch (event._tag) {
+      case 'Submitted':
+        console.log('Transaction submitted');
+        break;
+      case 'InBlock':
+        console.log('Transaction in block:', event.blockHash);
+        break;
+      case 'Finalized':
+        console.log('Transaction finalized');
+        break;
+    }
+  },
+});
+```
+
+## Exports
+
+### Default Export
+
+- `PolkadotNodeClient` - Main client class for node communication
+- `Config` - Configuration type
+- `makeConfig` - Configuration factory function
+- `DEFAULT_CONFIG` - Default configuration values
+
+### Effect Submodule (`/effect`)
+
+Effect.ts-based implementation for functional programming patterns:
+
+```typescript
+import { NodeClient, PolkadotNodeClient } from '@midnight-ntwrk/wallet-sdk-node-client/effect';
+```
+
+### Testing Submodule (`/testing`)
+
+Testing utilities and mocks:
+
+```typescript
+import { ... } from '@midnight-ntwrk/wallet-sdk-node-client/testing';
+```
+
+## License
+
+Apache-2.0

package/dist/effect/NodeClient.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, Effect, Option, Stream } from 'effect';
 import * as SubmissionEvent from './SubmissionEvent.js';
 import * as NodeClientError from './NodeClientError.js';

package/dist/effect/NodeClientError.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 { Data } from 'effect';
 export class SubmissionError extends Data.TaggedError('SubmissionError') {
 }

package/dist/effect/PolkadotNodeClient.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 '../gen/augment-api.js';
 import { ApiPromise, WsProvider } from '@polkadot/api';
 import { Duration, Effect, Either, Layer, pipe, Schedule, Schema, Stream, } from 'effect';
@@ -21,6 +33,7 @@ export class PolkadotNodeClient {
             // @ts-expect-error -- exactOptionalPropertyTypes cause an incompatibility here
             provider: new WsProvider(config.nodeURL.toString()),
             throwOnConnect: false,
+            noInitWarn: true,
         })), (api) => Effect.promise(() => api.disconnect())).pipe(Effect.map((api) => new PolkadotNodeClient(config, api)));
     }
     static layer(configInput) {

package/dist/effect/SubmissionEvent.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.
 import { Data } from 'effect';
 export const { Submitted, InBlock, Finalized, $match: match, $is: is } = Data.taggedEnum();

package/dist/effect/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.
 export * as NodeClient from './NodeClient.js';
 export * from './PolkadotNodeClient.js';
 export * as SubmissionEvent from './SubmissionEvent.js';

package/dist/gen/augment-api-errors.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.
 /* eslint-disable */
 /**
  * Auto-generated with scripts/generate-types.ts

package/dist/gen/augment-api-query.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.
 /* eslint-disable */
 /**
  * Auto-generated with scripts/generate-types.ts

package/dist/gen/augment-api-tx.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.
 /* eslint-disable */
 /**
  * Auto-generated with scripts/generate-types.ts

package/dist/gen/augment-api.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.
 /* eslint-disable */
 /**
  * Auto-generated with scripts/generate-types.ts

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 { NodeClient, PolkadotNodeClient as EffectNodeClient, } from './effect/index.js';
 import { Effect, Exit, pipe, Scope } from 'effect';
 import { ObservableOps } from '@midnight-ntwrk/wallet-sdk-utilities';

package/dist/testing/index.js

@@ -1 +1,13 @@
+// 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 TestTransactions from './test-transactions.js';

package/dist/testing/normalize-txs.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 { Encoding } from 'effect';
 export function normalizeTxs(tx) {
     const normalizedTxs = {

package/dist/testing/test-transactions.d.ts

@@ -1,5 +1,5 @@
 import { Error, FileSystem } from '@effect/platform';
-import * as ledger from '@midnight-ntwrk/ledger-v6';
+import * as ledger from '@midnight-ntwrk/ledger-v7';
 import { SerializedTransaction } from '@midnight-ntwrk/wallet-sdk-abstractions';
 import { ProverClient } from '@midnight-ntwrk/wallet-sdk-prover-client/effect';
 import { ClientError, ServerError } from '@midnight-ntwrk/wallet-sdk-utilities/networking';

package/dist/testing/test-transactions.js

@@ -1,5 +1,17 @@
+// 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 { FileSystem } from '@effect/platform';
-import * as ledger from '@midnight-ntwrk/ledger-v6';
+import * as ledger from '@midnight-ntwrk/ledger-v7';
 import { SerializedTransaction } from '@midnight-ntwrk/wallet-sdk-abstractions';
 import { HttpProverClient, ProverClient } from '@midnight-ntwrk/wallet-sdk-prover-client/effect';
 import { TestContainers } from '@midnight-ntwrk/wallet-sdk-utilities/testing';

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@midnight-ntwrk/wallet-sdk-node-client",
-  "version": "1.0.0-beta.8",
+  "version": "1.0.0",
   "type": "module",
   "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/"
@@ -43,9 +43,9 @@
     "@polkadot/types-support": "^16.3.1",
     "@types/bn.js": "^5.2.0",
     "bn.js": "^5.2.2",
-    "effect": "^3.17.3",
+    "effect": "^3.19.14",
     "rxjs": "^7.5",
-    "testcontainers": "^11.4.0"
+    "testcontainers": "^11.10.0"
   },
   "devDependencies": {
     "@effect/cluster": "^0.46.2",
@@ -55,18 +55,19 @@
     "@effect/rpc": "^0.68.0",
     "@effect/sql": "^0.44.0",
     "@effect/workflow": "^0.8.1",
-    "@midnight-ntwrk/ledger-v6": "6.1.0-alpha.4",
-    "@midnight-ntwrk/wallet-sdk-abstractions": "1.0.0-beta.7",
-    "@midnight-ntwrk/wallet-sdk-prover-client": "1.0.0-beta.7",
-    "@midnight-ntwrk/wallet-sdk-utilities": "1.0.0-beta.6",
+    "@midnight-ntwrk/ledger-v7": "7.0.0",
+    "@midnight-ntwrk/wallet-sdk-abstractions": "1.0.0",
+    "@midnight-ntwrk/wallet-sdk-prover-client": "1.0.0",
+    "@midnight-ntwrk/wallet-sdk-utilities": "1.0.0",
     "@polkadot/typegen": "^16.3.1",
     "@types/yargs": "^17.0.33",
     "eslint": "^9.37.0",
+    "prettier": "^3.7.0",
     "publint": "~0.3.14",
     "rimraf": "^6.0.1",
     "tsx": "^4.20.4",
     "typescript": "^5.9.3",
-    "vitest": "^3.2.4",
+    "vitest": "^4.0.16",
     "yargs": "^18.0.0"
   },
   "scripts": {
@@ -75,7 +76,8 @@
     "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",