Core/grin
0
0
Fork 0
mirror of https://github.com/mimblewimble/grin.git synced 2025-01-20 19:11:08 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions
grin/doc/code_structure.md
Paouky dfd0a649c7
Organize doc files (#3436) 
* create and occupy translations dir

* update translation links

* add mimblewimble whitepaper

* add p2p_protocol from docs

* add validation_logic from docs

Co-authored-by: Paouky <Paouky@users.noreply.github.com>
2020-09-10 09:45:14 -04:00

3.3 KiB
Raw Permalink Blame History

Grin code structure

Read this in other languages: 简体中文.

Grin is built in Rust, a memory safe, compiled language. Performance critical parts like the Cuckoo mining algorithm are built as plugins, making it easy to swap between algorithm implementations for various hardware. Grin comes with CPU and experimental GPU support.

Files in project root

List of files tracked in git and some files you'll create when you use grin.

  • CODE_OF_CONDUCT - How to behave if you want to participate. Taken from rust. Slightly modified.
  • CONTRIBUTING - How to help and become part of grin.
  • Cargo.toml and Cargo.lock (locally created, not in git) - defines how to the project code is to be compiled and built
  • LICENSE - Apache 2.0 license
  • README - The first document you should read, with pointers to find more detail.
  • rustfmt.toml - configuration file for rustfmt. Required before contributing new code.

Folder structure

After checking out grin, building and using, these are the folders you'll have:

  • api
    Code for ApiEndpoints accessible over REST.
  • chain
    The blockchain implementation. Accepts a block (see pipe.rs) and adds it to the chain, or reject it.
  • config
    Code for handling configuration.
  • core
    All core types: Hash, Block, Input, Output, and how to serialize them. Core mining algorithm, and more.
  • doc
    All documentation.
  • servers
    Many parts (adapters, lib, miner, seed, server, sync, types) that the grin server needs, including mining server.
  • keychain
    Code for working safely with keys and doing blinding.
  • p2p
    All peer to peer connection and protocol-related logic (handshake, block propagation, etc.).
  • pool
    Code for the transaction pool implementation.
  • server
    A folder you're supposed to create, before starting your server: cd to project root; mkdir server; cd server; grin server start (or run) and it will create a subfolder .grin
    • .grin
      • chain - a database with the blockchain blocks and related information
      • peers - a database with the list of Grin peers you're connected to
      • txhashset - contains folders kernel, rangeproof and output that each have a pmmr_dat.bin
  • src
    Code for the grin binary.
  • store
    Data store - Grin uses near-zero-cost Rust wrapper around LMDB, key-value embedded data store.
  • target
    Where the grin binary ends up, after the compile and build process finishes. In case of trouble, see troubleshooting
  • util
    Low-level rust utilities.
  • wallet
    Simple command line wallet implementation. Will generate:
    • wallet_data - a database storing your "outputs", that once confirmed and matured, can be spent with the grin wallet send command. (locally created, not in git)
    • wallet.seed - your secret wallet seed. (locally created, not in git)

grin dependencies

  • secp256k1 Integration and rust bindings for libsecp256k1, and some changes waiting to be upstreamed. Imported in util/Cargo.toml.