@midnightntwrk/wallet-sdk-capabilities 3.3.1

package/dist/simulation/index.js

@@ -0,0 +1,26 @@
+// This file is part of MIDNIGHT-WALLET-SDK.
+// Copyright (C) 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.
+// Re-export everything from SimulatorState
+export { 
+// State accessor functions (composable with simulator.query())
+getLastBlock, getCurrentBlockNumber, getCurrentTime, getBlockByNumber, getLastBlockResults, getLastBlockEvents, getBlockEventsFrom, getBlockEventsSince, hasPendingTransactions, 
+// State transformation functions
+resolveFullness, allMempoolTransactions, blankState, addToMempool, removeFromMempool, advanceTime, updateLedger, appendBlock, applyTransaction, 
+// Block production functions
+processTransaction, processTransactions, createBlock, createEmptyBlock, 
+// Helper functions
+createStrictness, blockHash, assignStrictness, assignStrictnessToAll, 
+// Strictness constants
+defaultStrictness, genesisStrictness, } from './SimulatorState.js';
+// Re-export from Simulator
+export { Simulator, immediateBlockProducer } from './Simulator.js';

package/dist/submission/index.d.ts

@@ -0,0 +1 @@
+export * from './submissionService.js';

package/dist/submission/index.js

@@ -0,0 +1,15 @@
+/*
+ * This file is part of MIDNIGHT-WALLET-SDK.
+ * Copyright (C) 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 * from './submissionService.js';

package/dist/submission/submissionService.d.ts

@@ -0,0 +1,60 @@
+import { Effect } from 'effect';
+import { SubmissionEvent as SubmissionEventImported } from '@midnightntwrk/wallet-sdk-node-client/effect';
+import { type FinalizedTransaction } from '@midnight-ntwrk/ledger-v8';
+import { type SimulatorState } from '../simulation/Simulator.js';
+export declare const SubmissionEvent: typeof SubmissionEventImported;
+export type SubmissionEvent = SubmissionEventImported.SubmissionEvent;
+export declare namespace SubmissionEventCases {
+    type Finalized = SubmissionEventImported.Cases.Finalized;
+    type Submitted = SubmissionEventImported.Cases.Submitted;
+    type InBlock = SubmissionEventImported.Cases.InBlock;
+}
+declare const SubmissionError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").VoidIfEmpty<{ readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }>) => import("effect/Cause").YieldableError & {
+    readonly _tag: "SubmissionError";
+} & Readonly<A>;
+export declare class SubmissionError extends SubmissionError_base<{
+    message: string;
+    cause?: unknown;
+}> {
+}
+export type SubmitTransactionMethod<TTransaction> = {
+    (transaction: TTransaction, waitForStatus: 'Submitted'): Promise<SubmissionEventCases.Submitted>;
+    (transaction: TTransaction, waitForStatus: 'InBlock'): Promise<SubmissionEventCases.InBlock>;
+    (transaction: TTransaction, waitForStatus: 'Finalized'): Promise<SubmissionEventCases.Finalized>;
+    (transaction: TTransaction): Promise<SubmissionEventCases.InBlock>;
+    (transaction: TTransaction, waitForStatus?: 'Submitted' | 'InBlock' | 'Finalized'): Promise<SubmissionEvent>;
+};
+export type SubmitTransactionMethodEffect<TTransaction> = {
+    (transaction: TTransaction, waitForStatus: 'Submitted'): Effect.Effect<SubmissionEventCases.Submitted, SubmissionError>;
+    (transaction: TTransaction, waitForStatus: 'InBlock'): Effect.Effect<SubmissionEventCases.InBlock, SubmissionError>;
+    (transaction: TTransaction, waitForStatus: 'Finalized'): Effect.Effect<SubmissionEventCases.Finalized, SubmissionError>;
+    (transaction: TTransaction): Effect.Effect<SubmissionEventCases.InBlock, SubmissionError>;
+    (transaction: TTransaction, waitForStatus?: 'Submitted' | 'InBlock' | 'Finalized'): Effect.Effect<SubmissionEvent, SubmissionError>;
+};
+export interface SubmissionServiceEffect<TTransaction> {
+    submitTransaction: SubmitTransactionMethodEffect<TTransaction>;
+    close(): Effect.Effect<void>;
+}
+export interface SubmissionService<TTransaction> {
+    submitTransaction: SubmitTransactionMethod<TTransaction>;
+    close(): Promise<void>;
+}
+export type DefaultSubmissionConfiguration = {
+    relayURL: URL;
+};
+export declare const makeDefaultSubmissionServiceEffect: <TTransaction extends {
+    serialize: () => Uint8Array;
+} = FinalizedTransaction>(config: DefaultSubmissionConfiguration) => SubmissionServiceEffect<TTransaction>;
+export declare const makeDefaultSubmissionService: <TTransaction extends {
+    serialize: () => Uint8Array;
+} = FinalizedTransaction>(config: DefaultSubmissionConfiguration) => SubmissionService<TTransaction>;
+export type SimulatorSubmissionConfiguration<TTransaction> = {
+    simulator: {
+        submitTransaction: (transaction: TTransaction) => Effect.Effect<void, Error>;
+        getLatestState: () => Effect.Effect<SimulatorState>;
+    };
+};
+export declare const makeSimulatorSubmissionService: <TTransaction extends {
+    serialize: () => Uint8Array;
+}>(waitForStatus?: "Submitted" | "InBlock" | "Finalized") => (config: SimulatorSubmissionConfiguration<TTransaction>) => SubmissionServiceEffect<TTransaction>;
+export {};

package/dist/submission/submissionService.js

@@ -0,0 +1,86 @@
+// This file is part of MIDNIGHT-WALLET-SDK.
+// Copyright (C) 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, Deferred, Effect, Encoding, Exit, pipe, Scope } from 'effect';
+import { NodeClient, PolkadotNodeClient, SubmissionEvent as SubmissionEventImported, } from '@midnightntwrk/wallet-sdk-node-client/effect';
+import { SerializedTransaction } from '@midnightntwrk/wallet-sdk-abstractions';
+import { getLastBlock } from '../simulation/Simulator.js';
+export const SubmissionEvent = SubmissionEventImported;
+export class SubmissionError extends Data.TaggedError('SubmissionError') {
+}
+export const makeDefaultSubmissionServiceEffect = (config) => {
+    const scopeAndClientDeferred = Deferred.make().pipe(Effect.runSync);
+    const makeScopeAndClient = Effect.gen(function* () {
+        const scope = yield* Scope.make();
+        const client = yield* PolkadotNodeClient.make({
+            nodeURL: config.relayURL,
+        }).pipe(Effect.provideService(Scope.Scope, scope));
+        return { scope, client };
+    });
+    void pipe(scopeAndClientDeferred, Deferred.complete(makeScopeAndClient), Effect.runPromise);
+    const submit = (transaction, waitForStatus = 'InBlock') => {
+        return pipe(NodeClient.sendMidnightTransactionAndWait(SerializedTransaction.from(transaction), waitForStatus), Effect.provideServiceEffect(NodeClient.NodeClient, pipe(scopeAndClientDeferred, Deferred.await, Effect.map(({ client }) => client))), Effect.mapError((err) => new SubmissionError({ message: 'Transaction submission error', cause: err })));
+    };
+    return {
+        submitTransaction: submit,
+        close() {
+            return pipe(scopeAndClientDeferred, Deferred.await, Effect.flatMap(({ scope }) => Scope.close(scope, Exit.void)), Effect.ignoreLogged);
+        },
+    };
+};
+export const makeDefaultSubmissionService = (config) => {
+    const effectService = makeDefaultSubmissionServiceEffect(config);
+    const submit = (transaction, waitForStatus = 'InBlock') => effectService.submitTransaction(transaction, waitForStatus).pipe(Effect.runPromise);
+    return {
+        submitTransaction: submit,
+        close: () => effectService.close().pipe(Effect.runPromise),
+    };
+};
+export const makeSimulatorSubmissionService = (waitForStatus = 'InBlock') => (config) => {
+    const submit = (transaction) => {
+        return pipe(config.simulator.submitTransaction(transaction), 
+        // Wait for stream-based block production
+        Effect.andThen(Effect.sleep('100 millis')), Effect.andThen(config.simulator.getLatestState())).pipe(Effect.map((state) => {
+            const lastBlock = getLastBlock(state);
+            const blockNumber = lastBlock?.number ?? 0n;
+            const blockHash = lastBlock?.hash ?? '';
+            const serializedTransaction = SerializedTransaction.from(transaction);
+            const fakeTxHash = Encoding.encodeHex(serializedTransaction).slice(0, 64);
+            // Let's mimic node's client behavior here
+            switch (waitForStatus) {
+                case 'Submitted':
+                    return SubmissionEvent.Submitted({
+                        tx: serializedTransaction,
+                        txHash: fakeTxHash,
+                    });
+                case 'InBlock':
+                    return SubmissionEvent.InBlock({
+                        tx: serializedTransaction,
+                        blockHash,
+                        blockHeight: blockNumber,
+                        txHash: fakeTxHash,
+                    });
+                case 'Finalized':
+                    return SubmissionEvent.Finalized({
+                        tx: serializedTransaction,
+                        blockHash,
+                        blockHeight: blockNumber,
+                        txHash: fakeTxHash,
+                    });
+            }
+        }), Effect.mapError((err) => new SubmissionError({ message: 'Transaction submission error', cause: err })));
+    };
+    return {
+        submitTransaction: submit,
+        close: () => Effect.void,
+    };
+};

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "@midnightntwrk/wallet-sdk-capabilities",
+  "version": "3.3.1",
+  "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://registry.npmjs.org/",
+    "access": "public"
+  },
+  "files": [
+    "dist/"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/midnightntwrk/midnight-wallet.git",
+    "directory": "packages/capabilities"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./balancer": {
+      "types": "./dist/balancer/index.d.ts",
+      "import": "./dist/balancer/index.js"
+    },
+    "./submission": {
+      "types": "./dist/submission/index.d.ts",
+      "import": "./dist/submission/index.js"
+    },
+    "./pendingTransactions": {
+      "types": "./dist/pendingTransactions/index.d.ts",
+      "import": "./dist/pendingTransactions/index.js"
+    },
+    "./proving": {
+      "types": "./dist/proving/index.d.ts",
+      "import": "./dist/proving/index.js"
+    },
+    "./simulation": {
+      "types": "./dist/simulation/index.d.ts",
+      "import": "./dist/simulation/index.js"
+    }
+  },
+  "dependencies": {
+    "@midnight-ntwrk/ledger-v8": "^8.1.0",
+    "@midnight-ntwrk/zkir-v2": "^2.1.0",
+    "@midnightntwrk/wallet-sdk-abstractions": "^2.1.0",
+    "@midnightntwrk/wallet-sdk-indexer-client": "^1.2.2",
+    "@midnightntwrk/wallet-sdk-node-client": "^1.1.2",
+    "@midnightntwrk/wallet-sdk-prover-client": "^1.2.2",
+    "@midnightntwrk/wallet-sdk-utilities": "^1.2.0",
+    "effect": "^3.19.19",
+    "rxjs": "^7.8.2"
+  },
+  "devDependencies": {
+    "@effect/cluster": "0.59.0",
+    "@effect/experimental": "0.60.0",
+    "@effect/platform": "0.96.1",
+    "@effect/platform-node": "0.107.0",
+    "@effect/rpc": "0.75.1",
+    "@effect/sql": "0.51.1",
+    "@effect/workflow": "0.18.2"
+  },
+  "scripts": {
+    "typecheck": "tsc -b ./tsconfig.json --noEmit --force",
+    "test": "vitest run",
+    "lint": "eslint --max-warnings 0",
+    "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",
+    "publint": "publint --strict"
+  }
+}