Merge pull request #471 from iotaledger/feat/vbytes-factor-issuer-val…

…idator Introduce VBytes factor for block issuer keys and staking.
iotaledger · Aug 4, 2023 · 7e29753 · 7e29753
2 parents 5a196b9 + 59ff31d
commit 7e29753
Show file tree

Hide file tree

Showing 12 changed files with 35 additions and 30 deletions.
diff --git a/api_test.go b/api_test.go
@@ -82,6 +82,8 @@ func TestProtocolParametersJSONMarshalling(t *testing.T) {
 			6,
 			7,
 			8,
+			9,
+			10,
 		),
 		iotago.WithWorkScoreOptions(
 			1,
@@ -120,7 +122,7 @@ func TestProtocolParametersJSONMarshalling(t *testing.T) {
 		iotago.WithVersionSignalingOptions(3, 4, 1),
 	)
 
-	protoParamsJSON := `{"type":0,"version":3,"networkName":"xxxNetwork","bech32Hrp":"xxx","rentStructure":{"vByteCost":6,"vByteFactorData":7,"vByteFactorKey":8},"workScoreStructure":{"dataByte":1,"block":2,"missingParent":3,"input":4,"contextInput":5,"output":6,"nativeToken":7,"staking":8,"blockIssuer":9,"allotment":10,"signatureEd25519":11,"minStrongParentsThreshold":12},"tokenSupply":"1234567890987654321","genesisUnixTimestamp":"1681373293","slotDurationInSeconds":10,"slotsPerEpochExponent":13,"manaGenerationRate":1,"manaGenerationRateExponent":27,"manaDecayFactors":[10,20],"manaDecayFactorsExponent":32,"manaDecayFactorEpochsSum":1337,"manaDecayFactorEpochsSumExponent":20,"stakingUnbondingPeriod":"11","livenessThreshold":"3","minCommittableAge":"10","maxCommittableAge":"20","epochNearingThreshold":"24","versionSignaling":{"windowSize":3,"windowTargetRatio":4,"activationOffset":1}}`
+	protoParamsJSON := `{"type":0,"version":3,"networkName":"xxxNetwork","bech32Hrp":"xxx","rentStructure":{"vByteCost":6,"vByteFactorData":7,"vByteFactorKey":8,"vByteFactorIssuerKeys":9,"vByteFactorStakingFeature":10},"workScoreStructure":{"dataByte":1,"block":2,"missingParent":3,"input":4,"contextInput":5,"output":6,"nativeToken":7,"staking":8,"blockIssuer":9,"allotment":10,"signatureEd25519":11,"minStrongParentsThreshold":12},"tokenSupply":"1234567890987654321","genesisUnixTimestamp":"1681373293","slotDurationInSeconds":10,"slotsPerEpochExponent":13,"manaGenerationRate":1,"manaGenerationRateExponent":27,"manaDecayFactors":[10,20],"manaDecayFactorsExponent":32,"manaDecayFactorEpochsSum":1337,"manaDecayFactorEpochsSumExponent":20,"stakingUnbondingPeriod":"11","livenessThreshold":"3","minCommittableAge":"10","maxCommittableAge":"20","epochNearingThreshold":"24","versionSignaling":{"windowSize":3,"windowTargetRatio":4,"activationOffset":1}}`
 
 	jsonProtoParams, err := tpkg.TestAPI.JSONEncode(protoParams)
 	require.NoError(t, err)

diff --git a/api_v3_protocol_parameters.go b/api_v3_protocol_parameters.go
@@ -24,7 +24,7 @@ func NewV3ProtocolParameters(opts ...options.Option[V3ProtocolParameters]) *V3Pr
 		append([]options.Option[V3ProtocolParameters]{
 			WithVersion(apiV3Version),
 			WithNetworkOptions("testnet", PrefixTestnet),
-			WithSupplyOptions(1813620509061365, 100, 1, 10),
+			WithSupplyOptions(1813620509061365, 100, 1, 10, 100, 100),
 			WithWorkScoreOptions(1, 100, 500, 20, 20, 20, 20, 100, 100, 100, 200, 4),
 			WithTimeProviderOptions(time.Now().Unix(), 10, 13),
 			// TODO: add sane default values
@@ -163,13 +163,15 @@ func WithNetworkOptions(networkName string, bech32HRP NetworkPrefix) options.Opt
 	}
 }
 
-func WithSupplyOptions(totalSupply BaseToken, vByteCost uint32, vBFactorData VByteCostFactor, vBFactorKey VByteCostFactor) options.Option[V3ProtocolParameters] {
+func WithSupplyOptions(totalSupply BaseToken, vByteCost uint32, vBFactorData, vBFactorKey, vBFactorIssuerKeys, vBFactorStakingFeature VByteCostFactor) options.Option[V3ProtocolParameters] {
 	return func(p *V3ProtocolParameters) {
 		p.basicProtocolParameters.TokenSupply = totalSupply
 		p.basicProtocolParameters.RentStructure = RentStructure{
-			VByteCost:    vByteCost,
-			VBFactorData: vBFactorData,
-			VBFactorKey:  vBFactorKey,
+			VByteCost:              vByteCost,
+			VBFactorData:           vBFactorData,
+			VBFactorKey:            vBFactorKey,
+			VBFactorIssuerKeys:     vBFactorIssuerKeys,
+			VBFactorStakingFeature: vBFactorStakingFeature,
 		}
 	}
 }

diff --git a/feat_blockissuer.go b/feat_blockissuer.go
@@ -36,11 +36,10 @@ func (s *BlockIssuerFeature) Clone() Feature {
 }
 
 func (s *BlockIssuerFeature) VBytes(rentStruct *RentStructure, _ VBytesFunc) VBytes {
-	// TODO: add factor for block issuer keys (higher than regular keys factor).
 	// VBFactorData: type prefix + expiry slot + keys length
-	// VBFactorKey: numKeys * pubKeyLength
+	// VBFactorIssuerKeys: numKeys * pubKeyLength
 	return rentStruct.VBFactorData.Multiply(serializer.SmallTypeDenotationByteSize+serializer.UInt64ByteSize+serializer.OneByte) +
-		rentStruct.VBFactorKey.Multiply(VBytes(len(s.BlockIssuerKeys))*(ed25519.PublicKeySize))
+		rentStruct.VBFactorIssuerKeys.Multiply(VBytes(len(s.BlockIssuerKeys))*(ed25519.PublicKeySize))
 }
 
 func (s *BlockIssuerFeature) WorkScore(workScoreStructure *WorkScoreStructure) (WorkScore, error) {

diff --git a/feat_staking.go b/feat_staking.go
@@ -46,11 +46,12 @@ func (s *StakingFeature) Clone() Feature {
 	return &StakingFeature{StakedAmount: s.StakedAmount, FixedCost: s.FixedCost, StartEpoch: s.StartEpoch, EndEpoch: s.EndEpoch}
 }
 
-func (s *StakingFeature) VBytes(rentStruct *RentStructure, _ VBytesFunc) VBytes {
-	vbytes := s.Size()
+func (s *StakingFeature) VBytes(rentStruct *RentStructure, f VBytesFunc) VBytes {
+	if f != nil {
+		return f(rentStruct)
+	}
 
-	// TODO: Introduce another vbyte factor for the staking feature.
-	return rentStruct.VBFactorData.Multiply(VBytes(vbytes))
+	return rentStruct.VBFactorStakingFeature.Multiply(VBytes(s.Size()))
 }
 
 func (s *StakingFeature) WorkScore(workScoreStructure *WorkScoreStructure) (WorkScore, error) {

diff --git a/nodeclient/apimodels/core_test.go b/nodeclient/apimodels/core_test.go
@@ -61,7 +61,7 @@ func Test_InfoResponse(t *testing.T) {
 		jsonResponse, err := api.JSONEncode(response)
 		require.NoError(t, err)
 
-		expected := "{\"name\":\"test\",\"version\":\"2.0.0\",\"status\":{\"isHealthy\":false,\"acceptedTangleTime\":\"2023-08-01T08:45:05Z\",\"relativeAcceptedTangleTime\":\"2023-08-01T08:45:05Z\",\"confirmedTangleTime\":\"2023-08-01T08:45:05Z\",\"relativeConfirmedTangleTime\":\"2023-08-01T08:45:05Z\",\"latestCommitmentId\":\"0x00000000000000000000000000000000000000000000000000000000000000000000000000000000\",\"latestFinalizedSlot\":\"1\",\"latestAcceptedBlockSlot\":\"2\",\"latestConfirmedBlockSlot\":\"3\",\"pruningSlot\":\"4\"},\"metrics\":{\"blocksPerSecond\":\"1.1E+00\",\"confirmedBlocksPerSecond\":\"2.2E+00\",\"confirmationRate\":\"3.3E+00\"},\"protocolParameters\":[{\"startEpoch\":\"0\",\"parameters\":{\"type\":0,\"version\":3,\"networkName\":\"testnet\",\"bech32Hrp\":\"rms\",\"rentStructure\":{\"vByteCost\":100,\"vByteFactorData\":1,\"vByteFactorKey\":10},\"workScoreStructure\":{\"dataByte\":1,\"block\":100,\"missingParent\":500,\"input\":20,\"contextInput\":20,\"output\":20,\"nativeToken\":20,\"staking\":100,\"blockIssuer\":100,\"allotment\":100,\"signatureEd25519\":200,\"minStrongParentsThreshold\":4},\"tokenSupply\":\"1813620509061365\",\"genesisUnixTimestamp\":\"1690879505\",\"slotDurationInSeconds\":10,\"slotsPerEpochExponent\":13,\"manaGenerationRate\":1,\"manaGenerationRateExponent\":0,\"manaDecayFactors\":[10,20],\"manaDecayFactorsExponent\":0,\"manaDecayFactorEpochsSum\":0,\"manaDecayFactorEpochsSumExponent\":0,\"stakingUnbondingPeriod\":\"10\",\"livenessThreshold\":\"3\",\"minCommittableAge\":\"10\",\"maxCommittableAge\":\"20\",\"epochNearingThreshold\":\"24\",\"versionSignaling\":{\"windowSize\":7,\"windowTargetRatio\":5,\"activationOffset\":7}}}],\"baseToken\":{\"name\":\"Shimmer\",\"tickerSymbol\":\"SMR\",\"unit\":\"SMR\",\"subunit\":\"glow\",\"decimals\":6,\"useMetricPrefix\":false},\"features\":[\"test\"]}"
+		expected := "{\"name\":\"test\",\"version\":\"2.0.0\",\"status\":{\"isHealthy\":false,\"acceptedTangleTime\":\"2023-08-01T08:45:05Z\",\"relativeAcceptedTangleTime\":\"2023-08-01T08:45:05Z\",\"confirmedTangleTime\":\"2023-08-01T08:45:05Z\",\"relativeConfirmedTangleTime\":\"2023-08-01T08:45:05Z\",\"latestCommitmentId\":\"0x00000000000000000000000000000000000000000000000000000000000000000000000000000000\",\"latestFinalizedSlot\":\"1\",\"latestAcceptedBlockSlot\":\"2\",\"latestConfirmedBlockSlot\":\"3\",\"pruningSlot\":\"4\"},\"metrics\":{\"blocksPerSecond\":\"1.1E+00\",\"confirmedBlocksPerSecond\":\"2.2E+00\",\"confirmationRate\":\"3.3E+00\"},\"protocolParameters\":[{\"startEpoch\":\"0\",\"parameters\":{\"type\":0,\"version\":3,\"networkName\":\"testnet\",\"bech32Hrp\":\"rms\",\"rentStructure\":{\"vByteCost\":100,\"vByteFactorData\":1,\"vByteFactorKey\":10,\"vByteFactorIssuerKeys\":100,\"vByteFactorStakingFeature\":100},\"workScoreStructure\":{\"dataByte\":1,\"block\":100,\"missingParent\":500,\"input\":20,\"contextInput\":20,\"output\":20,\"nativeToken\":20,\"staking\":100,\"blockIssuer\":100,\"allotment\":100,\"signatureEd25519\":200,\"minStrongParentsThreshold\":4},\"tokenSupply\":\"1813620509061365\",\"genesisUnixTimestamp\":\"1690879505\",\"slotDurationInSeconds\":10,\"slotsPerEpochExponent\":13,\"manaGenerationRate\":1,\"manaGenerationRateExponent\":0,\"manaDecayFactors\":[10,20],\"manaDecayFactorsExponent\":0,\"manaDecayFactorEpochsSum\":0,\"manaDecayFactorEpochsSumExponent\":0,\"stakingUnbondingPeriod\":\"10\",\"livenessThreshold\":\"3\",\"minCommittableAge\":\"10\",\"maxCommittableAge\":\"20\",\"epochNearingThreshold\":\"24\",\"versionSignaling\":{\"windowSize\":7,\"windowTargetRatio\":5,\"activationOffset\":7}}}],\"baseToken\":{\"name\":\"Shimmer\",\"tickerSymbol\":\"SMR\",\"unit\":\"SMR\",\"subunit\":\"glow\",\"decimals\":6,\"useMetricPrefix\":false},\"features\":[\"test\"]}"
 		require.Equal(t, expected, string(jsonResponse))
 
 		decoded := new(apimodels.InfoResponse)

diff --git a/nodeclient/http_api_client_test.go b/nodeclient/http_api_client_test.go
@@ -32,7 +32,7 @@ const (
 var (
 	protoParams = iotago.NewV3ProtocolParameters(
 		iotago.WithNetworkOptions("alphanet", "atoi"),
-		iotago.WithSupplyOptions(tpkg.TestTokenSupply, 500, 1, 10),
+		iotago.WithSupplyOptions(tpkg.TestTokenSupply, 500, 1, 10, 100, 100),
 	)
 
 	mockAPI = iotago.V3API(protoParams)

diff --git a/output_test.go b/output_test.go
@@ -201,7 +201,7 @@ func TestOutputsDeSerialize(t *testing.T) {
 
 func TestOutputsSyntacticalDepositAmount(t *testing.T) {
 	nonZeroCostParams := iotago.NewV3ProtocolParameters(
-		iotago.WithSupplyOptions(tpkg.TestTokenSupply, 100, iotago.VByteCostFactorData, iotago.VByteCostFactorKey),
+		iotago.WithSupplyOptions(tpkg.TestTokenSupply, 100, 1, 10, 10, 10),
 	)
 
 	tests := []struct {

diff --git a/rent.go b/rent.go
@@ -10,13 +10,6 @@ type VBytes uint64
 // VByteCostFactor defines the type of the virtual byte cost factor.
 type VByteCostFactor byte
 
-const (
-	// VByteCostFactorData defines the multiplier for data fields.
-	VByteCostFactorData VByteCostFactor = 1
-	// VByteCostFactorKey defines the multiplier for fields which can act as keys for lookups.
-	VByteCostFactorKey VByteCostFactor = 10
-)
-
 var (
 	// ErrVByteDepositNotCovered gets returned when a NonEphemeralObject does not cover the minimum deposit
 	// which is calculated from its virtual byte costs.
@@ -43,8 +36,12 @@ type RentStructure struct {
 	VByteCost uint32 `serix:"0,mapKey=vByteCost"`
 	// Defines the factor to be used for data only fields.
 	VBFactorData VByteCostFactor `serix:"1,mapKey=vByteFactorData"`
-	// defines the factor to be used for key/lookup generating fields.
+	// Defines the factor to be used for key/lookup generating fields.
 	VBFactorKey VByteCostFactor `serix:"2,mapKey=vByteFactorKey"`
+	// Defines the factor to be used for block issuer feature public keys.
+	VBFactorIssuerKeys VByteCostFactor `serix:"3,mapKey=vByteFactorIssuerKeys"`
+	// Defines the factor to be used for staking feature.
+	VBFactorStakingFeature VByteCostFactor `serix:"4,mapKey=vByteFactorStakingFeature"`
 }
 
 // CoversMinDeposit tells whether given this NonEphemeralObject, the base token amount fulfills the deposit requirements

diff --git a/rent_test.go b/rent_test.go
@@ -25,11 +25,13 @@ func TestRentStructure_DeSerialize(t *testing.T) {
 
 func TestRentStructureJSONMarshalling(t *testing.T) {
 	rentStructure := &iotago.RentStructure{
-		VByteCost:    500,
-		VBFactorData: 1,
-		VBFactorKey:  10,
+		VByteCost:              500,
+		VBFactorData:           1,
+		VBFactorKey:            10,
+		VBFactorIssuerKeys:     50,
+		VBFactorStakingFeature: 100,
 	}
-	rentStructureJSON := `{"vByteCost":500,"vByteFactorData":1,"vByteFactorKey":10}`
+	rentStructureJSON := `{"vByteCost":500,"vByteFactorData":1,"vByteFactorKey":10,"vByteFactorIssuerKeys":50,"vByteFactorStakingFeature":100}`
 
 	j, err := tpkg.TestAPI.JSONEncode(rentStructure)
 	require.NoError(t, err)

diff --git a/tpkg/test_consts.go b/tpkg/test_consts.go
@@ -7,7 +7,7 @@ import (
 var TestAPI = iotago.V3API(
 	iotago.NewV3ProtocolParameters(
 		iotago.WithNetworkOptions("TestJungle", "tgl"),
-		iotago.WithSupplyOptions(TestTokenSupply, 0, 0, 0),
+		iotago.WithSupplyOptions(TestTokenSupply, 0, 0, 0, 0, 0),
 	),
 )
 

diff --git a/tpkg/util.go b/tpkg/util.go
@@ -723,6 +723,8 @@ func RandProtocolParameters() iotago.ProtocolParameters {
 			RandUint32(math.MaxUint32),
 			iotago.VByteCostFactor(RandUint8(math.MaxUint8)),
 			iotago.VByteCostFactor(RandUint8(math.MaxUint8)),
+			iotago.VByteCostFactor(RandUint8(math.MaxUint8)),
+			iotago.VByteCostFactor(RandUint8(math.MaxUint8)),
 		),
 		iotago.WithWorkScoreOptions(
 			RandWorkScore(math.MaxUint32),

diff --git a/vm/stardust/vm_stardust_test.go b/vm/stardust/vm_stardust_test.go
@@ -32,7 +32,7 @@ var (
 
 	testProtoParams = iotago.NewV3ProtocolParameters(
 		iotago.WithNetworkOptions("test", "test"),
-		iotago.WithSupplyOptions(tpkg.TestTokenSupply, 100, 1, 10),
+		iotago.WithSupplyOptions(tpkg.TestTokenSupply, 100, 1, 10, 100, 100),
 		iotago.WithWorkScoreOptions(1, 100, 500, 20, 20, 20, 20, 100, 100, 100, 200, 4),
 		iotago.WithTimeProviderOptions(100, slotDurationSeconds, slotsPerEpochExponent),
 		iotago.WithManaOptions(generationRate,