Skip to content

Instantly share code, notes, and snippets.

@nheingit
Last active February 14, 2024 18:49
Show Gist options
  • Save nheingit/be4a9c2ef3cbd4105dfc10cd6958c922 to your computer and use it in GitHub Desktop.
Save nheingit/be4a9c2ef3cbd4105dfc10cd6958c922 to your computer and use it in GitHub Desktop.
Layer 1 Blockchain Docs template

Getting Started

Dive right into [Blockchain Name] to start building or set up your tooling.

Setup Local Environment:

Instructions on installing the necessary CLI tools to get your local development environment ready.

Hello World:

Guide to building and deploying your first on-chain program using [Blockchain Name] Playground or a similar browser-based IDE.

Start Learning

Build a strong understanding of the core concepts that distinguish [Blockchain Name] from other blockchains.

  • Transactions: Explanation of how transactions are structured, including the collection of instructions for the blockchain to execute.

  • Accounts: Overview of the data and state storage mechanisms on [Blockchain Name].

  • Programs (Smart Contracts): Details on the executable code used to perform actions on the blockchain.

  • Cross-Program Invocation (Inter-Contract Calls): Explanation of how smart contracts can interact with each other, highlighting the composability within [Blockchain Name]. Understanding the Architecture

  • Familiarize yourself with the underlying architecture of the proof-of-stake (or relevant consensus mechanism) blockchain.

Validators:

  • Description of the nodes that form the backbone of the network.

  • Clusters (Networks): Information about the collection of validators working together to achieve consensus. Running a Validator

  • Discover what it takes to operate a validator on [Blockchain Name] and contribute to network security.

  • System Requirements: Recommended hardware specifications and any cryptocurrency holdings needed to operate a validator.

  • Quick Start Guide: Instructions to set up a validator and connect to a network cluster for the first time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment