Merge pull request #93 from coinbase/patrick/export-internal

Export Internal Packages + Miscellaneous Bug Fixes

Makefile

@@ -11,11 +11,11 @@ ADDLICENSE_CMD=go run github.com/google/addlicense
 ADDLICENCE_SCRIPT=${ADDLICENSE_CMD} -c "Coinbase, Inc." -l "apache" -v
 GOLINES_CMD=go run github.com/segmentio/golines
 GOVERALLS_CMD=go run github.com/mattn/goveralls
-COVERAGE_TEST_DIRECTORIES=./configuration/... ./internal/constructor/... \
-	./internal/logger/... ./internal/scenario/... \
-	./internal/statefulsyncer/... ./internal/storage/... \
-	./internal/tester/... ./internal/utils/...
-TEST_SCRIPT=go test -v ./internal/... ./configuration/...
+COVERAGE_TEST_DIRECTORIES=./configuration/... ./pkg/constructor/... \
+	./pkg/logger/... ./pkg/scenario/... \
+	./pkg/statefulsyncer/... ./pkg/storage/... \
+	./pkg/tester/... ./pkg/utils/...
+TEST_SCRIPT=go test -v ./pkg/... ./configuration/...
 COVERAGE_TEST_SCRIPT=go test -v ${COVERAGE_TEST_DIRECTORIES}
 
 deps:
@@ -44,7 +44,7 @@ check-license:
 	${ADDLICENCE_SCRIPT} -check .
 
 shorten-lines:
-	${GOLINES_CMD} -w --shorten-comments internal cmd configuration
+	${GOLINES_CMD} -w --shorten-comments pkg cmd configuration
 
 salus:
 	docker run --rm -t -v ${PWD}:/home/repo coinbase/salus
@@ -59,4 +59,5 @@ install:
 
 mocks:
 	rm -rf mocks;
-	mockery --dir internal/constructor --all --case underscore --outpkg constructor --output mocks/constructor;
+	mockery --dir pkg/constructor --all --case underscore --outpkg constructor --output mocks/constructor;
+	${ADDLICENCE_SCRIPT} .;

cmd/check_construction.go

