-
Notifications
You must be signed in to change notification settings - Fork 95
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #77 from coinbase/patrick/coin-storage
Coin Storage (automated UTXO tracking)
- Loading branch information
Showing
3 changed files
with
588 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,324 @@ | ||
// 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 storage | ||
|
||
import ( | ||
"context" | ||
"fmt" | ||
|
||
"github.com/coinbase/rosetta-sdk-go/types" | ||
) | ||
|
||
const ( | ||
coinNamespace = "coinNamespace" | ||
coinAccountNamespace = "coinAccountNamespace" | ||
|
||
// For UTXOs to be recognized by CoinStorage, they must contain | ||
// coinCreated or coinSpent in the Operation.Metadata with a value | ||
// of the unique identifier of the coin. In Bitcoin, this unique | ||
// identifier would be the outpoint (tx_hash:index). | ||
coinCreated = "utxo_created" | ||
coinSpent = "utxo_spent" | ||
) | ||
|
||
var _ BlockWorker = (*CoinStorage)(nil) | ||
|
||
// CoinStorage implements storage methods for storing | ||
// UTXOs. | ||
type CoinStorage struct { | ||
db Database | ||
} | ||
|
||
// NewCoinStorage returns a new CoinStorage. | ||
func NewCoinStorage( | ||
db Database, | ||
) *CoinStorage { | ||
return &CoinStorage{ | ||
db: db, | ||
} | ||
} | ||
|
||
// Coin represents some spendable output (typically | ||
// referred to as a UTXO). | ||
type Coin struct { | ||
Identifier string `json:"identifier"` // uses "utxo_created" or "utxo_spent" | ||
Transaction *types.Transaction `json:"transaction"` | ||
Operation *types.Operation `json:"operation"` | ||
} | ||
|
||
func getCoinKey(identifier string) []byte { | ||
return []byte(fmt.Sprintf("%s/%s", coinNamespace, identifier)) | ||
} | ||
|
||
func getCoinAccountKey(accountIdentifier *types.AccountIdentifier) []byte { | ||
return []byte(fmt.Sprintf("%s/%s", coinAccountNamespace, types.Hash(accountIdentifier))) | ||
} | ||
|
||
func getAndDecodeCoin( | ||
ctx context.Context, | ||
transaction DatabaseTransaction, | ||
coinIdentifier string, | ||
) (bool, *Coin, error) { | ||
exists, val, err := transaction.Get(ctx, getCoinKey(coinIdentifier)) | ||
if err != nil { | ||
return false, nil, fmt.Errorf("%w: unable to query for coin", err) | ||
} | ||
|
||
if !exists { // this could occur if coin was created before we started syncing | ||
return false, nil, nil | ||
} | ||
|
||
var coin Coin | ||
if err := decode(val, &coin); err != nil { | ||
return false, nil, fmt.Errorf("%w: unable to decode coin", err) | ||
} | ||
|
||
return true, &coin, nil | ||
} | ||
|
||
func (c *CoinStorage) tryAddingCoin( | ||
ctx context.Context, | ||
transaction DatabaseTransaction, | ||
blockTransaction *types.Transaction, | ||
operation *types.Operation, | ||
identiferKey string, | ||
) error { | ||
rawIdentifier, ok := operation.Metadata[identiferKey] | ||
if ok { | ||
coinIdentifier, ok := rawIdentifier.(string) | ||
if !ok { | ||
return fmt.Errorf("unable to parse created coin %v", rawIdentifier) | ||
} | ||
|
||
newCoin := &Coin{ | ||
Identifier: coinIdentifier, | ||
Transaction: blockTransaction, | ||
Operation: operation, | ||
} | ||
|
||
encodedResult, err := encode(newCoin) | ||
if err != nil { | ||
return fmt.Errorf("%w: unable to encode coin data", err) | ||
} | ||
|
||
if err := transaction.Set(ctx, getCoinKey(coinIdentifier), encodedResult); err != nil { | ||
return fmt.Errorf("%w: unable to store coin", err) | ||
} | ||
|
||
accountExists, coins, err := getAndDecodeCoins(ctx, transaction, operation.Account) | ||
if err != nil { | ||
return fmt.Errorf("%w: unable to query coin account", err) | ||
} | ||
|
||
if !accountExists { | ||
coins = map[string]struct{}{} | ||
} | ||
|
||
if _, exists := coins[coinIdentifier]; exists { | ||
return fmt.Errorf( | ||
"coin %s already exists in account %s", | ||
coinIdentifier, | ||
types.PrettyPrintStruct(operation.Account), | ||
) | ||
} | ||
|
||
coins[coinIdentifier] = struct{}{} | ||
|
||
if err := encodeAndSetCoins(ctx, transaction, operation.Account, coins); err != nil { | ||
return fmt.Errorf("%w: unable to set coin account", err) | ||
} | ||
} | ||
|
||
return nil | ||
} | ||
|
||
func encodeAndSetCoins( | ||
ctx context.Context, | ||
transaction DatabaseTransaction, | ||
accountIdentifier *types.AccountIdentifier, | ||
coins map[string]struct{}, | ||
) error { | ||
encodedResult, err := encode(coins) | ||
if err != nil { | ||
return fmt.Errorf("%w: unable to encode coins", err) | ||
} | ||
|
||
if err := transaction.Set(ctx, getCoinAccountKey(accountIdentifier), encodedResult); err != nil { | ||
return fmt.Errorf("%w: unable to set coin account", err) | ||
} | ||
|
||
return nil | ||
} | ||
|
||
func getAndDecodeCoins( | ||
ctx context.Context, | ||
transaction DatabaseTransaction, | ||
accountIdentifier *types.AccountIdentifier, | ||
) (bool, map[string]struct{}, error) { | ||
accountExists, val, err := transaction.Get(ctx, getCoinAccountKey(accountIdentifier)) | ||
if err != nil { | ||
return false, nil, fmt.Errorf("%w: unable to query coin account", err) | ||
} | ||
|
||
if !accountExists { | ||
return false, nil, nil | ||
} | ||
|
||
var coins map[string]struct{} | ||
if err := decode(val, &coins); err != nil { | ||
return false, nil, fmt.Errorf("%w: unable to decode coin account", err) | ||
} | ||
|
||
return true, coins, nil | ||
} | ||
|
||
func (c *CoinStorage) tryRemovingCoin( | ||
ctx context.Context, | ||
transaction DatabaseTransaction, | ||
operation *types.Operation, | ||
identiferKey string, | ||
) error { | ||
rawIdentifier, ok := operation.Metadata[identiferKey] | ||
if ok { | ||
coinIdentifier, ok := rawIdentifier.(string) | ||
if !ok { | ||
return fmt.Errorf("unable to parse spent coin %v", rawIdentifier) | ||
} | ||
|
||
exists, _, err := transaction.Get(ctx, getCoinKey(coinIdentifier)) | ||
if err != nil { | ||
return fmt.Errorf("%w: unable to query for coin", err) | ||
} | ||
|
||
if !exists { // this could occur if coin was created before we started syncing | ||
return nil | ||
} | ||
|
||
if err := transaction.Delete(ctx, getCoinKey(coinIdentifier)); err != nil { | ||
return fmt.Errorf("%w: unable to delete coin", err) | ||
} | ||
|
||
accountExists, coins, err := getAndDecodeCoins(ctx, transaction, operation.Account) | ||
if err != nil { | ||
return fmt.Errorf("%w: unable to query coin account", err) | ||
} | ||
|
||
if !accountExists { | ||
return fmt.Errorf("%w: unable to find owner of coin", err) | ||
} | ||
|
||
if _, exists := coins[coinIdentifier]; !exists { | ||
return fmt.Errorf( | ||
"unable to find coin %s in account %s", | ||
coinIdentifier, | ||
types.PrettyPrintStruct(operation.Account), | ||
) | ||
} | ||
|
||
delete(coins, coinIdentifier) | ||
|
||
if err := encodeAndSetCoins(ctx, transaction, operation.Account, coins); err != nil { | ||
return fmt.Errorf("%w: unable to set coin account", err) | ||
} | ||
} | ||
|
||
return nil | ||
} | ||
|
||
// AddingBlock is called by BlockStorage when adding a block. | ||
func (c *CoinStorage) AddingBlock( | ||
ctx context.Context, | ||
block *types.Block, | ||
transaction DatabaseTransaction, | ||
) (CommitWorker, error) { | ||
for _, txn := range block.Transactions { | ||
for _, operation := range txn.Operations { | ||
if operation.Amount == nil { | ||
continue | ||
} | ||
|
||
if err := c.tryAddingCoin(ctx, transaction, txn, operation, coinCreated); err != nil { | ||
return nil, fmt.Errorf("%w: unable to add coin", err) | ||
} | ||
|
||
if err := c.tryRemovingCoin(ctx, transaction, operation, coinSpent); err != nil { | ||
return nil, fmt.Errorf("%w: unable to remove coin", err) | ||
} | ||
} | ||
} | ||
|
||
return nil, nil | ||
} | ||
|
||
// RemovingBlock is called by BlockStorage when removing a block. | ||
func (c *CoinStorage) RemovingBlock( | ||
ctx context.Context, | ||
block *types.Block, | ||
transaction DatabaseTransaction, | ||
) (CommitWorker, error) { | ||
for _, txn := range block.Transactions { | ||
for _, operation := range txn.Operations { | ||
if operation.Amount == nil { | ||
continue | ||
} | ||
|
||
// We add spent coins and remove created coins during a re-org (opposite of | ||
// AddingBlock). | ||
if err := c.tryAddingCoin(ctx, transaction, txn, operation, coinSpent); err != nil { | ||
return nil, fmt.Errorf("%w: unable to add coin", err) | ||
} | ||
|
||
if err := c.tryRemovingCoin(ctx, transaction, operation, coinCreated); err != nil { | ||
return nil, fmt.Errorf("%w: unable to remove coin", err) | ||
} | ||
} | ||
} | ||
|
||
return nil, nil | ||
} | ||
|
||
// GetCoins returns all unspent coins for a provided *types.AccountIdentifier. | ||
func (c *CoinStorage) GetCoins( | ||
ctx context.Context, | ||
accountIdentifier *types.AccountIdentifier, | ||
) ([]*Coin, error) { | ||
transaction := c.db.NewDatabaseTransaction(ctx, false) | ||
defer transaction.Discard(ctx) | ||
|
||
accountExists, coins, err := getAndDecodeCoins(ctx, transaction, accountIdentifier) | ||
if err != nil { | ||
return nil, fmt.Errorf("%w: unable to query account identifier", err) | ||
} | ||
|
||
if !accountExists { | ||
return []*Coin{}, nil | ||
} | ||
|
||
coinArr := []*Coin{} | ||
for coinIdentifier := range coins { | ||
exists, coin, err := getAndDecodeCoin(ctx, transaction, coinIdentifier) | ||
if err != nil { | ||
return nil, fmt.Errorf("%w: unable to query coin", err) | ||
} | ||
|
||
if !exists { | ||
return nil, fmt.Errorf("%w: unable to get coin %s", err, coinIdentifier) | ||
} | ||
|
||
coinArr = append(coinArr, coin) | ||
} | ||
|
||
return coinArr, nil | ||
} |
Oops, something went wrong.