Community Blueprints
Community blueprints are externally maintained Node Runners blueprints created by the community. They follow the same architecture as built-in blueprints but are published and maintained independently.
The community blueprint system is new. Be the first to publish one! See Creating Your Own Blueprint below.
Catalog
Community blueprints will be listed here as they are published and submitted for inclusion.
| Protocol | Package | Maintainer | Docs | Networks | Install |
|---|---|---|---|---|---|
| Example Chain | aws-bnr-blueprint-example-chain | @example-org | README | Mainnet, Testnet | npm install aws-bnr-blueprint-example-chain |
The example above shows the format. Real entries will appear once community blueprints are submitted.
Using a Community Blueprint
-
Install the package:
npm install aws-bnr-blueprint-<protocol>Or from a GitHub repository:
npm install github:org/aws-bnr-blueprint-<protocol> -
Configure your
.envfile using the blueprint's sample configs (check the blueprint's README for available networks and options). -
Deploy with the AI workflow (recommended):
@deploy using <protocol> blueprint on <network>Or deploy manually with
npx cdk deploy. -
Security review: On first use of any community blueprint, the AI workflow performs an automated security review of its configuration scripts before deployment. See the Security Review Guide for details.
Community blueprints are maintained by their respective authors. They have not been reviewed or endorsed by AWS. The automated security review helps catch common issues, but you should review any blueprint's source code before deploying to production.
Creating Your Own Blueprint
Want to add support for a new blockchain protocol? Community blueprints use the same pluggable NPM package system as built-in ones — there is no distinction at runtime.
Resources
- About Blueprints — Architecture overview, directory structure,
package.jsonformat, and the pluggable NPM system explained. - Add Protocol with AI — Step-by-step AI-assisted workflow for creating a new blueprint. Covers both core maintainer (Path A) and community developer (Path B) flows.
- Dummy Blueprint — The canonical reference implementation. Use it as your starting template.
- Contributing Guidelines — General contribution process, PR etiquette, and licensing.
Quick Summary
- Create your blueprint package following the structure in About Blueprints
- Include the
"aws-blockchain-node-runner"field in yourpackage.json(see format reference) - Publish to NPM or a public GitHub repository
- Submit for catalog listing
The fastest way to create a new blueprint is with the @add-protocol AI workflow. It guides you through the entire process interactively — from fetching your protocol's docs to generating all required files. See Add Protocol with AI for details.