@midnight-ntwrk/wallet-sdk-facade 2.0.0-rc.1 → 2.0.0-rc.3

package/dist/index.d.ts

@@ -1,13 +1,13 @@
 import * as ledger from '@midnight-ntwrk/ledger-v7';
 import { type DefaultSubmissionConfiguration, type SubmissionService } from '@midnight-ntwrk/wallet-sdk-capabilities';
+import { type DefaultProvingConfiguration, type ProvingService, type UnboundTransaction } from '@midnight-ntwrk/wallet-sdk-capabilities/proving';
 import { type AnyTransaction, type DefaultDustConfiguration, type CoinsAndBalances as DustCoinsAndBalances, type DustWalletAPI, type DustWalletState } from '@midnight-ntwrk/wallet-sdk-dust-wallet';
 import { type DefaultShieldedConfiguration, type ShieldedWalletAPI, type ShieldedWalletState } from '@midnight-ntwrk/wallet-sdk-shielded';
 import type { DefaultUnshieldedConfiguration, UnshieldedWalletAPI } from '@midnight-ntwrk/wallet-sdk-unshielded-wallet';
 import { type UnshieldedWalletState } from '@midnight-ntwrk/wallet-sdk-unshielded-wallet';
 import { type Observable } from 'rxjs';
-import { DefaultPendingTransactionsServiceConfiguration, PendingTransactions, PendingTransactionsService, PendingTransactionsServiceImpl } from '@midnight-ntwrk/wallet-sdk-capabilities';
+import { DefaultPendingTransactionsServiceConfiguration, PendingTransactions, PendingTransactionsService } from '@midnight-ntwrk/wallet-sdk-capabilities';
 import { DustAddress, ShieldedAddress, UnshieldedAddress } from '@midnight-ntwrk/wallet-sdk-address-format';
