Merge pull request #447 from lightninglabs/rename-uni-forest

Rename universe forest instances to multiverse

config.go

@@ -65,7 +65,7 @@ type DatabaseConfig struct {
 
 	TapAddrBook *tapdb.TapAddressBook
 
-	UniverseForest *tapdb.BaseUniverseForest
+	Multiverse *tapdb.BaseMultiverse
 
 	FederationDB *tapdb.UniverseFederationDB
 }

tapcfg/server.go

@@ -107,12 +107,12 @@ func genServerConfig(cfg *Config, cfgLogger btclog.Logger,
 			return db.WithTx(tx)
 		},
 	)
-	uniForestDB := tapdb.NewTransactionExecutor(
-		db, func(tx *sql.Tx) tapdb.BaseUniverseForestStore {
+	multiverseDB := tapdb.NewTransactionExecutor(
+		db, func(tx *sql.Tx) tapdb.BaseMultiverseStore {
 			return db.WithTx(tx)
 		},
 	)
-	uniForest := tapdb.NewBaseUniverseForest(uniForestDB)
+	multiverse := tapdb.NewBaseMultiverse(multiverseDB)
 
 	uniStatsDB := tapdb.NewTransactionExecutor(
 		db, func(tx *sql.Tx) tapdb.UniverseStatsStore {
@@ -133,7 +133,7 @@ func genServerConfig(cfg *Config, cfgLogger btclog.Logger,
 			)
 		},
 		HeaderVerifier: headerVerifier,
-		UniverseForest: uniForest,
+		Multiverse:     multiverse,
 		UniverseStats:  universeStats,
 	}
 
@@ -282,12 +282,12 @@ func genServerConfig(cfg *Config, cfgLogger btclog.Logger,
 		UniverseStats:      universeStats,
 		LogWriter:          cfg.LogWriter,
 		DatabaseConfig: &tap.DatabaseConfig{
-			RootKeyStore:   tapdb.NewRootKeyStore(rksDB),
-			MintingStore:   assetMintingStore,
-			AssetStore:     assetStore,
-			TapAddrBook:    tapdbAddrBook,
-			UniverseForest: uniForest,
-			FederationDB:   federationDB,
+			RootKeyStore: tapdb.NewRootKeyStore(rksDB),
+			MintingStore: assetMintingStore,
+			AssetStore:   assetStore,
+			TapAddrBook:  tapdbAddrBook,
+			Multiverse:   multiverse,
+			FederationDB: federationDB,
 		},
 	}, nil
 }

tapdb/universe_forest.go → tapdb/multiverse.go

@@ -18,70 +18,70 @@ type (
 	BaseUniverseRoot = sqlc.UniverseRootsRow
 )
 
-// BaseUniverseForestStore is used to interact with a set of base universe
-// roots, also known as a universe forest.
-type BaseUniverseForestStore interface {
+// BaseMultiverseStore is used to interact with a set of base universe
+// roots, also known as a multiverse.
+type BaseMultiverseStore interface {
 	BaseUniverseStore
 
 	UniverseRoots(ctx context.Context) ([]BaseUniverseRoot, error)
 }
 
-// BaseUniverseForestOptions is the set of options for universe grove queries.
-type BaseUniverseForestOptions struct {
+// BaseMultiverseOptions is the set of options for multiverse queries.
+type BaseMultiverseOptions struct {
 	readOnly bool
 }
 
 // ReadOnly returns true if the transaction is read-only.
-func (b *BaseUniverseForestOptions) ReadOnly() bool {
+func (b *BaseMultiverseOptions) ReadOnly() bool {
 	return b.readOnly
 }
 
-// NewBaseUniverseForestReadTx creates a new read-only transaction for the
-// universe forest.
-func NewBaseUniverseForestReadTx() BaseUniverseForestOptions {
-	return BaseUniverseForestOptions{
+// NewBaseMultiverseReadTx creates a new read-only transaction for the
+// multiverse.
+func NewBaseMultiverseReadTx() BaseMultiverseOptions {
+	return BaseMultiverseOptions{
 		readOnly: true,
 	}
 }
 
-// BatchedUniverseForest is a wrapper around the base universe forest that
-// allows us to perform batch transactional database queries with all the
-// relevant query interfaces.
-type BatchedUniverseForest interface {
-	BaseUniverseForestStore
+// BatchedMultiverse is a wrapper around the base multiverse that allows us to
+// perform batch transactional database queries with all the relevant query
+// interfaces.
+type BatchedMultiverse interface {
+	BaseMultiverseStore
 
-	BatchedTx[BaseUniverseForestStore]
+	BatchedTx[BaseMultiverseStore]
 }
 
-// BaseUniverseForest implements the persistent storage for a universe forest.
+// BaseMultiverse implements the persistent storage for a multiverse.
 //
 // NOTE: This implements the universe.BaseMultiverse interface.
-type BaseUniverseForest struct {
-	db BatchedUniverseForest
+type BaseMultiverse struct {
+	db BatchedMultiverse
 
 	// TODO(roasbeef): actually the start of multiverse?
 	// * mapping: assetID -> baseUniverseRoot => outpoint || scriptKey => transfer
 	// * drop base in front?
 }
 
-// NewBaseUniverseForest creates a new base universe forest.
-func NewBaseUniverseForest(db BatchedUniverseForest) *BaseUniverseForest {
-	return &BaseUniverseForest{
+// NewBaseMultiverse creates a new base multiverse.
+func NewBaseMultiverse(db BatchedMultiverse) *BaseMultiverse {
+	return &BaseMultiverse{
 		db: db,
 	}
 }
 
 // RootNodes returns the complete set of known base universe root nodes for the
-// set of base universes tracked in the universe forest.
-func (b *BaseUniverseForest) RootNodes(
+// set of base universes tracked in the multiverse.
+func (b *BaseMultiverse) RootNodes(
 	ctx context.Context) ([]universe.BaseRoot, error) {
 
 	var (
 		uniRoots []universe.BaseRoot
-		readTx   = NewBaseUniverseForestReadTx()
+		readTx   = NewBaseMultiverseReadTx()
 	)
 
-	dbErr := b.db.ExecTx(ctx, &readTx, func(db BaseUniverseForestStore) error {
+	dbErr := b.db.ExecTx(ctx, &readTx, func(db BaseMultiverseStore) error {
 		dbRoots, err := db.UniverseRoots(ctx)
 		if err != nil {
 			return err
@@ -135,7 +135,7 @@ func (b *BaseUniverseForest) RootNodes(
 // doesn't have a script key specified, then all the proofs for the minting
 // outpoint will be returned. If neither are specified, then proofs for all the
 // inserted leaves will be returned.
-func (b *BaseUniverseForest) FetchIssuanceProof(ctx context.Context,
+func (b *BaseMultiverse) FetchIssuanceProof(ctx context.Context,
 	id universe.Identifier,
 	universeKey universe.BaseKey) ([]*universe.IssuanceProof, error) {
 
@@ -144,7 +144,7 @@ func (b *BaseUniverseForest) FetchIssuanceProof(ctx context.Context,
 		proofs []*universe.IssuanceProof
 	)
 
-	dbErr := b.db.ExecTx(ctx, &readTx, func(dbTx BaseUniverseForestStore) error {
+	dbErr := b.db.ExecTx(ctx, &readTx, func(dbTx BaseMultiverseStore) error {
 		var err error
 		proofs, err = universeFetchIssuanceProof(
 			ctx, id, universeKey, dbTx,
@@ -194,17 +194,17 @@ func (b *BaseUniverseForest) FetchIssuanceProof(ctx context.Context,
 
 // RegisterIssuance inserts a new minting leaf within the multiverse tree and
 // the universe tree that corresponds to the given base key.
-func (b *BaseUniverseForest) RegisterIssuance(ctx context.Context,
+func (b *BaseMultiverse) RegisterIssuance(ctx context.Context,
 	id universe.Identifier, key universe.BaseKey,
 	leaf *universe.MintingLeaf,
 	metaReveal *proof.MetaReveal) (*universe.IssuanceProof, error) {
 
 	var (
-		writeTx       BaseUniverseForestOptions
+		writeTx       BaseMultiverseOptions
 		issuanceProof *universe.IssuanceProof
 	)
 
-	execTxFunc := func(dbTx BaseUniverseForestStore) error {
+	execTxFunc := func(dbTx BaseMultiverseStore) error {
 		// Register issuance in the asset (group) specific universe
 		// tree.
 		var (

tapdb/universe_test.go

@@ -366,16 +366,16 @@ func TestUniverseTreeIsolation(t *testing.T) {
 	require.Equal(t, groupLeaf.Leaf.Amt, groupRoot.NodeSum())
 	require.Equal(t, normalLeaf.Leaf.Amt, normalRoot.NodeSum())
 
-	// If we make a new Universe forest, then we should be able to fetch
-	// both the roots above.
-	forestDB := NewTransactionExecutor(db,
-		func(tx *sql.Tx) BaseUniverseForestStore {
+	// If we make a new multiverse, then we should be able to fetch both the
+	// roots above.
+	multiverseDB := NewTransactionExecutor(db,
+		func(tx *sql.Tx) BaseMultiverseStore {
 			return db.WithTx(tx)
 		},
 	)
-	universeForest := NewBaseUniverseForest(forestDB)
+	multiverse := NewBaseMultiverse(multiverseDB)
 
-	rootNodes, err := universeForest.RootNodes(ctx)
+	rootNodes, err := multiverse.RootNodes(ctx)
 	require.NoError(t, err)
 
 	// We should be able to find both of the roots we've inserted above.
@@ -401,8 +401,8 @@ func TestUniverseTreeIsolation(t *testing.T) {
 	require.Nil(t, normalRoot)
 	require.ErrorIs(t, err, universe.ErrNoUniverseRoot)
 
-	// The deleted universe should not be present in the universe forest.
-	rootNodes, err = universeForest.RootNodes(ctx)
+	// The deleted universe should not be present in the multiverse.
+	rootNodes, err = multiverse.RootNodes(ctx)
 	require.NoError(t, err)
 	require.Len(t, rootNodes, 1)
 	require.True(t, mssmt.IsEqualNode(rootNodes[0].Node, groupRoot))

universe/base.go

@@ -26,9 +26,9 @@ type MintingArchiveConfig struct {
 	// genesis proof.
 	HeaderVerifier proof.HeaderVerifier
 
-	// UniverseForest is used to interact with the set of known base
+	// Multiverse is used to interact with the set of known base
 	// universe trees, and also obtain associated metadata and statistics.
-	UniverseForest BaseMultiverse
+	Multiverse BaseMultiverse
 
 	// UniverseStats is used to export statistics related to the set of
 	// external/internal queries to the base universe instance.
@@ -126,7 +126,7 @@ func (a *MintingArchive) RootNode(ctx context.Context,
 func (a *MintingArchive) RootNodes(ctx context.Context) ([]BaseRoot, error) {
 	log.Debugf("Fetching all known Universe roots")
 
-	return a.cfg.UniverseForest.RootNodes(ctx)
+	return a.cfg.Multiverse.RootNodes(ctx)
 }
 
 // RegisterIssuance attempts to register a new issuance proof for a new minting
@@ -140,9 +140,8 @@ func (a *MintingArchive) RegisterIssuance(ctx context.Context, id Identifier,
 		id.StringForLog(), spew.Sdump(key))
 
 	// We'll first check to see if we already know of this leaf within the
-	// universe forest. If so, then we'll return the existing issuance
-	// proof.
-	issuanceProofs, err := a.cfg.UniverseForest.FetchIssuanceProof(
+	// multiverse. If so, then we'll return the existing issuance proof.
+	issuanceProofs, err := a.cfg.Multiverse.FetchIssuanceProof(
 		ctx, id, key,
 	)
 	switch {
@@ -213,7 +212,7 @@ func (a *MintingArchive) RegisterIssuance(ctx context.Context, id Identifier,
 
 	// Now that we know the proof is valid, we'll insert it into the base
 	// multiverse backend, and return the new issuance proof.
-	issuanceProof, err := a.cfg.UniverseForest.RegisterIssuance(
+	issuanceProof, err := a.cfg.Multiverse.RegisterIssuance(
 		ctx, id, key, leaf, assetSnapshot.MetaReveal,
 	)
 	if err != nil {
@@ -259,7 +258,7 @@ func (a *MintingArchive) FetchIssuanceProof(ctx context.Context, id Identifier,
 		}()
 	}()
 
-	return a.cfg.UniverseForest.FetchIssuanceProof(ctx, id, key)
+	return a.cfg.Multiverse.FetchIssuanceProof(ctx, id, key)
 }
 
 // MintingKeys returns the set of minting keys known for the specified base