# Aptos Node Management & CLI Cheat Sheet ## Staking (Validator Staking Pool) ### **Create Staking Pool (Validator Contract)** ```bash aptos stake create-staking-contract \ --operator \ --voter \ --amount 100000000000000 \ --commission-percentage 10 \ --profile ``` *Initializes a staking pool (requires ≥1,000,000 APT stake). Commission `10` equals 10%.* ### **Add Stake to Validator Pool** ```shell aptos stake add-stake --amount --profile ``` *Adds more APT to an existing validator’s stake.* ### **Increase Stake Lockup** ```shell aptos stake increase-lockup --profile ``` *Extends the lockup period for the staked funds (uses the maximum lockup by default).* ### **Unlock Stake (Begin Unstaking)** ```shell aptos stake unlock-stake --amount --profile ``` *Requests to unlock a portion of stake. The stake moves to `pending_inactive` and will become withdrawable after the lockup period ends.* ### **Withdraw Stake (After Unlock)** ```shell aptos stake withdraw-stake --amount --profile ``` *Withdraws unlocked stake (must be in `inactive` state after lockup expiration).* ### **Switch Operator Account** ```shell aptos stake set-operator --operator-address --profile ``` *Changes the operator of the staking pool (the new operator should be running a node).* ### **Switch Delegated Voter** ```shell aptos stake set-delegated-voter --voter-address --profile ``` *Changes the designated voting account for governance (the new voter must have the same or longer lockup as the owner).* ### **Request Staking Commission** ```shell aptos stake request-commission \ --operator-address \ --owner-address \ --profile ``` *Claims the validator operator’s commission rewards. This must be called **twice** for each epoch’s rewards: once before the lockup period ends (to initiate unlocking of commission), and once after the epoch/lockup ends (to actually withdraw the commission). Ensure both the operator and owner addresses are provided.* ### **Update Commission Percentage** ```shell aptos move run \ --function-id 0x1::staking_contract::update_commission \ --args address: u64: \ --profile ``` *Updates the staking pool’s commission rate (owner only). For example, `1325` = 13.25%. Must be requested at least 7.5 days before the current lockup ends; new rate takes effect after the lockup expires and a new epoch begins (triggered by calling `request-commission` after lockup)*. ### **Set Commission Beneficiary (Operator)** ```shell aptos move run \ --function-id 0x1::staking_contract::set_beneficiary_for_operator \ --args address: \ --profile ``` *Sets an address to receive the operator’s commission rewards for this staking pool*. *Any commission accrued but not yet paid will be paid out to the new beneficiary upon the next distribution*. ### **View Commission Beneficiary** ```shell aptos move view \ --function-id 0x1::staking_contract::beneficiary_for_operator \ --args address: \ --url https://fullnode.mainnet.aptoslabs.com/v1 ``` *Displays the current beneficiary address set for the operator*. ### **Check Staking Pool Status** ```shell aptos node get-stake-pool --owner-address --profile ``` *Shows details of your staking pool (state, pool\_address, operator, voter, total\_stake, commission %, etc.)*. *Use the `pool_address` (resource account) in your node’s config. State will be `Active` if already in validator set or `Pending_active` if waiting for next epoch*. ## Delegation Pool (Multi-Delegator Staking) ### **Add Stake to Delegation Pool** ```shell aptos move run \ --function-id 0x1::delegation_pool::add_stake \ --args address: u64: \ --profile ``` *Delegate coins to a validator’s delegation pool at `pool_address`. Minimum 10 APT required to delegate*. *(plus a small fee, mostly refunded as rewards).* ### **Unlock Delegated Stake** ```shell aptos move run \ --function-id 0x1::delegation_pool::unlock \ --args address: u64: \ --profile ``` *Initiates unstaking of delegated APT. The specified amount moves to a pending inactive state in the pool, and will become withdrawable after the lockup period ends*. ### **Reactivate Stake (Cancel Unlock)** ```shell aptos move run \ --function-id 0x1::delegation_pool::reactivate_stake \ --args address: u64: \ --profile ``` *Reverses a pending unlock, moving the stake back to active status (before it becomes fully inactive)*. ### **Withdraw Inactive Stake** ```shell aptos move run \ --function-id 0x1::delegation_pool::withdraw \ --args address: u64: \ --profile ``` *Withdraws your inactive stake from the delegation pool to your account (only funds that have completed the unlock period can be withdrawn)*. ### **Set Delegation Pool Operator (Owner)** ```shell aptos move run \ --function-id 0x1::delegation_pool::set_operator \ --args address: \ --profile ``` *Assigns a new operator for the delegation pool (owner only)*.*The operator’s account will run the validator node and earn the set commission on rewards.* ### **Update Delegation Pool Commission** ```shell aptos move run \ --function-id 0x1::delegation_pool::update_commission_percentage \ --args u64: \ --profile ``` *Changes the commission rate for the delegation pool (owner only). The value has two decimal places (e.g. `1325` = 13.25%). Must be initiated >7 days before epoch end; new rate takes effect after the current lockup cycle finishes and the owner calls `synchronize_delegation_pool` in the new epoch*. ### **Set Commission Beneficiary (Delegation Pool Operator)** ```shell aptos move run \ --function-id 0x1::delegation_pool::set_beneficiary_for_operator \ --args address: \ --profile ``` *Sets an address to receive the operator’s commission for all delegation pools this operator manages*. *The beneficiary can then unlock/withdraw the commission rewards on behalf of the operator.* ### **View Delegation Pool Beneficiary** ```shell aptos move view \ --function-id 0x1::delegation_pool::beneficiary_for_operator \ --args address: \ --url https://fullnode.mainnet.aptoslabs.com/v1 ``` *Shows the currently set beneficiary address for the operator’s commission*. ### **Find Delegation Pool Address (by Owner)** ```shell aptos move view \ --function-id 0x1::delegation_pool::get_owned_pool_address \ --args address: \ --url https://fullnode.mainnet.aptoslabs.com/v1 ``` *Returns the resource account address of the delegation pool owned by the given owner address (if one exists)*. ### **Check Delegation Pool Stake** ```shell aptos move view \ --function-id 0x1::delegation_pool::get_delegation_pool_stake \ --args address: \ --url https://fullnode.mainnet.aptoslabs.com/v1 ``` *Shows the total stake in the pool split by state: active, inactive, pending\_active, pending\_inactive*. ## Governance (On-Chain Proposals & Voting) ### **List Active Proposals** ```shell aptos governance list-proposals --url https://fullnode.mainnet.aptoslabs.com/v1 ``` *Displays all on-chain governance proposals and their details (proposal ID, status, etc.)*. ### **Vote on Proposal (Staking Pool Owner/Voter)** ```shell aptos governance vote \ --proposal-id \ --pool-address \ --profile \ --url https://fullnode.mainnet.aptoslabs.com/v1 ``` *Casts a vote on a governance proposal using your stake pool’s voting power*. *Use the stake **owner’s** profile (or delegated voter’s profile) and the stake **pool’s** address. Ensure your stake’s lockup is at least as long as the proposal voting period.* ### **Execute Approved Proposal** ```shell aptos governance execute-proposal --proposal-id --url https://fullnode.mainnet.aptoslabs.com/v1 ``` *Anyone may execute a proposal that has passed and met quorum, to enact the changes on-chain*. *This will run the proposal’s payload (such as code upgrade or parameter change). Only use on proposals in "Passed" state.* ### **Vote as Delegator (Delegation Pool)** ```shell aptos move run \ --function-id 0x1::delegation_pool::vote \ --args address: u64: u64: bool: \ --profile ``` *Vote on a proposal with a delegation pool stake. You can specify an amount of voting power (in APT) up to your active stake. `bool:true` = YES, `bool:false` = NO*. ### **Delegate Your Voting Power** ```shell aptos move run \ --function-id 0x1::delegation_pool::delegate_voting_power \ --args address: address: \ --profile ``` *Delegates your governance voting rights to another address. The delegated voter will vote on proposals using your stake’s power. This change takes effect in the next lockup cycle*. ### **View Delegated Voter** ```shell aptos move view \ --function-id 0x1::delegation_pool::calculate_and_update_delegator_voter \ --args address: address: \ --url https://fullnode.mainnet.aptoslabs.com/v1 ``` *Shows which voter address is currently designated to vote on behalf of the given delegator in the pool.* ## Node Operations & Status ### **Update Validator Network Addresses** ```shell aptos node update-validator-network-addresses \ --pool-address \ --operator-config-file ~/workspace//operator.yaml \ --profile ``` *Updates your validator’s on-chain network addresses (for validator node and its fullnode). Run this after editing your `operator.yaml` with the correct addresses. Changes take effect at the next epoch*. ### **Update Consensus Key** ```shell aptos node update-consensus-key \ --pool-address \ --operator-config-file ~/workspace//operator.yaml \ --profile ``` *Rotates the validator’s consensus public key on-chain. Use the new key in your node config file before running this. Takes effect after the current epoch ends*. ### **Join Validator Set** ```shell aptos node join-validator-set --pool-address --profile ``` *Signals that your validator (with an active stake pool) wants to join the consensus validator set*. *The validator will enter `Pending_active` state and will become an active validator at the next epoch boundary.* ### **Leave Validator Set** ```shell aptos node leave-validator-set --profile ``` *Voluntarily removes your validator from the active set. The validator will move to an inactive state at the next epoch (or immediately if stake falls below minimum)*. ### **Check Validator Set Status** ```shell aptos node show-validator-set --profile ``` *Displays the current on-chain list of validators. Look for your `pool_address` in the output. (For example, to see if you’re in pending or active set: `aptos node show-validator-set | jq -r '.Result.pending_active[] | .pool_address'` and likewise for `.active_validators`).* ### **Check Validator Performance** ```shell aptos node get-performance --pool-address --profile ``` *Shows your validator’s performance stats for recent epochs, including successful proposals and voting on governance, as well as rewards earned*. ### **Analyze Performance (All Epochs)** ```shell aptos node analyze-validator-performance \ --analyze-mode detailed-epoch-table \ --start-epoch 0 --profile | grep ``` *Outputs a table of performance metrics for every epoch since genesis. You can grep for your pool address to find your validator’s history*. ### **Basic Node Health Check** ```shell curl -s http://127.0.0.1:8080/v1/-/healthy ``` *Returns HTTP 200 if the node’s REST API is up and the node is healthy (latest ledger info is recent)*. *A non-200 response or error indicates the node is unhealthy.* ### **Check Sync Progress** ```shell curl -s http://127.0.0.1:9101/metrics | grep "aptos_state_sync_version{.*\"synced\"}" | awk '{print $2}' ``` *Queries the node’s metrics to get the highest synced ledger version*. *Compare this number with the latest block height on an explorer; if it’s catching up, the node is syncing properly (Requires the metrics port, default 9101, to be accessible).* ### **Check Peer Connectivity** ```shell curl -s http://127.0.0.1:9101/metrics | grep 'aptos_connections{direction="outbound"' ``` *Shows the count of outbound peer connections from your node*. *A healthy node should have a non-zero number of outbound peers. If it’s `0`, your node isn’t connecting to the network (check network config or update to the latest release).* ### **Get Node Ledger Info** ```shell curl -s http://127.0.0.1:8080/v1/ | jq '{chain_id, block_height, git_hash}' ``` *Fetches basic ledger information from the node’s REST API, including the chain ID, current block height, and the node’s git commit hash (version)*. ### **Check Node Version (Binary)** ```shell aptos-node --version ``` *If running a local binary, this outputs the Aptos node software version and commit hash (Not an Aptos CLI command, but the node binary itself).* ### **View Running Docker Container** *(if using Docker)* ```shell docker ps | grep aptos ``` *Verifies the Aptos node container is running. Note the container NAME or ID and image tag (which indicates the release version).* ### **Check Ledger DB Size (Docker)** ```shell docker exec -it du -sh /opt/aptos/data ``` *Shows the storage used by the node’s ledger database inside the container*. *This helps monitor disk usage growth over time.* ### **Check Ledger DB Size (Bare Metal)** ```shell du -sh /opt/aptos/data ``` *If running natively on bare metal, check the data directory size (path may vary based on your config). Default ledger directory is `/opt/aptos/data` for many installations.* ### **Tail Node Logs (Docker)** ```shell docker logs -f ``` *Streams the Aptos node’s logs in real-time. Useful for debugging issues (e.g., consensus, networking problems). Press Ctrl+C to stop.* --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://cryptomolot.gitbook.io/cryptomolot-docs/mainnets/aptos/aptos-node-management-and-cli-cheat-sheet.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.