-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of https://github.com/AlphaGamingArcade/Aga
- Loading branch information
Showing
1 changed file
with
227 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,79 +1,280 @@ | ||
| <div align="center"> | ||
|
|
||
|  | ||
|  | ||
|
|
||
| # [AGA](https://aga.network) | ||
|
|
||
| [](https://twitter.com/Allfeat_music) [](https://t.me/Allfeat_fndn) [](https://allfeat.discord.com) | ||
| [](https://twitter.com/Aga) [](https://t.me/Allfeat_fndn) [](https://allfeat.discord.com) | ||
| [](https://github.com/allfeat/allfeat) [](https://github.com/allfeat/allfeat) [](https://github.com/allfeat/allfeat/actions/workflows/checks.yml/badge.svg) | ||
| </div> | ||
|
|
||
| </div> | ||
|
|
||
| ## Introduction | ||
|
|
||
| - **MIDDS: Metadata Integrity, Certification, and Monetization** | ||
| - **AGA: Seamless Asset Transfers Across Games** | ||
|
|
||
| At the heart of Allfeat lies **MIDDS** (Metadata Integrity and Data Decentralization System), a groundbreaking approach to the certification, securitization, and monetization of music metadata. With MIDDS, artists and creators can confidently certify their metadata on-chain, ensuring its integrity while monetizing their content directly. | ||
| At the core of our blockchain lies **AGA**, a revolutionary system designed to enable seamless asset transfers between different games. AGA ensures a secure and frictionless experience for players and developers alike. | ||
|
|
||
| - **Proof Of Metadata** | ||
| - **Game Asset Portability** | ||
|
|
||
| Allfeat leverages a highly secure blockchain infrastructure to offer decentralized storage and verification of music metadata through his own consensus, which ensures that the data is protected, immutable, and auditable. By using MIDDS, Allfeat enables artists to secure their creations and protect their intellectual property. | ||
| AGA utilizes cutting-edge blockchain technology to facilitate decentralized storage and verification of game assets. By implementing a robust Proof of Authority (PoA) consensus mechanism and leveraging a cross-chain bridge, AGA ensures that assets remain secure, immutable, and auditable, empowering players to truly own their digital possessions. | ||
|
|
||
| - **Monetization and Certification Platform** | ||
| - **Interoperability and Integration** | ||
|
|
||
| Through MIDDS, creators can certify their metadata in a transparent way that integrates monetization opportunities, opening new revenue streams. Fans, collaborators, and partners can easily verify the authenticity of metadata, enabling a more trustworthy music ecosystem. | ||
| Built with a focus on flexibility, AGA offers compatibility with EVM-compatible chains and other ecosystems. This cross-chain functionality, powered by the cross-chain bridge, allows game developers to integrate their titles effortlessly, while players can enjoy a unified experience across multiple games. | ||
|
|
||
| - **Cross-Chain Compatibility and Integration** | ||
| - **Player-Centric Economy** | ||
|
|
||
| Built with modern frameworks, Allfeat integrates seamlessly with EVM-compatible chains and other ecosystems to provide cross-chain functionalities. This ensures that certified metadata and Assets as NFTs can interact across various blockchain networks, enhancing discoverability and collaboration. | ||
| AGA opens the door to new economic opportunities by enabling a player-driven marketplace for in-game assets. Players can trade, sell, and purchase assets transparently, while developers benefit from increased engagement and monetization avenues. | ||
|
|
||
| - **Developer-Friendly Framework** | ||
|
|
||
| AGA provides an intuitive platform with tools and SDKs designed for game developers to easily onboard and integrate asset transfer functionalities. The streamlined process reduces development overhead and fosters innovation within the gaming industry. | ||
|
|
||
| ## Release | ||
|
|
||
| ### Testnet (Harmonie) | ||
| ### Testnet (Pioneer Phase) | ||
|
|
||
| Test and experience the features of the Allfeat network, including MIDDS registration, NFT deployment, and cross-chain functionalities. Developers can participate in the gamified testnet and provide feedback. | ||
| Experience the capabilities of AGA through our Aga Testnet. Test asset transfers, explore cross-game compatibility, and provide valuable feedback to shape the future of the platform. Join the community of developers and players pioneering this new era of gaming interoperability. | ||
|
|
||
| ### Mainnet | ||
|
|
||
| Coming soon. Stay tuned for updates. | ||
| The Mainnet launch is on the horizon. Stay connected for updates and announcements as we bring AGA to life and redefine the gaming experience. | ||
|
|
||
| ### Tags and Runtime Versions | ||
|
|
||
| Each release tag includes the different versions of the runtimes corresponding to on-chain upgrades. This ensures that all changes and updates to the Allfeat network and runtime environments are fully traceable and easy to follow. | ||
|
|
||
| ## Documentation | ||
|
|
||
| - [Allfeat Docs](https://docs.allfeat.com) | ||
| - [MIDDS Overview](https://docs.allfeat.com/features/midds/) | ||
| - [AGA Docs](https://docs.aga.com) | ||
|
|
||
| # Installation | ||
|
|
||
| This guide is for reference only, please check the latest information on getting started with Substrate [here](https://docs.substrate.io/main-docs/install/). | ||
|
|
||
| This page will guide you through the **2 steps** needed to prepare a computer for **Substrate** development. Since | ||
| Substrate is built with [the Rust programming language](https://www.rust-lang.org/), the first thing you will need to do | ||
| is prepare the computer for Rust development - these steps will vary based on the computer's operating system. Once Rust | ||
| is configured, you will use its toolchains to interact with Rust projects; the commands for Rust's toolchains will be | ||
| the same for all supported, Unix-based operating systems. | ||
|
|
||
| ## Build dependencies | ||
|
|
||
| Substrate development is easiest on Unix-based operating systems like macOS or Linux. The examples in the [Substrate | ||
| Docs](https://docs.substrate.io) use Unix-style terminals to demonstrate how to interact with Substrate from the command | ||
| line. | ||
|
|
||
| ### Ubuntu/Debian | ||
|
|
||
| Use a terminal shell to execute the following commands: | ||
|
|
||
| ```bash | ||
| sudo apt update | ||
| # May prompt for location information | ||
| sudo apt install -y git clang curl libssl-dev llvm libudev-dev | ||
| ``` | ||
|
|
||
| ### Arch Linux | ||
|
|
||
| Run these commands from a terminal: | ||
|
|
||
| ```bash | ||
| pacman -Syu --needed --noconfirm curl git clang | ||
| ``` | ||
|
|
||
| ### Fedora | ||
|
|
||
| Run these commands from a terminal: | ||
|
|
||
| ```bash | ||
| sudo dnf update | ||
| sudo dnf install clang curl git openssl-devel | ||
| ``` | ||
|
|
||
| ### OpenSUSE | ||
|
|
||
| Run these commands from a terminal: | ||
|
|
||
| ## Quick Node Bootstrap | ||
| ```bash | ||
| sudo zypper install clang curl git openssl-devel llvm-devel libudev-devel | ||
| ``` | ||
|
|
||
| You can easily bootstrap your own Allfeat node either with Docker or by building it from source using Rust. Below are the instructions for Docker: | ||
| ### macOS | ||
|
|
||
| ### Using Docker | ||
| > **Apple M1 ARM** If you have an Apple M1 ARM system on a chip, make sure that you have Apple Rosetta 2 installed | ||
| > through `softwareupdate --install-rosetta`. This is only needed to run the `protoc` tool during the build. The build | ||
| > itself and the target binaries would remain native. | ||
| 1. Pull the Allfeat node Docker image: | ||
| Open the Terminal application and execute the following commands: | ||
|
|
||
| ```bash | ||
| docker pull allfeatnetwork/allfeat:master | ||
| # Install Homebrew if necessary https://brew.sh/ | ||
| /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)" | ||
|
|
||
| # Make sure Homebrew is up-to-date, install openssl | ||
| brew update | ||
| brew install openssl | ||
| ``` | ||
|
|
||
| 2. Run the Allfeat node Docker container: | ||
| ### Windows | ||
|
|
||
| **_PLEASE NOTE:_** Native Windows development of Substrate is _not_ very well supported! It is _highly_ | ||
| recommended to use [Windows Subsystem Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10) | ||
| (WSL) and follow the instructions for [Ubuntu/Debian](#ubuntudebian). | ||
| Please refer to the separate | ||
| [guide for native Windows development](https://docs.substrate.io/main-docs/install/windows/). | ||
|
|
||
| ## Rust developer environment | ||
|
|
||
| This guide uses <https://rustup.rs> installer and the `rustup` tool to manage the Rust toolchain. First install and | ||
| configure `rustup`: | ||
|
|
||
| ```bash | ||
| docker run docker.io/allfeatnetwork/allfeat:master | ||
| # Install | ||
| curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh | ||
| # Configure | ||
| source ~/.cargo/env | ||
| ``` | ||
|
|
||
| It will start syncing the blockchain with the Harmonie Live Testnet. | ||
| You can also choose to start a Development Node in local by using `--dev` argument. | ||
| Configure the Rust toolchain to default to the latest stable version, add nightly and the nightly wasm target: | ||
|
|
||
| ```bash | ||
| docker run docker.io/allfeatnetwork/allfeat:master --dev | ||
| rustup default stable | ||
| rustup update | ||
| rustup update nightly | ||
| rustup target add wasm32-unknown-unknown --toolchain nightly | ||
| ``` | ||
|
|
||
| ## Test your set-up | ||
|
|
||
| Now the best way to ensure that you have successfully prepared a computer for Substrate development is to follow the | ||
| steps in [our first Substrate tutorial](https://docs.substrate.io/tutorials/v3/create-your-first-substrate-chain/). | ||
|
|
||
| ## Troubleshooting Substrate builds | ||
|
|
||
| Sometimes you can't get the Substrate node template to compile out of the box. Here are some tips to help you work | ||
| through that. | ||
|
|
||
| ### Rust configuration check | ||
|
|
||
| To see what Rust toolchain you are presently using, run: | ||
|
|
||
| ```bash | ||
| rustup show | ||
| ``` | ||
|
|
||
| This will show something like this (Ubuntu example) output: | ||
|
|
||
| ```text | ||
| Default host: x86_64-unknown-linux-gnu | ||
| rustup home: /home/user/.rustup | ||
| installed toolchains | ||
| -------------------- | ||
| stable-x86_64-unknown-linux-gnu (default) | ||
| nightly-2020-10-06-x86_64-unknown-linux-gnu | ||
| nightly-x86_64-unknown-linux-gnu | ||
| installed targets for active toolchain | ||
| -------------------------------------- | ||
| wasm32-unknown-unknown | ||
| x86_64-unknown-linux-gnu | ||
| active toolchain | ||
| ---------------- | ||
| stable-x86_64-unknown-linux-gnu (default) | ||
| rustc 1.50.0 (cb75ad5db 2021-02-10) | ||
| ``` | ||
|
|
||
| As you can see above, the default toolchain is stable, and the `nightly-x86_64-unknown-linux-gnu` toolchain as well as | ||
| its `wasm32-unknown-unknown` target is installed. You also see that `nightly-2020-10-06-x86_64-unknown-linux-gnu` is | ||
| installed, but is not used unless explicitly defined as illustrated in the [specify your nightly | ||
| version](#specifying-nightly-version) section. | ||
|
|
||
| ### WebAssembly compilation | ||
|
|
||
| Substrate uses [WebAssembly](https://webassembly.org) (Wasm) to produce portable blockchain runtimes. You will need to | ||
| configure your Rust compiler to use [`nightly` builds](https://doc.rust-lang.org/book/appendix-07-nightly-rust.html) to | ||
| allow you to compile Substrate runtime code to the Wasm target. | ||
|
|
||
| > There are upstream issues in Rust that need to be resolved before all of Substrate can use the stable Rust toolchain. | ||
| > [This is our tracking issue](https://github.com/paritytech/substrate/issues/1252) if you're curious as to why and how | ||
| > this will be resolved. | ||
| #### Latest nightly for Substrate `master` | ||
|
|
||
| Developers who are building Substrate _itself_ should always use the latest bug-free versions of Rust stable and | ||
| nightly. This is because the Substrate codebase follows the tip of Rust nightly, which means that changes in Substrate | ||
| often depend on upstream changes in the Rust nightly compiler. To ensure your Rust compiler is always up to date, you | ||
| should run: | ||
|
|
||
| ```bash | ||
| rustup update | ||
| rustup update nightly | ||
| rustup target add wasm32-unknown-unknown --toolchain nightly | ||
| ``` | ||
|
|
||
| > NOTE: It may be necessary to occasionally rerun `rustup update` if a change in the upstream Substrate codebase depends | ||
| > on a new feature of the Rust compiler. When you do this, both your nightly and stable toolchains will be pulled to the | ||
| > most recent release, and for nightly, it is generally _not_ expected to compile WASM without error (although it very | ||
| > often does). Be sure to [specify your nightly version](#specifying-nightly-version) if you get WASM build errors from | ||
| > `rustup` and [downgrade nightly as needed](#downgrading-rust-nightly). | ||
| #### Rust nightly toolchain | ||
|
|
||
| If you want to guarantee that your build works on your computer as you update Rust and other dependencies, you should | ||
| use a specific Rust nightly version that is known to be compatible with the version of Substrate they are using; this | ||
| version will vary from project to project and different projects may use different mechanisms to communicate this | ||
| version to developers. For instance, the Polkadot client specifies this information in its [release | ||
| notes](https://github.com/paritytech/polkadot-sdk/releases). | ||
|
|
||
| ```bash | ||
| # Specify the specific nightly toolchain in the date below: | ||
| rustup install nightly-<yyyy-MM-dd> | ||
| ``` | ||
|
|
||
| #### Wasm toolchain | ||
|
|
||
| Now, configure the nightly version to work with the Wasm compilation target: | ||
|
|
||
| ```bash | ||
| rustup target add wasm32-unknown-unknown --toolchain nightly-<yyyy-MM-dd> | ||
| ``` | ||
|
|
||
| ### Specifying nightly version | ||
|
|
||
| Use the `WASM_BUILD_TOOLCHAIN` environment variable to specify the Rust nightly version a Substrate project should use | ||
| for Wasm compilation: | ||
|
|
||
| ```bash | ||
| WASM_BUILD_TOOLCHAIN=nightly-<yyyy-MM-dd> cargo build --release | ||
| ``` | ||
|
|
||
| > Note that this only builds _the runtime_ with the specified nightly. The rest of project will be compiled with **your | ||
| > default toolchain**, i.e. the latest installed stable toolchain. | ||
| ### Downgrading Rust nightly | ||
|
|
||
| If your computer is configured to use the latest Rust nightly and you would like to downgrade to a specific nightly | ||
| version, follow these steps: | ||
|
|
||
| ```bash | ||
| rustup uninstall nightly | ||
| rustup install nightly-<yyyy-MM-dd> | ||
| rustup target add wasm32-unknown-unknown --toolchain nightly-<yyyy-MM-dd> | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Contribution | ||
|
|
||
| [](https://www.gnu.org/licenses/gpl-3.0) | ||
|
|
||
| Allfeat is open-source under the GPLv3 license. We welcome community contributions. Please review [CONTRIBUTIONS.md](doc/CONTRIBUTIONS.md) for details on how to contribute to the project. | ||
| AGA is open-source under the GPLv3 license. We welcome community contributions. Please review [CONTRIBUTIONS.md](doc/CONTRIBUTIONS.md) for details on how to contribute to the project. |