Docs/external blueprint install peer deps#279
Merged
Conversation
Installing an external blueprint (`npm install aws-bnr-blueprint-<protocol>` or a github: URL) fails with npm E404 on npm 7+: the blueprint declares a peer dependency on the `aws-blockchain-node-runners` framework, which is not published to the npm registry, so strict peer resolution cannot satisfy it. Add `--legacy-peer-deps` (with a short explanation of why) to every external-blueprint install command across the docs: README, the community blueprints page, the blueprint security-review workflow, and the add-protocol workflow. Bare `npm install` (repo dependencies) is unaffected and left as-is. Surfaced while validating the first community blueprint (TRON, issue #263).
Add the TRON blueprint (aws-bnr-blueprint-tron, java-tron client) as the first entry in the community blueprint catalog. Supports FullNode and Lite FullNode variants on x86_64 and ARM64/Graviton, mainnet and Nile testnet. Install command includes --legacy-peer-deps for consistency with external blueprint install guidance. Closes #263
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
|
Scan for commit: 🔒 Security Scan ResultsScanned files: 4 ✅ No security issues found. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
Type of Change
Testing
npm run buildsuccessfullynpm run testand all tests passnpx cdk synthwith a sample.env(e.g. fromblueprints/dummy/samples/) and it succeedsnpm run run-pre-commitNew Blueprint Checklist (if adding a protocol)
blueprints/dummy/(reference implementation).envfiles are provided for at least one network (mainnet or testnet)blueprints/dummy/)website/docs/blueprints/(.mdx mirror importing README)Documentation
cd website && npm run buildwith no broken links (if docs changed)License
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.