github.com/TrueBlocks/trueblocks-core/src/apps/chifra@v0.0.0-20241022031540-b362680128f7/internal/init/doc.go (about)

     1  // Copyright 2016, 2024 The TrueBlocks Authors. All rights reserved.
     2  // Use of this source code is governed by a license that can
     3  // be found in the LICENSE file.
     4  /*
     5   * Parts of this file were auto generated. Edit only those parts of
     6   * the code inside of 'EXISTING_CODE' tags.
     7   */
     8  
     9  // initPkg implements the chifra init command.
    10  //
    11  // When invoked, chifra init reads a value from a smart contract called **The Unchained Index**
    12  // (0x0c316b7042b419d07d343f2f4f5bd54ff731183d).
    13  //
    14  // This value (manifestHashMap) is an IPFS hash pointing to a pinned file (called the Manifest) that
    15  // contains a large collection of other IPFS hashes. These other hashes point to each of the Bloom
    16  // filter and Index Chunk. TrueBlocks periodically publishes the Manifest's hash to the smart contract.
    17  // This makes the index available for our software to use and impossible for us to withhold. Both of
    18  // these aspects of the manifest are by design.
    19  //
    20  // If you stop chifra init before it finishes, it will pick up again where it left off the next
    21  // time you run it.
    22  //
    23  // Certain parts of the system (chifra list and chifra export for example) if you have not
    24  // previously run chifra init or chifra scrape. You will be warned by the system until it's
    25  // satisfied.
    26  //
    27  // If you run chifra init and allow it to complete, the next time you run chifra scrape, it will
    28  // start where init finished. This means that only the blooms will be stored on your hard drive.
    29  // Subsequent scraping will produce both chunks and blooms, although you can, if you wish delete
    30  // chunks that are not being used. You may periodically run chifra init if you prefer not to scrape.
    31  package initPkg