@dfinity/ckbtc 0.0.7-next-2023-07-03 → 0.0.7

package/README.md

@@ -74,17 +74,11 @@ Parameters:
 - `params`: The Bitcoin address and network to parse
 - `params.network`: Optional. Default BtcNetwork is Mainnet
 
-### :factory: CkBTCMinterCanister
-
-#### Constructors
-
-`public`
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/utils/btc.utils.ts#L194)
 
-Parameters:
+### :factory: CkBTCMinterCanister
 
-- `id`
-- `service`
-- `certifiedService`
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/minter.canister.ts#L33)
 
 #### Methods
 
@@ -102,6 +96,8 @@ Parameters:
 | -------- | ------------------------------------------------------------------------ |
 | `create` | `(options: CkBTCMinterCanisterOptions<_SERVICE>) => CkBTCMinterCanister` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/minter.canister.ts#L34)
+
 ##### :gear: getBtcAddress
 
 Returns a BTC address for a given account.
@@ -118,6 +114,8 @@ Parameters:
 - `params.owner`: The owner for which the BTC address should be generated. If not provided, the `caller` will be use instead.
 - `params.subaccount`: An optional subaccount to compute the address.
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/minter.canister.ts#L55)
+
 ##### :gear: updateBalance
 
 Notify the minter about the bitcoin transfer.
@@ -134,6 +132,8 @@ Parameters:
 - `params.owner`: The owner of the address. If not provided, the `caller` will be use instead.
 - `params.subaccount`: An optional subaccount of the address.
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/minter.canister.ts#L74)
+
 ##### :gear: getWithdrawalAccount
 
 Returns the account to which the caller should deposit ckBTC before withdrawing BTC using the [retrieveBtc] endpoint.
@@ -142,6 +142,8 @@ Returns the account to which the caller should deposit ckBTC before withdrawing
 | ---------------------- | ------------------------ |
 | `getWithdrawalAccount` | `() => Promise<Account>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/minter.canister.ts#L97)
+
 ##### :gear: retrieveBtc
 
 Submits a request to convert ckBTC to BTC.
@@ -164,6 +166,8 @@ Parameters:
 - `params.address`: The bitcoin address.
 - `params.amount`: The ckBTC amount.
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/minter.canister.ts#L116)
+
 ##### :gear: estimateWithdrawalFee
 
 Returns an estimation of the user's fee (in Satoshi) for a retrieve_btc request based on the current status of the Bitcoin network and the fee related to the minter.
@@ -178,6 +182,8 @@ Parameters:
 - `params.certified`: query or update call
 - `params.amount`: The optional amount for which the fee should be estimated.
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/minter.canister.ts#L135)
+
 ##### :gear: getMinterInfo
 
 Returns internal minter parameters such as the minimal amount to retrieve BTC, minimal number of confirmations or KYT fee.
@@ -191,6 +197,8 @@ Parameters:
 - `params`: The parameters to get the deposit fee.
 - `params.certified`: query or update call
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/minter.canister.ts#L149)
+
 <!-- TSDOC_END -->
 
 ## Resources

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dfinity/ckbtc",
-  "version": "0.0.7-next-2023-07-03",
+  "version": "0.0.7",
   "description": "A library for interfacing with ckBTC.",
   "license": "Apache-2.0",
   "main": "dist/cjs/index.cjs.js",
@@ -38,14 +38,14 @@
   ],
   "homepage": "https://github.com/dfinity/ic-js#readme",
   "peerDependencies": {
-    "@dfinity/agent": "*",
-    "@dfinity/candid": "*",
-    "@dfinity/principal": "*",
-    "@dfinity/utils": "*"
+    "@dfinity/agent": "^0.15.4",
+    "@dfinity/candid": "^0.15.4",
+    "@dfinity/principal": "^0.15.4",
+    "@dfinity/utils": "^0.0.18"
   },
   "dependencies": {
     "base58-js": "^1.0.5",
     "bech32": "^2.0.0",
     "js-sha256": "^0.9.0"
   }
-}
+}