v2 -- Bitcoin Core Implementation #207

racket2000 · 2025-06-11T18:37:43Z

What does this PR do?

🛑 Please open an issue first to discuss any significant work and flesh out details/direction - we would hate for your time to be wasted.
Consult the CONTRIBUTING guide for submitting pull-requests.

Motivation

License

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

More

Yes, I have tested the PR using my local account setup (Provide any test evidence report under Additional Notes)
Mandatory for new node blueprints. Yes, I have added usage example to the README.md file in my blueprint folder
Mandatory for new node blueprints. Yes, I have implemented automated tests for all stacks in my blueprint and they pass
Mandatory for new node blueprints. Yes, I have added a reference to my README.md file to website/docs section for this feature
Yes, I have set up and ran all pre-merge quality control tools on my local machine and they don't show warnings.

For Moderators

The tests for all current blueprints successfully complete before merge?
Mandatory for new node blueprints. All pre-merge quality control tools and cdk-nag tools don't show warnings?
Mandatory for new node blueprints. The deployment test works on blank AWS account according to instructions in the README.md before merge?
Mandatory for new node blueprints. The website builds without errors?

Additional Notes

I have incorporated all feedback to refactor the Blueprint to better align with other ones.

…gn with other bluepritns

github-actions · 2025-07-24T00:07:51Z

This PR has been automatically marked as stale because it has been open 30 days
with no activity. Remove stale label or comment or this PR will be closed in 10 days

frbrkoala

Thanks again for the contribution! It is a great blueprint and it will be wonderful to have it merged once all the problems are fixed.
Please also note that you need to add a file with reference to the local README.md inside the website/docs/blueprints directory to make it visible on the public web page. Example: https://github.com/aws-samples/aws-blockchain-node-runners/blob/main/website/docs/Blueprints/Base.md

frbrkoala · 2025-07-30T23:39:21Z

lib/bitcoin-core/generateRPCAuth.js

This is a command line script and uses generic "crypto" module. Choosing to use JavaScript for this script introduces extra dependencies to the global OR local package.json files, which is not allowed.
Can it be rewritten in bash with standard linux tools and OpenSSL for crypto?

I understand that "introducing extra dependencies to the global or local package.json is not allowed", and it is a personal opinion you have.

However, it is absolutely necessary to incorporate the Secrets Manager dependency, as the generateRPCAuth script requires it to securely store the credentials which are needed to access the node. (To my understanding, this is the only Blueprint that requires credentials for performing external RPC Requests )

FYI, the generateRPCAuth.js script is based on an opensource tool.

The above links to this script , which I expanded upon.

Though it can be rewritten in bash, I do not believe it is worth my time or effort to do so.

I am closing this.

We have successfully maintained our protocol of avoiding additional dependencies in both global and local package.json files across all blueprints. Please continue adhering to this standard by:

Evaluating if new dependencies are absolutely essential, rather than merely convenient

Prioritizing Bash implementations where feasible

Thoroughly exploring alternative solutions before introducing new dependencies

Please note that this requirement serves as a critical blocking issue for this blueprint. The inclusion of new dependencies will only be considered if there is substantial evidence demonstrating that:

A Bash implementation is not viable

Alternative dependency-free solutions are not feasible

Before proceeding, please ensure these criteria are thoroughly evaluated and documented.

Please note that crypto module is part of NodeJS standard API. There shouldn't be any addition to package.json

Noted with thanks. The script includes "@aws-sdk/client-secrets-manager" and "base64url" that are also added as dependencies to the root package.json file, and that is a problem. See our conversation here: https://github.com/aws-samples/aws-blockchain-node-runners/pull/207/files/c78aab85e13997f02078bfedd442835b22ec098c#r2244133508

The reason I brought up "crypto" in the original message is to highlight that there is no Bitcoin-specific cryptography involved in this logic. Therefore, there is a potential to use OpenSSL to do the same in Bash. This needs to be researched.

frbrkoala · 2025-07-30T23:39:55Z

lib/bitcoin-core/generateRPCAuth.js

+const { SecretsManagerClient, CreateSecretCommand, PutSecretValueCommand } = require('@aws-sdk/client-secrets-manager');
+
+// Set up AWS SDK client
+const client = new SecretsManagerClient({ region: 'us-east-1' }); // Change region if needed


AWS region is hard coded. Please make this configurable as the script can be used in different regions.

frbrkoala · 2025-07-30T23:49:25Z

lib/bitcoin-core/lib/assets/blockheight-cron.sh

