@dfinity/ckbtc 5.0.0-next-2025-10-22.4 → 5.0.0
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.
- package/README.md +17 -17
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -72,11 +72,11 @@ Parameters:
|
|
|
72
72
|
- `params`: The Bitcoin address and network to parse
|
|
73
73
|
- `params.network`: Optional. Default BtcNetwork is Mainnet
|
|
74
74
|
|
|
75
|
-
[:link: Source](https://github.com/dfinity/
|
|
75
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ckbtc/src/utils/btc.utils.ts#L195)
|
|
76
76
|
|
|
77
77
|
### :factory: CkBTCMinterCanister
|
|
78
78
|
|
|
79
|
-
[:link: Source](https://github.com/dfinity/
|
|
79
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ckbtc/src/minter.canister.ts#L42)
|
|
80
80
|
|
|
81
81
|
#### Static Methods
|
|
82
82
|
|
|
@@ -88,7 +88,7 @@ Parameters:
|
|
|
88
88
|
| -------- | ------------------------------------------------------------------ |
|
|
89
89
|
| `create` | `(options: CkBTCCanisterOptions<_SERVICE>) => CkBTCMinterCanister` |
|
|
90
90
|
|
|
91
|
-
[:link: Source](https://github.com/dfinity/
|
|
91
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ckbtc/src/minter.canister.ts#L43)
|
|
92
92
|
|
|
93
93
|
#### Methods
|
|
94
94
|
|
|
@@ -123,7 +123,7 @@ Returns:
|
|
|
123
123
|
|
|
124
124
|
The BTC address of the given account.
|
|
125
125
|
|
|
126
|
-
[:link: Source](https://github.com/dfinity/
|
|
126
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ckbtc/src/minter.canister.ts#L64)
|
|
127
127
|
|
|
128
128
|
##### :gear: updateBalance
|
|
129
129
|
|
|
@@ -145,7 +145,7 @@ Returns:
|
|
|
145
145
|
|
|
146
146
|
The result of the balance update.
|
|
147
147
|
|
|
148
|
-
[:link: Source](https://github.com/dfinity/
|
|
148
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ckbtc/src/minter.canister.ts#L83)
|
|
149
149
|
|
|
150
150
|
##### :gear: getWithdrawalAccount
|
|
151
151
|
|
|
@@ -159,7 +159,7 @@ Returns:
|
|
|
159
159
|
|
|
160
160
|
The account to which ckBTC needs to be transferred. Provide corresponding information to map an Icrc1 account.
|
|
161
161
|
|
|
162
|
-
[:link: Source](https://github.com/dfinity/
|
|
162
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ckbtc/src/minter.canister.ts#L106)
|
|
163
163
|
|
|
164
164
|
##### :gear: retrieveBtc
|
|
165
165
|
|
|
@@ -187,7 +187,7 @@ Returns:
|
|
|
187
187
|
|
|
188
188
|
The result or the operation.
|
|
189
189
|
|
|
190
|
-
[:link: Source](https://github.com/dfinity/
|
|
190
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ckbtc/src/minter.canister.ts#L125)
|
|
191
191
|
|
|
192
192
|
##### :gear: retrieveBtcWithApproval
|
|
193
193
|
|
|
@@ -217,7 +217,7 @@ Returns:
|
|
|
217
217
|
|
|
218
218
|
The result or the operation.
|
|
219
219
|
|
|
220
|
-
[:link: Source](https://github.com/dfinity/
|
|
220
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ckbtc/src/minter.canister.ts#L155)
|
|
221
221
|
|
|
222
222
|
##### :gear: retrieveBtcStatus
|
|
223
223
|
|
|
@@ -237,7 +237,7 @@ Returns:
|
|
|
237
237
|
|
|
238
238
|
The status of the BTC retrieval request.
|
|
239
239
|
|
|
240
|
-
[:link: Source](https://github.com/dfinity/
|
|
240
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ckbtc/src/minter.canister.ts#L187)
|
|
241
241
|
|
|
242
242
|
##### :gear: retrieveBtcStatusV2ByAccount
|
|
243
243
|
|
|
@@ -256,7 +256,7 @@ Returns:
|
|
|
256
256
|
|
|
257
257
|
The statuses of the BTC retrieval requests.
|
|
258
258
|
|
|
259
|
-
[:link: Source](https://github.com/dfinity/
|
|
259
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ckbtc/src/minter.canister.ts#L205)
|
|
260
260
|
|
|
261
261
|
##### :gear: estimateWithdrawalFee
|
|
262
262
|
|
|
@@ -272,7 +272,7 @@ Parameters:
|
|
|
272
272
|
- `params.certified`: query or update call
|
|
273
273
|
- `params.amount`: The optional amount for which the fee should be estimated.
|
|
274
274
|
|
|
275
|
-
[:link: Source](https://github.com/dfinity/
|
|
275
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ckbtc/src/minter.canister.ts#L239)
|
|
276
276
|
|
|
277
277
|
##### :gear: getMinterInfo
|
|
278
278
|
|
|
@@ -287,7 +287,7 @@ Parameters:
|
|
|
287
287
|
- `params`: The parameters to get the minter info.
|
|
288
288
|
- `params.certified`: query or update call
|
|
289
289
|
|
|
290
|
-
[:link: Source](https://github.com/dfinity/
|
|
290
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ckbtc/src/minter.canister.ts#L253)
|
|
291
291
|
|
|
292
292
|
##### :gear: getKnownUtxos
|
|
293
293
|
|
|
@@ -307,11 +307,11 @@ Returns:
|
|
|
307
307
|
|
|
308
308
|
The known utxos (with no guarantee in the ordering).
|
|
309
309
|
|
|
310
|
-
[:link: Source](https://github.com/dfinity/
|
|
310
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ckbtc/src/minter.canister.ts#L266)
|
|
311
311
|
|
|
312
312
|
### :factory: BitcoinCanister
|
|
313
313
|
|
|
314
|
-
[:link: Source](https://github.com/dfinity/
|
|
314
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ckbtc/src/bitcoin.canister.ts#L17)
|
|
315
315
|
|
|
316
316
|
#### Static Methods
|
|
317
317
|
|
|
@@ -323,7 +323,7 @@ The known utxos (with no guarantee in the ordering).
|
|
|
323
323
|
| -------- | -------------------------------------------------------------- |
|
|
324
324
|
| `create` | `(options: CkBTCCanisterOptions<_SERVICE>) => BitcoinCanister` |
|
|
325
325
|
|
|
326
|
-
[:link: Source](https://github.com/dfinity/
|
|
326
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ckbtc/src/bitcoin.canister.ts#L18)
|
|
327
327
|
|
|
328
328
|
#### Methods
|
|
329
329
|
|
|
@@ -350,7 +350,7 @@ Returns:
|
|
|
350
350
|
|
|
351
351
|
The UTXOs are returned sorted by block height in descending order.
|
|
352
352
|
|
|
353
|
-
[:link: Source](https://github.com/dfinity/
|
|
353
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ckbtc/src/bitcoin.canister.ts#L42)
|
|
354
354
|
|
|
355
355
|
##### :gear: getBalanceQuery
|
|
356
356
|
|
|
@@ -372,7 +372,7 @@ Returns:
|
|
|
372
372
|
|
|
373
373
|
The balance is returned in `Satoshi` (10^8 Satoshi = 1 Bitcoin).
|
|
374
374
|
|
|
375
|
-
[:link: Source](https://github.com/dfinity/
|
|
375
|
+
[:link: Source](https://github.com/dfinity/icp-js-canisters/tree/main/packages/ckbtc/src/bitcoin.canister.ts#L64)
|
|
376
376
|
|
|
377
377
|
<!-- TSDOC_END -->
|
|
378
378
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dfinity/ckbtc",
|
|
3
|
-
"version": "5.0.0
|
|
3
|
+
"version": "5.0.0",
|
|
4
4
|
"description": "A library for interfacing with ckBTC.",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"type": "module",
|
|
@@ -33,11 +33,11 @@
|
|
|
33
33
|
},
|
|
34
34
|
"repository": {
|
|
35
35
|
"type": "git",
|
|
36
|
-
"url": "git+https://github.com/dfinity/
|
|
36
|
+
"url": "git+https://github.com/dfinity/icp-js-canisters.git",
|
|
37
37
|
"directory": "packages/ckbtc"
|
|
38
38
|
},
|
|
39
39
|
"bugs": {
|
|
40
|
-
"url": "https://github.com/dfinity/
|
|
40
|
+
"url": "https://github.com/dfinity/icp-js-canisters"
|
|
41
41
|
},
|
|
42
42
|
"keywords": [
|
|
43
43
|
"internet computer",
|
|
@@ -49,14 +49,14 @@
|
|
|
49
49
|
"minter",
|
|
50
50
|
"token"
|
|
51
51
|
],
|
|
52
|
-
"homepage": "https://github.com/dfinity/
|
|
52
|
+
"homepage": "https://github.com/dfinity/icp-js-canisters#readme",
|
|
53
53
|
"peerDependencies": {
|
|
54
|
-
"@dfinity/utils": "
|
|
55
|
-
"@icp-sdk/core": "
|
|
54
|
+
"@dfinity/utils": "^4",
|
|
55
|
+
"@icp-sdk/core": "^4"
|
|
56
56
|
},
|
|
57
57
|
"dependencies": {
|
|
58
58
|
"@noble/hashes": "^1.8.0",
|
|
59
59
|
"base58-js": "^3.0.3",
|
|
60
60
|
"bech32": "^2.0.0"
|
|
61
61
|
}
|
|
62
|
-
}
|
|
62
|
+
}
|