@multiplechain/bitcoin 0.4.5 → 0.4.6

package/dist/models/CoinTransaction.d.ts

@@ -3,22 +3,22 @@ import { Transaction } from './Transaction';
 
 export declare class CoinTransaction extends Transaction implements CoinTransactionInterface {
     /**
-     * @returns {Promise<WalletAddress>} Wallet address of the receiver of transaction
+     * @returns Wallet address of the receiver of transaction
      */
     getReceiver(): Promise<WalletAddress>;
     /**
-     * @returns {Promise<WalletAddress>} Wallet address of the sender of transaction
+     * @returns Wallet address of the sender of transaction
      */
     getSender(): Promise<WalletAddress>;
     /**
-     * @returns {Promise<TransferAmount>} Amount of coin that will be transferred
+     * @returns Amount of coin that will be transferred
      */
     getAmount(): Promise<TransferAmount>;
     /**
-     * @param {AssetDirectionEnum} direction - Direction of the transaction (asset)
-     * @param {WalletAddress} address - Wallet address of the receiver or sender of the transaction, dependant on direction
-     * @param {TransferAmount} amount Amount of assets that will be transferred
-     * @returns {Promise<TransactionStatusEnum>} Status of the transaction
+     * @param direction - Direction of the transaction (asset)
+     * @param address - Wallet address of the receiver or sender of the transaction, dependant on direction
+     * @param amount Amount of assets that will be transferred
+     * @returns Status of the transaction
      */
     verifyTransfer(direction: AssetDirectionEnum, address: WalletAddress, amount: TransferAmount): Promise<TransactionStatusEnum>;
 }

package/dist/models/Transaction.d.ts

@@ -54,53 +54,53 @@ export declare class Transaction implements TransactionInterface<TransactionData
      */
     data: TransactionData | null;
     /**
-     * @param {TransactionId} id Transaction id
-     * @param {Provider} provider Blockchain network provider
+     * @param id Transaction id
+     * @param provider Blockchain network provider
      */
     constructor(id: TransactionId, provider?: Provider);
     /**
-     * @returns {Promise<TransactionData | null>} Transaction data
+     * @returns Transaction data
      */
     getData(): Promise<TransactionData | null>;
     /**
-     * @param {number} ms - Milliseconds to wait for the transaction to be confirmed. Default is 4000ms
-     * @returns {Promise<TransactionStatusEnum>} Status of the transaction
+     * @param ms - Milliseconds to wait for the transaction to be confirmed. Default is 4000ms
+     * @returns Status of the transaction
      */
     wait(ms?: number): Promise<TransactionStatusEnum>;
     /**
-     * @returns {TransactionId} Transaction ID
+     * @returns Transaction ID
      */
     getId(): TransactionId;
     /**
-     * @returns {Promise<TransactionTypeEnum>} Transaction type
+     * @returns Transaction type
      */
     getType(): Promise<TransactionTypeEnum>;
     /**
-     * @returns {string} Transaction URL
+     * @returns Transaction URL
      */
     getUrl(): string;
     /**
-     * @returns {Promise<WalletAddress>} Wallet address of the sender of transaction
+     * @returns Wallet address of the sender of transaction
      */
     getSigner(): Promise<WalletAddress>;
     /**
-     * @returns {Promise<TransactionFee>} Transaction fee
+     * @returns Transaction fee
      */
     getFee(): Promise<TransactionFee>;
     /**
-     * @returns {Promise<BlockNumber>} Block number that transaction
+     * @returns Block number that transaction
      */
     getBlockNumber(): Promise<BlockNumber>;
     /**
-     * @returns {Promise<BlockTimestamp>} Block timestamp that transaction
+     * @returns Block timestamp that transaction
      */
     getBlockTimestamp(): Promise<BlockTimestamp>;
     /**
-     * @returns {Promise<BlockConfirmationCount>} Confirmation count of the block
+     * @returns Confirmation count of the block
      */
     getBlockConfirmationCount(): Promise<BlockConfirmationCount>;
     /**
-     * @returns {Promise<TransactionStatusEnum>} Status of the transaction
+     * @returns Status of the transaction
      */
     getStatus(): Promise<TransactionStatusEnum>;
 }

package/dist/services/Provider.d.ts

@@ -1,7 +1,6 @@
-import { ProviderInterface } from '@multiplechain/types';
+import { NetworkConfigInterface, ProviderInterface } from '@multiplechain/types';
 
