You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Rename "claim_address" to "destination_address" (#119)
* Rename claim_address to destination_address for clarity in deposit and withdrawal commands
* fmt
* change all "claim"s to "destination" for clarity
* typo
---------
Co-authored-by: Ceyhun Şen <ceyhuusen@gmail.com>
Copy file name to clipboardExpand all lines: docs/deposit.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ The deposit process consists of several stages:
27
27
4.**Recovery (if needed)** - Recover funds if bridging fails
28
28
29
29
> [!IMPORTANT]
30
-
> The `RECOVERY_TAPROOT_ADDRESS` and the `DEPOSIT_ADDRESS` are different. The `RECOVERY_TAPROOT_ADDRESS` will belong to your Clementine wallet to be able to perform deposit specific signing operations in case the deposit fails, whereas the `DEPOSIT_ADDRESS` is the address you send Bitcoin to in order to perform the deposit operation. Your `RECOVERY_TAPROOT_ADDRESS` is used alongside the `N_of_N_ADDRESS` when creating the `DEPOSIT_ADDRESS` to make sure if the deposit fails, you can recover your funds back to your `CLAIM_ADDRESS`.
30
+
> The `RECOVERY_TAPROOT_ADDRESS` and the `DEPOSIT_ADDRESS` are different. The `RECOVERY_TAPROOT_ADDRESS` will belong to your Clementine wallet to be able to perform deposit specific signing operations in case the deposit fails, whereas the `DEPOSIT_ADDRESS` is the address you send Bitcoin to in order to perform the deposit operation. Your `RECOVERY_TAPROOT_ADDRESS` is used alongside the `N_of_N_ADDRESS` when creating the `DEPOSIT_ADDRESS` to make sure if the deposit fails, you can recover your funds back to your `DESTINATION_ADDRESS`.
31
31
32
32
## Step 1: Generate Deposit Address
33
33
@@ -101,14 +101,14 @@ Gather all necessary information on your online device:
101
101
-`RECOVERY_TAPROOT_ADDRESS`: Your wallet's recovery address (from airgapped device)
102
102
-`EVM_ADDRESS`: Your Citrea address used for the deposit
103
103
-`DEPOSIT_UTXO_OUTPOINT`: Your deposit Outpoint (`txid:vout`)
104
-
-`CLAIM_ADDRESS`: Bitcoin address where recovered funds will be sent
104
+
-`DESTINATION_ADDRESS`: Bitcoin address where recovered funds will be sent
Copy file name to clipboardExpand all lines: docs/withdraw.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ All available withdrawal commands can be viewed using `clementine-cli withdraw -
9
9
Before starting a withdrawal, ensure you have:
10
10
11
11
- A Clementine wallet with `withdrawal` purpose ("wit" prefix address)
12
-
- A Bitcoin address where funds will be sent (claim address)
12
+
- A Bitcoin address where funds will be sent (destination address)
13
13
- Access to both airgapped and online devices
14
14
- Sufficient balance on Citrea to withdraw
15
15
@@ -27,20 +27,20 @@ The withdrawal process follows these sequential steps:
27
27
8.**Check Status** - Monitor withdrawal progress for operator-paid withdrawal
28
28
29
29
> [!IMPORTANT]
30
-
> The `SIGNER_ADDRESS` and the `CLAIM_ADDRESS` are different. The `SIGNER_ADDRESS` will belong to your Clementine wallet to be able to perform withdrawal specific signing operations, whereas `CLAIM_ADDRESS` is the address that the withdrawn BTC funds will be sent to.
30
+
> The `SIGNER_ADDRESS` and the `DESTINATION_ADDRESS` are different. The `SIGNER_ADDRESS` will belong to your Clementine wallet to be able to perform withdrawal specific signing operations, whereas `DESTINATION_ADDRESS` is the address that the withdrawn BTC funds will be sent to.
31
31
32
32
## Step 1: Start Withdrawal
33
33
34
34
**ONLINE DEVICE OPERATION:** Start the withdrawal process:
Copy file name to clipboardExpand all lines: src/bitcoin_utils.rs
+27-25Lines changed: 27 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -79,14 +79,14 @@ fn sign_with_tweak(
79
79
}
80
80
81
81
#[allow(clippy::too_many_arguments)]
82
-
/// Sign a recovery transaction with a given keypair, Citrea address, recovery taproot address, deposit outpoint, deposit amount, claim address, fee rate, and network
82
+
/// Sign a recovery transaction with a given keypair, Citrea address, recovery taproot address, deposit outpoint, deposit amount, destination address, fee rate, and network
0 commit comments