{"id":20484104,"url":"https://github.com/standardweb3/standard-v3","last_synced_at":"2025-03-05T16:18:32.964Z","repository":{"id":114558652,"uuid":"351004558","full_name":"standardweb3/standard-v3","owner":"standardweb3","description":"v3 version of standard","archived":false,"fork":false,"pushed_at":"2021-04-07T18:23:32.000Z","size":88,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-16T04:25:52.402Z","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/standardweb3.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":"2021-03-24T08:36:51.000Z","updated_at":"2021-08-16T14:57:21.000Z","dependencies_parsed_at":"2023-05-28T11:15:47.473Z","dependency_job_id":null,"html_url":"https://github.com/standardweb3/standard-v3","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/standardweb3%2Fstandard-v3","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/standardweb3%2Fstandard-v3/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/standardweb3%2Fstandard-v3/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/standardweb3%2Fstandard-v3/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/standardweb3","download_url":"https://codeload.github.com/standardweb3/standard-v3/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242058218,"owners_count":20065066,"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-15T16:19:51.803Z","updated_at":"2025-03-05T16:18:32.958Z","avatar_url":"https://github.com/standardweb3.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Substrate Node Template\n\nA fresh FRAME-based [Substrate](https://www.substrate.io/) node, ready for hacking :rocket:\n\n## Getting Started\n\nFollow these steps to get started with the Node Template :hammer_and_wrench:\n\n### Rust Setup\n\nFirst, complete the [basic Rust setup instructions](./doc/rust-setup.md).\n\n### Run\n\nUse Rust's native `cargo` command to build and launch the template node:\n\n```sh\ncargo run --release -- --dev --tmp\n```\n\n### Build\n\nThe `cargo run` command will perform an initial build. Use the following command to build the node\nwithout launching it:\n\n```sh\ncargo build --release\n```\n\n### Embedded Docs\n\nOnce the project has been built, the following command can be used to explore all parameters and\nsubcommands:\n\n```sh\n./target/release/node-template -h\n```\n\n## Run\n\nThe provided `cargo run` command will launch a temporary node and its state will be discarded after\nyou terminate the process. After the project has been built, there are other ways to launch the\nnode.\n\n### Single-Node Development Chain\n\nThis command will start the single-node development chain with persistent state:\n\n```bash\n./target/release/node-template --dev\n```\n\nPurge the development chain's state:\n\n```bash\n./target/release/node-template purge-chain --dev\n```\n\nStart the development 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\n    [Web3 Foundation research](https://research.web3.foundation/en/latest/polkadot/NPoS/index.html).\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\nIn Substrate, the terms\n\"[runtime](https://substrate.dev/docs/en/knowledgebase/getting-started/glossary#runtime)\" and\n\"[state transition function](https://substrate.dev/docs/en/knowledgebase/getting-started/glossary#stf-state-transition-function)\"\nare analogous - they refer to the core logic of the blockchain that is responsible for validating\nblocks and executing the state changes they define. The Substrate project in this repository uses\nthe [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\n[a variety of needs](https://www.substrate.io/substrate-users/).\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::Config 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-   Config: The `Config` configuration interface is used to define the types and parameters upon\n    which 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%2Fstandardweb3%2Fstandard-v3","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstandardweb3%2Fstandard-v3","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstandardweb3%2Fstandard-v3/lists"}