From 20954c3958f8677436e5a30d287a3ebf3372f193 Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 31 Jan 2024 07:48:39 +0000 Subject: [PATCH] =?UTF-8?q?=F0=9F=A4=96=20Documentation=20auto-update?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- packages/ckbtc/README.md | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/packages/ckbtc/README.md b/packages/ckbtc/README.md index b4ad2dab8..4c590acda 100644 --- a/packages/ckbtc/README.md +++ b/packages/ckbtc/README.md @@ -76,7 +76,7 @@ Parameters: ### :factory: CkBTCMinterCanister -[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/minter.canister.ts#L38) +[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/minter.canister.ts#L40) #### Methods @@ -97,7 +97,7 @@ Parameters: | -------- | ------------------------------------------------------------------------ | | `create` | `(options: CkBTCMinterCanisterOptions<_SERVICE>) => CkBTCMinterCanister` | -[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/minter.canister.ts#L39) +[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/minter.canister.ts#L41) ##### :gear: getBtcAddress @@ -115,7 +115,7 @@ 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#L60) +[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/minter.canister.ts#L62) ##### :gear: updateBalance @@ -133,7 +133,7 @@ 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#L79) +[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/minter.canister.ts#L81) ##### :gear: getWithdrawalAccount @@ -143,7 +143,7 @@ Returns the account to which the caller should deposit ckBTC before withdrawing | ---------------------- | ------------------------ | | `getWithdrawalAccount` | `() => Promise` | -[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/minter.canister.ts#L102) +[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/minter.canister.ts#L104) ##### :gear: retrieveBtc @@ -167,7 +167,7 @@ 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#L121) +[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/minter.canister.ts#L123) ##### :gear: retrieveBtcWithApproval @@ -193,7 +193,7 @@ Parameters: - `params.fromSubaccount`: An optional subaccount from which the ckBTC should be transferred. -[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/minter.canister.ts#L151) +[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/minter.canister.ts#L153) ##### :gear: retrieveBtcStatus @@ -209,21 +209,22 @@ Parameters: - `transactionId`: The ID of the corresponding burn transaction. - `certified`: query or update call -[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/minter.canister.ts#L183) +[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/minter.canister.ts#L185) ##### :gear: retrieveBtcStatusV2ByAccount -Returns the status of all BTC withdrawals for the user's main account. +Returns the status of all BTC withdrawals for an account. -| Method | Type | -| ------------------------------ | ----------------------------------------------------------------------------------- | -| `retrieveBtcStatusV2ByAccount` | `({ certified, }: { certified: boolean; }) => Promise` | +| Method | Type | +| ------------------------------ | ------------------------------------------------------------------------------------------------------- | +| `retrieveBtcStatusV2ByAccount` | `({ account, certified, }: RetrieveBtcStatusV2ByAccountParams) => Promise` | Parameters: - `certified`: query or update call +- `account`: an optional account to retrieve the statuses. If not provided, statuses for the caller are retrieved. -[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/minter.canister.ts#L200) +[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/minter.canister.ts#L203) ##### :gear: estimateWithdrawalFee @@ -239,7 +240,7 @@ 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#L221) +[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/minter.canister.ts#L237) ##### :gear: getMinterInfo @@ -254,7 +255,7 @@ 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#L235) +[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/ckbtc/src/minter.canister.ts#L251)