@midnight-ntwrk/midnight-js-types 3.0.0-alpha.7 → 3.0.0-alpha.9

package/dist/index.d.cts

@@ -578,14 +578,37 @@ interface PublicDataProvider {
     watchForUnshieldedBalances(contractAddress: ContractAddress): Promise<UnshieldedBalances>;
     /**
      * Retrieves data of the deployment transaction for the contract at the given contract address.
-     * Waits indefinitely for matching data to appear.
+     *
+     * **IMPORTANT: This method waits indefinitely** until the deployment transaction appears on the
+     * blockchain. It will never timeout or reject unless an error occurs.
+     *
+     * Custom implementations MUST maintain this indefinite waiting behavior to ensure consistency
+     * across all PublicDataProvider implementations. Do not implement timeouts in this method.
+     *
      * @param contractAddress The address of the contract of interest.
+     *
+     * @returns A promise that resolves with finalized transaction data when the deployment appears on-chain.
+     *          The promise never rejects due to timeout.
      */
     watchForDeployTxData(contractAddress: ContractAddress): Promise<FinalizedTxData>;
     /**
      * Retrieves data of the transaction containing the call or deployment with the given identifier.
-     * Waits indefinitely for matching data to appear.
+     *
+     * **IMPORTANT: This method waits indefinitely** until the transaction appears on the blockchain.
+     * It will never timeout or reject unless an error occurs.
+     *
+     * Custom implementations MUST maintain this indefinite waiting behavior to ensure consistency
+     * across all PublicDataProvider implementations. Do not implement timeouts in this method.
+     *
+     * Applications using this method should be aware that:
+     * - The promise will not resolve until the transaction appears on-chain
+     * - If a transaction is invalid and never appears, this will never return
+     * - Consider using application-level timeouts or cancellation mechanisms if needed
+     *
      * @param txId The identifier of the call or deployment of interest.
+     *
+     * @returns A promise that resolves with finalized transaction data when the transaction appears on-chain.
+     *          The promise never rejects due to timeout.
      */
     watchForTxData(txId: TransactionId): Promise<FinalizedTxData>;
     /**

package/dist/index.d.mts

@@ -578,14 +578,37 @@ interface PublicDataProvider {
     watchForUnshieldedBalances(contractAddress: ContractAddress): Promise<UnshieldedBalances>;
     /**
      * Retrieves data of the deployment transaction for the contract at the given contract address.
-     * Waits indefinitely for matching data to appear.
+     *
+     * **IMPORTANT: This method waits indefinitely** until the deployment transaction appears on the
+     * blockchain. It will never timeout or reject unless an error occurs.
+     *
+     * Custom implementations MUST maintain this indefinite waiting behavior to ensure consistency
+     * across all PublicDataProvider implementations. Do not implement timeouts in this method.
+     *
      * @param contractAddress The address of the contract of interest.
+     *
+     * @returns A promise that resolves with finalized transaction data when the deployment appears on-chain.
+     *          The promise never rejects due to timeout.
      */
     watchForDeployTxData(contractAddress: ContractAddress): Promise<FinalizedTxData>;
     /**
      * Retrieves data of the transaction containing the call or deployment with the given identifier.
-     * Waits indefinitely for matching data to appear.
+     *
+     * **IMPORTANT: This method waits indefinitely** until the transaction appears on the blockchain.
+     * It will never timeout or reject unless an error occurs.
+     *
+     * Custom implementations MUST maintain this indefinite waiting behavior to ensure consistency
+     * across all PublicDataProvider implementations. Do not implement timeouts in this method.
+     *
+     * Applications using this method should be aware that:
+     * - The promise will not resolve until the transaction appears on-chain
+     * - If a transaction is invalid and never appears, this will never return
+     * - Consider using application-level timeouts or cancellation mechanisms if needed
+     *
      * @param txId The identifier of the call or deployment of interest.
+     *
+     * @returns A promise that resolves with finalized transaction data when the transaction appears on-chain.
+     *          The promise never rejects due to timeout.
      */
     watchForTxData(txId: TransactionId): Promise<FinalizedTxData>;
     /**

package/dist/index.d.ts

@@ -578,14 +578,37 @@ interface PublicDataProvider {
     watchForUnshieldedBalances(contractAddress: ContractAddress): Promise<UnshieldedBalances>;
     /**
      * Retrieves data of the deployment transaction for the contract at the given contract address.
-     * Waits indefinitely for matching data to appear.
+     *
+     * **IMPORTANT: This method waits indefinitely** until the deployment transaction appears on the
+     * blockchain. It will never timeout or reject unless an error occurs.
+     *
+     * Custom implementations MUST maintain this indefinite waiting behavior to ensure consistency
+     * across all PublicDataProvider implementations. Do not implement timeouts in this method.
+     *
      * @param contractAddress The address of the contract of interest.
+     *
+     * @returns A promise that resolves with finalized transaction data when the deployment appears on-chain.
+     *          The promise never rejects due to timeout.
      */
     watchForDeployTxData(contractAddress: ContractAddress): Promise<FinalizedTxData>;
     /**
      * Retrieves data of the transaction containing the call or deployment with the given identifier.
-     * Waits indefinitely for matching data to appear.
+     *
+     * **IMPORTANT: This method waits indefinitely** until the transaction appears on the blockchain.
+     * It will never timeout or reject unless an error occurs.
+     *
+     * Custom implementations MUST maintain this indefinite waiting behavior to ensure consistency
+     * across all PublicDataProvider implementations. Do not implement timeouts in this method.
+     *
+     * Applications using this method should be aware that:
+     * - The promise will not resolve until the transaction appears on-chain
+     * - If a transaction is invalid and never appears, this will never return
+     * - Consider using application-level timeouts or cancellation mechanisms if needed
+     *
      * @param txId The identifier of the call or deployment of interest.
+     *
+     * @returns A promise that resolves with finalized transaction data when the transaction appears on-chain.
+     *          The promise never rejects due to timeout.
      */
     watchForTxData(txId: TransactionId): Promise<FinalizedTxData>;
     /**

package/dist/public-data-provider.d.ts

@@ -109,14 +109,37 @@ export interface PublicDataProvider {
     watchForUnshieldedBalances(contractAddress: ContractAddress): Promise<UnshieldedBalances>;
     /**
      * Retrieves data of the deployment transaction for the contract at the given contract address.
-     * Waits indefinitely for matching data to appear.
+     *
+     * **IMPORTANT: This method waits indefinitely** until the deployment transaction appears on the
+     * blockchain. It will never timeout or reject unless an error occurs.
+     *
+     * Custom implementations MUST maintain this indefinite waiting behavior to ensure consistency
+     * across all PublicDataProvider implementations. Do not implement timeouts in this method.
+     *
      * @param contractAddress The address of the contract of interest.
+     *
+     * @returns A promise that resolves with finalized transaction data when the deployment appears on-chain.
+     *          The promise never rejects due to timeout.
      */
     watchForDeployTxData(contractAddress: ContractAddress): Promise<FinalizedTxData>;
     /**
      * Retrieves data of the transaction containing the call or deployment with the given identifier.
-     * Waits indefinitely for matching data to appear.
+     *
+     * **IMPORTANT: This method waits indefinitely** until the transaction appears on the blockchain.
+     * It will never timeout or reject unless an error occurs.
+     *
+     * Custom implementations MUST maintain this indefinite waiting behavior to ensure consistency
+     * across all PublicDataProvider implementations. Do not implement timeouts in this method.
+     *
+     * Applications using this method should be aware that:
+     * - The promise will not resolve until the transaction appears on-chain
+     * - If a transaction is invalid and never appears, this will never return
+     * - Consider using application-level timeouts or cancellation mechanisms if needed
+     *
      * @param txId The identifier of the call or deployment of interest.
+     *
+     * @returns A promise that resolves with finalized transaction data when the transaction appears on-chain.
+     *          The promise never rejects due to timeout.
      */
     watchForTxData(txId: TransactionId): Promise<FinalizedTxData>;
     /**

package/dist/public-data-provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"public-data-provider.d.ts","sourceRoot":"","sources":["../src/public-data-provider.ts"],"names":[],"mappings":"AAeA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjG,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAEvC,OAAO,KAAK,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAE5E;;GAEG;AACH,MAAM,MAAM,GAAG,GAAG;IAChB,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;CACtB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;CACzB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;CAC9B,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,6BAA6B,GACrC,CAAC,CAAC,UAAU,GAAG,eAAe,GAAG,iBAAiB,CAAC,GAAG;IACpD;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;CAC9B,CAAC,GACF,MAAM,GACN,GAAG,CAAC;AAER;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;;;OAOG;IACH,kBAAkB,CAChB,eAAe,EAAE,eAAe,EAChC,MAAM,CAAC,EAAE,iBAAiB,GAAG,eAAe,GAC3C,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC;IAEjC;;;;;;;OAOG;IACH,0BAA0B,CACxB,eAAe,EAAE,eAAe,EAChC,MAAM,CAAC,EAAE,iBAAiB,GAAG,eAAe,GAC3C,OAAO,CAAC,CAAC,eAAe,EAAE,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC;IAEpD;;;;OAIG;IACH,wBAAwB,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC;IAE1F;;;;;OAKG;IACH,uBAAuB,CACrB,eAAe,EAAE,eAAe,EAChC,MAAM,CAAC,EAAE,iBAAiB,GAAG,eAAe,GAC3C,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAAC;IAEtC;;;;OAIG;IACH,qBAAqB,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAEhF;;;;;OAKG;IACH,0BAA0B,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAE1F;;;;OAIG;IACH,oBAAoB,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAEjF;;;;OAIG;IACH,cAAc,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAE9D;;;;;;OAMG;IACH,uBAAuB,CAAC,OAAO,EAAE,eAAe,EAAE,MAAM,EAAE,6BAA6B,GAAG,UAAU,CAAC,aAAa,CAAC,CAAC;IAEpH;;;;;;OAMG;IACH,4BAA4B,CAAC,OAAO,EAAE,eAAe,EAAE,MAAM,EAAE,6BAA6B,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC;CAC/H"}
+{"version":3,"file":"public-data-provider.d.ts","sourceRoot":"","sources":["../src/public-data-provider.ts"],"names":[],"mappings":"AAeA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjG,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAEvC,OAAO,KAAK,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAE5E;;GAEG;AACH,MAAM,MAAM,GAAG,GAAG;IAChB,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;CACtB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;CACzB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;CAC9B,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,6BAA6B,GACrC,CAAC,CAAC,UAAU,GAAG,eAAe,GAAG,iBAAiB,CAAC,GAAG;IACpD;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;CAC9B,CAAC,GACF,MAAM,GACN,GAAG,CAAC;AAER;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;;;OAOG;IACH,kBAAkB,CAChB,eAAe,EAAE,eAAe,EAChC,MAAM,CAAC,EAAE,iBAAiB,GAAG,eAAe,GAC3C,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC;IAEjC;;;;;;;OAOG;IACH,0BAA0B,CACxB,eAAe,EAAE,eAAe,EAChC,MAAM,CAAC,EAAE,iBAAiB,GAAG,eAAe,GAC3C,OAAO,CAAC,CAAC,eAAe,EAAE,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC;IAEpD;;;;OAIG;IACH,wBAAwB,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC;IAE1F;;;;;OAKG;IACH,uBAAuB,CACrB,eAAe,EAAE,eAAe,EAChC,MAAM,CAAC,EAAE,iBAAiB,GAAG,eAAe,GAC3C,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAAC;IAEtC;;;;OAIG;IACH,qBAAqB,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAEhF;;;;;OAKG;IACH,0BAA0B,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAE1F;;;;;;;;;;;;;OAaG;IACH,oBAAoB,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAEjF;;;;;;;;;;;;;;;;;;OAkBG;IACH,cAAc,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAE9D;;;;;;OAMG;IACH,uBAAuB,CAAC,OAAO,EAAE,eAAe,EAAE,MAAM,EAAE,6BAA6B,GAAG,UAAU,CAAC,aAAa,CAAC,CAAC;IAEpH;;;;;;OAMG;IACH,4BAA4B,CAAC,OAAO,EAAE,eAAe,EAAE,MAAM,EAAE,6BAA6B,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC;CAC/H"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midnight-ntwrk/midnight-js-types",
-  "version": "3.0.0-alpha.7",
+  "version": "3.0.0-alpha.9",
   "description": "Shared data types and interfaces for MidnightJS modules",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",