{"id":25808091,"url":"https://github.com/subhajitroycode/subhajitroycode_nickspallet","last_synced_at":"2025-02-27T21:57:09.541Z","repository":{"id":48163274,"uuid":"516638827","full_name":"subhajitroycode/subhajitroycode_nickspallet","owner":"subhajitroycode","description":null,"archived":false,"fork":false,"pushed_at":"2022-07-22T06:46:19.000Z","size":48464,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2023-05-17T09:13:49.379Z","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/subhajitroycode.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}},"created_at":"2022-07-22T06:36:53.000Z","updated_at":"2022-07-22T06:46:28.000Z","dependencies_parsed_at":"2022-08-30T04:01:55.527Z","dependency_job_id":null,"html_url":"https://github.com/subhajitroycode/subhajitroycode_nickspallet","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subhajitroycode%2Fsubhajitroycode_nickspallet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subhajitroycode%2Fsubhajitroycode_nickspallet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subhajitroycode%2Fsubhajitroycode_nickspallet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subhajitroycode%2Fsubhajitroycode_nickspallet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/subhajitroycode","download_url":"https://codeload.github.com/subhajitroycode/subhajitroycode_nickspallet/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241064282,"owners_count":19903236,"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":"2025-02-27T21:57:08.887Z","updated_at":"2025-02-27T21:57:09.534Z","avatar_url":"https://github.com/subhajitroycode.png","language":"Rust","readme":"# Substrate Node Template\n\n[![Try on playground](https://img.shields.io/badge/Playground-Node_Template-brightgreen?logo=Parity%20Substrate)](https://docs.substrate.io/playground/) [![Matrix](https://img.shields.io/matrix/substrate-technical:matrix.org)](https://matrix.to/#/#substrate-technical:matrix.org)\n\nA fresh FRAME-based [Substrate](https://www.substrate.io/) node, ready for hacking :rocket:\n\n## Getting Started\n\nFollow the steps below to get started with the Node Template, or get it up and running right from\nyour browser in just a few clicks using\nthe [Substrate Playground](https://docs.substrate.io/playground/) :hammer_and_wrench:\n\n### Using Nix\n\nInstall [nix](https://nixos.org/) and optionally [direnv](https://github.com/direnv/direnv) and\n[lorri](https://github.com/nix-community/lorri) for a fully plug and play experience for setting up\nthe development environment. To get all the correct dependencies activate direnv `direnv allow` and\nlorri `lorri shell`.\n\n### Rust Setup\n\nFirst, complete the [basic Rust setup instructions](./docs/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\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 non-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_BACKTRACE=1 ./target/release/node-template -ldebug --dev\n```\n\n\u003e Development chain means that the state of our chain will be in a tmp folder while the nodes are\n\u003e running. Also, **alice** account will be authority and sudo account as declared in the\n\u003e [genesis state](https://github.com/substrate-developer-hub/substrate-node-template/blob/main/node/src/chain_spec.rs#L49).\n\u003e At the same time the following accounts will be pre-funded:\n\u003e - Alice\n\u003e - Bob\n\u003e - Alice//stash\n\u003e - Bob//stash\n\nIn case of being interested in maintaining the chain' state between runs a base path must be added\nso the db can be stored in the provided folder instead of a temporal one. We could use this folder\nto store different chain databases, as a different folder will be created per different chain that\nis ran. The following commands shows how to use a newly created folder as our db base path.\n\n```bash\n// Create a folder to use as the db base path\n$ mkdir my-chain-state\n\n// Use of that folder to store the chain state\n$ ./target/release/node-template --dev --base-path ./my-chain-state/\n\n// Check the folder structure created inside the base path after running the chain\n$ ls ./my-chain-state\nchains\n$ ls ./my-chain-state/chains/\ndev\n$ ls ./my-chain-state/chains/dev\ndb keystore network\n```\n\n\n### Connect with Polkadot-JS Apps Front-end\n\nOnce the node template is running locally, you can connect it with **Polkadot-JS Apps** front-end\nto interact with your chain. [Click\nhere](https://polkadot.js.org/apps/#/explorer?rpc=ws://localhost:9944) connecting the Apps to your\nlocal node template.\n\n### Multi-Node Local Testnet\n\nIf you want to see the multi-node consensus algorithm in action, refer to our\n[Start a Private Network tutorial](https://docs.substrate.io/tutorials/v3/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://docs.substrate.io/v3/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://docs.substrate.io/v3/runtime/chain-specs) 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://docs.substrate.io/v3/tools/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://docs.substrate.io/v3/advanced/consensus#longest-chain-rule),\n  the [Aura](https://docs.substrate.io/v3/advanced/consensus#aura) block authoring\n  mechanism and the\n  [GRANDPA](https://docs.substrate.io/v3/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://docs.substrate.io/v3/getting-started/glossary#runtime)\" and\n\"[state transition function](https://docs.substrate.io/v3/getting-started/glossary#state-transition-function-stf)\"\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://docs.substrate.io/v3/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://docs.substrate.io/v3/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://docs.substrate.io/v3/runtime/frame#support-crate)\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 comprised of a number of blockchain primitives:\n\n- Storage: FRAME defines a rich set of powerful\n  [storage abstractions](https://docs.substrate.io/v3/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 and errors](https://docs.substrate.io/v3/runtime/events-and-errors)\n  to 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\n(`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","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsubhajitroycode%2Fsubhajitroycode_nickspallet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsubhajitroycode%2Fsubhajitroycode_nickspallet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsubhajitroycode%2Fsubhajitroycode_nickspallet/lists"}