Context

Each time a release version is downloaded the ManifestManager must check if the version is already installed by checking the ~/.config/shran/manifest.yaml. if it doesn't exist it should be saved to the manifest file with the following meta data. If a release version is removed the corresponding manifest entry needs to be removed as well.

Meta data

1. Blockchain type (bitcoin)
2. version of said blockchain (v23.0)
3. published release date
4. Release/Changelog release notes
5. absolute path to installed source directory

Context

When shran auth --token is called, said token should be written to the ~/.config/shran/gh.yaml file. This is needed so when other subcommands like shran fetch --latest are called, they can actually check for that token on disk.

Context

File/directory creation and deletion need to be managed in a succinct manner that is applicable to where shran stores and loads and updates information on disk.

Context

shran needs a way to utilile github to pull down bitcoins source code, as well as connect to proprietary repositories that may have their own customized version of bitcoin that needs to be worked on or compiled or deployed. To do this I will utilze the ocotocrab library, and rely on github user tokens for verification.

Context

Clap just release a new major version 3.0.10. This has made some major improvements, and with all major version releases it has broken the v2 code

Test all possible combinations of subcommands to verify proper usage is enforced, and descriptive error messages are given when commands are used wrong. Get code coverage up to > 90%

Context

The current cli design is proving to not be robust enough.

Sub commands to remove

1. shran fetch

   • fetch will be split up between new commands get and list

2. shran generate

   • generate will be renamed to create

Sub commands to add

1. shran get

   • shran get --btc --latest
     • get the latest release of bitcoin
   • shran get --btc v23.0
     • get a specific version

2. shran remove

   • shran remove --btc v23.0

3. shran list

   • shran list --btc --local

     • List all versions installed on the local system

   • shran list --btc --remote

     • List all available versions on github

Modified subcommands

1. shran build

• shran build --btc <v23.0> --with-strategy <path to strategy file>

  • --btc argument takes version to build
  • --with-strategy takes a path to build.yaml
  • builds bitcoin with a custom strategy

• shran build --btc <v23.0> --rpc-node

  • --btc argument takes version to build
  • --rpc-node takes no argument
  • builds a node compiled with only the features needed for rpc functionality with -03 optimization

• shran build --btc <v23.0> --wallet-node

  • --btc argument takes version to build
  • --wallet-node takes no argument
  • builds a node compiled with only the features needed for wallet functionality with -03 optimization

• shran build --btc <v23.0> --full-node

  • --btc argument takes version to build
  • --full-node takes no argument
  • builds a node with all functionality with -03 optimization

• shran build --btc <v23.0> --dev-node

  • --btc argument takes version to build
  • --dev-node takes no argument
  • builds a node in -02 and debug mode, with all tests enabled and all functionlity on

2. shran create
   • shran create --btc --strategy
     • creates a build.yaml file configured for a full node, this option is for tinkerers, researchers, developers, and people who wish to heavily modify bitcoin builds. The generated build.yaml file can then be given to the build --with-strategy command