feat(ledger): implement Shelley stake pool validation rules

ledger/allegra/pparams_test.go

@@ -90,6 +90,7 @@ func TestAllegraUtxorpc(t *testing.T) {
 		ProtocolMajor:      8,
 		ProtocolMinor:      0,
 		MinUtxoValue:       1000000,
+		MinPoolCost:        340000000,
 	}
 
 	expectedUtxorpc := &utxorpc.PParams{
@@ -118,6 +119,7 @@ func TestAllegraUtxorpc(t *testing.T) {
 			Major: 8,
 			Minor: 0,
 		},
+		MinPoolCost: common.ToUtxorpcBigInt(340000000),
 	}
 
 	result, err := inputParams.Utxorpc()

ledger/allegra/rules.go

@@ -91,6 +91,10 @@ var utxoValidationRuleDescriptors = []common.UtxoValidationRuleDescriptor{
 		Id:        common.UtxoValidationRuleWithdrawals,
 		Validator: UtxoValidateWithdrawals,
 	},
+	{
+		Id:        common.UtxoValidationRulePoolCertificates,
+		Validator: UtxoValidatePoolCertificates,
+	},
 }
 
 // UtxoValidationRuleDescriptors returns the authoritative ordered rule
@@ -341,6 +345,21 @@ func UtxoValidateWithdrawals(
 	return shelley.UtxoValidateWithdrawals(tx, slot, ls, pp)
 }
 
+// UtxoValidatePoolCertificates applies the Shelley POOL rule, which this era
+// inherits unchanged.
+//
+// Reference: eras/allegra/impl/src/Cardano/Ledger/Allegra/Rules/Pool.hs
+// declares only the EraRuleFailure and EraRuleEvent instances and reuses
+// Shelley.poolTransition.
+func UtxoValidatePoolCertificates(
+	tx common.Transaction,
+	slot uint64,
+	ls common.LedgerState,
+	pp common.ProtocolParameters,
+) error {
+	return shelley.UtxoValidatePoolCertificates(tx, slot, ls, pp)
+}
+
 // UtxoValidateMIRGenesisQuorum ensures a move instantaneous rewards
 // certificate is authorized by a quorum of the current genesis delegates
 func UtxoValidateMIRGenesisQuorum(

ledger/alonzo/pparams.go

@@ -410,3 +410,18 @@ func UpgradePParams(
 		MinPoolCost:        prevPParams.MinPoolCost,
 	}
 }
+
+// ProtocolMajorVersion returns the active major protocol version.
+func (p *AlonzoProtocolParameters) ProtocolMajorVersion() uint {
+	return p.ProtocolMajor
+}
+
+// MinPoolCostValue returns the minPoolCost protocol parameter.
+func (p *AlonzoProtocolParameters) MinPoolCostValue() uint64 {
+	return p.MinPoolCost
+}
+
+// PoolRetirementMaxEpoch returns the eMax protocol parameter.
+func (p *AlonzoProtocolParameters) PoolRetirementMaxEpoch() uint64 {
+	return uint64(p.MaxEpoch)
+}

ledger/alonzo/rules.go

@@ -144,6 +144,10 @@ var utxoValidationRuleDescriptors = []common.UtxoValidationRuleDescriptor{
 		Id:        common.UtxoValidationRuleWithdrawals,
 		Validator: UtxoValidateWithdrawals,
 	},
+	{
+		Id:        common.UtxoValidationRulePoolCertificates,
+		Validator: UtxoValidatePoolCertificates,
+	},
 }
 
 // UtxoValidationRuleDescriptors returns the authoritative ordered rule
@@ -175,7 +179,9 @@ var UtxoValidationRules = common.ComposeUtxoValidationRules(
 		UtxoValidateExUnitsTooBigUtxo, UtxoValidateNativeScripts,
 		UtxoValidateExtraneousRedeemers, UtxoValidatePlutusScripts,
 	),
-	common.Phase2ValidUtxoValidationRules(UtxoValidateDelegation, UtxoValidateWithdrawals),
+	common.Phase2ValidUtxoValidationRules(
+		UtxoValidateDelegation, UtxoValidateWithdrawals, UtxoValidatePoolCertificates,
+	),
 )
 
 // UtxoValidateOutputTooBigUtxo ensures that transaction output values are not too large
@@ -1063,6 +1069,21 @@ func UtxoValidateScriptDataHash(
 	return nil
 }
 