-export interface BitcoinNetworkConfigInterface {
-    testnet: boolean;
+export interface BitcoinNetworkConfigInterface extends NetworkConfigInterface {
     blockCypherToken?: string;
 }
 export declare class Provider implements ProviderInterface<BitcoinNetworkConfigInterface> {
@@ -39,42 +38,40 @@ export declare class Provider implements ProviderInterface<BitcoinNetworkConfigI
     constructor(network: BitcoinNetworkConfigInterface);
     /**
      * Get the static instance of the provider
-     * @returns {Provider} Provider
+     * @returns Provider
      */
     static get instance(): Provider;
     /**
      * Initialize the static instance of the provider
-     * @param {BitcoinNetworkConfigInterface} network - Network configuration of the provider
-     * @returns {void}
+     * @param network - Network configuration of the provider
      */
     static initialize(network: BitcoinNetworkConfigInterface): void;
     /**
      * Check RPC connection
-     * @param {string} url - RPC URL
-     * @returns {Promise<boolean | Error>}
+     * @param url - RPC URL
+     * @returns Connection status
      */
     checkRpcConnection(url?: string): Promise<boolean | Error>;
     /**
      * Check WS connection
-     * @param {string} url - Websocket URL
-     * @returns {Promise<boolean | Error>}
+     * @param url - Websocket URL
+     * @returns Connection status
      */
     checkWsConnection(url?: string): Promise<boolean | Error>;
     /**
      * Update network configuration of the provider
-     * @param {BitcoinNetworkConfigInterface} network - Network configuration
-     * @returns {void}
+     * @param network - Network configuration
      */
     update(network: BitcoinNetworkConfigInterface): void;
     /**
      * Create a new endpoint
-     * @param {string} endpoint - Endpoint
-     * @returns {string} Endpoint
+     * @param endpoint - Endpoint
+     * @returns Endpoint
      */
     createEndpoint(endpoint: string): string;
     /**
      * Get the current network configuration is testnet or not
-     * @returns {boolean} Testnet or not
+     * @returns Testnet or not
      */
     isTestnet(): boolean;
 }

package/dist/services/TransactionListener.d.ts

@@ -46,74 +46,66 @@ export declare class TransactionListener<T extends TransactionTypeEnum, DTransac
      */
     dynamicStop: () => void;
     /**
-     * @param {T} type - Transaction type
-     * @param {DynamicTransactionListenerFilterType<T>} filter - Transaction listener filter
-     * @param {Provider} provider - Provider
+     * @param type - Transaction type
+     * @param filter - Transaction listener filter
+     * @param provider - Provider
      */
     constructor(type: T, filter?: DynamicTransactionListenerFilterType<T>, provider?: Provider);
     /**
      * Close the listener
-     * @returns {void}
      */
     stop(): void;
     /**
      * Start the listener
-     * @returns {void}
      */
     start(): void;
     /**
      * Get the listener status
-     * @returns {boolean} Listener status
+     * @returns Listener status
      */
     getStatus(): boolean;
     /**
      * Listen to the transaction events
-     * @param {CallBackType} callback - Transaction listener callback
-     * @returns {Promise<boolean>}
+     * @param callback - Transaction listener callback
+     * @returns Connection status
      */
     on(callback: CallBackType): Promise<boolean>;
     /**
      * Trigger the event when a transaction is detected
-     * @param {TransactionListenerTriggerType<T>} transaction - Transaction data
-     * @returns {void}
+     * @param transaction - Transaction data
      */
     trigger<T extends TransactionTypeEnum>(transaction: TransactionListenerTriggerType<T>): void;
     isBlockCypherProcess(): boolean;
     /**
      * Create message for the listener
-     * @param {string} receiver - Receiver address
-     * @returns {string} Message
+     * @param receiver - Receiver address
+     * @returns Message
      */
     createMessage(receiver?: string): string;
     /**
      * Parse the data
-     * @param {any} data - Data
-     * @returns {Values} Parsed data
+     * @param data - Data
+     * @returns Parsed data
      */
     getValues(data: any): Values;
     /**
      * General transaction process
-     * @returns {void}
      */
     generalProcess(): void;
     /**
      * Contract transaction process
-     * @returns {void}
      */
     contractProcess(): void;
     /**
      * Coin transaction process
-     * @returns {void}
      */
     coinProcess(): void;
     /**
      * Token transaction process
-     * @returns {void}
      */
     tokenProcess(): void;
     /**
      * NFT transaction process
-     * @returns {void}
      */
     nftProcess(): void;
 }

package/dist/services/TransactionSigner.d.ts

@@ -22,29 +22,29 @@ export declare class TransactionSigner implements TransactionSignerInterface<Tra
      */
     provider: Provider;
     /**
-     * @param {TransactionData} rawData - Transaction data
-     * @param {Provider} provider - Blockchain network provider
+     * @param rawData - Transaction data
+     * @param provider - Blockchain network provider
      */
     constructor(rawData: TransactionData, provider?: Provider);
     /**
      * Sign the transaction
-     * @param {PrivateKey} privateKey - Transaction data
-     * @returns {Promise<this>} Signed transaction data
+     * @param privateKey - Transaction data
+     * @returns Signed transaction data
      */
     sign(privateKey: PrivateKey): Promise<this>;
     /**
      * Send the transaction to the blockchain network
-     * @returns {Promise<TransactionId>}
+     * @returns Transaction ID
      */
     send(): Promise<TransactionId>;
     /**
      * Get the raw transaction data
-     * @returns {TransactionData}
+     * @returns Transaction data
      */
     getRawData(): TransactionData;
     /**
      * Get the signed transaction data
-     * @returns {string}
+     * @returns Signed transaction data
      */
     getSignedData(): string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@multiplechain/bitcoin",
-    "version": "0.4.5",
+    "version": "0.4.6",
     "type": "module",
     "main": "dist/index.cjs",
     "module": "dist/index.es.js",
@@ -72,15 +72,17 @@
         "url": "https://github.com/MultipleChain/js/issues"
     },
     "dependencies": {
-        "@multiplechain/types": "^0.1.66",
+        "@multiplechain/types": "^0.1.68",
         "@multiplechain/utils": "^0.1.21",
         "axios": "^1.6.8",
         "bitcore-lib": "^10.0.28",
+        "lodash": "^4.17.21",
         "sats-connect": "^2.3.1",
         "ws": "^8.17.0"
     },
     "devDependencies": {
         "@types/bitcore-lib": "^0.15.6",
+        "@types/lodash": "^4.17.7",
         "@types/ws": "^8.5.10"
     }
 }