Skip to content

Commit 3b2be14

Browse files
kelvinator07kelvinator07
committed
first commit
0 parents  commit 3b2be14

File tree

14 files changed

+5166
-0
lines changed

14 files changed

+5166
-0
lines changed

‎.github/workflows/python-tests.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Run Python Capstone Project Tests
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
run-tests:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- name: Checkout code
15+
uses: actions/checkout@v3
16+
17+
- name: Set up Docker
18+
uses: docker/setup-buildx-action@v3
19+
20+
- name: Set up Node.js with NVM
21+
run: |
22+
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
23+
export NVM_DIR="$HOME/.nvm"
24+
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
25+
nvm install --lts
26+
node -v
27+
npm install
28+
29+
- name: Make scripts executable
30+
run: |
31+
chmod +x ./test.sh
32+
chmod +x ./run.sh
33+
chmod +x ./python/run-python.sh
34+
35+
- name: Run test.sh
36+
run: |
37+
export NVM_DIR="$HOME/.nvm"
38+
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
39+
bash test.sh
40+
41+
- name: Check result
42+
if: ${{ failure() }}
43+
run: echo "❌ Some tests failed. Please review the output above."
44+
45+
- name: Check result on success
46+
if: ${{ success() }}
47+
run: echo "✅ All tests passed successfully!"
48+
49+
- name: Upload output file (optional)
50+
if: success()
51+
uses: actions/upload-artifact@v4
52+
with:
53+
name: out.txt
54+
path: ./out.txt

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/node_modules/
2+
/target/*
3+
__pycache__/
4+
.venv/

‎README.md‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# Btrust Builders: Python Language Club - Capstone Project: Setting up and interacting with a Bitcoin Node
2+
3+
## Overview
4+
5+
In this capstone project week, you'll learn how to use Bitcoin Core's RPC to interact with a running Bitcoin node. The tasks involve connecting to a Bitcoin Core RPC daemon, creating wallets, generating addresses, creating transactions, and mining Bitcoin blocks. You'll need a Bitcoin node running in `regtest` mode on your local machine to test your solution.
6+
7+
A [docker-compose](./docker-compose.yaml) file is provided to help you launch a Bitcoin node in `regtest` mode locally.
8+
9+
> [!TIP]
10+
> [OPTIONAL] You can also use the [bitcoin.conf](./bitcoin.conf) file to start a local regtest node with your locally built bitcoin binaries.
11+
> Copy the `bitcoin.conf` file in the default bitcoin data-directory `~/.bitcoin/`. If you don't have the data-directory, just create one.
12+
13+
14+
## Objective
15+
Implement the tasks in this specific directory: [main.py](./python/main.py)
16+
17+
Your program must:
18+
19+
- Create two wallet named `Miner` and `Trader`. The names are case-sensitive and should be exact.
20+
- Generate one address from the `Miner` wallet with a label "Mining Reward".
21+
- Mine new blocks to this address until you get positive wallet balance. (use `generatetoaddress`) (observe how many blocks it took to get to a positive balance)
22+
- Write a short comment describing why wallet balance for block rewards behaves that way.
23+
- Print the balance of the `Miner` wallet.
24+
- Create a receiving addressed labeled "Received" from `Trader` wallet.
25+
- Send a transaction paying 20 BTC from `Miner` wallet to `Trader`'s wallet.
26+
- Fetch the unconfirmed transaction from the node's mempool and print the result. (hint: `bitcoin-cli help` to find list of all commands, look for `getmempoolentry`).
27+
- Confirm the transaction by mining 1 block.
28+
29+
30+
### Output
31+
- Fetch the following details of the transaction and output them to a `out.txt` file in the following format. Each attribute should be on a new line.
32+
- `Transaction ID (txid)`
33+
- `Miner's Input Address`
34+
- `Miner's Input Amount (in BTC)`
35+
- `Trader's Output Address`
36+
- `Trader's Output Amount (in BTC)`
37+
- `Miner's Change Address`
38+
- `Miner's Change Amount (in BTC)`
39+
- `Transaction Fees (in BTC)`
40+
- `Block height at which the transaction is confirmed`
41+
- `Block hash at which the transaction is confirmed`
42+
43+
44+
- Sample output file:
45+
```
46+
57ecbb84fd3246ebcc734455fd30f5536637878b40fb2742d1a4fced3c28862c
47+
bcrt1qv5plgft75j0hegtvf6zs5pajh7k0gxg2dhj224
48+
50
49+
bcrt1qak6gpu2p6zjpwrhvd4dvdnp4rt3ysm9rpst3wu
50+
20
51+
bcrt1qxw3msnuqps0kgn6dprs9ldlz79yfj63swqupd0
52+
29.9999859
53+
-1.41e-05
54+
102
55+
3b821acd7c32c2b3da143e2c6b0134e5aa8206aeae0a54bfa4963e73ac2857a0
56+
```
57+
58+
### Local Testing Steps
59+
It's a good idea to run the whole test locally to ensure your code is working properly.
60+
- Ensure that you have `npm` and `nvm` installed and your system. You will need `node v18` or greater to run the test script.
61+
- Ensure that there is no `bitcoind` process running in your system.
62+
- Give execution permission to `test.sh`, by running `chmod +x ./test.sh`.
63+
- Execute [`./test.sh`](./test.sh).
64+
65+
If your code works, you will see the test completed successfully.
66+
67+
## Submission:
68+
- Create a commit with your local changes.
69+
- Push the commit to your forked repository (`git push origin main`).
70+
- The autograder will run your script against a test script to verify the functionality.
71+
- Check the status of the autograder on Github Actions to see if it passed successfully or failed.
72+
- You can submit multiple times before the deadline. The latest submission before the deadline will be considered your final submission.
73+
74+
### Common Issues
75+
- Your submission should not stop the Bitcoin Core daemon at any point.
76+
- Linux and MacOS are the recommended operating systems for this challenge. If you are using Windows, you may face compatibility issues.
77+
- The autograder will run the test script on an Ubuntu 22.04 environment. Make sure your script is compatible with this environment.
78+
- If you are unable to run the test script locally, you can submit your solution and check the results on the Github Actions tab.
79+
80+
## Evaluation Criteria
81+
Your submission will be evaluated based on:
82+
- **Autograder**: Your code must pass the autograder [test script](./test/test.spec.ts).
83+
- **Explainer Comments**: Include comments explaining each step of your code.
84+
- **Code Quality**: Your code should be well-organized, commented, and adhere to best practices.
85+
86+
### Plagiarism Policy
87+
Our plagiarism detection checker thoroughly identifies any instances of copying or cheating. Participants are required to publish their solutions in the designated repository, which is private and accessible only to the individual and the administrator. Solutions should not be shared publicly or with peers. In case of plagiarism, both parties involved will be directly disqualified to maintain fairness and integrity.
88+
89+
### AI Usage Disclaimer
90+
You may use AI tools like ChatGPT to gather information and explore alternative approaches, but avoid relying solely on AI for complete solutions. Verify and validate any insights obtained and maintain a balance between AI assistance and independent problem-solving.
91+
92+
## Why These Restrictions?
93+
These rules are designed to enhance your understanding of the technical aspects of Bitcoin. By completing this assignment, you gain practical experience with the technology that secures and maintains the trustlessness of Bitcoin. This challenge not only tests your ability to develop functional Bitcoin applications but also encourages deep engagement with the core elements of Bitcoin technology.

‎bitcoin.conf‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
regtest=1
2+
server=1
3+
4+
[regtest]
5+
rest=1
6+
rpcbind=0.0.0.0:18443
7+
rpcallowip=0.0.0.0/0
8+
#rpcauth=alice:88cae77e34048eff8b9f0be35527dd91$$d5c4e7ff4dfe771808e9c00a1393b90d498f54dcab0ee74a2d77bd01230cd4cc
9+
rpcuser=alice
10+
rpcpassword=password
11+
debug=1
12+
logips=1
13+
logtimemicros=1
14+
blockmintxfee=0
15+
deprecatedrpc=signrawtransaction
16+
listenonion=0
17+
fallbackfee=0.00001
18+
txindex=1

‎docker-compose.yaml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
services:
2+
bitcoin:
3+
image: btcpayserver/bitcoin:24.0.1-1
4+
environment:
5+
BITCOIN_NETWORK: regtest
6+
BITCOIN_EXTRA_ARGS: |
7+
server=1
8+
rest=1
9+
rpcbind=0.0.0.0:18443
10+
rpcallowip=0.0.0.0/0
11+
rpcauth=alice:88cae77e34048eff8b9f0be35527dd91$$d5c4e7ff4dfe771808e9c00a1393b90d498f54dcab0ee74a2d77bd01230cd4cc
12+
debug=1
13+
logips=1
14+
logtimemicros=1
15+
blockmintxfee=0
16+
deprecatedrpc=signrawtransaction
17+
listenonion=0
18+
fallbackfee=0.00001
19+
txindex=1
20+
ports:
21+
- "18443:18443"

‎jest.config.ts‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
import type { Config } from '@jest/types';
2+
3+
const config: Config.InitialOptions = {
4+
preset: 'ts-jest',
5+
verbose: true,
6+
moduleFileExtensions: ['js', 'json', 'ts'],
7+
rootDir: '.',
8+
testRegex: '.*\\.spec\\.ts$',
9+
transform: {
10+
'^.+\\.(t|j)s$': 'ts-jest',
11+
},
12+
testEnvironment: 'node',
13+
};
14+
export default config;

0 commit comments

Comments
 (0)