@@ -20,8 +20,8 @@ import (
 	"os"
 	"time"
 
-	"github.com/coinbase/rosetta-cli/internal/tester"
-	"github.com/coinbase/rosetta-cli/internal/utils"
+	"github.com/coinbase/rosetta-cli/pkg/tester"
+	"github.com/coinbase/rosetta-cli/pkg/utils"
 
 	"github.com/coinbase/rosetta-sdk-go/fetcher"
 	"github.com/fatih/color"

cmd/check_data.go

@@ -19,8 +19,8 @@ import (
 	"log"
 	"time"
 
-	"github.com/coinbase/rosetta-cli/internal/tester"
-	"github.com/coinbase/rosetta-cli/internal/utils"
+	"github.com/coinbase/rosetta-cli/pkg/tester"
+	"github.com/coinbase/rosetta-cli/pkg/utils"
 
 	"github.com/coinbase/rosetta-sdk-go/fetcher"
 	"github.com/spf13/cobra"

cmd/configuration_create.go

@@ -18,7 +18,7 @@ import (
 	"log"
 
 	"github.com/coinbase/rosetta-cli/configuration"
-	"github.com/coinbase/rosetta-cli/internal/utils"
+	"github.com/coinbase/rosetta-cli/pkg/utils"
 
 	"github.com/spf13/cobra"
 )

cmd/root.go

@@ -24,7 +24,7 @@ import (
 	"time"
 
 	"github.com/coinbase/rosetta-cli/configuration"
-	"github.com/coinbase/rosetta-cli/internal/utils"
+	"github.com/coinbase/rosetta-cli/pkg/utils"
 
 	"github.com/fatih/color"
 	"github.com/spf13/cobra"

cmd/utils_asserter_configuration.go

@@ -19,7 +19,7 @@ import (
 	"log"
 	"time"
 
-	"github.com/coinbase/rosetta-cli/internal/utils"
+	"github.com/coinbase/rosetta-cli/pkg/utils"
 
 	"github.com/coinbase/rosetta-sdk-go/fetcher"
 	"github.com/spf13/cobra"

cmd/view_account.go

@@ -22,7 +22,7 @@ import (
 	"strconv"
 	"time"
 
-	"github.com/coinbase/rosetta-cli/internal/utils"
+	"github.com/coinbase/rosetta-cli/pkg/utils"
 
 	"github.com/coinbase/rosetta-sdk-go/asserter"
 	"github.com/coinbase/rosetta-sdk-go/fetcher"

cmd/view_block.go

@@ -21,7 +21,7 @@ import (
 	"strconv"
 	"time"
 
-	"github.com/coinbase/rosetta-cli/internal/utils"
+	"github.com/coinbase/rosetta-cli/pkg/utils"
 
 	"github.com/coinbase/rosetta-sdk-go/fetcher"
 	"github.com/coinbase/rosetta-sdk-go/parser"

configuration/configuration.go

@@ -19,8 +19,8 @@ import (
 	"log"
 	"math/big"
 
-	"github.com/coinbase/rosetta-cli/internal/scenario"
-	"github.com/coinbase/rosetta-cli/internal/utils"
+	"github.com/coinbase/rosetta-cli/pkg/scenario"
+	"github.com/coinbase/rosetta-cli/pkg/utils"
 
 	"github.com/coinbase/rosetta-sdk-go/asserter"
 	"github.com/coinbase/rosetta-sdk-go/types"
@@ -322,6 +322,12 @@ type DataConfiguration struct {
 	// consistency.
 	BalanceTrackingDisabled bool `json:"balance_tracking_disabled"`
 
+	// CoinTrackingDisabled is a boolean that indicates coin (or UTXO) tracking
+	// should not be attempted. When first testing an implemenation, it can be
+	// useful to just try to fetch all blocks before checking for coin
+	// consistency.
+	CoinTrackingDisabled bool `json:"coin_tracking_disabled"`
+
 	// EndCondition contains the conditions for the syncer to stop
 	EndConditions *EndConditions `json:"end_conditions,omitempty"`
 }
@@ -358,6 +364,10 @@ type Configuration struct {
 	// that uses more memory.
 	DisableMemoryLimit bool `json:"disable_memory_limit"`
 
+	// LogConfiguration determines if the configuration settings
+	// should be printed to the console when a file is loaded.
+	LogConfiguration bool `json:"log_configuration"`
+
 	Construction *ConstructionConfiguration `json:"construction"`
 	Data         *DataConfiguration         `json:"data"`
 }
@@ -550,7 +560,9 @@ func LoadConfiguration(filePath string) (*Configuration, error) {
 		filePath,
 	)
 
-	log.Println(types.PrettyPrintStruct(config))
+	if config.LogConfiguration {
+		log.Println(types.PrettyPrintStruct(config))
+	}
 
 	return config, nil
 }

configuration/configuration_test.go

@@ -19,7 +19,7 @@ import (
 	"os"
 	"testing"
 
-	"github.com/coinbase/rosetta-cli/internal/utils"
+	"github.com/coinbase/rosetta-cli/pkg/utils"
 
 	"github.com/coinbase/rosetta-sdk-go/types"
 	"github.com/stretchr/testify/assert"

internal/constructor/constructor.go → pkg/constructor/constructor.go

@@ -23,10 +23,10 @@ import (
 	"time"
 
 	"github.com/coinbase/rosetta-cli/configuration"
-	"github.com/coinbase/rosetta-cli/internal/logger"
-	"github.com/coinbase/rosetta-cli/internal/scenario"
-	"github.com/coinbase/rosetta-cli/internal/storage"
-	"github.com/coinbase/rosetta-cli/internal/utils"
+	"github.com/coinbase/rosetta-cli/pkg/logger"
+	"github.com/coinbase/rosetta-cli/pkg/scenario"
+	"github.com/coinbase/rosetta-cli/pkg/storage"
+	"github.com/coinbase/rosetta-cli/pkg/utils"
 
 	"github.com/coinbase/rosetta-sdk-go/keys"
 	"github.com/coinbase/rosetta-sdk-go/parser"

internal/constructor/constructor_test.go → pkg/constructor/constructor_test.go

@@ -22,9 +22,9 @@ import (
 	"time"
 
 	"github.com/coinbase/rosetta-cli/configuration"
-	"github.com/coinbase/rosetta-cli/internal/scenario"
-	"github.com/coinbase/rosetta-cli/internal/storage"
 	mocks "github.com/coinbase/rosetta-cli/mocks/constructor"
+	"github.com/coinbase/rosetta-cli/pkg/scenario"
+	"github.com/coinbase/rosetta-cli/pkg/storage"
 
 	"github.com/coinbase/rosetta-sdk-go/asserter"
 	"github.com/coinbase/rosetta-sdk-go/parser"

internal/logger/logger.go → pkg/logger/logger.go

@@ -22,9 +22,9 @@ import (
 	"os"
 	"path"
 
-	"github.com/coinbase/rosetta-cli/internal/scenario"
-	"github.com/coinbase/rosetta-cli/internal/storage"
-	"github.com/coinbase/rosetta-cli/internal/utils"
+	"github.com/coinbase/rosetta-cli/pkg/scenario"
+	"github.com/coinbase/rosetta-cli/pkg/storage"
+	"github.com/coinbase/rosetta-cli/pkg/utils"
 
 	"github.com/coinbase/rosetta-sdk-go/parser"
 	"github.com/coinbase/rosetta-sdk-go/reconciler"

internal/processor/balance_storage_handler.go → pkg/processor/balance_storage_handler.go

@@ -17,8 +17,8 @@ package processor
 import (
 	"context"
 
-	"github.com/coinbase/rosetta-cli/internal/logger"
-	"github.com/coinbase/rosetta-cli/internal/storage"
+	"github.com/coinbase/rosetta-cli/pkg/logger"
+	"github.com/coinbase/rosetta-cli/pkg/storage"
 
 	"github.com/coinbase/rosetta-sdk-go/parser"
 	"github.com/coinbase/rosetta-sdk-go/reconciler"

internal/processor/balance_storage_helper.go → pkg/processor/balance_storage_helper.go

@@ -18,7 +18,7 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/coinbase/rosetta-cli/internal/storage"
+	"github.com/coinbase/rosetta-cli/pkg/storage"
 
 	"github.com/coinbase/rosetta-sdk-go/asserter"
 	"github.com/coinbase/rosetta-sdk-go/fetcher"

internal/processor/broadcast_storage_handler.go → pkg/processor/broadcast_storage_handler.go

@@ -20,7 +20,7 @@ import (
 	"math/big"
 
 	"github.com/coinbase/rosetta-cli/configuration"
-	"github.com/coinbase/rosetta-cli/internal/storage"
+	"github.com/coinbase/rosetta-cli/pkg/storage"
 
 	"github.com/coinbase/rosetta-sdk-go/parser"
 	"github.com/coinbase/rosetta-sdk-go/types"

internal/processor/broadcast_storage_helper.go → pkg/processor/broadcast_storage_helper.go

@@ -18,7 +18,7 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/coinbase/rosetta-cli/internal/storage"
+	"github.com/coinbase/rosetta-cli/pkg/storage"
 
 	"github.com/coinbase/rosetta-sdk-go/fetcher"
 	"github.com/coinbase/rosetta-sdk-go/types"

pkg/processor/coin_storage_helper.go

@@ -0,0 +1,45 @@
+// Copyright 2020 Coinbase, Inc.
+//
+// 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 processor
+
+import (
+	"context"
+
+	"github.com/coinbase/rosetta-cli/pkg/storage"
+
+	"github.com/coinbase/rosetta-sdk-go/types"
+)
+
+var _ storage.CoinStorageHelper = (*CoinStorageHelper)(nil)
+
+// CoinStorageHelper implements the storage.CoinStorageHelper
+// interface.
+type CoinStorageHelper struct {
+	blockStorage *storage.BlockStorage
+}
+
+// NewCoinStorageHelper returns a new *CoinStorageHelper.
+func NewCoinStorageHelper(blockStorage *storage.BlockStorage) *CoinStorageHelper {
+	return &CoinStorageHelper{blockStorage: blockStorage}
+}
+
+// CurrentBlockIdentifier returns the head *types.BlockIdentifier in
+// the context of a storage.DatabaseTransaction.
+func (c *CoinStorageHelper) CurrentBlockIdentifier(
+	ctx context.Context,
+	transaction storage.DatabaseTransaction,
+) (*types.BlockIdentifier, error) {
+	return c.blockStorage.GetHeadBlockIdentifierTransactional(ctx, transaction)
+}

internal/processor/constructor_handler.go → pkg/processor/constructor_handler.go

@@ -18,8 +18,8 @@ import (
 	"context"
 	"math/big"
 
-	"github.com/coinbase/rosetta-cli/internal/constructor"
-	"github.com/coinbase/rosetta-cli/internal/storage"
+	"github.com/coinbase/rosetta-cli/pkg/constructor"
+	"github.com/coinbase/rosetta-cli/pkg/storage"
 
 	"github.com/coinbase/rosetta-sdk-go/types"
 )

internal/processor/constructor_helper.go → pkg/processor/constructor_helper.go

@@ -19,9 +19,9 @@ import (
 	"fmt"
 	"math/big"
 
-	"github.com/coinbase/rosetta-cli/internal/constructor"
-	"github.com/coinbase/rosetta-cli/internal/storage"
-	"github.com/coinbase/rosetta-cli/internal/utils"
+	"github.com/coinbase/rosetta-cli/pkg/constructor"
+	"github.com/coinbase/rosetta-cli/pkg/storage"
+	"github.com/coinbase/rosetta-cli/pkg/utils"
 
 	"github.com/coinbase/rosetta-sdk-go/fetcher"
 	"github.com/coinbase/rosetta-sdk-go/keys"
@@ -216,7 +216,13 @@ func (c *ConstructorHelper) CoinBalance(
 	accountIdentifier *types.AccountIdentifier,
 	currency *types.Currency,
 ) (*big.Int, *types.CoinIdentifier, error) {
-	return c.coinStorage.GetLargestCoin(ctx, accountIdentifier, currency)
+	coinValue, coinIdentifier, _, err := c.coinStorage.GetLargestCoin(
+		ctx,
+		accountIdentifier,
+		currency,
+	)
+
+	return coinValue, coinIdentifier, err
 }
 
 // LockedAddresses returns a slice of all addresses currently sending or receiving

internal/processor/reconciler_handler.go → pkg/processor/reconciler_handler.go

@@ -19,8 +19,8 @@ import (
 	"errors"
 	"math/big"
 
-	"github.com/coinbase/rosetta-cli/internal/logger"
-	"github.com/coinbase/rosetta-cli/internal/storage"
+	"github.com/coinbase/rosetta-cli/pkg/logger"
+	"github.com/coinbase/rosetta-cli/pkg/storage"
 
 	"github.com/coinbase/rosetta-sdk-go/reconciler"
 	"github.com/coinbase/rosetta-sdk-go/types"

internal/processor/reconciler_helper.go → pkg/processor/reconciler_helper.go

@@ -18,7 +18,7 @@ import (
 	"context"
 	"errors"
 
-	"github.com/coinbase/rosetta-cli/internal/storage"
+	"github.com/coinbase/rosetta-cli/pkg/storage"
 
 	"github.com/coinbase/rosetta-sdk-go/types"
 )

internal/statefulsyncer/stateful_syncer.go → pkg/statefulsyncer/stateful_syncer.go

@@ -21,8 +21,8 @@ import (
 	"math/big"
 	"time"
 
-	"github.com/coinbase/rosetta-cli/internal/logger"
-	"github.com/coinbase/rosetta-cli/internal/storage"
+	"github.com/coinbase/rosetta-cli/pkg/logger"
+	"github.com/coinbase/rosetta-cli/pkg/storage"
 
 	"github.com/coinbase/rosetta-sdk-go/fetcher"
 	"github.com/coinbase/rosetta-sdk-go/syncer"

internal/storage/badger_storage_test.go → pkg/storage/badger_storage_test.go

@@ -19,7 +19,7 @@ import (
 	"fmt"
 	"testing"
 
-	"github.com/coinbase/rosetta-cli/internal/utils"
+	"github.com/coinbase/rosetta-cli/pkg/utils"
 
 	"github.com/stretchr/testify/assert"
 )

internal/storage/balance_storage.go → pkg/storage/balance_storage.go

@@ -21,7 +21,7 @@ import (
 	"log"
 	"math/big"
 
-	"github.com/coinbase/rosetta-cli/internal/utils"
+	"github.com/coinbase/rosetta-cli/pkg/utils"
 
 	"github.com/coinbase/rosetta-sdk-go/asserter"
 	"github.com/coinbase/rosetta-sdk-go/parser"

internal/storage/balance_storage_test.go → pkg/storage/balance_storage_test.go

@@ -22,7 +22,7 @@ import (
 	"path"
 	"testing"
 
-	"github.com/coinbase/rosetta-cli/internal/utils"
+	"github.com/coinbase/rosetta-cli/pkg/utils"
 
 	"github.com/coinbase/rosetta-sdk-go/asserter"
 	"github.com/coinbase/rosetta-sdk-go/parser"