all: update state element

SiaFoundation · Oct 30, 2024 · c2ba31c · c2ba31c
1 parent b338b73
commit c2ba31c
Show file tree

Hide file tree

Showing 9 changed files with 226 additions and 124 deletions.
diff --git a/chain/chain_test.go b/chain/chain_test.go
@@ -13,7 +13,7 @@ import (
 
 type memState struct {
 	index              types.ChainIndex
-	utxos              map[types.Hash256]types.SiacoinElement
+	utxos              map[types.SiacoinOutputID]types.SiacoinElement
 	chainIndexElements []types.ChainIndexElement
 }
 
@@ -109,7 +109,7 @@ func (ms *memState) SpendableElement(t *testing.T) (se types.SiacoinElement) {
 
 func newMemState() *memState {
 	return &memState{
-		utxos: make(map[types.Hash256]types.SiacoinElement),
+		utxos: make(map[types.SiacoinOutputID]types.SiacoinElement),
 	}
 }
 

diff --git a/chain/db.go b/chain/db.go
@@ -352,13 +352,13 @@ func (db *DBStore) getElementProof(leafIndex, numLeaves uint64) (proof []types.H
 func (db *DBStore) getSiacoinElement(id types.SiacoinOutputID, numLeaves uint64) (sce types.SiacoinElement, ok bool) {
 	ok = db.bucket(bSiacoinElements).get(id[:], &sce)
 	if ok {
-		sce.MerkleProof = db.getElementProof(sce.LeafIndex, numLeaves)
+		sce.StateElement.MerkleProof = db.getElementProof(sce.StateElement.LeafIndex, numLeaves)
 	}
 	return
 }
 
 func (db *DBStore) putSiacoinElement(sce types.SiacoinElement) {
-	sce.MerkleProof = nil
+	sce.StateElement.MerkleProof = nil
 	db.bucket(bSiacoinElements).put(sce.ID[:], sce)
 }
 
@@ -369,13 +369,13 @@ func (db *DBStore) deleteSiacoinElement(id types.SiacoinOutputID) {
 func (db *DBStore) getSiafundElement(id types.SiafundOutputID, numLeaves uint64) (sfe types.SiafundElement, ok bool) {
 	ok = db.bucket(bSiafundElements).get(id[:], &sfe)
 	if ok {
-		sfe.MerkleProof = db.getElementProof(sfe.LeafIndex, numLeaves)
+		sfe.StateElement.MerkleProof = db.getElementProof(sfe.StateElement.LeafIndex, numLeaves)
 	}
 	return
 }
 
 func (db *DBStore) putSiafundElement(sfe types.SiafundElement) {
-	sfe.MerkleProof = nil
+	sfe.StateElement.MerkleProof = nil
 	db.bucket(bSiafundElements).put(sfe.ID[:], sfe)
 }
 
@@ -386,13 +386,13 @@ func (db *DBStore) deleteSiafundElement(id types.SiafundOutputID) {
 func (db *DBStore) getFileContractElement(id types.FileContractID, numLeaves uint64) (fce types.FileContractElement, ok bool) {
 	ok = db.bucket(bFileContractElements).get(id[:], &fce)
 	if ok {
-		fce.MerkleProof = db.getElementProof(fce.LeafIndex, numLeaves)
+		fce.StateElement.MerkleProof = db.getElementProof(fce.StateElement.LeafIndex, numLeaves)
 	}
 	return
 }
 
 func (db *DBStore) putFileContractElement(fce types.FileContractElement) {
-	fce.MerkleProof = nil
+	fce.StateElement.MerkleProof = nil
 	db.bucket(bFileContractElements).put(fce.ID[:], fce)
 }
 

diff --git a/chain/manager.go b/chain/manager.go
@@ -667,48 +667,48 @@ func (m *Manager) revertPoolUpdate(cru consensus.RevertUpdate, cs consensus.Stat
 	// applying a block can make ephemeral elements in the txpool non-ephemeral;
 	// here, we undo that
 	var uncreated map[types.Hash256]bool
-	replaceEphemeral := func(e *types.StateElement) {
+	replaceEphemeral := func(id types.Hash256, e *types.StateElement) {
 		if e.LeafIndex == types.UnassignedLeafIndex {
 			return
 		} else if uncreated == nil {
 			uncreated = make(map[types.Hash256]bool)
 			cru.ForEachSiacoinElement(func(sce types.SiacoinElement, created, spent bool) {
 				if created {
-					uncreated[sce.ID] = true
+					uncreated[types.Hash256(sce.ID)] = true
 				}
 			})
 			cru.ForEachSiafundElement(func(sfe types.SiafundElement, created, spent bool) {
 				if created {
-					uncreated[sfe.ID] = true
+					uncreated[types.Hash256(sfe.ID)] = true
 				}
 			})
 			cru.ForEachFileContractElement(func(fce types.FileContractElement, created bool, rev *types.FileContractElement, resolved, valid bool) {
 				if created {
-					uncreated[fce.ID] = true
+					uncreated[types.Hash256(fce.ID)] = true
 				}
 			})
 			cru.ForEachV2FileContractElement(func(fce types.V2FileContractElement, created bool, rev *types.V2FileContractElement, res types.V2FileContractResolutionType) {
 				if created {
-					uncreated[fce.ID] = true
+					uncreated[types.Hash256(fce.ID)] = true
 				}
 			})
 		}
-		if uncreated[e.ID] {
-			*e = types.StateElement{ID: e.ID, LeafIndex: types.UnassignedLeafIndex}
+		if uncreated[id] {
+			*e = types.StateElement{LeafIndex: types.UnassignedLeafIndex}
 		}
 	}
 	for _, txn := range m.txpool.v2txns {
-		for i := range txn.SiacoinInputs {
-			replaceEphemeral(&txn.SiacoinInputs[i].Parent.StateElement)
+		for i, si := range txn.SiacoinInputs {
+			replaceEphemeral(types.Hash256(si.Parent.ID), &txn.SiacoinInputs[i].Parent.StateElement)
 		}
-		for i := range txn.SiafundInputs {
-			replaceEphemeral(&txn.SiafundInputs[i].Parent.StateElement)
+		for i, si := range txn.SiafundInputs {
+			replaceEphemeral(types.Hash256(si.Parent.ID), &txn.SiafundInputs[i].Parent.StateElement)
 		}
-		for i := range txn.FileContractRevisions {
-			replaceEphemeral(&txn.FileContractRevisions[i].Parent.StateElement)
+		for i, fcr := range txn.FileContractRevisions {
+			replaceEphemeral(types.Hash256(fcr.Parent.ID), &txn.FileContractRevisions[i].Parent.StateElement)
 		}
-		for i := range txn.FileContractResolutions {
-			replaceEphemeral(&txn.FileContractResolutions[i].Parent.StateElement)
+		for i, fcr := range txn.FileContractResolutions {
+			replaceEphemeral(types.Hash256(fcr.Parent.ID), &txn.FileContractResolutions[i].Parent.StateElement)
 		}
 	}
 
@@ -724,48 +724,48 @@ func (m *Manager) revertPoolUpdate(cru consensus.RevertUpdate, cs consensus.Stat
 func (m *Manager) applyPoolUpdate(cau consensus.ApplyUpdate, cs consensus.State) {
 	// applying a block can make ephemeral elements in the txpool non-ephemeral
 	var newElements map[types.Hash256]types.StateElement
-	replaceEphemeral := func(e *types.StateElement) {
+	replaceEphemeral := func(id types.Hash256, e *types.StateElement) {
 		if e.LeafIndex != types.UnassignedLeafIndex {
 			return
 		} else if newElements == nil {
 			newElements = make(map[types.Hash256]types.StateElement)
 			cau.ForEachSiacoinElement(func(sce types.SiacoinElement, created, spent bool) {
 				if created {
-					newElements[sce.ID] = sce.StateElement
+					newElements[types.Hash256(sce.ID)] = sce.StateElement
 				}
 			})
 			cau.ForEachSiafundElement(func(sfe types.SiafundElement, created, spent bool) {
 				if created {
-					newElements[sfe.ID] = sfe.StateElement
+					newElements[types.Hash256(sfe.ID)] = sfe.StateElement
 				}
 			})
 			cau.ForEachFileContractElement(func(fce types.FileContractElement, created bool, rev *types.FileContractElement, resolved, valid bool) {
 				if created {
-					newElements[fce.ID] = fce.StateElement
+					newElements[types.Hash256(fce.ID)] = fce.StateElement
 				}
 			})
 			cau.ForEachV2FileContractElement(func(fce types.V2FileContractElement, created bool, rev *types.V2FileContractElement, res types.V2FileContractResolutionType) {
 				if created {
-					newElements[fce.ID] = fce.StateElement
+					newElements[types.Hash256(fce.ID)] = fce.StateElement
 				}
 			})
 		}
-		if se, ok := newElements[e.ID]; ok {
+		if se, ok := newElements[id]; ok {
 			*e = se
 		}
 	}
 	for _, txn := range m.txpool.v2txns {
-		for i := range txn.SiacoinInputs {
-			replaceEphemeral(&txn.SiacoinInputs[i].Parent.StateElement)
+		for i, si := range txn.SiacoinInputs {
+			replaceEphemeral(types.Hash256(si.Parent.ID), &txn.SiacoinInputs[i].Parent.StateElement)
 		}
-		for i := range txn.SiafundInputs {
-			replaceEphemeral(&txn.SiafundInputs[i].Parent.StateElement)
+		for i, si := range txn.SiafundInputs {
+			replaceEphemeral(types.Hash256(si.Parent.ID), &txn.SiafundInputs[i].Parent.StateElement)
 		}
-		for i := range txn.FileContractRevisions {
-			replaceEphemeral(&txn.FileContractRevisions[i].Parent.StateElement)
+		for i, fcr := range txn.FileContractRevisions {
+			replaceEphemeral(types.Hash256(fcr.Parent.ID), &txn.FileContractRevisions[i].Parent.StateElement)
 		}
-		for i := range txn.FileContractResolutions {
-			replaceEphemeral(&txn.FileContractResolutions[i].Parent.StateElement)
+		for i, fcr := range txn.FileContractResolutions {
+			replaceEphemeral(types.Hash256(fcr.Parent.ID), &txn.FileContractResolutions[i].Parent.StateElement)
 		}
 	}
 
@@ -1082,12 +1082,12 @@ func (m *Manager) updateV2TransactionProofs(txns []types.V2Transaction, from, to
 		confirmedStateElements := make(map[types.Hash256]types.StateElement)
 		cau.ForEachSiacoinElement(func(sce types.SiacoinElement, created, spent bool) {
 			if created {
-				confirmedStateElements[sce.ID] = sce.StateElement
+				confirmedStateElements[types.Hash256(sce.ID)] = sce.StateElement
 			}
 		})
 		cau.ForEachSiafundElement(func(sfe types.SiafundElement, created, spent bool) {
 			if created {
-				confirmedStateElements[sfe.ID] = sfe.StateElement
+				confirmedStateElements[types.Hash256(sfe.ID)] = sfe.StateElement
 			}
 		})
 
@@ -1100,7 +1100,7 @@ func (m *Manager) updateV2TransactionProofs(txns []types.V2Transaction, from, to
 
 			// update the state elements for any confirmed ephemeral elements
 			for j := range txns[i].SiacoinInputs {
-				if txns[i].SiacoinInputs[j].Parent.LeafIndex != types.UnassignedLeafIndex {
+				if txns[i].SiacoinInputs[j].Parent.StateElement.LeafIndex != types.UnassignedLeafIndex {
 					continue
 				}
 				se, ok := confirmedStateElements[types.Hash256(txns[i].SiacoinInputs[j].Parent.ID)]
@@ -1112,7 +1112,7 @@ func (m *Manager) updateV2TransactionProofs(txns []types.V2Transaction, from, to
 
 			// update the state elements for any confirmed ephemeral elements
 			for j := range txns[i].SiafundInputs {
-				if txns[i].SiafundInputs[j].Parent.LeafIndex != types.UnassignedLeafIndex {
+				if txns[i].SiafundInputs[j].Parent.StateElement.LeafIndex != types.UnassignedLeafIndex {
 					continue
 				}
 				se, ok := confirmedStateElements[types.Hash256(txns[i].SiafundInputs[j].Parent.ID)]

diff --git a/miner_test.go b/miner_test.go
@@ -105,7 +105,7 @@ func TestV2MineBlocks(t *testing.T) {
 	// mine until just before the allow height
 	mineBlocks(t, 4)
 
-	elements := make(map[types.Hash256]types.SiacoinElement)
+	elements := make(map[types.SiacoinOutputID]types.SiacoinElement)
 	_, applied, err := cm.UpdatesSince(types.ChainIndex{}, 500)
 	if err != nil {
 		t.Fatal(err)

diff --git a/rhp/v4/rpc.go b/rhp/v4/rpc.go
@@ -659,12 +659,9 @@ func RPCRenewContract(ctx context.Context, t TransportClient, tp TxPool, signer
 		FileContractResolutions: []types.V2FileContractResolution{
 			{
 				Parent: types.V2FileContractElement{
-					StateElement: types.StateElement{
-						// the other parts of the state element are not required
-						// for signing the transaction. Let the host fill them
-						// in.
-						ID: types.Hash256(params.ContractID),
-					},
+					ID: params.ContractID,
+					// the state element field is not required for signing the
+					// transaction. The host will fill it in.
 				},
 				Resolution: &renewal,
 			},
@@ -787,12 +784,9 @@ func RPCRefreshContract(ctx context.Context, t TransportClient, tp TxPool, signe
 		FileContractResolutions: []types.V2FileContractResolution{
 			{
 				Parent: types.V2FileContractElement{
-					StateElement: types.StateElement{
-						// the other parts of the state element are not required
-						// for signing the transaction. Let the host fill them
-						// in.
-						ID: types.Hash256(params.ContractID),
-					},
+					ID: params.ContractID,
+					// the state element field is not required for signing the
+					// transaction. The host will fill it in.
 				},
 				Resolution: &renewal,
 			},

diff --git a/testutil/wallet.go b/testutil/wallet.go
@@ -33,14 +33,13 @@ func (et *ephemeralWalletUpdateTxn) WalletStateElements() (elements []types.Stat
 	return
 }
 
-func (et *ephemeralWalletUpdateTxn) UpdateWalletStateElements(elements []types.StateElement) error {
-	for _, se := range elements {
-		utxo, ok := et.store.utxos[types.SiacoinOutputID(se.ID)]
-		if !ok {
-			panic(fmt.Sprintf("siacoin element %q does not exist", se.ID))
-		}
-		utxo.StateElement = se
-		et.store.utxos[types.SiacoinOutputID(se.ID)] = utxo
+// UpdateWalletSiacoinElementProofs updates the proofs of all state elements
+// affected by the update. ProofUpdater.UpdateElementProof must be called
+// for each state element in the database.
+func (et *ephemeralWalletUpdateTxn) UpdateWalletSiacoinElementProofs(pu wallet.ProofUpdater) error {
+	for _, se := range et.store.utxos {
+		pu.UpdateElementProof(&se.StateElement)
+		et.store.utxos[se.ID] = se
 	}
 	return nil
 }
@@ -131,7 +130,7 @@ func (es *EphemeralWalletStore) UnspentSiacoinElements() (utxos []types.SiacoinE
 	defer es.mu.Unlock()
 
 	for _, se := range es.utxos {
-		se.MerkleProof = append([]types.Hash256(nil), se.MerkleProof...)
+		se.StateElement.MerkleProof = append([]types.Hash256(nil), se.StateElement.MerkleProof...)
 		utxos = append(utxos, se)
 	}
 	return utxos, nil