ipld-eth-server/examples/erc20_watcher/every_block/repository.go

// Copyright 2018 Vulcanize
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package every_block

import (
	"fmt"
	"github.com/vulcanize/vulcanizedb/pkg/datastore/postgres"
	"log"
)

// Interface definition for a generic ERC20 token repository
type ERC20RepositoryInterface interface {
	CreateSupply(supply TokenSupply) error
	CreateBalance(balance TokenBalance) error
	CreateAllowance(allowance TokenAllowance) error
	MissingSupplyBlocks(startingBlock, highestBlock int64, tokenAddress string) ([]int64, error)
	MissingBalanceBlocks(startingBlock, highestBlock int64, tokenAddress, holderAddress string) ([]int64, error)
	MissingAllowanceBlocks(startingBlock, highestBlock int64, tokenAddress, holderAddress, spenderAddress string) ([]int64, error)
}

// Generic ERC20 token Repo struct
type ERC20TokenRepository struct {
	*postgres.DB
}

// Repo error
type repositoryError struct {
	err         string
	msg         string
	blockNumber int64
}

// Repo error method
func (re *repositoryError) Error() string {
	return fmt.Sprintf(re.msg, re.blockNumber, re.err)
}

// Used to create a new Repo error for a given error and fetch method
func newRepositoryError(err error, msg string, blockNumber int64) error {
	e := repositoryError{err.Error(), msg, blockNumber}
	log.Println(e.Error())
	return &e
}

// Constant error definitions
const (
	GetBlockError             = "Error fetching block number %d: %s"
	InsertTokenSupplyError    = "Error inserting token_supply for block number %d: %s"
	InsertTokenBalanceError   = "Error inserting token_balance for block number %d: %s"
	InsertTokenAllowanceError = "Error inserting token_allowance for block number %d: %s"
	MissingBlockError         = "Error finding missing token_supply records starting at block %d: %s"
)

// Supply methods
// This method inserts the supply for a given token contract address at a given block height into the token_supply table
func (tsp *ERC20TokenRepository) CreateSupply(supply TokenSupply) error {
	var blockId int
	err := tsp.DB.Get(&blockId, `SELECT id FROM blocks WHERE number = $1 AND eth_node_id = $2`, supply.BlockNumber, tsp.NodeID)
	if err != nil {
		return newRepositoryError(err, GetBlockError, supply.BlockNumber)
	}

	_, err = tsp.DB.Exec(
		`INSERT INTO token_supply (supply, token_address, block_id)
                VALUES($1, $2, $3)`,
		supply.Value, supply.TokenAddress, blockId)
	if err != nil {
		return newRepositoryError(err, InsertTokenSupplyError, supply.BlockNumber)
	}
	return nil
}

// This method returns an array of blocks that are missing a token_supply entry for a given tokenAddress
func (tsp *ERC20TokenRepository) MissingSupplyBlocks(startingBlock, highestBlock int64, tokenAddress string) ([]int64, error) {
	blockNumbers := make([]int64, 0)

	err := tsp.DB.Select(
		&blockNumbers,
		`SELECT number FROM BLOCKS
               LEFT JOIN token_supply ON blocks.id = block_id 
			   AND token_address = $1
               WHERE block_id ISNULL
               AND eth_node_id = $2
               AND number >= $3
               AND number <= $4
               LIMIT 20`,
		tokenAddress,
		tsp.NodeID,
		startingBlock,
		highestBlock,
	)
	if err != nil {
		return []int64{}, newRepositoryError(err, MissingBlockError, startingBlock)
	}
	return blockNumbers, err
}

// Balance methods
// This method inserts the balance for a given token contract address and token owner address at a given block height into the token_balance table
func (tsp *ERC20TokenRepository) CreateBalance(balance TokenBalance) error {
	var blockId int
	err := tsp.DB.Get(&blockId, `SELECT id FROM blocks WHERE number = $1 AND eth_node_id = $2`, balance.BlockNumber, tsp.NodeID)
	if err != nil {
		return newRepositoryError(err, GetBlockError, balance.BlockNumber)
	}

	_, err = tsp.DB.Exec(
		`INSERT INTO token_balance (balance, token_address, block_id, token_holder_address)
                VALUES($1, $2, $3, $4)`,
		balance.Value, balance.TokenAddress, blockId, balance.TokenHolderAddress)
	if err != nil {
		return newRepositoryError(err, InsertTokenBalanceError, balance.BlockNumber)
	}
	return nil
}

// This method returns an array of blocks that are missing a token_balance entry for a given token contract address and token owner address
func (tsp *ERC20TokenRepository) MissingBalanceBlocks(startingBlock, highestBlock int64, tokenAddress, holderAddress string) ([]int64, error) {
	blockNumbers := make([]int64, 0)

	err := tsp.DB.Select(
		&blockNumbers,
		`SELECT number FROM BLOCKS
               LEFT JOIN token_balance ON blocks.id = block_id
			   AND token_address = $1
			   AND token_holder_address = $2
               WHERE block_id ISNULL
               AND eth_node_id = $3
               AND number >= $4
               AND number <= $5
               LIMIT 20`,
		tokenAddress,
		holderAddress,
		tsp.NodeID,
		startingBlock,
		highestBlock,
	)
	if err != nil {
		return []int64{}, newRepositoryError(err, MissingBlockError, startingBlock)
	}
	return blockNumbers, err
}

// Allowance methods
// This method inserts the allowance for a given token contract address, token owner address, and token spender address at a given block height into the
func (tsp *ERC20TokenRepository) CreateAllowance(allowance TokenAllowance) error {
	var blockId int
	err := tsp.DB.Get(&blockId, `SELECT id FROM blocks WHERE number = $1 AND eth_node_id = $2`, allowance.BlockNumber, tsp.NodeID)
	if err != nil {
		return newRepositoryError(err, GetBlockError, allowance.BlockNumber)
	}

	_, err = tsp.DB.Exec(
		`INSERT INTO token_allowance (allowance, token_address, block_id, token_holder_address, token_spender_address)
                VALUES($1, $2, $3, $4, $5)`,
		allowance.Value, allowance.TokenAddress, blockId, allowance.TokenHolderAddress, allowance.TokenSpenderAddress)
	if err != nil {
		return newRepositoryError(err, InsertTokenAllowanceError, allowance.BlockNumber)
	}
	return nil
}

// This method returns an array of blocks that are missing a token_allowance entry for a given token contract address, token owner address, and token spender address
func (tsp *ERC20TokenRepository) MissingAllowanceBlocks(startingBlock, highestBlock int64, tokenAddress, holderAddress, spenderAddress string) ([]int64, error) {
	blockNumbers := make([]int64, 0)

	err := tsp.DB.Select(
		&blockNumbers,
		`SELECT number FROM BLOCKS
               LEFT JOIN token_allowance ON blocks.id = block_id
			   AND token_address = $1 
			   AND token_holder_address = $2
			   AND token_spender_address = $3
               WHERE block_id ISNULL
               AND eth_node_id = $4
               AND number >= $5
               AND number <= $6
               LIMIT 20`,
		tokenAddress,
		holderAddress,
		spenderAddress,
		tsp.NodeID,
		startingBlock,
		highestBlock,
	)
	if err != nil {
		return []int64{}, newRepositoryError(err, MissingBlockError, startingBlock)
	}
	return blockNumbers, err
}