Blockchain A-Z by re:Software S.L.

Blockchain A-Z is a pot pourri of blockchain features, developed by re:Software S.L..

• Getting started
• Developer notes
• Getting help
• License

NOTE: The author(s) and contributor(s) of this package cannot be held responsible for any loss of money or for any malintentioned usage forms of this package. Please use this package with caution.

Getting started

Dependencies

This project is maintained with lerna to permit joining multiple sub-projects together in one codebase.

  - node v18+ (stable LTS)
  - lerna v7

You can install lerna globally using npm install -g lerna@4.0.0.

Following command installs the Blockchain A-Z dependencies:

npm install --workspaces

Building packages

Using lerna instead of npm, scripts will run directly inside all packages (use --parallel for parallel execution). If using npm or yarn, use the scripts as provided in package.json.

lerna run lint --stream
lerna run build --stream
lerna run test --stream
lerna run docs --stream

Packaging use-cases

Individual use-cases can be packaged into executable files for all major operating systems using pkg. Following command can be used to generate the bin/ directory of one of the Blockchain A-Z use-cases:

npm run package -w use-cases/bitcoin-block

Examples

1. Execute the use-cases/bitcoin-block software:

npm run start -w use-cases/bitcoin-block miner

Developer notes

Due to this repository holding more than one software package, and being worked with as a so-called monorepo, sometimes your IDEs or Code Editor may not recognize NPM Workspaces dependencies which are installed in the root folder (for deduplication purposes).

A fix, to permit having access to the several @types/* dependencies that are needed for example by VSCode, you can create a symbolic link in the packages' node_modules folder. Note that this symbolic link won't survive a dependencies install.

# prepare types folder
cd core/blockchain.ts/node_modules
mkdir @types
cd \@types

# add @types/node and @types/mocha
ln -s ../../../../node_modules/\@types/mocha
ln -s ../../../../node_modules/\@types/node

Getting help

Use the following available resources to get help:

• Reference Documentation
• If you found a bug, open a new issue

License

Copyright 2024-present re:Software S.L., All rights reserved.

Licensed under the LGPL v3.0