Please follow the sync-checker pattern for script naming and use of systemd services instead of corn. Cron is no longer comes as standard in newer versions of Linux. Example implementation of SyncChecker scripts: https://github.com/aws-samples/aws-blockchain-node-runners/tree/main/lib/base/lib/assets/sync-checker

frbrkoala · 2025-07-30T23:50:31Z

lib/bitcoin-core/lib/assets/blockheight-cron.sh

Please make sure the script reports at least two metrics: Current Block Height and Blocks Behind. That way operator will get a clearer picture on how the node is performing.

frbrkoala · 2025-07-30T23:51:42Z

lib/bitcoin-core/lib/assets/cloudwatch-setup.sh

+      "mem": {
+        "measurement": ["mem_used_percent"]
+      },
+      "cpu": {


Please add "cpu_usage_iowait"

frbrkoala · 2025-07-31T01:15:17Z

lib/bitcoin-core/sample-configs/.env-sample-bitcoin-mainnet

The file name says it is a configuration for mainet, but the config doesn't seem to have a variable setting to choose between mainnet and testnet. Is it possible to configure in bitcoin? And, if yes, can it be implemented in the blueprint?

frbrkoala · 2025-07-31T01:21:42Z

lib/bitcoin-core/test/ha-node-stack.test.ts

+        template.hasResourceProperties("AWS::ElasticLoadBalancingV2::TargetGroup", {
+            Port: 8332,
+            Protocol: "HTTP",
+        });


The test doesn't validate Security Groups and actual configuration parameters for Launch Templates (just matches any value). Also skips testing majority of the parameters for ALB target group, ALB configuration, autoScaling Group ( just matches any value), Instance IAM role, etc. Please make testes more explicit and follow this example for reference:

aws-blockchain-node-runners/lib/base/test/ha-nodes-stack.test.ts

Line 26 in 5c8636c

template.hasResourceProperties("AWS::EC2::SecurityGroup", {

frbrkoala · 2025-07-31T01:22:32Z

lib/bitcoin-core/test/single-node-stack.test.ts

+
+        // Has EC2 instance with node configuration
+        template.hasResourceProperties("AWS::EC2::Instance", {
+            InstanceType: Match.stringLikeRegexp(".*"), // accept any value including 'undefined.undefined'


Please verify instance type

frbrkoala · 2025-07-31T01:23:53Z

lib/bitcoin-core/test/single-node-stack.test.ts

+
+
+        // Has CloudWatch dashboard
+        template.hasResourceProperties("AWS::CloudWatch::Dashboard", {


Please validate that dashboard name follows naming convention as it affects usability. Example:

aws-blockchain-node-runners/lib/base/test/base-single-node.test.ts

Line 137 in 5c8636c

DashboardName: {

frbrkoala · 2025-07-31T01:27:03Z

lib/bitcoin-core/README.md

+npx cdk deploy HABitcoinCoreNodeStack --json --outputs-file ha-nodes-deploy.json
+```
+
+### Deployment Architectures for Bitcoin Nodes


Please move this introductory section with architecture overview to the top, before Well Architected.

Simon Goldberg added 4 commits June 11, 2025 14:35

refactor to typescript along with several other changes to better ali…

2484005

…gn with other bluepritns

pre-commit

167f34c

fix single node stack tests

071c1b5

fix pre-commit pt2

a494a32

racket2000 mentioned this pull request Jun 11, 2025

Bitcoin Core Implementation #185

Closed

9 tasks

Simon Goldberg and others added 6 commits June 11, 2025 19:18

fix generateRPCAuth.js

ef8f008

update package.json

7739fa7

move local btc packages to root

64104ee

update package.json

7ad76fe

remove package-lock local

94e7d58

Merge branch 'main' into v2-bitcoin-core

c78aab8

github-actions bot added stale and removed stale labels Jul 24, 2025

frbrkoala requested changes Jul 31, 2025

View reviewed changes



		// Has CloudWatch dashboard
		template.hasResourceProperties("AWS::CloudWatch::Dashboard", {

v2 -- Bitcoin Core Implementation #207

Are you sure you want to change the base?

v2 -- Bitcoin Core Implementation #207

Uh oh!

Conversation

racket2000 commented Jun 11, 2025

What does this PR do?

Motivation

License

More

For Moderators

Additional Notes

Uh oh!

github-actions bot commented Jul 24, 2025

Uh oh!

frbrkoala left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

racket2000 Aug 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

racket2000 Aug 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

racket2000 Aug 5, 2025 •

edited

Loading

racket2000 Aug 5, 2025 •

edited

Loading