BSP Finalizer [This repository is deprecated and is no longer being actively developed.]

Finalisation and reward processor for consensus block specimens sessions and block results session using the covalent db and proofchain. It functions at the end of the BSP stack within the following pipeline bsp-geth -> bsp-agent -> bsp-staking -> bsp-finalizer -> rudder/refiner -> bsp-finalizer

The "finalizer" functions for the network on proof-chain smart contracts can be called by anyone with gas available in their account. The function is a simple call to the proof chain smart contract with chain ID and the block height being finalized for block specimens/block results whose sessions have been started by a submission and the submissions period has ended (so no more participants can submit a valid hash). A valid session is created for each hash that is submitted by an operator.

Three issues are possible during submission -

• "Session not past deadline" - trying to finalize a session that's not reached a deadline for submissions yet
• "Session cannot be finalized" - issues on the proofchain contract end
• "Session not started" - trying to finalize a session for a block number that's not been started by any participant yet.

The process of finalization invokes the reward paid out to all the contributors to the consensus blocks and also produces a finalization hash which is then indexed by the covalent db. The covalent db is used as a reference point for finalized vs un-finalized blocks and any gaps in the indexing of finalized hashes will result in interim hiccups in this process.

finalizeAndRewardSpecimenSession(uint64 chainId, uint64 blockHeight)

The finalizer will also be extended for block results and their respective finalizations and rewards pay outs.

finalizeAndRewardResultSession(uint64 chainId, uint64 blockHeight)

Standalone Run

In order to run access to the covalent db is required. Please ask the code owners of this repo @noslav or @kitti-katy for access.

1. Place appropriate values in an .envrc or .env file:

    export RPC_ENDPOINT="http://endpoint-to-where-proofchain-is-deployed"
    export BLOCK_ID_START="1910104892088990000"
    export PROOFCHAIN_ADDRESS="<<ASK-ON-DISCORD>>"
    export FINALIZER_PRIVATE_KEY="0xprivatekeyoffinalizerwithgas"
    export FINALIZER_ADDRESS="0xpublicaddressofaboveprivatekey"
    export DB_USER="db_access_user"
    export DB_PASSWORD="db_access_user_password"
    export DB_HOST="replica.reach.point"
    export DB_DATABASE="blockchains"
    export CHAIN_TABLE_NAME="chain_moonbeam_moonbase_alpha"
    export GAS_PRICE=1
    export GAS_LIMIT=300000

1. Load environment variables:

    direnv allow .

1. Create directories for logging:

    mkdir -p logs/{Contract,Finalizer,DB}

1. Install python packages (virtualenv):

    python3 -m virtualenv ./.venv
    source .venv/bin/activate
    brew install openssl # In case you don't have it already installed
    export LDFLAGS="-L/opt/homebrew/opt/openssl@3/lib"; pip install -r requirements.txt

1. Run the script:

    python3 src/main.py

Docker run

1. Login to GCR for docker images with -

    gcloud auth print-access-token | docker login -u oauth2accesstoken --password-stdin https://gcr.io

1. Add an .env file with all the env variables mentioned above.

Pull the images and run (arm64) -

    docker pull us-docker.pkg.dev/covalent-project/network/bsp-finalizer:latest
    docker run --env-file .env us-docker.pkg.dev/covalent-project/network/bsp-finalizer:latest

1. Pull the images and run (amd64) -

    docker pull us-docker.pkg.dev/covalent-project/network/bsp-finalizer:latest
    docker run --env-file .env us-docker.pkg.dev/covalent-project/network/bsp-finalizer:latest

1. If the run is successful you should see logs such as below.

INFO DB (dbmanager.py:74) - Connecting to the database...
INFO DB (dbmanager.py:76) - Initial scan block_id=1870737934539735450
DEBUG Finalizer (finalizer.py:43) - Nothing ready to finalize height=3958481 openSessions=0..