Skip to content

V31 consensus upgrade #3553

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tsachiherman merged 8 commits into from
Feb 10, 2022
Merged

V31 consensus upgrade #3553

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8b54ef8
create v31 consensus version.
Feb 2, 2022
7d34cfa
v31 include more feature + change the current
Feb 2, 2022
355b97f
Update config/consensus.go
id-ms Feb 2, 2022
00e75f8
Merge branch 'master' into create-v31-version
tsachiherman Feb 8, 2022
4236478
Merge branch 'master' into create-v31-version
tsachiherman Feb 10, 2022
3ce0afb
update upgrade.
tsachiherman Feb 10, 2022
4ba3d33
update per peer review
tsachiherman Feb 10, 2022
6326a0c
reduce runtime of unit test: TestKeyregValidityPeriod
Aharonee Feb 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 23 additions & 18 deletions config/consensus.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1057,9 +1057,31 @@ func initConsensusProtocols() {
// v29 can be upgraded to v30, with an update delay of 7 days ( see calculation above )
v29.ApprovedUpgrades[protocol.ConsensusV30] = 140000

v31 := v30
v31.ApprovedUpgrades = map[protocol.ConsensusVersion]uint64{}
v31.EnableBatchVerification = true
v31.RewardsCalculationFix = true
v31.MaxProposedExpiredOnlineAccounts = 32

// Enable TEAL 6 / AVM 1.1
v31.LogicSigVersion = 6
v31.EnableInnerTransactionPooling = true
v31.IsolateClearState = true

// stat proof key registration
v31.EnableStateProofKeyregCheck = true

// Maximum validity period for key registration, to prevent generating too many StateProof keys
v31.MaxKeyregValidPeriod = 256*(1<<16) - 1
Copy link
Contributor

@gmalouf gmalouf Feb 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was about to ask some questions about the numbers going into this formula, seems like intent is to address this in a follow on issue: #3257 cc @algonautshant

Copy link
Contributor

@algonautshant algonautshant Feb 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The assumption is that the source of the truth is here: v31.MaxKeyregValidPeriod = 256*(1<<16) - 1
Anywhere else should be referencing this parameter.

The issue in #3257 is to make sure this variable is used for testing (instead of hardcoding the same value elsewhere), and fix the package dependency issue.

This is not a blocking issue.

Copy link
Contributor

@algonautshant algonautshant Feb 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MaxKeyregValidPeriod combines 256 and 16, which are based on two different limits.
for example:
merklearray/merkle.go: MaxEncodedTreeDepth = 16


Consensus[protocol.ConsensusV31] = v31

// v30 can be upgraded to v31, with an update delay of 7 days ( see calculation above )
v30.ApprovedUpgrades[protocol.ConsensusV31] = 140000

// ConsensusFuture is used to test features that are implemented
// but not yet released in a production protocol version.
vFuture := v30
vFuture := v31
vFuture.ApprovedUpgrades = map[protocol.ConsensusVersion]uint64{}

// FilterTimeout for period 0 should take a new optimized, configured value, need to revisit this later
Expand All @@ -1072,23 +1094,6 @@ func initConsensusProtocols() {
vFuture.CompactCertWeightThreshold = (1 << 32) * 30 / 100
vFuture.CompactCertSecKQ = 128

// Enable TEAL 6 / AVM 1.1
vFuture.LogicSigVersion = 6
vFuture.EnableInnerTransactionPooling = true
vFuture.IsolateClearState = true

vFuture.MaxProposedExpiredOnlineAccounts = 32

vFuture.EnableBatchVerification = true

vFuture.RewardsCalculationFix = true

// stat proof key registration
vFuture.EnableStateProofKeyregCheck = true

// Maximum validity period for key registration, to prevent generating too many StateProof keys
vFuture.MaxKeyregValidPeriod = 256*(1<<16) - 1

Consensus[protocol.ConsensusFuture] = vFuture
}

Expand Down
2 changes: 1 addition & 1 deletion data/account/participation.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ func FillDBWithParticipationKeys(store db.Accessor, address basics.Address, firs

// TODO: change to ConsensusCurrentVersion when updated
interval := config.Consensus[protocol.ConsensusFuture].CompactCertRounds
maxValidPeriod := config.Consensus[protocol.ConsensusFuture].MaxKeyregValidPeriod
maxValidPeriod := config.Consensus[protocol.ConsensusCurrentVersion].MaxKeyregValidPeriod

if maxValidPeriod != 0 && uint64(lastValid-firstValid) > maxValidPeriod {
return PersistedParticipation{}, fmt.Errorf("the validity period for mss is too large: the limit is %d", maxValidPeriod)
Expand Down
24 changes: 11 additions & 13 deletions data/account/participation_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -462,9 +462,8 @@ func TestKeyregValidityOverLimit(t *testing.T) {
partitiontest.PartitionTest(t)
a := require.New(t)

// TODO: change to ConsensusCurrentVersion when updated
maxValidPeriod := config.Consensus[protocol.ConsensusFuture].MaxKeyregValidPeriod
dilution := config.Consensus[protocol.ConsensusFuture].DefaultKeyDilution
maxValidPeriod := config.Consensus[protocol.ConsensusCurrentVersion].MaxKeyregValidPeriod
dilution := config.Consensus[protocol.ConsensusCurrentVersion].DefaultKeyDilution

var address basics.Address
crypto.RandBytes(address[:])
Expand All @@ -481,8 +480,7 @@ func TestFillDBWithParticipationKeys(t *testing.T) {
partitiontest.PartitionTest(t)
a := require.New(t)

// TODO: change to ConsensusCurrentVersion when updated
dilution := config.Consensus[protocol.ConsensusFuture].DefaultKeyDilution
dilution := config.Consensus[protocol.ConsensusCurrentVersion].DefaultKeyDilution

var address basics.Address
crypto.RandBytes(address[:])
Expand All @@ -499,19 +497,19 @@ func TestKeyregValidityPeriod(t *testing.T) {
partitiontest.PartitionTest(t)
a := require.New(t)

// TODO: change to ConsensusCurrentVersion when updated
// setup patched version
version := config.Consensus[protocol.ConsensusFuture]
oldValue := config.Consensus[protocol.ConsensusFuture].MaxKeyregValidPeriod
// Patch the global consensus variable since FillDBWithParticipationKeys uses is to check the validity period
// this allows us to reduce the runtime of the test while checking the logic of FillDBWithParticipationKeys
version := config.Consensus[protocol.ConsensusCurrentVersion]
oldValue := config.Consensus[protocol.ConsensusCurrentVersion].MaxKeyregValidPeriod
version.MaxKeyregValidPeriod = 256*(1<<4) - 1
config.Consensus[protocol.ConsensusFuture] = version
config.Consensus[protocol.ConsensusCurrentVersion] = version
defer func() {
version.MaxKeyregValidPeriod = oldValue
config.Consensus[protocol.ConsensusFuture] = version
config.Consensus[protocol.ConsensusCurrentVersion] = version
}()

maxValidPeriod := config.Consensus[protocol.ConsensusFuture].MaxKeyregValidPeriod
dilution := config.Consensus[protocol.ConsensusFuture].DefaultKeyDilution
maxValidPeriod := config.Consensus[protocol.ConsensusCurrentVersion].MaxKeyregValidPeriod
dilution := config.Consensus[protocol.ConsensusCurrentVersion].DefaultKeyDilution

var address basics.Address

Expand Down
2 changes: 1 addition & 1 deletion gen/generate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ func generateGenesisFiles(outDir string, protoVersion protocol.ConsensusVersion,
data.VoteFirstValid = part.FirstValid
data.VoteLastValid = part.LastValid
data.VoteKeyDilution = part.KeyDilution
if config.Consensus[protocol.ConsensusFuture].EnableStateProofKeyregCheck {
if protoParams.EnableStateProofKeyregCheck {
data.StateProofID = *part.StateProofVerifier()
}
}
Expand Down
2 changes: 1 addition & 1 deletion ledger/accountdb_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ func TestAccountDBRound(t *testing.T) {
}

func TestAccountStorageWithStateProofID(t *testing.T) {
proto := config.Consensus[protocol.ConsensusFuture]
proto := config.Consensus[protocol.ConsensusCurrentVersion]

dbs, _ := dbOpenTest(t, true)
setDbLogging(t, dbs)
Expand Down
8 changes: 4 additions & 4 deletions ledger/apply/keyreg_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,21 +188,21 @@ func TestStateProofPKKeyReg(t *testing.T) {
secretParticipation := keypair()

tx := createTestTxn(t, src, secretParticipation, vrfSecrets)
mockBal := makeMockBalances(protocol.ConsensusCurrentVersion)
mockBal := makeMockBalances(protocol.ConsensusV30)
err := Keyreg(tx.KeyregTxnFields, tx.Header, mockBal, transactions.SpecialAddresses{FeeSink: feeSink}, nil, basics.Round(0))
require.NoError(t, err)

acct, err := mockBal.Get(tx.Src(), false)
require.NoError(t, err)
require.Equal(t, acct.StateProofID.IsEmpty(), true)
require.True(t, acct.StateProofID.IsEmpty())

mockBal = makeMockBalances(protocol.ConsensusFuture)
mockBal = makeMockBalances(protocol.ConsensusCurrentVersion)
err = Keyreg(tx.KeyregTxnFields, tx.Header, mockBal, transactions.SpecialAddresses{FeeSink: feeSink}, nil, basics.Round(0))
require.NoError(t, err)

acct, err = mockBal.Get(tx.Src(), false)
require.NoError(t, err)
require.Equal(t, acct.StateProofID.IsEmpty(), false)
require.False(t, acct.StateProofID.IsEmpty())
}

func createTestTxn(t *testing.T, src basics.Address, secretParticipation *crypto.SignatureSecrets, vrfSecrets *crypto.VRFSecrets) transactions.Transaction {
Expand Down
9 changes: 8 additions & 1 deletion protocol/consensus.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,13 @@ const ConsensusV30 = ConsensusVersion(
"https://github.com/algorandfoundation/specs/tree/bc36005dbd776e6d1eaf0c560619bb183215645c",
)

// ConsensusV31 enables the batch verification for ed25519 signatures, Fix reward calculation issue, introduces the ability
// to force an expired participation offline, enables TEAL 6 ( AVM 1.1 ) and add support for creating
// state proof keys.
const ConsensusV31 = ConsensusVersion(
"https://github.com/algorandfoundation/specs/tree/85e6db1fdbdef00aa232c75199e10dc5fe9498f6",
)

// ConsensusFuture is a protocol that should not appear in any production
// network, but is used to test features before they are released.
const ConsensusFuture = ConsensusVersion(
Expand All @@ -176,7 +183,7 @@ const ConsensusFuture = ConsensusVersion(

// ConsensusCurrentVersion is the latest version and should be used
// when a specific version is not provided.
const ConsensusCurrentVersion = ConsensusV30
const ConsensusCurrentVersion = ConsensusV31

// Error is used to indicate that an unsupported protocol has been detected.
type Error ConsensusVersion
Expand Down
1 change: 1 addition & 0 deletions test/e2e-go/features/participation/onlineOfflineParticipation_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,6 +284,7 @@ func TestAccountGoesOnlineForShortPeriod(t *testing.T) {

// we try to register online with a period in which we don't have stateproof keys
partKeyFirstValid := uint64(1)
// TODO: Change consensus version when compact certs are deployed
partKeyLastValid := config.Consensus[protocol.ConsensusFuture].CompactCertRounds - 1
partkeyResponse, _, err := client.GenParticipationKeys(newAccount, partKeyFirstValid, partKeyLastValid, 1000)
a.NoError(err, "rest client should be able to add participation key to new account")
Expand Down
2 changes: 1 addition & 1 deletion test/e2e-go/features/participation/participationExpiration_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ func testExpirationAccounts(t *testing.T, fixture *fixtures.RestClientFixture, f
_, currentRound := fixture.GetBalanceAndRound(richAccount)
// account adds part key
partKeyFirstValid := uint64(0)
partKeyValidityPeriod := uint64(150)
partKeyValidityPeriod := uint64(150) // TODO: maybe increase?
Copy link
Contributor

@jannotti jannotti Feb 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What are the units? I would have guessed rounds, but that would be very short.

Copy link
Contributor

@Aharonee Aharonee Feb 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes they are rounds and it is very short, maybe we should put 1000-3000 there instead, as no State Proof keys will be generated for such a short interval.

partKeyLastValid = currentRound + partKeyValidityPeriod
partkeyResponse, _, err := sClient.GenParticipationKeys(sAccount, partKeyFirstValid, partKeyLastValid, 0)
a.NoError(err)
Expand Down
26 changes: 6 additions & 20 deletions test/e2e-go/restAPI/restClient_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -553,6 +553,9 @@ func TestAccountParticipationInfo(t *testing.T) {
firstRound := basics.Round(params.LastRound + 1)
lastRound := basics.Round(params.LastRound + 1000)
dilution := uint64(100)
var stateproof merklesignature.Verifier
stateproof[0] = 1 // change some byte so the stateproof is not considered empty (required since consensus v31)

randomVotePKStr := randomString(32)
var votePK crypto.OneTimeSignatureVerifier
copy(votePK[:], []byte(randomVotePKStr))
Expand All @@ -576,6 +579,7 @@ func TestAccountParticipationInfo(t *testing.T) {
VoteKeyDilution: dilution,
VoteFirst: firstRound,
VoteLast: lastRound,
StateProofPK: stateproof,
},
}
txID, err := testClient.SignAndBroadcastTransaction(wh, nil, tx)
Expand All @@ -590,6 +594,7 @@ func TestAccountParticipationInfo(t *testing.T) {
a.Equal(uint64(firstRound), account.Participation.VoteFirst, "API must print correct first participation round")
a.Equal(uint64(lastRound), account.Participation.VoteLast, "API must print correct last participation round")
a.Equal(dilution, account.Participation.VoteKeyDilution, "API must print correct key dilution")
// TODO: should we update the v1 API to support state proof? Currently it does not return this field.
Copy link
Contributor

@gmalouf gmalouf Feb 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tsachiherman did we already address this?

Copy link
Contributor

@tsachiherman tsachiherman Feb 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I copied this comment from @Aharonee 's PR, but I believe that the answer is no, and I think it's fine. We want to avoid updating the v1 endpoint any further.

Copy link
Contributor

@cce cce Feb 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed, if we are using v1 somewhere internally that needs it, we should just convert it to using v2 instead

}

func TestSupply(t *testing.T) {
Expand Down Expand Up @@ -1063,9 +1068,6 @@ func TestStateProofInParticipationInfo(t *testing.T) {
var localFixture fixtures.RestClientFixture

proto := config.Consensus[protocol.ConsensusCurrentVersion]
// TODO: remove these 2 lines when CurrentVersion contains them already
proto.EnableStateProofKeyregCheck = true
proto.MaxKeyregValidPeriod = config.Consensus[protocol.ConsensusFuture].MaxKeyregValidPeriod
localFixture.SetConsensus(config.ConsensusProtocols{protocol.ConsensusCurrentVersion: proto})

localFixture.Setup(t, filepath.Join("nettemplates", "TwoNodes50Each.json"))
Expand Down Expand Up @@ -1168,22 +1170,7 @@ func TestNilStateProofInParticipationInfo(t *testing.T) {
a := require.New(fixtures.SynchronizedTest(t))
var localFixture fixtures.RestClientFixture

// currently, the genesis creator uses the EnableStateProofKeyregCheck flag on the future
// version to write a statproof to the genesis file.
// we want to create a gensis file without state proof.
// + need to revert this change if other tests use that
tmp := config.Consensus[protocol.ConsensusFuture]
tmp.EnableStateProofKeyregCheck = false
config.Consensus[protocol.ConsensusFuture] = tmp

defer func() {
tmp := config.Consensus[protocol.ConsensusFuture]
tmp.EnableStateProofKeyregCheck = true
config.Consensus[protocol.ConsensusFuture] = tmp
}()

localFixture.SetConsensus(config.Consensus)
localFixture.Setup(t, filepath.Join("nettemplates", "TwoNodes50Each.json"))
localFixture.Setup(t, filepath.Join("nettemplates", "TwoNodes50EachV30.json"))
defer localFixture.Shutdown()

testClient := localFixture.LibGoalClient
Expand Down Expand Up @@ -1226,7 +1213,6 @@ func TestNilStateProofInParticipationInfo(t *testing.T) {
VotePK: votePK,
SelectionPK: selPK,
VoteFirst: firstRound,
StateProofPK: merklesignature.Verifier{},
VoteLast: lastRound,
VoteKeyDilution: dilution,
Nonparticipation: false,
Expand Down
35 changes: 16 additions & 19 deletions test/e2e-go/upgrades/stateproof_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,25 +31,27 @@ import (
"time"
)

func waitUntilProtocolFuture(a *require.Assertions, fixture *fixtures.RestClientFixture, nodeClient libgoal.Client) {
func waitUntilProtocolUpgrades(a *require.Assertions, fixture *fixtures.RestClientFixture, nodeClient libgoal.Client) {

curRound, err := nodeClient.CurrentRound()
a.NoError(err)

blk, err := nodeClient.Block(curRound)
a.NoError(err)
curProtocl := blk.CurrentProtocol
curProtocol := blk.CurrentProtocol

startTime := time.Now()

for strings.Compare(curProtocl, string(consensusTestFastUpgrade(protocol.ConsensusFuture))) != 0 {
// while consensus version has not upgraded
for strings.Compare(curProtocol, string(consensusTestFastUpgrade(protocol.ConsensusV30))) == 0 {
curRound = curRound + 1
fixture.WaitForRoundWithTimeout(curRound + 1)

// TODO: check node status instead of latest block?
blk, err := nodeClient.Block(curRound)
a.NoError(err)

curProtocl = blk.CurrentProtocol
curProtocol = blk.CurrentProtocol
if time.Now().After(startTime.Add(5 * time.Minute)) {
a.Fail("upgrade taking too long")
}
Expand All @@ -62,7 +64,7 @@ func TestKeysWithoutStateProofKeyCannotRegister(t *testing.T) {
defer fixtures.ShutdownSynchronizedTest(t)

a := require.New(fixtures.SynchronizedTest(t))
consensus := getStateProofConcensus()
consensus := getStateProofConsensus()

var fixture fixtures.RestClientFixture
fixture.SetConsensus(consensus)
Expand All @@ -72,21 +74,18 @@ func TestKeysWithoutStateProofKeyCannotRegister(t *testing.T) {

nodeClient := fixture.GetLibGoalClientForNamedNode("Node")

waitUntilProtocolFuture(a, &fixture, nodeClient)
waitUntilProtocolUpgrades(a, &fixture, nodeClient)

a.Error(registerKeyInto(&nodeClient, a, lastValid+2, protocol.ConsensusV30))
a.NoError(registerKeyInto(&nodeClient, a, lastValid+3, protocol.ConsensusFuture))
a.NoError(registerKeyInto(&nodeClient, a, lastValid+3, protocol.ConsensusV31))
}

func TestKeysWithoutStateProofKeyCanRegister(t *testing.T) {
partitiontest.PartitionTest(t)
defer fixtures.ShutdownSynchronizedTest(t)

a := require.New(fixtures.SynchronizedTest(t))
consensus := make(config.ConsensusProtocols)
currentCon := config.Consensus[protocol.ConsensusV30]

consensus[consensusTestFastUpgrade(protocol.ConsensusV30)] = currentCon
consensus := getStateProofConsensus()

var fixture fixtures.RestClientFixture
fixture.SetConsensus(consensus)
Expand All @@ -97,8 +96,7 @@ func TestKeysWithoutStateProofKeyCanRegister(t *testing.T) {
nodeClient := fixture.GetLibGoalClientForNamedNode("Node")

a.NoError(registerKeyInto(&nodeClient, a, lastValid, protocol.ConsensusV30))
a.Error(registerKeyInto(&nodeClient, a, lastValid+1, protocol.ConsensusFuture))

a.Error(registerKeyInto(&nodeClient, a, lastValid+1, protocol.ConsensusV31))
}

func registerKeyInto(client *libgoal.Client, a *require.Assertions, lastValid uint64, ver protocol.ConsensusVersion) error {
Expand Down Expand Up @@ -139,12 +137,11 @@ func registerKeyInto(client *libgoal.Client, a *require.Assertions, lastValid ui
return err
}

func getStateProofConcensus() config.ConsensusProtocols {
func getStateProofConsensus() config.ConsensusProtocols {
consensus := generateFastUpgradeConsensus()

// TODO: when upgrading from v29, need to change this from future to v30.
consensus[consensusTestFastUpgrade(protocol.ConsensusV30)].
ApprovedUpgrades[consensusTestFastUpgrade(protocol.ConsensusFuture)] = 0
ApprovedUpgrades[consensusTestFastUpgrade(protocol.ConsensusV31)] = 0
return consensus
}

Expand Down Expand Up @@ -175,15 +172,15 @@ func waitForAccountToProposeBlock(a *require.Assertions, fixture *fixtures.RestC
return false
}

// This test starts with participation keys in Version29, then attempts to let the richest user participate even after
// This test starts with participation keys in Version30, then attempts to let the richest user participate even after
// consensus upgrade.
func TestParticipationWithoutStateProofKeys(t *testing.T) {
partitiontest.PartitionTest(t)
defer fixtures.ShutdownSynchronizedTest(t)

a := require.New(fixtures.SynchronizedTest(t))

consensus := getStateProofConcensus()
consensus := getStateProofConsensus()

var fixture fixtures.RestClientFixture
fixture.SetConsensus(consensus)
Expand All @@ -197,7 +194,7 @@ func TestParticipationWithoutStateProofKeys(t *testing.T) {
var address = act.Address

nodeClient := fixture.GetLibGoalClientForNamedNode("Node")
waitUntilProtocolFuture(a, &fixture, nodeClient)
waitUntilProtocolUpgrades(a, &fixture, nodeClient)

a.NotEmpty(address)

Expand Down
Loading