-export type UnboundTransaction = ledger.Transaction<ledger.SignatureEnabled, ledger.Proof, ledger.PreBinding>;
 type TokenKind = 'dust' | 'shielded' | 'unshielded';
 type TokenKindsToBalance = 'all' | TokenKind[];
 declare const TokenKindsToBalance: {
@@ -61,6 +61,7 @@ export type UtxoWithMeta = {
     utxo: ledger.Utxo;
     meta: {
         ctime: Date;
+        registeredForDustGeneration: boolean;
     };
 };
 export declare class FacadeState {
@@ -71,26 +72,29 @@ export declare class FacadeState {
     get isSynced(): boolean;
     constructor(shielded: ShieldedWalletState, unshielded: UnshieldedWalletState, dust: DustWalletState, pending: PendingTransactions.PendingTransactions<ledger.FinalizedTransaction>);
 }
-export type DefaultConfiguration = DefaultUnshieldedConfiguration & DefaultShieldedConfiguration & DefaultDustConfiguration & DefaultSubmissionConfiguration & DefaultPendingTransactionsServiceConfiguration;
+export type DefaultConfiguration = DefaultUnshieldedConfiguration & DefaultShieldedConfiguration & DefaultDustConfiguration & DefaultSubmissionConfiguration & DefaultPendingTransactionsServiceConfiguration & Partial<DefaultProvingConfiguration>;
 type MaybePromise<T> = T | Promise<T>;
 export type InitParams<TConfig extends DefaultConfiguration> = {
     configuration: TConfig;
     submissionService?: (config: TConfig) => MaybePromise<SubmissionService<ledger.FinalizedTransaction>>;
     pendingTransactionsService?: (config: TConfig) => MaybePromise<PendingTransactionsService<ledger.FinalizedTransaction>>;
+    provingService?: (config: TConfig) => MaybePromise<ProvingService<UnboundTransaction>>;
     shielded: (config: TConfig) => MaybePromise<ShieldedWalletAPI>;
     unshielded: (config: TConfig) => MaybePromise<UnshieldedWalletAPI>;
     dust: (config: TConfig) => MaybePromise<DustWalletAPI>;
 };
 export declare class WalletFacade {
     #private;
-    static makeDefaultSubmissionService<TConfig extends DefaultSubmissionConfiguration>(config: TConfig): SubmissionService<ledger.FinalizedTransaction>;
-    static makeDefaultPendingTransactionsService<TConfig extends DefaultPendingTransactionsServiceConfiguration>(config: TConfig): Promise<PendingTransactionsServiceImpl<ledger.FinalizedTransaction>>;
+    private static makeDefaultSubmissionService;
+    private static makeDefaultPendingTransactionsService;
+    private static makeDefaultProvingService;
     static init<TConfig extends DefaultConfiguration>(initParams: InitParams<TConfig>): Promise<WalletFacade>;
     readonly shielded: ShieldedWalletAPI;
     readonly unshielded: UnshieldedWalletAPI;
     readonly dust: DustWalletAPI;
     readonly submissionService: SubmissionService<ledger.FinalizedTransaction>;
     readonly pendingTransactionsService: PendingTransactionsService<ledger.FinalizedTransaction>;
+    readonly provingService: ProvingService<UnboundTransaction>;
     private constructor();
     private defaultTtl;
     private mergeUnprovenTransactions;

package/dist/index.js

@@ -12,6 +12,7 @@
 // limitations under the License.
 import * as ledger from '@midnight-ntwrk/ledger-v7';
 import { makeDefaultSubmissionService, } from '@midnight-ntwrk/wallet-sdk-capabilities';
+import { makeDefaultProvingService, } from '@midnight-ntwrk/wallet-sdk-capabilities/proving';
 import { Array as Arr, pipe } from 'effect';
 import { combineLatest, map, firstValueFrom, concatMap } from 'rxjs';
 import { PendingTransactions, PendingTransactionsServiceImpl, } from '@midnight-ntwrk/wallet-sdk-capabilities';
@@ -77,6 +78,16 @@ export class WalletFacade {
             txTrait: finalizedTransactionTrait,
         });
     }
+    static makeDefaultProvingService(config) {
+        if (config.provingServerUrl) {
+            return makeDefaultProvingService({
+                provingServerUrl: config.provingServerUrl,
+            });
+        }
+        else {
+            throw new Error("Missing required configuration: 'provingServerUrl' must be set in config, or provide a custom provingService in init parameters.");
+        }
+    }
     static async init(initParams) {
         const submissionService = await Promise.resolve(initParams.submissionService
             ? initParams.submissionService(initParams.configuration)
@@ -84,23 +95,28 @@ export class WalletFacade {
         const pendingTransactionsService = await Promise.resolve(initParams.pendingTransactionsService
             ? initParams.pendingTransactionsService(initParams.configuration)
             : WalletFacade.makeDefaultPendingTransactionsService(initParams.configuration));
+        const provingService = await Promise.resolve(initParams.provingService
+            ? initParams.provingService(initParams.configuration)
+            : WalletFacade.makeDefaultProvingService(initParams.configuration));
         const shielded = await Promise.resolve(initParams.shielded(initParams.configuration));
         const unshielded = await Promise.resolve(initParams.unshielded(initParams.configuration));
         const dust = await Promise.resolve(initParams.dust(initParams.configuration));
-        return new WalletFacade(shielded, unshielded, dust, submissionService, pendingTransactionsService);
+        return new WalletFacade(shielded, unshielded, dust, submissionService, pendingTransactionsService, provingService);
     }
     shielded;
     unshielded;
     dust;
     submissionService;
     pendingTransactionsService;
+    provingService;
     #pendingSubscription;
-    constructor(shieldedWallet, unshieldedWallet, dustWallet, submissionService, pendingTransactionsService) {
+    constructor(shieldedWallet, unshieldedWallet, dustWallet, submissionService, pendingTransactionsService, provingService) {
         this.shielded = shieldedWallet;
         this.unshielded = unshieldedWallet;
         this.dust = dustWallet;
         this.submissionService = submissionService;
         this.pendingTransactionsService = pendingTransactionsService;
+        this.provingService = provingService;
         this.#pendingSubscription = this.pendingTransactionsService
             .state()
             .pipe(concatMap((pending) => PendingTransactions.allFailed(pending)), concatMap((item) => this.revert(item.tx)))
@@ -116,7 +132,11 @@ export class WalletFacade {
     }
     async createDustActionTransaction(action, nightUtxos, nightVerifyingKey, signDustRegistration) {
         const ttl = this.defaultTtl();
-        const transaction = await this.dust.createDustGenerationTransaction(undefined, ttl, nightUtxos.map(({ utxo, meta }) => ({ ...utxo, ctime: meta.ctime })), nightVerifyingKey, action.type === 'registration' ? action.dustReceiverAddress : undefined);
+        const transaction = await this.dust.createDustGenerationTransaction(undefined, ttl, nightUtxos.map(({ utxo, meta }) => ({
+            ...utxo,
+            ctime: meta.ctime,
+            registeredForDustGeneration: meta.registeredForDustGeneration,
+        })), nightVerifyingKey, action.type === 'registration' ? action.dustReceiverAddress : undefined);
         const intent = transaction.intents?.get(1);
         if (!intent) {
             throw Error('Dust generation transaction is missing intent segment 1.');
@@ -300,9 +320,20 @@ export class WalletFacade {
         return await this.unshielded.signUnboundTransaction(tx, signSegment);
     }
     async finalizeTransaction(tx) {
-        const finalizedTx = await this.shielded.finalizeTransaction(tx);
-        await this.pendingTransactionsService.addPendingTransaction(finalizedTx);
-        return finalizedTx;
+        try {
+            const unboundTx = await this.provingService.prove(tx);
+            const finalizedTx = unboundTx.bind();
+            await this.pendingTransactionsService.addPendingTransaction(finalizedTx);
+            return finalizedTx;
+        }
+        catch (error) {
+            await Promise.allSettled([
+                this.shielded.revertTransaction(tx),
+                this.unshielded.revertTransaction(tx),
+                this.dust.revertTransaction(tx),
+            ]);
+            throw error;
+        }
     }
     async calculateTransactionFee(tx) {
         return await this.dust.calculateFee([tx]);
@@ -338,7 +369,11 @@ export class WalletFacade {
     async estimateRegistration(nightUtxos) {
         const now = new Date();
         const dustState = await this.dust.waitForSyncedState();
-        const dustGenerationEstimations = pipe(nightUtxos, Arr.map(({ utxo, meta }) => ({ ...utxo, ctime: meta.ctime })), (utxosWithMeta) => dustState.estimateDustGeneration(utxosWithMeta, now), (estimatedUtxos) => dustState.capabilities.coinsAndBalances.splitNightUtxos(estimatedUtxos), (split) => split.guaranteed);
+        const dustGenerationEstimations = pipe(nightUtxos, Arr.map(({ utxo, meta }) => ({
+            ...utxo,
+            ctime: meta.ctime,
+            registeredForDustGeneration: meta.registeredForDustGeneration,
+        })), (utxosWithMeta) => dustState.estimateDustGeneration(utxosWithMeta, now), (estimatedUtxos) => dustState.capabilities.coinsAndBalances.splitNightUtxos(estimatedUtxos), (split) => split.guaranteed);
         const fakeSigningKey = ledger.sampleSigningKey();
         const fakeVerifyingKey = ledger.signatureVerifyingKey(fakeSigningKey);
         const fakeRegistrationRecipe = await this.registerNightUtxosForDustGeneration(nightUtxos, fakeVerifyingKey, (payload) => ledger.signData(fakeSigningKey, payload), dustState.address);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midnight-ntwrk/wallet-sdk-facade",
-  "version": "2.0.0-rc.1",
+  "version": "2.0.0-rc.3",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -25,17 +25,17 @@
   },
   "dependencies": {
     "@midnight-ntwrk/ledger-v7": "^7.0.0",
-    "@midnight-ntwrk/wallet-sdk-abstractions": "^2.0.0-rc.0",
     "@midnight-ntwrk/wallet-sdk-address-format": "^3.0.0",
-    "@midnight-ntwrk/wallet-sdk-capabilities": "^3.1.0-rc.1",
-    "@midnight-ntwrk/wallet-sdk-dust-wallet": "^2.0.0-rc.1",
-    "@midnight-ntwrk/wallet-sdk-hd": "^3.0.0",
-    "@midnight-ntwrk/wallet-sdk-shielded": "^2.0.0-rc.1",
-    "@midnight-ntwrk/wallet-sdk-unshielded-wallet": "^2.0.0-rc.1",
+    "@midnight-ntwrk/wallet-sdk-capabilities": "^3.1.0-rc.2",
+    "@midnight-ntwrk/wallet-sdk-dust-wallet": "^2.0.0-rc.3",
+    "@midnight-ntwrk/wallet-sdk-shielded": "^2.0.0-rc.2",
+    "@midnight-ntwrk/wallet-sdk-unshielded-wallet": "^2.0.0-rc.2",
     "rxjs": "^7.5"
   },
   "devDependencies": {
-    "@midnight-ntwrk/wallet-sdk-prover-client": "^1.1.0-rc.1",
+    "@midnight-ntwrk/wallet-sdk-abstractions": "^2.0.0-rc.1",
+    "@midnight-ntwrk/wallet-sdk-hd": "^3.0.0",
+    "@midnight-ntwrk/wallet-sdk-prover-client": "^1.1.0-rc.2",
     "eslint": "^9.37.0",
     "prettier": "^3.7.0",
     "publint": "~0.3.14",