{"id":18284837,"url":"https://github.com/samlet/subs.node","last_synced_at":"2025-07-06T04:40:59.616Z","repository":{"id":95955718,"uuid":"289494363","full_name":"samlet/subs.node","owner":"samlet","description":"substrate node","archived":false,"fork":false,"pushed_at":"2020-08-22T13:41:56.000Z","size":59,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-15T00:28:38.234Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/samlet.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-08-22T13:37:36.000Z","updated_at":"2020-08-22T13:41:58.000Z","dependencies_parsed_at":null,"dependency_job_id":"55195edb-59ef-4cde-9229-031290dbd076","html_url":"https://github.com/samlet/subs.node","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samlet%2Fsubs.node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samlet%2Fsubs.node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samlet%2Fsubs.node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samlet%2Fsubs.node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/samlet","download_url":"https://codeload.github.com/samlet/subs.node/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247987108,"owners_count":21028891,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T13:14:45.681Z","updated_at":"2025-04-09T05:47:44.971Z","avatar_url":"https://github.com/samlet.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Substrate Node Template\n\nA new FRAME-based Substrate node, ready for hacking :rocket:\n\n## Local Development\n\nFollow these steps to prepare a local Substrate development environment :hammer_and_wrench:\n\n### Simple Setup\n\nInstall all the required dependencies with a single command (be patient, this can take up to 30\nminutes).\n\n```bash\ncurl https://getsubstrate.io -sSf | bash -s -- --fast\n```\n\n### Manual Setup\n\nFind manual setup instructions at the\n[Substrate Developer Hub](https://substrate.dev/docs/en/knowledgebase/getting-started/#manual-installation).\n\n### Build\n\nOnce the development environment is set up, build the node template. This command will build the\n[Wasm](https://substrate.dev/docs/en/knowledgebase/advanced/executor#wasm-execution) and\n[native](https://substrate.dev/docs/en/knowledgebase/advanced/executor#native-execution) code:\n\n```bash\ncargo build --release\n```\n\n## Run\n\n### Single Node Development Chain\n\nPurge any existing dev chain state:\n\n```bash\n./target/release/node-template purge-chain --dev\n```\n\nStart a dev chain:\n\n```bash\n./target/release/node-template --dev\n```\n\nOr, start a dev chain with detailed logging:\n\n```bash\nRUST_LOG=debug RUST_BACKTRACE=1 ./target/release/node-template -lruntime=debug --dev\n```\n\n### Multi-Node Local Testnet\n\nIf you want to see the multi-node consensus algorithm in action, refer to\n[our Start a Private Network tutorial](https://substrate.dev/docs/en/tutorials/start-a-private-network/).\n\n## Template Structure\n\nA Substrate project such as this consists of a number of components that are spread across a few\ndirectories.\n\n### Node\n\nA blockchain node is an application that allows users to participate in a blockchain network.\nSubstrate-based blockchain nodes expose a number of capabilities:\n\n-   Networking: Substrate nodes use the [`libp2p`](https://libp2p.io/) networking stack to allow the\n    nodes in the network to communicate with one another.\n-   Consensus: Blockchains must have a way to come to\n    [consensus](https://substrate.dev/docs/en/knowledgebase/advanced/consensus) on the state of the\n    network. Substrate makes it possible to supply custom consensus engines and also ships with\n    several consensus mechanisms that have been built on top of Web3 Foundation research.\n-   RPC Server: A remote procedure call (RPC) server is used to interact with Substrate nodes.\n\nThere are several files in the `node` directory - take special note of the following:\n\n-   [`chain_spec.rs`](./node/src/chain_spec.rs): A\n    [chain specification](https://substrate.dev/docs/en/knowledgebase/integrate/chain-spec) is a\n    source code file that defines a Substrate chain's initial (genesis) state. Chain specifications\n    are useful for development and testing, and critical when architecting the launch of a\n    production chain. Take note of the `development_config` and `testnet_genesis` functions, which\n    are used to define the genesis state for the local development chain configuration. These\n    functions identify some\n    [well-known accounts](https://substrate.dev/docs/en/knowledgebase/integrate/subkey#well-known-keys)\n    and use them to configure the blockchain's initial state.\n-   [`service.rs`](./node/src/service.rs): This file defines the node implementation. Take note of\n    the libraries that this file imports and the names of the functions it invokes. In particular,\n    there are references to consensus-related topics, such as the\n    [longest chain rule](https://substrate.dev/docs/en/knowledgebase/advanced/consensus#longest-chain-rule),\n    the [Aura](https://substrate.dev/docs/en/knowledgebase/advanced/consensus#aura) block authoring\n    mechanism and the\n    [GRANDPA](https://substrate.dev/docs/en/knowledgebase/advanced/consensus#grandpa) finality\n    gadget.\n\nAfter the node has been [built](#build), refer to the embedded documentation to learn more about the\ncapabilities and configuration parameters that it exposes:\n\n```shell\n./target/release/node-template --help\n```\n\n### Runtime\n\nThe Substrate project in this repository uses the\n[FRAME](https://substrate.dev/docs/en/knowledgebase/runtime/frame) framework to construct a\nblockchain runtime. FRAME allows runtime developers to declare domain-specific logic in modules\ncalled \"pallets\". At the heart of FRAME is a helpful\n[macro language](https://substrate.dev/docs/en/knowledgebase/runtime/macros) that makes it easy to\ncreate pallets and flexibly compose them to create blockchains that can address a variety of needs.\n\nReview the [FRAME runtime implementation](./runtime/src/lib.rs) included in this template and note\nthe following:\n\n-   This file configures several pallets to include in the runtime. Each pallet configuration is\n    defined by a code block that begins with `impl $PALLET_NAME::Trait for Runtime`.\n-   The pallets are composed into a single runtime by way of the\n    [`construct_runtime!`](https://crates.parity.io/frame_support/macro.construct_runtime.html)\n    macro, which is part of the core\n    [FRAME Support](https://substrate.dev/docs/en/knowledgebase/runtime/frame#support-library)\n    library.\n\n### Pallets\n\nThe runtime in this project is constructed using many FRAME pallets that ship with the\n[core Substrate repository](https://github.com/paritytech/substrate/tree/master/frame) and a\ntemplate pallet that is [defined in the `pallets`](./pallets/template/src/lib.rs) directory.\n\nA FRAME pallet is compromised of a number of blockchain primitives:\n\n-   Storage: FRAME defines a rich set of powerful\n    [storage abstractions](https://substrate.dev/docs/en/knowledgebase/runtime/storage) that makes\n    it easy to use Substrate's efficient key-value database to manage the evolving state of a\n    blockchain.\n-   Dispatchables: FRAME pallets define special types of functions that can be invoked (dispatched)\n    from outside of the runtime in order to update its state.\n-   Events: Substrate uses [events](https://substrate.dev/docs/en/knowledgebase/runtime/events) to\n    notify users of important changes in the runtime.\n-   Errors: When a dispatchable fails, it returns an error.\n-   Trait: The `Trait` configuration interface is used to define the types and parameters upon which\n    a FRAME pallet depends.\n\n### Run in Docker\n\nFirst, install [Docker](https://docs.docker.com/get-docker/) and\n[Docker Compose](https://docs.docker.com/compose/install/).\n\nThen run the following command to start a single node development chain.\n\n```bash\n./scripts/docker_run.sh\n```\n\nThis command will firstly compile your code, and then start a local development network. You can\nalso replace the default command (`cargo build --release \u0026\u0026 ./target/release/node-template --dev --ws-external`)\nby appending your own. A few useful ones are as follow.\n\n```bash\n# Run Substrate node without re-compiling\n./scripts/docker_run.sh ./target/release/node-template --dev --ws-external\n\n# Purge the local dev chain\n./scripts/docker_run.sh ./target/release/node-template purge-chain --dev\n\n# Check whether the code is compilable\n./scripts/docker_run.sh cargo check\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamlet%2Fsubs.node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsamlet%2Fsubs.node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamlet%2Fsubs.node/lists"}