+// UtxoValidatePoolCertificates applies the Shelley POOL rule, which this era
+// inherits unchanged.
+//
+// Reference: eras/alonzo/impl/src/Cardano/Ledger/Alonzo/Rules/Pool.hs declares
+// only the EraRuleFailure and EraRuleEvent instances and reuses
+// Shelley.poolTransition.
+func UtxoValidatePoolCertificates(
+	tx common.Transaction,
+	slot uint64,
+	ls common.LedgerState,
+	pp common.ProtocolParameters,
+) error {
+	return shelley.UtxoValidatePoolCertificates(tx, slot, ls, pp)
+}
+
 // UtxoValidateMIRGenesisQuorum ensures a move instantaneous rewards
 // certificate is authorized by a quorum of the current genesis delegates
 func UtxoValidateMIRGenesisQuorum(

ledger/babbage/pparams.go

@@ -315,3 +315,18 @@ func UpgradePParams(
 	}
 	return ret
 }
+
+// ProtocolMajorVersion returns the active major protocol version.
+func (p *BabbageProtocolParameters) ProtocolMajorVersion() uint {
+	return p.ProtocolMajor
+}
+
+// MinPoolCostValue returns the minPoolCost protocol parameter.
+func (p *BabbageProtocolParameters) MinPoolCostValue() uint64 {
+	return p.MinPoolCost
+}
+
+// PoolRetirementMaxEpoch returns the eMax protocol parameter.
+func (p *BabbageProtocolParameters) PoolRetirementMaxEpoch() uint64 {
+	return uint64(p.MaxEpoch)
+}

ledger/babbage/rules.go

@@ -169,6 +169,10 @@ var utxoValidationRuleDescriptors = []common.UtxoValidationRuleDescriptor{
 		Id:        common.UtxoValidationRuleWithdrawals,
 		Validator: UtxoValidateWithdrawals,
 	},
+	{
+		Id:        common.UtxoValidationRulePoolCertificates,
+		Validator: UtxoValidatePoolCertificates,
+	},
 }
 
 // UtxoValidationRuleDescriptors returns the authoritative ordered rule
@@ -204,7 +208,9 @@ var UtxoValidationRules = common.ComposeUtxoValidationRules(
 		UtxoValidateExtraneousRedeemers, UtxoValidateMalformedReferenceScripts,
 		UtxoValidatePlutusScripts,
 	),
