@multiplechain/bitcoin 0.4.5 → 0.4.8

package/dist/assets/Coin.d.ts

@@ -8,31 +8,31 @@ export declare class Coin implements CoinInterface<TransactionSigner> {
      */
     provider: Provider;
     /**
-     * @param {Provider} provider network provider
+     * @param provider network provider
      */
     constructor(provider?: Provider);
     /**
-     * @returns {string} Coin name
+     * @returns Coin name
      */
     getName(): string;
     /**
-     * @returns {string} Coin symbol
+     * @returns Coin symbol
      */
     getSymbol(): string;
     /**
-     * @returns {number} Decimal value of the coin
+     * @returns Decimal value of the coin
      */
     getDecimals(): number;
     /**
-     * @param {WalletAddress} owner Wallet address
-     * @returns {Promise<number>} Wallet balance as currency of COIN
+     * @param owner Wallet address
+     * @returns Wallet balance as currency of COIN
      */
     getBalance(owner: WalletAddress): Promise<number>;
     /**
-     * @param {WalletAddress} sender Sender wallet address
-     * @param {WalletAddress} receiver Receiver wallet address
-     * @param {TransferAmount} amount Amount of assets that will be transferred
-     * @returns {Promise<TransactionSigner>} Transaction signer
+     * @param sender Sender wallet address
+     * @param receiver Receiver wallet address
+     * @param amount Amount of assets that will be transferred
+     * @returns Transaction signer
      */
     transfer(sender: WalletAddress, receiver: WalletAddress, amount: TransferAmount): Promise<TransactionSigner>;
 }

package/dist/browser/Wallet.d.ts

@@ -14,67 +14,66 @@ export declare class Wallet implements WalletInterface<Provider, WalletProvider,
     walletProvider: WalletProvider;
     networkProvider: Provider;
     /**
-     * @param {WalletAdapter} adapter
-     * @param {Provider} provider
+     * @param adapter - Wallet adapter
+     * @param provider - Network provider
      */
     constructor(adapter: WalletAdapter, provider?: Provider);
     /**
-     * @returns {string}
+     * @returns Wallet ID
      */
     getId(): string;
     /**
-     * @returns {string}
+     * @returns Wallet name
      */
     getName(): string;
     /**
-     * @returns {string}
+     * @returns Wallet icon
      */
     getIcon(): string;
     /**
-     * @returns {WalletPlatformEnum[]}
+     * @returns Wallet platforms
      */
     getPlatforms(): WalletPlatformEnum[];
     /**
-     * @returns {string}
+     * @returns Wallet download link
      */
     getDownloadLink(): string | undefined;
     /**
-     * @param {string} url
-     * @param {UnknownConfig} config
-     * @returns {string}
+     * @param url url for deep linking
+     * @param config configuration for deep linking
+     * @returns deep link
      */
     createDeepLink(url: string, config?: UnknownConfig): string | null;
     /**
-     * @param {ConnectConfig} config
-     * @returns {Promise<WalletAddress>}
+     * @param config connection configuration
+     * @returns WalletAddress
      */
     connect(config?: ConnectConfig): Promise<WalletAddress>;
     /**
-     * @returns {boolean}
+     * @returns wallet detection status
      */
     isDetected(): Promise<boolean>;
     /**
-     * @returns {boolean}
+     * @returns connection status
      */
     isConnected(): Promise<boolean>;
     /**
-     * @returns {Promise<WalletAddress>}
+     * @returns wallet address
      */
     getAddress(): Promise<WalletAddress>;
     /**
-     * @param {string} message
-     * @returns {Promise<SignedMessage>}
+     * @param message message to sign
+     * @returns signed message
      */
     signMessage(message: string): Promise<SignedMessage>;
     /**
-     * @param {TransactionSigner} transactionSigner
-     * @returns {Promise<TransactionId>}
+     * @param transactionSigner transaction signer
+     * @returns transaction id
      */
     sendTransaction(transactionSigner: TransactionSigner): Promise<TransactionId>;
     /**
-     * @param {string} eventName
-     * @param {Function} callback
-     * @returns {void}
+     * @param eventName event name
+     * @param callback event callback
      */
     on(eventName: string, callback: (...args: any[]) => void): void;
 }