github.com/amazechain/amc@v0.1.3/docs/intro.md (about)

     1  # AMC DOCS
     2  Documentation provided for amc users and developers.
     3  
     4  [![Telegram Chat][tg-badge]][tg-url]
     5  
     6  AMC (Amaze Chain) is a blockchain full node implementation characterized by being user-friendly, highly modular, and fast and efficient.
     7  
     8  
     9  ## What is this about?
    10  
    11  AMC is a node implementation compatible with all node protocols that support Amaze Chain.
    12  
    13  It was originally built and promoted by Amze, licensed under Apache and MIT licenses.
    14  
    15  As a complete Amaze Chain node, amc allows users to connect to the Amaze Chain network and interact with the Amaze Chain blockchain.
    16  
    17  This includes sending and receiving transactions, querying logs and traces, as well as accessing and interacting with smart contracts.
    18  
    19  Creating a successful Amaze Chain node requires creating a high-quality implementation that is both secure and efficient, and easy to use on consumer hardware. It also requires building a strong community of contributors to help support and improve the software.
    20  
    21  ## What are the goals of amc?
    22  
    23  **1. Modularity**
    24  
    25  Every component of amc is built as a library: well-tested, heavily documented, and benchmarked. We envision developers importing the node's packages, mixing and matching, and innovating on top of them.
    26  
    27  Examples of such usage include, but are not limited to, launching standalone P2P networks, talking directly to a node's database, or "unbundling" the node into the components you need.
    28  
    29  To achieve this, we are licensing amc under the Apache/MIT permissive license.
    30  
    31  **2. Performance**
    32  
    33  AMC aims to be fast, so we used golang and parallel virtual machine sync node architecture.
    34  
    35  We also used tested and optimized Amaze Chain libraries.
    36  
    37  **3. Free for anyone to use any way they want**
    38  
    39  AMC is free open-source software, built by the community for the community.
    40  
    41  By licensing the software under the Apache/MIT license, we want developers to use it without being bound by business licenses, or having to think about the implications of GPL-like licenses.
    42  
    43  **4. Client Diversity**
    44  
    45  The Amaze Chain protocol becomes more antifragile when no node implementation dominates. This ensures that if there's a software bug, the network does not confirm a wrong block. By building a new client, we hope to contribute to Amaze Chain's antifragility.
    46  
    47  **5. Used by a wide demographic**
    48  
    49  We aim to solve for node operators who care about fast historical queries, but also for hobbyists who cannot operate on large hardware.
    50  
    51  We also want to support teams and individuals who want both sync from genesis and via "fast sync".
    52  
    53  We envision that amc will be flexible enough for the trade-offs each team faces.
    54  
    55  ## Who is this for?
    56  
    57  amc is a new Amaze Chain full node allowing users to sync and interact with the entire blockchain, including its historical state if in archive mode.
    58  - Full node: It can be used as a full node, storing and processing the entire blockchain, validating blocks and transactions, and participating in the consensus process.
    59  - Archive node: It can also be used as an archive node, storing the entire history of the blockchain, which is useful for applications that need access to historical data. As a data er/analyst, or as a data indexer, you'll want to use Archive mode. For all other use cases where historical access is not needed, you can use Full mode. 
    60  
    61  As a data engineer/analyst, or as a data indexer, you'll want to use Archive mode. For all other use cases where historical access is not needed, you can use Full mode.
    62  
    63  ## Is this secure?
    64  
    65  AMC implements the specification of Amaze Chain as defined in the repository. To ensure the node is built securely, we run the following tests:
    66  
    67  1. Virtual machine state tests are run on every Pull Request
    68  1. We regularly re-sync multiple nodes from scratch.
    69  1. We operate multiple nodes at the tip of Amaze Chain mainnet and various testnets.
    70  1. We extensively unit test, fuzz test, and document all our code, while also restricting PRs with aggressive lint rules.
    71  1. We also plan to audit / fuzz the virtual machine & parts of the codebase. Please reach out if you're interested in collaborating on securing this codebase.
    72  
    73  We intend to also audit / fuzz the EVM & parts of the codebase. Please reach out if you're interested in collaborating on securing this codebase.
    74  
    75  ## Sections
    76  
    77  Here are some useful sections to jump to:
    78  
    79  - Install amc by following the [guide](./installation/installation.md).
    80  - Sync your node on any [official network](./run/run-a-node.md).
    81  - View [statistics and metrics](./run/observability.md) about your node.
    82  - Query the [JSON-RPC](./jsonrpc/intro.md) using Foundry's `cast` or `curl`.
    83  - Set up your [development environment and contribute](./developers/contribute.md)!
    84  
    85  > 📖 **About this book**
    86  >
    87  > The book is continuously rendered [here](https://github.com/WeAreAmaze/amc/docs)!
    88  > You can contribute to this book on [GitHub][gh-book].
    89  
    90  [tg-badge]: https://img.shields.io/endpoint?color=neon&logo=telegram&label=chat&url=https%3A%2F%2Ftg.sumanjay.workers.dev%2Fparadigm%5Freth
    91  [tg-url]: https://t.me/amazechain
    92  [gh-book]: https://github.com/WeAreAmaze/amc/docs