-	common.Phase2ValidUtxoValidationRules(UtxoValidateDelegation, UtxoValidateWithdrawals),
+	common.Phase2ValidUtxoValidationRules(
+		UtxoValidateDelegation, UtxoValidateWithdrawals, UtxoValidatePoolCertificates,
+	),
 )
 
 func UtxoValidateOutsideValidityIntervalUtxo(
@@ -1435,6 +1441,21 @@ func UtxoValidateMalformedReferenceScripts(
 	return common.ValidatePlutusScriptsWellFormed(tx, params.ProtocolMajor)
 }
 
+// UtxoValidatePoolCertificates applies the Shelley POOL rule, which this era
+// inherits unchanged.
+//
+// Reference: eras/babbage/impl/src/Cardano/Ledger/Babbage/Rules/Pool.hs
+// declares only the EraRuleFailure and EraRuleEvent instances and reuses
+// Shelley.poolTransition.
+func UtxoValidatePoolCertificates(
+	tx common.Transaction,
+	slot uint64,
+	ls common.LedgerState,
+	pp common.ProtocolParameters,
+) error {
+	return shelley.UtxoValidatePoolCertificates(tx, slot, ls, pp)
+}
+
 // UtxoValidateMIRGenesisQuorum ensures a move instantaneous rewards
 // certificate is authorized by a quorum of the current genesis delegates
 func UtxoValidateMIRGenesisQuorum(

ledger/common/certs.go

@@ -670,6 +670,35 @@ type PoolRegistrationCertificate struct {
 	PoolOwners           []AddrKeyHash `json:"poolOwners"`
 	Relays               []PoolRelay   `json:"relays"`
 	PoolMetadata         *PoolMetadata `json:"poolMetadata,omitempty"`
+
+	// rewardAccountNetworkId holds the network id from the address header
+	// byte of the wire reward_account, which RewardAccount itself does not
+	// retain. rewardAccountNetworkIdKnown is false when the certificate was
+	// not decoded from a CBOR reward account carrying a header byte (a
+	// programmatically constructed certificate, one built from JSON, or the
+	// legacy 28-byte encoding).
+	rewardAccountNetworkId      uint
+	rewardAccountNetworkIdKnown bool
+}
+
+// RewardAccountNetworkId returns the network id encoded in the header byte of
+// the certificate's reward account. The second return value is false when the
+// certificate did not come from a wire reward_account carrying that header, in
+// which case no network id is recoverable and callers must not treat the zero
+// value as testnet.
+func (c *PoolRegistrationCertificate) RewardAccountNetworkId() (uint, bool) {
+	return c.rewardAccountNetworkId, c.rewardAccountNetworkIdKnown
+}
+
+// SetCbor invalidates the decoded reward-account network only when replacing
+// the cached bytes. Clearing the cache before mutating fields must preserve
+// that consensus-relevant metadata.
+func (c *PoolRegistrationCertificate) SetCbor(cborData []byte) {
+	c.DecodeStoreCbor.SetCbor(cborData)
+	if cborData != nil {
+		c.rewardAccountNetworkId = 0
+		c.rewardAccountNetworkIdKnown = false
+	}
 }
 
 // ErrPoolMarginOutsideUnitInterval identifies a stake-pool margin outside the
@@ -1076,6 +1105,8 @@ func (c *PoolRegistrationCertificate) UnmarshalCBOR(cborData []byte) error {
 		c.Cost = tmp.Cost
 		c.Margin = tmp.Margin
 		c.RewardAccount = tmp.RewardAccount.credential
+		c.rewardAccountNetworkId = tmp.RewardAccount.networkId
+		c.rewardAccountNetworkIdKnown = tmp.RewardAccount.networkIdKnown
 		c.PoolOwners = tmp.PoolOwners
 		c.Relays = tmp.Relays
 		c.PoolMetadata = tmp.PoolMetadata
@@ -1097,6 +1128,8 @@ func (c *PoolRegistrationCertificate) UnmarshalCBOR(cborData []byte) error {
 		c.Cost = tmp.Cost
 		c.Margin = tmp.Margin
 		c.RewardAccount = tmp.RewardAccount.credential
+		c.rewardAccountNetworkId = tmp.RewardAccount.networkId
+		c.rewardAccountNetworkIdKnown = tmp.RewardAccount.networkIdKnown
 		c.PoolOwners = tmp.PoolOwners
 		c.Relays = tmp.Relays
 		c.PoolMetadata = tmp.PoolMetadata
@@ -1106,7 +1139,9 @@ func (c *PoolRegistrationCertificate) UnmarshalCBOR(cborData []byte) error {
 			len(fields),
 		)
 	}
-	c.SetCbor(cborData)
+	// Preserve the header metadata decoded above; the public SetCbor method
+	// intentionally clears that metadata when callers replace the cache.
+	c.DecodeStoreCbor.SetCbor(cborData)
 	return nil
 }
 

ledger/common/certs_test.go

@@ -346,6 +346,52 @@ func TestPoolRegistrationCertificateRewardAccountDecode(t *testing.T) {
 				credential...,
 			),
 		},
+		{
+			name: "non-reward address",
+			rewardAccount: append(
+				[]byte{0x01},
+				credential...,
+			),
+			wantErr: "invalid reward account address header",
+		},
+		{
+			// 0xf1 is the script-credential reward-address header on
+			// mainnet, the last of the four headers
+			// headerIsAccountAddress admits.
+			name: "script reward address",
+			rewardAccount: append(
+				[]byte{0xf1},
+				credential...,
+			),
+		},
+		// headerIsAccountAddress in Cardano.Ledger.Address requires
+		// header .&. 0b11101110 == 0b11100000, so bits 3-1 must be clear
+		// and only 0xe0, 0xe1, 0xf0 and 0xf1 are valid. Each header below
+		// has the reward-address high nibble but a reserved bit set.
+		{
+			name: "reserved bit 1 set",
+			rewardAccount: append(
+				[]byte{0xe2},
+				credential...,
+			),
+			wantErr: "invalid reward account address header",
+		},
+		{
+			name: "reserved bit 2 set",
+			rewardAccount: append(
+				[]byte{0xe5},
+				credential...,
+			),
+			wantErr: "invalid reward account address header",
+		},
+		{
+			name: "reserved bit 3 set",
+			rewardAccount: append(
+				[]byte{0xe8},
+				credential...,
+			),
+			wantErr: "invalid reward account address header",
+		},
 		{
 			name:          "long",
 			rewardAccount: bytes.Repeat([]byte{0x03}, Blake2b224Size+2),