Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CLI Doc: Update conway stake address registration #1408

Merged
merged 5 commits into from
Feb 27, 2025
Merged

CLI Doc: Update conway stake address registration #1408

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d1c6b69
CLI Doc: Update conway stake address registration
dev6699 Feb 23, 2025
6033004
CLI Doc: Standardized cardano-cli conway query
dev6699 Feb 23, 2025
85cbb20
CLI Doc: Replace cli `conway` with `latest`
dev6699 Feb 23, 2025
abcfda3
Revert "CLI Doc: Replace cli `conway` with `latest`"
dev6699 Feb 23, 2025
4542288
CLI Doc: Replace cli `conway` with `latest` in stakeaddress registration
dev6699 Feb 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 24 additions & 23 deletions docs/get-started/cardano-cli/get-started/stakeaddress-registration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,20 @@ keywords: [cardano-cli, cli, keys, stake addresses, register, cardano-node, tran
---

:::tip
To integrate the Conway era, which differs significantly from previous eras, `cardano-cli` has introduced `<era>` as a top-level command, replacing the former `<era>` flags. For example, instead of using era-specific flags like `--babbage-era` with commands such as `cardano-cli conway transaction build --babbage-era`, users must now utilize the syntax `cardano-cli conway transaction build <options>`.
To integrate the latest (Conway) era, which differs significantly from previous eras, `cardano-cli` has introduced `<era>` as a top-level command, replacing the former `<era>` flags. For example, instead of using era-specific flags like `--babbage-era` with commands such as `cardano-cli transaction build --babbage-era`, users must now utilize the syntax `cardano-cli <era> transaction build <options>`.
:::

## Registering a stake address

To participate in the protocol, such as delegating stake to a stake pool to earn rewards or, in the upcoming Conway era, delegating stake to a delegate representative, you must first register your stake credentials on the chain. This registration is accomplished by submitting a **stake address registration certificate** within a transaction. The process includes paying a deposit, the amount of which is determined by the `stakeAddressDeposit` protocol parameter. You can get the deposit back when you submit a **stake address deregistration certificate**.
To participate in the protocol, such as delegating stake to a stake pool to earn rewards or, in the Conway era, delegating stake to a delegate representative, you must first register your stake credentials on the chain. This registration is accomplished by submitting a **stake address registration certificate** within a transaction. The process includes paying a deposit, the amount of which is determined by the `stakeAddressDeposit` protocol parameter. You can get the deposit back when you submit a **stake address deregistration certificate**.

Delegating to a stake pool also involves submitting a certificate to the chain, in this case, a **stake address delegation certificate**.

You can easily generate such certificates with `cardano-cli`. The corresponding commands can be found under `cardano-cli conway stake-address`:
You can easily generate such certificates with `cardano-cli`. The corresponding commands can be found under `cardano-cli latest stake-address`:

```shell
cardano-cli conway stake-address
Usage: cardano-cli conway stake-address
cardano-cli latest stake-address
Usage: cardano-cli latest stake-address
( key-gen
| key-hash
| build
Expand All @@ -43,15 +43,16 @@ Usage: cardano-cli conway stake-address
Query the protocol parameters to find out the amount of lovelace required as a deposit for registering a stake address, in this case, it is 2000000 lovelace (two ada):

```shell
cardano-cli conway query protocol-parameters | jq .stakeAddressDeposit
cardano-cli latest query protocol-parameters | jq .stakeAddressDeposit
2000000
```

To generate the registration certificate, run:

```shell
cardano-cli stake-address registration-certificate \
cardano-cli latest stake-address registration-certificate \
--stake-verification-key-file stake.vkey \
--key-reg-deposit-amt 2000000 \
--out-file registration.cert
```

Expand All @@ -75,8 +76,8 @@ It's important to note that when using `build`, the deposit is automatically inc
### Using the `build` command

```shell
cardano-cli conway transaction build \
--tx-in $(cardano-cli query utxo --address $(< payment.addr) --output-json | jq -r 'keys[0]') \
cardano-cli latest transaction build \
--tx-in $(cardano-cli latest query utxo --address $(< payment.addr) --output-json | jq -r 'keys[0]') \
--change-address $(< payment.addr) \
--certificate-file registration.cert \
--out-file tx.raw
Expand Down Expand Up @@ -144,7 +145,7 @@ Using the `build-raw` command involves a slightly more intricate process. Simila
Query the balance of the `payment.addr`:

```shell
cardano-cli conway query utxo --address $(< paymentstake.addr)
cardano-cli latest query utxo --address $(< paymentstake.addr)
TxHash TxIx Amount
--------------------------------------------------------------------------------------
0690c70f117281627fc128ede51b1fe762c2bbc15c2e3d4eff2101c9d2613cd8 0 9999834851 lovelace + TxOutDatumNone
Expand All @@ -154,7 +155,7 @@ cardano-cli conway query utxo --address $(< paymentstake.addr)
You can leverage `jq` by having `cardano-cli` return the output in JSON:

```shell
cardano-cli conway query utxo --address $(< paymentstake.addr) --output-json
cardano-cli latest query utxo --address $(< paymentstake.addr) --output-json
{
"0690c70f117281627fc128ede51b1fe762c2bbc15c2e3d4eff2101c9d2613cd8#0": {
"address": "addr_test1qp9khgeajxw8snjjvaaule727hpytrvpsnq8z7h9t3zeue2jrk54ttv0yj7llrfuhr66z4wynpcqxuqeln0jp9y70e0qvjewan",
Expand All @@ -170,23 +171,23 @@ cardano-cli conway query utxo --address $(< paymentstake.addr) --output-json
```
Using `jq` to parse that JSON
```shell
cardano-cli conway query utxo --address $(< payment.addr) --output-json | jq -r .[].value.lovelace
cardano-cli latest query utxo --address $(< payment.addr) --output-json | jq -r .[].value.lovelace
9999834851
```
:::

Query the protocol parameters:

```shell
cardano-cli conway query protocol parameters --out-file pparams.json
cardano-cli latest query protocol parameters --out-file pparams.json
```

Draft the transaction to calculate its transaction fee:

```shell
cardano-cli conway transaction build-raw \
--tx-in $(cardano-cli query utxo --address $(< payment.addr) --output-json | jq -r 'keys[0]') \
--tx-out $(< payment.addr)+"$(cardano-cli conway query utxo --address $(< payment.addr) --out-file /dev/stdout | jq -r .[].value.lovelace)" \
cardano-cli latest transaction build-raw \
--tx-in $(cardano-cli latest query utxo --address $(< payment.addr) --output-json | jq -r 'keys[0]') \
--tx-out $(< payment.addr)+"$(cardano-cli latest query utxo --address $(< payment.addr) --out-file /dev/stdout | jq -r .[].value.lovelace)" \
--fee 0 \
--certificate-file registration.cert \
--out-file tx.draft
Expand All @@ -195,7 +196,7 @@ cardano-cli conway transaction build-raw \
Calculate the transaction fee, it is useful to assign the output to a variable (`fee`):

```shell
cardano-cli conway transaction calculate-min-fee \
cardano-cli latest transaction calculate-min-fee \
--tx-body-file tx.draft \
--protocol-params-file pparams.json \
--tx-in-count 1 \
Expand All @@ -210,14 +211,14 @@ Calculate the change of the transaction. Note that the deposit is not explicitly
Query the protocol parameters to get the deposit amount:

```shell
cardano-cli conway query protocol-parameters | jq .stakeAddressDeposit
cardano-cli latest query protocol-parameters | jq .stakeAddressDeposit
2000000
```
Query the current balance of `payment.addr`:


```shell
cardano-cli conway query utxo --address $(< payment.addr) --output-json | jq -r .[].value.lovelace
cardano-cli latest query utxo --address $(< payment.addr) --output-json | jq -r .[].value.lovelace
9999834851
```

Expand All @@ -228,8 +229,8 @@ change=$((9999834851 - 171089 - 2000000))
Build the transaction:

```shell
cardano-cli conway transaction build-raw \
--tx-in $(cardano-cli query utxo --address $(< payment.addr) --output-json | jq -r 'keys[0]') \
cardano-cli latest transaction build-raw \
--tx-in $(cardano-cli latest query utxo --address $(< payment.addr) --output-json | jq -r 'keys[0]') \
--tx-out $(< payment.addr)+$change \
--fee 171089 \
--certificate-file registration.cert \
Expand All @@ -238,13 +239,13 @@ cardano-cli conway transaction build-raw \
## Sign and submit the transaction

```shell
cardano-cli conway transaction sign \
cardano-cli latest transaction sign \
--tx-body-file tx.raw \
--signing-key-file payment.skey \
--out-file tx.signed
```
```shell
cardano-cli conway transaction submit \
cardano-cli latest transaction submit \
--tx-file tx.signed
```

Expand Down
Loading