@midnight-ntwrk/wallet-sdk-facade 2.0.0 → 3.0.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import * as ledger from '@midnight-ntwrk/ledger-v7';
+import * as ledger from '@midnight-ntwrk/ledger-v8';
 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 DefaultDustConfiguration, type DustWalletAPI, type DustWalletState } from '@midnight-ntwrk/wallet-sdk-dust-wallet';
@@ -73,6 +73,27 @@ export declare class FacadeState {
     get isSynced(): boolean;
     constructor(shielded: ShieldedWalletState, unshielded: UnshieldedWalletState, dust: DustWalletState, pending: PendingTransactions.PendingTransactions<ledger.FinalizedTransaction>);
 }
+/**
+ * The Terms and Conditions returned by the indexer, containing a URL for display
+ * and a SHA-256 hash for content verification.
+ */
+export type TermsAndConditions = {
+    /** The hex-encoded SHA-256 hash of the Terms and Conditions document. */
+    hash: string;
+    /** The URL pointing to the Terms and Conditions document. */
+    url: string;
+};
+/**
+ * Minimal configuration required for {@link WalletFacade.fetchTermsAndConditions}.
+ * Accepts the shared `indexerClientConnection` sub-object found on all wallet configurations,
+ * so callers can pass the full wallet configuration directly without any adaptation.
+ */
+export type FetchTermsAndConditionsConfiguration = {
+    indexerClientConnection: {
+        indexerHttpUrl: string;
+        indexerWsUrl?: string;
+    };
+};
 export type DefaultConfiguration = DefaultUnshieldedConfiguration & DefaultShieldedConfiguration & DefaultDustConfiguration & DefaultSubmissionConfiguration & DefaultPendingTransactionsServiceConfiguration & Partial<DefaultProvingConfiguration>;
 type MaybePromise<T> = T | Promise<T>;
 export type InitParams<TConfig extends DefaultConfiguration> = {
@@ -89,6 +110,23 @@ export declare class WalletFacade {
     private static makeDefaultSubmissionService;
     private static makeDefaultPendingTransactionsService;
     private static makeDefaultProvingService;
+    /**
+     * Fetches the current Terms and Conditions from the network indexer.
+     *
+     * This is a static, pre-initialization utility — no wallet instance is required.
+     * Wallet builders should call this before or independently of wallet initialization
+     * to display the current T&C to end users and obtain the hash for content verification.
+     *
+     * The returned `hash` is the hex-encoded SHA-256 hash of the document at `url`.
+     * Wallet builders are responsible for fetching and rendering the document content
+     * via `url` in whatever manner suits their application.
+     *
+     * @param configuration - An object with an `indexerClientConnection.indexerHttpUrl`.
+     *   Any wallet configuration that satisfies {@link FetchTermsAndConditionsConfiguration} can be passed directly.
+     * @returns A promise resolving to the current {@link TermsAndConditions}, or rejecting if
+     *   no Terms and Conditions have been set on the network yet.
+     */
+    static fetchTermsAndConditions(configuration: FetchTermsAndConditionsConfiguration): Promise<TermsAndConditions>;
     static init<TConfig extends DefaultConfiguration>(initParams: InitParams<TConfig>): Promise<WalletFacade>;
     readonly shielded: ShieldedWalletAPI;
     readonly unshielded: UnshieldedWalletAPI;
@@ -129,7 +167,13 @@ export declare class WalletFacade {
     signUnprovenTransaction(tx: ledger.UnprovenTransaction, signSegment: (data: Uint8Array) => ledger.Signature): Promise<ledger.UnprovenTransaction>;
     signUnboundTransaction(tx: UnboundTransaction, signSegment: (data: Uint8Array) => ledger.Signature): Promise<UnboundTransaction>;
     finalizeTransaction(tx: ledger.UnprovenTransaction): Promise<ledger.FinalizedTransaction>;
+    /** Estimates the fee for the given transaction only. This lacks the fees of the balancing transaction. */
     calculateTransactionFee(tx: AnyTransaction): Promise<bigint>;
+    /** Calculates the total fee for the given transaction plus the fee of the balancing transaction. */
+    estimateTransactionFee(tx: AnyTransaction, secretKey: ledger.DustSecretKey, options?: {
+        ttl?: Date;
+        currentTime?: Date;
+    }): Promise<bigint>;
     transferTransaction(outputs: CombinedTokenTransfer[], secretKeys: {
         shieldedSecretKeys: ledger.ZswapSecretKeys;
         dustSecretKey: ledger.DustSecretKey;

package/dist/index.js

@@ -10,9 +10,11 @@
 // 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 * as ledger from '@midnight-ntwrk/ledger-v7';
+import * as ledger from '@midnight-ntwrk/ledger-v8';
 import { makeDefaultSubmissionService, } from '@midnight-ntwrk/wallet-sdk-capabilities';
 import { makeDefaultProvingService, } from '@midnight-ntwrk/wallet-sdk-capabilities/proving';
+import { FetchTermsAndConditions as FetchTermsAndConditionsQuery } from '@midnight-ntwrk/wallet-sdk-indexer-client';
+import { QueryRunner } from '@midnight-ntwrk/wallet-sdk-indexer-client/effect';
 import { Array as Arr, pipe } from 'effect';
 import { combineLatest, map, firstValueFrom, concatMap } from 'rxjs';
 import { PendingTransactions, PendingTransactionsServiceImpl, } from '@midnight-ntwrk/wallet-sdk-capabilities';
@@ -88,6 +90,32 @@ export class WalletFacade {
             throw new Error("Missing required configuration: 'provingServerUrl' must be set in config, or provide a custom provingService in init parameters.");
         }
     }
+    /**
+     * Fetches the current Terms and Conditions from the network indexer.
+     *
+     * This is a static, pre-initialization utility — no wallet instance is required.
+     * Wallet builders should call this before or independently of wallet initialization
+     * to display the current T&C to end users and obtain the hash for content verification.
+     *
+     * The returned `hash` is the hex-encoded SHA-256 hash of the document at `url`.
+     * Wallet builders are responsible for fetching and rendering the document content
+     * via `url` in whatever manner suits their application.
+     *
+     * @param configuration - An object with an `indexerClientConnection.indexerHttpUrl`.
+     *   Any wallet configuration that satisfies {@link FetchTermsAndConditionsConfiguration} can be passed directly.
+     * @returns A promise resolving to the current {@link TermsAndConditions}, or rejecting if
+     *   no Terms and Conditions have been set on the network yet.
+     */
+    static async fetchTermsAndConditions(configuration) {
+        const result = await QueryRunner.runPromise(FetchTermsAndConditionsQuery, {}, {
+            url: configuration.indexerClientConnection.indexerHttpUrl,
+        });
+        const tc = result.block?.systemParameters?.termsAndConditions;
+        if (!tc) {
+            throw new Error('Terms and Conditions are not currently set on the network.');
+        }
+        return tc;
+    }
     static async init(initParams) {
         const submissionService = await Promise.resolve(initParams.submissionService
             ? initParams.submissionService(initParams.configuration)
@@ -335,9 +363,15 @@ export class WalletFacade {
             throw error;
         }
     }
+    /** Estimates the fee for the given transaction only. This lacks the fees of the balancing transaction. */
     async calculateTransactionFee(tx) {
         return await this.dust.calculateFee([tx]);
     }
+    /** Calculates the total fee for the given transaction plus the fee of the balancing transaction. */
+    async estimateTransactionFee(tx, secretKey, options) {
+        const ttl = options?.ttl ?? this.defaultTtl();
+        return await this.dust.estimateFee(secretKey, [tx], ttl, options?.currentTime);
+    }
     async transferTransaction(outputs, secretKeys, options) {
         const { shieldedSecretKeys, dustSecretKey } = secretKeys;
         const { ttl, payFees = true } = options;

package/dist/transaction.d.ts

@@ -1,3 +1,3 @@
 import { PendingTransactions } from '@midnight-ntwrk/wallet-sdk-capabilities';
-import * as ledger from '@midnight-ntwrk/ledger-v7';
+import * as ledger from '@midnight-ntwrk/ledger-v8';
 export declare const finalizedTransactionTrait: PendingTransactions.TransactionTrait<ledger.FinalizedTransaction>;

package/dist/transaction.js

@@ -13,7 +13,7 @@
  * limitations under the License.
  */
 import { Array as Arr, DateTime, Duration, HashSet, Option, Order, pipe } from 'effect';
-import * as ledger from '@midnight-ntwrk/ledger-v7';
+import * as ledger from '@midnight-ntwrk/ledger-v8';
 export const finalizedTransactionTrait = {
     areAllTxIdsIncluded(tx, txIds) {
         const txIdsSet = HashSet.fromIterable(tx.identifiers());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midnight-ntwrk/wallet-sdk-facade",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -24,18 +24,19 @@
     }
   },
   "dependencies": {
-    "@midnight-ntwrk/ledger-v7": "^7.0.2",
-    "@midnight-ntwrk/wallet-sdk-address-format": "^3.0.1",
-    "@midnight-ntwrk/wallet-sdk-capabilities": "^3.1.0",
-    "@midnight-ntwrk/wallet-sdk-dust-wallet": "^2.0.0",
-    "@midnight-ntwrk/wallet-sdk-shielded": "^2.0.0",
-    "@midnight-ntwrk/wallet-sdk-unshielded-wallet": "^2.0.0",
+    "@midnight-ntwrk/ledger-v8": "^8.0.2",
+    "@midnight-ntwrk/wallet-sdk-address-format": "^3.1.0",
+    "@midnight-ntwrk/wallet-sdk-capabilities": "^3.2.0",
+    "@midnight-ntwrk/wallet-sdk-dust-wallet": "^3.0.0",
+    "@midnight-ntwrk/wallet-sdk-indexer-client": "^1.2.0",
+    "@midnight-ntwrk/wallet-sdk-shielded": "^2.1.0",
+    "@midnight-ntwrk/wallet-sdk-unshielded-wallet": "^2.1.0",
     "rxjs": "^7.8.2"
   },
   "devDependencies": {
     "@midnight-ntwrk/wallet-sdk-abstractions": "^2.0.0",
     "@midnight-ntwrk/wallet-sdk-hd": "^3.0.1",
-    "@midnight-ntwrk/wallet-sdk-utilities": "1.0.1"
+    "@midnight-ntwrk/wallet-sdk-utilities": "1.1.0"
   },
   "scripts": {
     "typecheck": "tsc -b ./tsconfig.json --noEmit --force",