Skip to content

Commit

Permalink
Merge pull request #69 from rsksmart/devportalAutoImplem
Browse files Browse the repository at this point in the history
Devportal auto implementation on main branch
  • Loading branch information
SebasGuaquetaRSK authored Dec 13, 2024
1 parent fb28096 commit 305132d
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 5 deletions.
11 changes: 9 additions & 2 deletions .github/workflows/devportal-update.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ jobs:
run: |
mkdir -p transformed
# Remove the unwanted lines from README.md
tail -n +3 README.md > temp_README.md
# Process README.md
echo "---" > transformed/README.md
echo "sidebar_label: Bitcoin Transaction Solidity Helper Library" >> transformed/README.md
Expand All @@ -44,7 +47,11 @@ jobs:
echo "If you wish to suggest changes on this document, please open a PR on the [Bitcoin Transaction Solidity Helper](https://github.com/rsksmart/btc-transaction-solidity-helper.git)" >> transformed/README.md
echo ":::" >> transformed/README.md
echo "" >> transformed/README.md
cat README.md >> transformed/README.md
cat temp_README.md >> transformed/README.md
# Clean up temporary file
rm temp_README.md
cp transformed/README.md devportal/docs/02-developers/08-libraries/bitcoin-tx-solidity-helper.md
# Step 3: Commit and Push Changes to Devportal Repository
Expand All @@ -71,4 +78,4 @@ jobs:
-H "Authorization: Bearer ${{ secrets.DEVPORTAL_DOCS_UPDATE_TOKEN }}" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/repos/rsksmart/devportal/pulls \
-d '{"title":"Automated update of documentation","body":"This PR updates the Devportal documentation with the latest changes from the original repository.","head":"update-from-btc-transaction-solidity-helper","base":"main"}'
-d '{"title":"Btc-transaction-solidity-helper automated update of documentation","body":"This PR updates the Devportal documentation with the latest changes from the original repository.","head":"update-from-btc-transaction-solidity-helper","base":"main"}'
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/rsksmart/btc-transaction-solidity-helper/badge)](https://scorecard.dev/viewer/?uri=github.com/rsksmart/btc-transaction-solidity-helper)
<img src="img/rootstock-docs.png" alt="RSK Logo" style="width:100%; height: auto;" />

<img src="rootstock-logo.png" alt="RSK Logo" style="width:100%; height: auto;" />
# btc-transaction-solidity-helper
# BTC Transaction Solidity Helper

Bitcoin, a decentralized digital currency, serves as both a store of value and a means of transferring wealth. Its security is rooted in the blockchain, a distributed ledger maintained by a network of miners. These miners expend significant computational power and energy to create new blocks, which are added to the blockchain every 10 minutes. The more hashing power contributed by miners, the more secure the network becomes. [Learn more about Bitcoin](https://developer.bitcoin.org/index.html).

Expand Down Expand Up @@ -105,6 +105,7 @@ require(expectedValue <= outputs[0].value, "incorrect amount");
The value field of the output structure is in satoshis.
:::


## Hashing Transactions
The hash algorithm used in the Bitcoin Network is just the `SHA256(SHA256())` of the serialized transaction. The library exposes one function that will apply this hash algorithm to any byte array passed to it, making it easy to calculate the transaction id of any raw transaction present in the contract.

Expand Down Expand Up @@ -174,4 +175,4 @@ Congratulations, we have successfully learnt how to use the Solidity Helper libr
* Please refer to the Rootstock Contribution Guidelines for more information on how to contribute to this project.

## License:
MIT License - Copyright (c) 2023 Rootstock
MIT License - Copyright (c) 2023 Rootstock
Binary file added img/rootstock-docs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes

0 comments on commit 305132d

Please sign in to comment.