+ 
+
+📢 Follow our latest updates on [Twitter](https://twitter.com/TanssiNetwork)
+🤝 Engage with fellow developers on our [Discord server](https://discord.com/invite/kuyPhew2KB)
-## Leptos/Rust Frontend +## Build the Tanssi Node -https://github.com/reaudito-org/shivarthu-client +To build Tanssi, you will need a proper Substrate development environment. -## React Frontend +If you need a refresher setting up your Substrate environment, see [Substrate's Getting Started Guide](https://substrate.dev/docs/en/knowledgebase/getting-started/). -https://github.com/amiyatulu/shivarthu_frontend - -## Whitepaper - -https://shivarthu.reaudito.com/paper/Shivarthu_whitepaper.pdf - -## Technical Details - -https://github.com/reaudito-org/shivarthu/blob/main/docs/Shivarthu.md - - - -# Substrate Node Template - -[](https://playground.substrate.dev/?deploy=node-template) [](https://matrix.to/#/#substrate-technical:matrix.org) - -A fresh FRAME-based [Substrate](https://www.substrate.io/) node, ready for hacking :rocket: - -## Getting Started - -Follow the steps below to get started with the Node Template, or get it up and running right from your browser -in just a few clicks using [Playground](https://playground.substrate.dev/) :hammer_and_wrench: - -### Using Nix - -Install [nix](https://nixos.org/) and optionally [direnv](https://github.com/direnv/direnv) and [lorri](https://github.com/target/lorri) for a fully plug -and play experience for setting up the development environment. To get all the correct dependencies activate direnv `direnv allow` and lorri `lorri shell`. - -### Rust Setup +```bash +# Fetch the code +git clone https://github.com/moondance-labs/tanssi +cd tanssi -First, complete the [basic Rust setup instructions](./docs/rust-setup.md). +# Build the node (The first build will be long (~30min)) +cargo build --release +``` -### Run +## Run tests -Use Rust's native `cargo` command to build and launch the template node: +Tanssi has Rust unit tests as well as typescript integration tests. These tests are run in CI, and can also be run locally. Tanssi tests (specially those in typescript) depend on sessions being shorter, so you probably want to compile the node first as: -```sh -cargo run --release -- --dev --tmp +```bash +# Build the node with short session times +cargo build --features=fast-runtime --release ``` -### Build - -The `cargo run` command will perform an initial build. Use the following command to build the node -without launching it: +Then to run the tests: -```sh -cargo build --release +```bash +# Run the Rust unit tests +cargo test --features=fast-runtime --release ``` -### Test +Typescript tests are run with [Moonwall](https://github.com/Moonsong-Labs/moonwall). To run these you will need to have pnpm installed: -Use the following command to test the contract -```sh -cargo test -``` +```bash +# Install moonwall +sudo npm i -g pnpm -### Generate docs +# Install dependencies +pnpm i -To generate docs use command -```sh -cargo doc --no-deps --open -``` +# Run manual seal orchestrator tests +pnpm moonwall test dev_tanssi -To view in the python server, go to target folder -```sh -cd target/doc -python3 -m http.server +# Run zombienet tests (with container-chains) +pnpm moonwall test zombie_tanssi ``` -View the docs at: -http://localhost:8000/election/ - -Schelling game shared docs: -http://localhost:8000/schelling_game_shared/pallet/struct.Pallet.html -### Embedded Docs +Moonwall lets you also run the testing environment wihtout performing any tests on it, as a method for you to manually test certain things: -Once the project has been built, the following command can be used to explore all parameters and -subcommands: +```bash +# Spin up single manual-seal orchestrator +pnpm moonwall run dev_tanssi -```sh -./target/release/node-template -h +# Spin up orchestrator and two container-chains with zombienet +pnpm moonwall run zombie_tanssi ``` -## Run - -The provided `cargo run` command will launch a temporary node and its state will be discarded after -you terminate the process. After the project has been built, there are other ways to launch the -node. - -### Single-Node Development Chain +### Sealing options -This command will start the single-node development chain with persistent state: +The command above will start the node in instant seal mode. It creates a block when a transaction arrives, similar to Ganache's auto-mine. You can also choose to author blocks at a regular interval, or control authoring manually through the RPC. ```bash -./target/release/node-template --dev -``` - -Purge the development chain's state: +# Author a block every 6 seconds. +./target/release/tanssi-node --dev --sealing 6000 -```bash -./target/release/node-template purge-chain --dev +# Manually control the block authorship and finality +./target/release/tanssi-node --dev --sealing manual ``` -Start the development chain with detailed logging: +### Prefunded Development Addresses -```bash -RUST_BACKTRACE=1 ./target/release/node-template -ldebug --dev -``` +Running Tanssi in development mode will pre-fund several well-known addresses that (mostly) These addresses are derived from +using the well known private key `bottom drive obey lake curtain smoke basket hold race lonely fit walk` and appending the account name as a hard derivation key to the seed above, e.g., `bottom drive obey lake curtain smoke basket hold race lonely fit walk//Alice`: -### Connect with Yew Apps Front-end +``` +# Alice: +- Address: 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY -The front end repository: https://github.com/amiyatulu/shivarthu_client +# Bob: +- Address: 5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty -```bash -cd shivarthu_client -trunk serve -``` +# Charlie: +- Address: 5FLSigC9HGRKVhB9FiEo4Y3koPsNmBmLJbpXg2mp1hXcS59Y -### Substrate explorer +# Dave: +- Address: 5DAAnrj7VHTznn2AWBemMuyBwZWs6FNFjdyVXUeYum3PTXFy -
(author_pub: Pub, slot: Slot) -> Self
+ where
+ P: Pair (slot, author_pub),
+ slot,
+ }
+ }
+
+ /// Get the author's public key.
+ pub fn author_pub(&self) -> &Pub {
+ &self.author_pub
+ }
+
+ /// Get the pre-digest.
+ pub fn pre_digest(&self) -> &Vec ,
+ chain_head: &B::Header,
+ slot: Slot,
+ force_authoring: bool,
+ keystore: &KeystorePtr,
+) -> Result (slot, &aux_data.authorities, keystore, force_authoring);
+ match res {
+ Some(p) => p,
+ None => return Ok(None),
+ }
+ };
+
+ if is_parathread_and_should_skip_slot:: (author_pub, slot)))
+}
+
+/// Returns true if this container chain is a parathread and the collator should skip this slot and not produce a block
+pub fn is_parathread_and_should_skip_slot ,
+ chain_head: &B::Header,
+ slot: Slot,
+) -> bool
+where
+ P: Pair + Send + Sync + 'static,
+ P::Public: Codec + std::fmt::Debug,
+ P::Signature: Codec,
+ B: BlockT,
+{
+ if slot.is_zero() {
+ // Always produce on slot 0 (for tests)
+ return false;
+ }
+ if let Some(min_slot_freq) = aux_data.min_slot_freq {
+ if let Ok(chain_head_slot) = find_pre_digest:: (
+ slot: Slot,
+ authorities: &Vec (slot, authorities.as_slice());
+ // if not running with force-authoring, just do the usual slot check
+ if !force_authoring {
+ expected_author.and_then(|p| {
+ if keystore.has_keys(&[(p.to_raw_vec(), NIMBUS_KEY_ID)]) {
+ Some(p.clone())
+ } else {
+ None
+ }
+ })
+ }
+ // if running with force-authoring, as long as you are in the authority set,
+ // propose
+ else {
+ authorities
+ .iter()
+ .find(|key| keystore.has_keys(&[(key.to_raw_vec(), NIMBUS_KEY_ID)]))
+ .cloned()
+ }
+}
+
+/// Seal a block with a signature in the header.
+pub fn seal_tanssi ,
+ >
+ + 'static
+ + Sync
+ + Send,
+{
+ let mut collation_requests = match params.collation_request_receiver {
+ Some(receiver) => receiver,
+ None => {
+ cumulus_client_collator::relay_chain_driven::init(
+ params.collator_key,
+ params.para_id,
+ params.overseer_handle,
+ )
+ .await
+ }
+ };
+
+ let mut collator = {
+ let params = collator_util::Params {
+ create_inherent_data_providers: params.create_inherent_data_providers.clone(),
+ block_import: params.block_import,
+ relay_client: params.relay_client.clone(),
+ keystore: params.keystore.clone(),
+ para_id: params.para_id,
+ proposer: params.proposer,
+ collator_service: params.collator_service,
+ };
+
+ collator_util::Collator::