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

ledger: wait for node to sync before running cli commands #1258

Merged
merged 5 commits into from
Apr 13, 2023
Merged

ledger: wait for node to sync before running cli commands #1258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6912180
ledger: wait for node to sync before running cli commands
Mar 27, 2023
e8bbe47
fixup: improve retry logic
Mar 27, 2023
354c7de
ledger: change wait time strategy
Mar 27, 2023
6354951
ledger: wait for node to sync before running cli commands
Mar 27, 2023
7dbb8a5
changelog: add #1258
tzemanovic Mar 30, 2023
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
3 changes: 3 additions & 0 deletions .changelog/unreleased/improvements/1258-improve-cli-check.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- Check in the client that the ledger node has at least one
block and is synced before submitting transactions and queries.
([#1258](https://github.com/anoma/namada/pull/1258))
96 changes: 95 additions & 1 deletion apps/src/bin/namada-client/cli.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
//! Namada client CLI.

use std::time::Duration;

use color_eyre::eyre::Result;
use namada_apps::cli;
use namada_apps::cli::cmds::*;
use namada_apps::cli::{self, safe_exit};
use namada_apps::client::{rpc, tx, utils};
use namada_apps::facade::tendermint::block::Height;
use namada_apps::facade::tendermint_config::net::Address as TendermintAddress;
use namada_apps::facade::tendermint_rpc::{Client, HttpClient};
use tokio::time::sleep;

pub async fn main() -> Result<()> {
match cli::namada_client_cli()? {
Expand All @@ -13,86 +19,126 @@ pub async fn main() -> Result<()> {
match cmd {
// Ledger cmds
Sub::TxCustom(TxCustom(args)) => {
wait_until_node_is_synched(&args.tx.ledger_address).await;
tx::submit_custom(ctx, args).await;
}
Sub::TxTransfer(TxTransfer(args)) => {
wait_until_node_is_synched(&args.tx.ledger_address).await;
tx::submit_transfer(ctx, args).await;
}
Sub::TxIbcTransfer(TxIbcTransfer(args)) => {
wait_until_node_is_synched(&args.tx.ledger_address).await;
tx::submit_ibc_transfer(ctx, args).await;
}
Sub::TxUpdateVp(TxUpdateVp(args)) => {
wait_until_node_is_synched(&args.tx.ledger_address).await;
tx::submit_update_vp(ctx, args).await;
}
Sub::TxInitAccount(TxInitAccount(args)) => {
wait_until_node_is_synched(&args.tx.ledger_address).await;
tx::submit_init_account(ctx, args).await;
}
Sub::TxInitValidator(TxInitValidator(args)) => {
wait_until_node_is_synched(&args.tx.ledger_address).await;
tx::submit_init_validator(ctx, args).await;
}
Sub::TxInitProposal(TxInitProposal(args)) => {
wait_until_node_is_synched(&args.tx.ledger_address).await;
tx::submit_init_proposal(ctx, args).await;
}
Sub::TxVoteProposal(TxVoteProposal(args)) => {
wait_until_node_is_synched(&args.tx.ledger_address).await;
tx::submit_vote_proposal(ctx, args).await;
}
Sub::TxRevealPk(TxRevealPk(args)) => {
wait_until_node_is_synched(&args.tx.ledger_address).await;
tx::submit_reveal_pk(ctx, args).await;
}
Sub::Bond(Bond(args)) => {
wait_until_node_is_synched(&args.tx.ledger_address).await;
tx::submit_bond(ctx, args).await;
}
Sub::Unbond(Unbond(args)) => {
wait_until_node_is_synched(&args.tx.ledger_address).await;
tx::submit_unbond(ctx, args).await;
}
Sub::Withdraw(Withdraw(args)) => {
wait_until_node_is_synched(&args.tx.ledger_address).await;
tx::submit_withdraw(ctx, args).await;
}
// Ledger queries
Sub::QueryEpoch(QueryEpoch(args)) => {
wait_until_node_is_synched(&args.ledger_address).await;
rpc::query_and_print_epoch(args).await;
}
Sub::QueryTransfers(QueryTransfers(args)) => {
wait_until_node_is_synched(&args.query.ledger_address)
.await;
rpc::query_transfers(ctx, args).await;
}
Sub::QueryConversions(QueryConversions(args)) => {
wait_until_node_is_synched(&args.query.ledger_address)
.await;
rpc::query_conversions(ctx, args).await;
}
Sub::QueryBlock(QueryBlock(args)) => {
wait_until_node_is_synched(&args.ledger_address).await;
rpc::query_block(args).await;
}
Sub::QueryBalance(QueryBalance(args)) => {
wait_until_node_is_synched(&args.query.ledger_address)
.await;
rpc::query_balance(ctx, args).await;
}
Sub::QueryBonds(QueryBonds(args)) => {
wait_until_node_is_synched(&args.query.ledger_address)
.await;
rpc::query_bonds(ctx, args).await;
}
Sub::QueryBondedStake(QueryBondedStake(args)) => {
wait_until_node_is_synched(&args.query.ledger_address)
.await;
rpc::query_bonded_stake(ctx, args).await;
}
Sub::QueryCommissionRate(QueryCommissionRate(args)) => {
wait_until_node_is_synched(&args.query.ledger_address)
.await;
rpc::query_and_print_commission_rate(ctx, args).await;
}
Sub::QuerySlashes(QuerySlashes(args)) => {
wait_until_node_is_synched(&args.query.ledger_address)
.await;
rpc::query_slashes(ctx, args).await;
}
Sub::QueryDelegations(QueryDelegations(args)) => {
wait_until_node_is_synched(&args.query.ledger_address)
.await;
rpc::query_delegations(ctx, args).await;
}
Sub::QueryResult(QueryResult(args)) => {
wait_until_node_is_synched(&args.query.ledger_address)
.await;
rpc::query_result(ctx, args).await;
}
Sub::QueryRawBytes(QueryRawBytes(args)) => {
wait_until_node_is_synched(&args.query.ledger_address)
.await;
rpc::query_raw_bytes(ctx, args).await;
}

Sub::QueryProposal(QueryProposal(args)) => {
wait_until_node_is_synched(&args.query.ledger_address)
.await;
rpc::query_proposal(ctx, args).await;
}
Sub::QueryProposalResult(QueryProposalResult(args)) => {
wait_until_node_is_synched(&args.query.ledger_address)
.await;
rpc::query_proposal_result(ctx, args).await;
}
Sub::QueryProtocolParameters(QueryProtocolParameters(args)) => {
wait_until_node_is_synched(&args.query.ledger_address)
.await;
rpc::query_protocol_parameters(ctx, args).await;
}
}
Expand All @@ -115,3 +161,51 @@ pub async fn main() -> Result<()> {
}
Ok(())
}

/// Wait for a first block and node to be synced. Will attempt to
async fn wait_until_node_is_synched(ledger_address: &TendermintAddress) {
let client = HttpClient::new(ledger_address.clone()).unwrap();
let height_one = Height::try_from(1_u64).unwrap();
let mut try_count = 0_u64;
const MAX_TRIES: u64 = 5;

loop {
let node_status = client.status().await;
match node_status {
Ok(status) => {
let latest_block_height = status.sync_info.latest_block_height;
let is_catching_up = status.sync_info.catching_up;
let is_at_least_height_one = latest_block_height >= height_one;
if is_at_least_height_one && !is_catching_up {
return;
} else {
if try_count > MAX_TRIES {
println!(
"Node is still catching up, wait for it to finish \
synching."
);
safe_exit(1)
} else {
println!(
" Waiting for {} ({}/{} tries)...",
if is_at_least_height_one {
"a first block"
} else {
"node to sync"
},
try_count + 1,
MAX_TRIES
);
sleep(Duration::from_secs((try_count + 1).pow(2)))
.await;
}
try_count += 1;
}
}
Err(e) => {
eprintln!("Failed to query node status with error: {}", e);
safe_exit(1)
}
}
}
}