From 9f3899779a834cafe4024d061720429990e615ee Mon Sep 17 00:00:00 2001 From: Abdul Rabbani Date: Wed, 2 Mar 2022 18:09:01 -0500 Subject: [PATCH] Update the readme and cleanup the make file --- Makefile | 2 +- README.md | 24 ++++++++++++++++++++++++ 2 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 README.md diff --git a/Makefile b/Makefile index 16b547a..8507af3 100644 --- a/Makefile +++ b/Makefile @@ -6,7 +6,7 @@ PKGS = go list ./... | grep -v "^vendor/" ## Testing library GINKGO = $(BIN)/ginkgo $(BIN)/ginkgo: - go get -u github.com/onsi/ginkgo/ginkgo + go install github.com/onsi/ginkgo/ginkgo .PHONY: integrationtest integrationtest: | $(GINKGO) $(GOOSE) diff --git a/README.md b/README.md new file mode 100644 index 0000000..b058bb2 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# Overview + +This repository contains the validator. The purpose of the validator is to ensure that the data in the Core Postgres database match the data on the blockchain. + +# Intention for the Validator + +The perfect scenario for the validator is as follows: + +1. The validator will have the capacity to perform historical checks for the Core Postgres database. Users can contain these historical checks to specified configurations (block range). +2. The validator will perform validation for a certain number of trailing blocks, `t`, trailing the head, `n`. Therefore the validator will constantly perform real-time validation starting at `n` and ending at `n - t`. +3. The validator validates IDLP blocks in the Core Database; it will update the core database to indicate that the validator validated the block. + +## Edge Cases + +We must consider the following edge cases for the validator. + +- There are three different data types that the validator must account for. + +# Instructions for Testing + +To run the test, do the following: + +1. Make sure `GOPATH` is set in your `~/.bashrc` or `~/.bash_profile`: `export GOPATH=$(go env GOPATH)` +2. `./scripts/run_integration_test.sh`