@multiplechain/bitcoin 0.4.4 → 0.4.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8,31 +8,31 @@ export declare class Coin implements CoinInterface<TransactionSigner> {
8
8
  */
9
9
  provider: Provider;
10
10
  /**
11
- * @param {Provider} provider network provider
11
+ * @param provider network provider
12
12
  */
13
13
  constructor(provider?: Provider);
14
14
  /**
15
- * @returns {string} Coin name
15
+ * @returns Coin name
16
16
  */
17
17
  getName(): string;
18
18
  /**
19
- * @returns {string} Coin symbol
19
+ * @returns Coin symbol
20
20
  */
21
21
  getSymbol(): string;
22
22
  /**
23
- * @returns {number} Decimal value of the coin
23
+ * @returns Decimal value of the coin
24
24
  */
25
25
  getDecimals(): number;
26
26
  /**
27
- * @param {WalletAddress} owner Wallet address
28
- * @returns {Promise<number>} Wallet balance as currency of COIN
27
+ * @param owner Wallet address
28
+ * @returns Wallet balance as currency of COIN
29
29
  */
30
30
  getBalance(owner: WalletAddress): Promise<number>;
31
31
  /**
32
- * @param {WalletAddress} sender Sender wallet address
33
- * @param {WalletAddress} receiver Receiver wallet address
34
- * @param {TransferAmount} amount Amount of assets that will be transferred
35
- * @returns {Promise<TransactionSigner>} Transaction signer
32
+ * @param sender Sender wallet address
33
+ * @param receiver Receiver wallet address
34
+ * @param amount Amount of assets that will be transferred
35
+ * @returns Transaction signer
36
36
  */
37
37
  transfer(sender: WalletAddress, receiver: WalletAddress, amount: TransferAmount): Promise<TransactionSigner>;
38
38
  }
@@ -14,67 +14,66 @@ export declare class Wallet implements WalletInterface<Provider, WalletProvider,
14
14
  walletProvider: WalletProvider;
15
15
  networkProvider: Provider;
16
16
  /**
17
- * @param {WalletAdapter} adapter
18
- * @param {Provider} provider
17
+ * @param adapter - Wallet adapter
18
+ * @param provider - Network provider
19
19
  */
20
20
  constructor(adapter: WalletAdapter, provider?: Provider);
21
21
  /**
22
- * @returns {string}
22
+ * @returns Wallet ID
23
23
  */
24
24
  getId(): string;
25
25
  /**
26
- * @returns {string}
26
+ * @returns Wallet name
27
27
  */
28
28
  getName(): string;
29
29
  /**
30
- * @returns {string}
30
+ * @returns Wallet icon
31
31
  */
32
32
  getIcon(): string;
33
33
  /**
34
- * @returns {WalletPlatformEnum[]}
34
+ * @returns Wallet platforms
35
35
  */
36
36
  getPlatforms(): WalletPlatformEnum[];
37
37
  /**
38
- * @returns {string}
38
+ * @returns Wallet download link
39
39
  */
40
40
  getDownloadLink(): string | undefined;
41
41
  /**
42
- * @param {string} url
43
- * @param {UnknownConfig} config
44
- * @returns {string}
42
+ * @param url url for deep linking
43
+ * @param config configuration for deep linking
44
+ * @returns deep link
45
45
  */
46
46
  createDeepLink(url: string, config?: UnknownConfig): string | null;
47
47
  /**
48
- * @param {ConnectConfig} config
49
- * @returns {Promise<WalletAddress>}
48
+ * @param config connection configuration
49
+ * @returns WalletAddress
50
50
  */
51
51
  connect(config?: ConnectConfig): Promise<WalletAddress>;
52
52
  /**
53
- * @returns {boolean}
53
+ * @returns wallet detection status
54
54
  */
55
55
  isDetected(): Promise<boolean>;
56
56
  /**
57
- * @returns {boolean}
57
+ * @returns connection status
58
58
  */
59
59
  isConnected(): Promise<boolean>;
60
60
  /**
61
- * @returns {Promise<WalletAddress>}
61
+ * @returns wallet address
62
62
  */
63
63
  getAddress(): Promise<WalletAddress>;
64
64
  /**
65
- * @param {string} message
66
- * @returns {Promise<SignedMessage>}
65
+ * @param message message to sign
66
+ * @returns signed message
67
67
  */
68
68
  signMessage(message: string): Promise<SignedMessage>;
69
69
  /**
70
- * @param {TransactionSigner} transactionSigner
71
- * @returns {Promise<TransactionId>}
70
+ * @param transactionSigner transaction signer
71
+ * @returns transaction id
72
72
  */
73
73
  sendTransaction(transactionSigner: TransactionSigner): Promise<TransactionId>;
74
74
  /**
75
- * @param {string} eventName
76
- * @param {Function} callback
77
- * @returns {void}
75
+ * @param eventName event name
76
+ * @param callback event callback
78
77
  */
79
78
  on(eventName: string, callback: (...args: any[]) => void): void;
80
79
  }