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.

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

fix: multiple typos of different importance #441

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 5 additions & 5 deletions bbn-test-4/finality-providers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ such as the finality provider's moniker, website, and identity.
To protect this registry against spam, we require finality providers to submit
a deposit using the self-custodial Bitcoin staking to lock `0.1 signet BTC` for
one year. The deposit will be fully in the custody of the finality provider,
but not be counted as active stake and can be retrieved
but not be counted as an active stake and can be retrieved
after the deposit period expires.

An entry can be created in this registry by opening a pull
Expand Down Expand Up @@ -172,12 +172,12 @@ curl https://bitcoin-testnet-archive.allthatnode.com \
f22b9a1892df0e50977455b85b65324b079a9f230c5a9dede5ac711b9415d15b
```

Once the transaction is submited onchain it outputs an transaction hash.
Once the transaction is submitted onchain it outputs a transaction hash.
Wait a few minutes and make sure that the transaction is included in the
blockchain by using the explorer
`https://live.blockcypher.com/btc-testnet/tx/<btc_staking_tx_hash>`.

> Make sure that the transaction has at least 6 confirmations block before
> Make sure that the transaction has at least 6 confirmation blocks before
> creation of the pull request.

Keep the following information for inclusion in your finality provider
Expand Down Expand Up @@ -248,7 +248,7 @@ are indeed the owner of the Bitcoin Public Key contained within it. You can do
so, by signing the file with the corresponding Bitcoin Private Key of your
finality provider. This is another step of validation that
guarantees that the information provided by the finality provider was not tempered
and that the finality provider posseses the private key of that particular pub key.
and that the finality provider possesses the private key of that particular pub key.

To sign the file,
head back to the guide that you used to create your finality provider keys,
Expand All @@ -274,7 +274,7 @@ The content of the file should be the plain value of the `schnorr_signature_hex`
__⚠ Warning!__
The signature was generated by reading the entire file data, not only the file
content. For proper verification, the exact file used for signing should
be submited in the pull request.
be submitted in the pull request.

## 5. Create Pull Request

Expand Down
4 changes: 2 additions & 2 deletions bbn-test-4/finality-providers/scripts/utils.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# USAGE:
# ./utils.sh

# creates usefull functions for other scripts to use.
# creates useful functions for other scripts to use.

# fpChanged verifies the modified files in the finality provider registry and returns it
# as a list ready to be iterated.
Expand All @@ -27,4 +27,4 @@ function checkCommandJq {
echo "Install it by checking https://stedolan.github.io/jq/download/"
exit 1
fi
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -33,21 +33,21 @@ for filePathRegistryFP in ${FP_CHANGED_FILES}; do
moniker=$(cat "$filePathRegistryFP" | jq -r '.description.moniker')
echo "fp moniker:" $moniker
if [ ${#moniker} -lt 3 ]; then
echo $moniker "has less than 3 characteres"
echo $moniker "has less than 3 characters"
exit 1
fi

securityContact=$(cat "$filePathRegistryFP" | jq -r '.description.security_contact')
echo "fp security_contact:" $securityContact
if [ ${#securityContact} -lt 4 ]; then
echo $securityContact "has less than 4 characteres"
echo $securityContact "has less than 4 characters"
exit 1
fi

commission=$(cat "$filePathRegistryFP" | jq -r '.commission')
echo "fp commission:" $commission
if ! [[ "$commission" =~ ^0\.[0-9]+$ ]]; then
echo $commission "is not valid commision decimal, use 0.1 for 10%"
echo $commission "is not valid commission decimal, use 0.1 for 10%"
exit 1
fi

Expand Down Expand Up @@ -75,4 +75,4 @@ for filePathRegistryFP in ${FP_CHANGED_FILES}; do
echo "stakercli check transaction"
FP_BTC_PK=$btcPk SIGNED_TX=$signedTx STAKERCLI_BIN=$STAKERCLI_BIN $CWD/fp-check-tx.sh
echo "✅ '${nickname}' is a valid fp offchain-registration"
done
done