Skip to content

Latest commit

 

History

History
220 lines (148 loc) · 7.11 KB

README.md

File metadata and controls

220 lines (148 loc) · 7.11 KB
Raw


Myriad Node

It's Your Turn to Own Your Web

Starting with Myriad.Social, we are creating a platform where social app, metaverse and messenger seamlessly integrate, together and with further applications. As a user, a content creator or a builder, Myriad is designed to be yours.

Substrate Medium

Table of Contents

  1. Getting Started
  2. Rust Setup
  3. Single-Node Development Chain
  4. Run in Docker
  5. Migrating Octopus Appchain to Rococo Parachain
  6. Guide to Testing the Project Using Docker
  7. Myriad Social on Paseo Network

Getting Started

Follow these steps to get started with the Node

Rust Setup

First, complete the basic Rust setup instructions.

Single-Node Development Chain

This command will start the single-node development chain with persistent state:

./target/debug/myriad \
--base-path .local \
--dev \
--alice \
--collator \
--force-authoring \
-- \
--execution wasm \
--dev

Purge the development chain's state:

./target/debug/myriad \
purge-chain \
--base-path .local \
--dev

Start the development chain with detailed logging:

RUST_LOG=debug RUST_BACKTRACE=1 ./target/debug/myriad \
./target/debug/myriad \
--base-path .local \
--dev \
--alice \
--collator \
--force-authoring \
-lruntime=debug \
-- \
--execution wasm \
--dev

Run in Docker

First, install Docker and Docker Compose.

Then run the following command to start a single node development chain.

./.maintain/docker/create-network.sh
./.maintain/docker/start-docker-compose.sh

Migrating Octopus Appchain to Rococo Parachain

1. Fork the Substrate Cumulus Node Parachain Template Repository

Step 1: Begin by forking a new repository based on the Substrate Cumulus Node Parachain Template.

  • Action Required: Click the "Fork" button on the GitHub repository page to create a copy under your account.

2. Define Chain Specification Configuration

Step 2: In order to configure your Substrate project, you need to define the Chain Specification Configuration. This configuration encompasses essential details about your blockchain. These details include:

  • ID: A unique identifier for your blockchain.
  • Name: The name of your blockchain.
  • Chain Type: The type of blockchain (e.g., Parachain, Relay Chain).
  • Chain Genesis: Information about the initial state of your blockchain, including privileged accounts, collator accounts, pre-funded accounts, and the parachain ID.
  • Bootnodes: Addresses of nodes that can be used as entry points into your blockchain.
  • Telemetry: Telemetry server details, if applicable.
  • Protocol ID: The identifier for the network protocol.
  • Fork ID: ID for specifying forks in the blockchain.
  • Properties: Miscellaneous properties or settings.
  • Extension: Any additional extensions or customizations.

It's important to configure the Chain Specification for the following contexts:

  • Local Chain: Configuration for a local development environment.
  • Development Chain: Configuration for a development environment.
  • Rococo Chain: Configuration for integration with the Rococo testnet.

3. Replace Parachain Template Runtime

Step 3: Replace the default runtime of the Substrate Cumulus Node Parachain Template, which is known as parachain_template_runtime, with the runtime of the Octopus application that you intend to migrate to the parachain.

  • Action Required: Replace the runtime code files as needed to integrate the Octopus application runtime.

4. Move Octopus Application Pallets

Step 4: Move the Octopus application's pallet code into the new parachain repository. Ensure that all pallets are placed within the pallets folder of the repository.

  • Action Required: Organize the Octopus application's pallet code files within the pallets directory of your new repository.

Guide to Testing the Project Using Docker

Substrate is a modular framework that enables you to create purpose-built blockchains by composing custom or pre-built components. This guide will walk you through the steps to use Docker for testing a Rust-based Substrate project.

Prerequisites

  1. Docker Installed: Ensure Docker is installed on your machine. If not, follow the official installation guide.

  2. Docker Daemon Running: Ensure the Docker daemon is running.

  3. Substrate Project: A directory containing your Substrate project.

Step-by-Step Instructions

1. Create a Dockerfile

Create a Dockerfile in the root directory of your Substrate project with the following content:

# Use an official Rust base image
FROM rust:1.70.0

# Set the working directory inside the container
WORKDIR /usr/src/substrate_project

# Copy the entire project into the container
COPY . .

# Build the application
RUN cargo build

# Run tests on container startup
CMD ["cargo", "test"]

2. Build the Docker Image

Navigate to your project's directory and build the Docker image:

cd /path/to/your/myriad-node-parachain
docker build -t substrate-test .

Myriad Social on Paseo Network


Myriad Social has been successfully integrated as a Parachain in the Paseo network with the ParaID 4005.

This integration brings enhanced functionality and connectivity to the Myriad ecosystem.

Accessing Myriad Social on Paseo

You can access Myriad Social on the Paseo network via the following RPC endpoint:

wss://ws-rpc.paseo.myriad.social

This WebSocket RPC endpoint allows you to interact with the Myriad Social parachain on the Paseo network, enabling you to leverage the full capabilities of the integrated platform.

For developers and users looking to connect to or interact with Myriad Social on Paseo, simply use this RPC endpoint in your configuration or connection settings.

These steps provide a comprehensive guide for migrating Substrate project from an Octopus Appchain to a Rococo Parachain. Ensure that you follow each step carefully to successfully configure your Substrate-based parachain with the Octopus application runtime.

Feel free to reach out if you have any questions or need further assistance during this process.