Merge pull request #20 from ava-labs/value-units

Work Units Overhaul

Author: patrick-ogrady

README.md

@@ -77,26 +77,21 @@ prefix pat info &{Owner:0xc00011dd70 LastUpdated:1638591044 Expiry:1638591074 Ke
 ```
 
 # Difficulty Estiamtes
+To see what performance you can get, run:
 ```bash
-difficulty: 0 avg solution time: 1.74µs
-difficulty: 1 avg solution time: 3.263µs
-difficulty: 2 avg solution time: 7.591µs
-difficulty: 3 avg solution time: 9.47µs
-difficulty: 4 avg solution time: 17.529µs
-difficulty: 5 avg solution time: 30.728µs
-difficulty: 6 avg solution time: 56.324µs
-difficulty: 7 avg solution time: 96.442µs
-difficulty: 8 avg solution time: 191.322µs
-difficulty: 9 avg solution time: 386.001µs
-difficulty: 10 avg solution time: 794.525µs
-difficulty: 11 avg solution time: 1.541153ms
-difficulty: 12 avg solution time: 3.766751ms
-difficulty: 13 avg solution time: 6.686821ms
-difficulty: 14 avg solution time: 11.626156ms
-difficulty: 15 avg solution time: 24.456795ms
-difficulty: 16 avg solution time: 50.756825ms
-difficulty: 17 avg solution time: 108.462722ms
-difficulty: 18 avg solution time: 218.103048ms
-difficulty: 19 avg solution time: 458.385183ms
-difficulty: 20 avg solution time: 863.973251ms
+go test -bench=. ./pow/...
+```
+
+Here are some example results:
+```bash
+goos: darwin
+goarch: amd64
+pkg: github.com/ava-labs/quarkvm/pow
+cpu: Intel(R) Core(TM) i9-9980HK CPU @ 2.40GHz
+BenchmarkDifficulty1-16       	 1145233	      1047 ns/op
+BenchmarkDifficulty10-16      	  113216	     10335 ns/op
+BenchmarkDifficulty50-16      	   23011	     52336 ns/op
+BenchmarkDifficulty100-16     	   11540	    102029 ns/op
+BenchmarkDifficulty500-16     	    1962	    535265 ns/op
+BenchmarkDifficulty1000-16    	    1132	   1082758 ns/op
 ```

chain/base_tx.go

@@ -57,3 +57,7 @@ func (b *BaseTx) ExecuteBase() error {
 	}
 	return nil
 }
+
+func (b *BaseTx) Units() uint64 {
+	return BaseTxUnits
+}

chain/block.go

@@ -24,7 +24,7 @@ type StatefulBlock struct {
 	Prnt       ids.ID         `serialize:"true" json:"parent"`
 	Tmstmp     int64          `serialize:"true" json:"timestamp"`
 	Hght       uint64         `serialize:"true" json:"height"`
-	Difficulty uint64         `serialize:"true" json:"difficulty"`
+	Difficulty uint64         `serialize:"true" json:"difficulty"` // difficulty per unit
 	Cost       uint64         `serialize:"true" json:"cost"`
 	Txs        []*Transaction `serialize:"true" json:"txs"`
 }
@@ -59,7 +59,6 @@ func NewBlock(vm VM, parent snowman.Block, tmstp int64, context *Context) *State
 	}
 }
 
-// TODO: check work here? Seems like a DoS vuln?
 func ParseBlock(
 	source []byte,
 	status choices.Status,
@@ -159,20 +158,18 @@ func (b *StatelessBlock) verify() (*StatelessBlock, *versiondb.Database, error)
 	}
 
 	// Process new transactions
-	log.Debug("build context", "next difficulty", context.NextDifficulty, "next cost", context.NextCost)
-	var surplusDifficulty uint64
+	log.Debug("build context", "height", b.Hght, "difficulty", b.Difficulty, "cost", b.Cost)
+	surplusWork := uint64(0)
 	for _, tx := range b.Txs {
 		if err := tx.Execute(onAcceptDB, b.Tmstmp, context); err != nil {
-			log.Debug("failed tx verification", "err", err)
 			return nil, nil, err
 		}
-		surplusDifficulty += tx.Difficulty() - context.NextDifficulty
+		surplusWork += (tx.Difficulty() - b.Difficulty) * tx.Units()
 	}
 	// Ensure enough work is performed to compensate for block production speed
 	requiredSurplus := b.Difficulty * b.Cost
-	if surplusDifficulty < requiredSurplus {
-		log.Debug("insufficient block surplus", "found", surplusDifficulty, "required", requiredSurplus)
-		return nil, nil, ErrInsufficientSurplus
+	if surplusWork < requiredSurplus {
+		return nil, nil, fmt.Errorf("%w: required=%d found=%d", ErrInsufficientSurplus, requiredSurplus, surplusWork)
 	}
 	return parent, onAcceptDB, nil
 }

chain/builder.go

@@ -43,7 +43,8 @@ func BuildBlock(vm VM, preferred ids.ID) (snowman.Block, error) {
 	mempool.Prune(context.RecentBlockIDs) // clean out invalid txs
 	vdb := versiondb.New(parentDB)
 	b.Txs = []*Transaction{}
-	for len(b.Txs) < TargetTransactions && mempool.Len() > 0 {
+	units := uint64(0)
+	for units < TargetUnits && mempool.Len() > 0 {
 		next, diff := mempool.PopMax()
 		if diff < b.Difficulty {
 			mempool.Add(next)
@@ -61,6 +62,7 @@ func BuildBlock(vm VM, preferred ids.ID) (snowman.Block, error) {
 		}
 		// Wait to add prefix until after verification
 		b.Txs = append(b.Txs, next)
+		units += next.Units()
 	}
 
 	// Compute block hash and marshaled representation

chain/chain.go

@@ -9,18 +9,26 @@ import (
 
 // TODO: load from genesis
 const (
-	MaxValueLength     = 256
-	LookbackWindow     = 10
-	BlockTarget        = 1
-	TargetTransactions = 10 * LookbackWindow / BlockTarget // TODO: can be higher on real network
-	MinDifficulty      = 1                                 // TODO: set much higher on real network
-	MinBlockCost       = 0                                 // in units of tx surplus
-	expiryTime         = 30                                // TODO: set much longer on real network
+	ExpiryTime    = 60 * 60 * 24 * 30 // 30 Days
+	ValueUnitSize = 256               // 256B
+	MaxValueSize  = 1 << 10 * 128     // 128KB (500 Units)
+	BaseTxUnits   = 10
+
+	LookbackWindow = 60                                               // 60 Seconds
+	BlockTarget    = 1                                                // 1 Block per Second
+	TargetUnits    = BaseTxUnits * 512 * LookbackWindow / BlockTarget // 512 Units Per Block
+
+	MinDifficulty = 10 // ~10ms per unit (100 ms for claim)
+	MinBlockCost  = 1  // Minimum Unit Overhead
 )
 
 type Context struct {
 	RecentBlockIDs ids.Set
 	RecentTxIDs    ids.Set
+	RecentUnits    uint64
+
+	Difficulties []uint64
+	Costs        []uint64
 
 	NextCost       uint64
 	NextDifficulty uint64

chain/claim_tx.go

@@ -16,7 +16,7 @@ type ClaimTx struct {
 	*BaseTx `serialize:"true" json:"baseTx"`
 }
 
-func (c *ClaimTx) Execute(db database.Database, blockTime int64) error {
+func (c *ClaimTx) Execute(db database.Database, blockTime uint64) error {
 	// Restrict address prefix to be owned by pk
 	// [33]byte prefix is reserved for pubkey
 	if len(c.Prefix) == crypto.SECP256K1RPKLen && !bytes.Equal(c.Sender[:], c.Prefix) {
@@ -37,10 +37,10 @@ func (c *ClaimTx) Execute(db database.Database, blockTime int64) error {
 		Owner:       c.Sender,
 		Created:     blockTime,
 		LastUpdated: blockTime,
-		Expiry:      blockTime + expiryTime,
-		Keys:        1,
+		Expiry:      blockTime + ExpiryTime,
+		Units:       1,
 	}
-	if err := PutPrefixInfo(db, c.Prefix, newInfo, -1); err != nil {
+	if err := PutPrefixInfo(db, c.Prefix, newInfo, 0); err != nil {
 		return err
 	}
 	return nil

chain/claim_tx_test.go

@@ -53,22 +53,22 @@ func TestClaimTx(t *testing.T) {
 		},
 		{ // invalid claim due to expiration
 			tx:        &ClaimTx{BaseTx: &BaseTx{Sender: sender, Prefix: []byte("foo")}},
-			blockTime: 1,
+			blockTime: 100,
 			err:       ErrPrefixNotExpired,
 		},
 		{ // successful new claim
 			tx:        &ClaimTx{BaseTx: &BaseTx{Sender: sender, Prefix: []byte("foo")}},
-			blockTime: 100,
+			blockTime: ExpiryTime * 2,
 			err:       nil,
 		},
 		{ // successful new claim by different owner
 			tx:        &ClaimTx{BaseTx: &BaseTx{Sender: sender2, Prefix: []byte("foo")}},
-			blockTime: 150,
+			blockTime: ExpiryTime * 4,
 			err:       nil,
 		},
 		{ // invalid claim due to expiration by different owner
 			tx:        &ClaimTx{BaseTx: &BaseTx{Sender: sender2, Prefix: []byte("foo")}},
-			blockTime: 177,
+			blockTime: ExpiryTime*4 + 3,
 			err:       ErrPrefixNotExpired,
 		},
 	}
@@ -79,7 +79,7 @@ func TestClaimTx(t *testing.T) {
 				t.Fatalf("#%d: ExpireNext errored %v", i, err)
 			}
 		}
-		err := tv.tx.Execute(db, tv.blockTime)
+		err := tv.tx.Execute(db, uint64(tv.blockTime))
 		if !errors.Is(err, tv.err) {
 			t.Fatalf("#%d: tx.Execute err expected %v, got %v", i, tv.err, err)
 		}
@@ -99,12 +99,16 @@ func TestClaimTx(t *testing.T) {
 	}
 
 	// Cleanup DB after all txs submitted
-	if err := ExpireNext(db, 0, 1000); err != nil {
+	if err := ExpireNext(db, 0, ExpiryTime*10); err != nil {
 		t.Fatal(err)
 	}
-	if err := PruneNext(db, 100); err != nil {
+	pruned, err := PruneNext(db, 100)
+	if err != nil {
 		t.Fatal(err)
 	}
+	if pruned != 3 {
+		t.Fatalf("expected to prune 3 but got %d", pruned)
+	}
 	_, exists, err := GetPrefixInfo(db, []byte("foo"))
 	if err != nil {
 		t.Fatalf("failed to get prefix info %v", err)

chain/codec.go

@@ -6,17 +6,23 @@ package chain
 import (
 	"github.com/ava-labs/avalanchego/codec"
 	"github.com/ava-labs/avalanchego/codec/linearcodec"
+	"github.com/ava-labs/avalanchego/utils/units"
 	"github.com/ava-labs/avalanchego/utils/wrappers"
 )
 
-// codecVersion is the current default codec version
-const codecVersion = 0
+const (
+	// codecVersion is the current default codec version
+	codecVersion = 0
+
+	// maxSize is 1MB to support large blocks (~9 large key settings)
+	maxSize = 1 * units.MiB
+)
 
 var codecManager codec.Manager
 
 func init() {
 	c := linearcodec.NewDefault()
-	codecManager = codec.NewDefaultManager()
+	codecManager = codec.NewManager(maxSize)
 	errs := wrappers.Errs{}
 	errs.Add(
 		c.RegisterType(&BaseTx{}),

chain/lifeline_tx.go

@@ -13,7 +13,7 @@ type LifelineTx struct {
 	*BaseTx `serialize:"true" json:"baseTx"`
 }
 
-func (l *LifelineTx) Execute(db database.Database, blockTime int64) error {
+func (l *LifelineTx) Execute(db database.Database, blockTime uint64) error {
 	i, has, err := GetPrefixInfo(db, l.Prefix)
 	if err != nil {
 		return err
@@ -22,8 +22,8 @@ func (l *LifelineTx) Execute(db database.Database, blockTime int64) error {
 	if !has {
 		return ErrPrefixMissing
 	}
-	// If you are "in debt", lifeline only adds but doesn't reset to new
+	// Lifeline spread across all units
 	lastExpiry := i.Expiry
-	i.Expiry += expiryTime / i.Keys
+	i.Expiry += ExpiryTime / i.Units
 	return PutPrefixInfo(db, l.Prefix, i, lastExpiry)
 }

chain/lifeline_tx_test.go

@@ -27,7 +27,7 @@ func TestLifelineTx(t *testing.T) {
 
 	tt := []struct {
 		utx       UnsignedTransaction
-		blockTime int64
+		blockTime uint64
 		err       error
 	}{
 		{ // invalid when prefix info is missing