add RegistryFactory and deprecate global action, auth and output registries in VMs

README.md

@@ -51,13 +51,16 @@ Services are created by adding an [Option](./vm/option.go) to the VM. They can b
 ```golang
 // NewWithOptions returns a VM with the specified options
 func New(options ...vm.Option) (*vm.VM, error) {
-	options = append(options, With(), indexer.With()) // Add MorpheusVM API and Indexer
-	return vm.New(
+	options = append(options, With()) // Add MorpheusVM API
+	registry, err := newRegistry()
+	if err != nil {
+		return nil, err
+	}
+	return defaultvm.New(
 		consts.Version,
 		genesis.DefaultGenesisFactory{},
 		&storage.StateManager{},
-		ActionParser,
-		AuthParser,
+		registry,
 		auth.Engines(),
 		options...,
 	)

chain/dependencies.go

@@ -287,3 +287,9 @@ type AuthFactory interface {
 	MaxUnits() (bandwidth uint64, compute uint64)
 	Address() codec.Address
 }
+
+type Registry interface {
+	ActionRegistry() ActionRegistry
+	AuthRegistry() AuthRegistry
+	OutputRegistry() OutputRegistry
+}

docs/tutorials/morpheusvm/morpheusvm.md

@@ -768,39 +768,40 @@ import (
 	"github.com/ava-labs/hypersdk/auth"
 	"github.com/ava-labs/hypersdk/chain"
 	"github.com/ava-labs/hypersdk/codec"
-	"github.com/ava-labs/hypersdk/examples/tutorial/actions"
+	"github.com/ava-labs/hypersdk/examples/morpheusvm/actions"
+	"github.com/ava-labs/hypersdk/examples/morpheusvm/consts"
+	"github.com/ava-labs/hypersdk/examples/morpheusvm/storage"
+	"github.com/ava-labs/hypersdk/genesis"
+	"github.com/ava-labs/hypersdk/vm"
+	"github.com/ava-labs/hypersdk/vm/defaultvm"
 )
 
-var (
-	ActionParser *codec.TypeParser[chain.Action]
-	AuthParser   *codec.TypeParser[chain.Auth]
-	OutputParser *codec.TypeParser[codec.Typed]
-)
-
-// Setup types
-func init() {
-	ActionParser = codec.NewTypeParser[chain.Action]()
-	AuthParser = codec.NewTypeParser[chain.Auth]()
-	OutputParser = codec.NewTypeParser[codec.Typed]()
+func newRegistry() (chain.Registry, error) {
+	actionParser := codec.NewTypeParser[chain.Action]()
+	authParser := codec.NewTypeParser[chain.Auth]()
+	outputParser := codec.NewTypeParser[codec.Typed]()
 
 	errs := &wrappers.Errs{}
 	errs.Add(
-		ActionParser.Register(&actions.Transfer{}, actions.UnmarshalTransfer),
+		// When registering new actions, ALWAYS make sure to append at the end.
+		// Pass nil as second argument if manual marshalling isn't needed (if in doubt, you probably don't)
+		actionParser.Register(&actions.Transfer{}, actions.UnmarshalTransfer),
 
-		AuthParser.Register(&auth.ED25519{}, auth.UnmarshalED25519),
-		AuthParser.Register(&auth.SECP256R1{}, auth.UnmarshalSECP256R1),
-		AuthParser.Register(&auth.BLS{}, auth.UnmarshalBLS),
+		// When registering new auth, ALWAYS make sure to append at the end.
+		authParser.Register(&auth.ED25519{}, auth.UnmarshalED25519),
+		authParser.Register(&auth.SECP256R1{}, auth.UnmarshalSECP256R1),
+		authParser.Register(&auth.BLS{}, auth.UnmarshalBLS),
 
-		OutputParser.Register(&actions.TransferResult{}, nil),
+		outputParser.Register(&actions.TransferResult{}, nil),
 	)
 	if errs.Errored() {
-		panic(errs.Err)
+		return nil, errs.Err
 	}
+	return vm.NewRegistry(actionParser, authParser, outputParser), nil
 }
-
 ```
 
-By “registry”, we mean the `ActionParser` and `AuthParser` which tell our VM
+By “registry”, we mean the `actionParser`, `authParser` and `outputParser` which tell our VM
 which actions and cryptographic functions that it’ll support.
 
 Finally, we create a `New()` function that allows for the VM we’ve worked on to
@@ -809,13 +810,16 @@ be instantiated.
 ```golang
 // NewWithOptions returns a VM with the specified options
 func New(options ...vm.Option) (*vm.VM, error) {
+	options = append(options, With()) // Add MorpheusVM API
+	registry, err := newRegistry()
+	if err != nil {
+		return nil, err
+	}
 	return defaultvm.New(
 		consts.Version,
 		genesis.DefaultGenesisFactory{},
 		&storage.StateManager{},
-		ActionParser,
-		AuthParser,
-		OutputParser,
+		registry,
 		auth.Engines(),
 		options...,
 	)

docs/tutorials/morpheusvm/options.md

@@ -252,32 +252,33 @@ func (cli *JSONRPCClient) Parser(ctx context.Context) (chain.Parser, error) {
 
 var _ chain.Parser = (*Parser)(nil)
 
-type Parser struct {
-	genesis *genesis.DefaultGenesis
+type Parser struct {type Parser struct {
+	genesis  *genesis.DefaultGenesis
+	registry chain.Registry
 }
 
 func (p *Parser) Rules(_ int64) chain.Rules {
 	return p.genesis.Rules
 }
 
-func (*Parser) ActionRegistry() chain.ActionRegistry {
-	return ActionParser
+func (p *Parser) ActionRegistry() chain.ActionRegistry {
+	return p.registry.ActionRegistry()
 }
 
-func (*Parser) OutputRegistry() chain.OutputRegistry {
-	return OutputParser
+func (p *Parser) AuthRegistry() chain.AuthRegistry {
+	return p.registry.AuthRegistry()
 }
 
-func (*Parser) AuthRegistry() chain.AuthRegistry {
-	return AuthParser
+func (p *Parser) OutputRegistry() chain.OutputRegistry {
+	return p.registry.OutputRegistry()
 }
 
 func (*Parser) StateManager() chain.StateManager {
 	return &storage.StateManager{}
 }
 
-func NewParser(genesis *genesis.DefaultGenesis) chain.Parser {
-	return &Parser{genesis: genesis}
+func NewParser(genesis *genesis.DefaultGenesis, registry chain.Registry) chain.Parser {
+	return &Parser{genesis: genesis, registry: registry}
 }
 
 // Used as a lambda function for creating ExternalSubscriberServer parser
@@ -286,7 +287,11 @@ func CreateParser(genesisBytes []byte) (chain.Parser, error) {
 	if err := json.Unmarshal(genesisBytes, &genesis); err != nil {
 		return nil, err
 	}
-	return NewParser(&genesis), nil
+	registry, err := newRegistry()
+	if err != nil {
+		return nil, err
+	}
+	return NewParser(&genesis, registry), nil
 }
 ```
 

examples/morpheusvm/tests/e2e/e2e_test.go

@@ -42,7 +42,10 @@ var _ = ginkgo.SynchronizedBeforeSuite(func() []byte {
 	genesisBytes, err := json.Marshal(gen)
 	require.NoError(err)
 
-	expectedABI, err := abi.NewABI(vm.ActionParser.GetRegisteredTypes(), vm.OutputParser.GetRegisteredTypes())
+	parser, err := vm.CreateParser(genesisBytes)
+	require.NoError(err)
+
+	expectedABI, err := abi.NewABI((*parser.ActionRegistry()).GetRegisteredTypes(), (*parser.OutputRegistry()).GetRegisteredTypes())
 	require.NoError(err)
 
 	// Import HyperSDK e2e test coverage and inject MorpheusVM name

examples/morpheusvm/tests/workload/workload.go

@@ -245,7 +245,9 @@ func confirmTx(ctx context.Context, require *require.Assertions, uri string, txI
 	transferOutputBytes := []byte(txRes.Outputs[0])
 	require.Equal(consts.TransferID, transferOutputBytes[0])
 	reader := codec.NewReader(transferOutputBytes, len(transferOutputBytes))
-	transferOutputTyped, err := vm.OutputParser.Unmarshal(reader)
+	parser, err := lcli.Parser(context.Background())
+	require.NoError(err)
+	transferOutputTyped, err := (*parser.OutputRegistry()).Unmarshal(reader)
 	require.NoError(err)
 	transferOutput, ok := transferOutputTyped.(*actions.TransferResult)
 	require.True(ok)

examples/morpheusvm/vm/client.go

@@ -93,37 +93,42 @@ func (cli *JSONRPCClient) Parser(ctx context.Context) (chain.Parser, error) {
 	if err != nil {
 		return nil, err
 	}
-	return NewParser(g), nil
+	registry, err := newRegistry()
+	if err != nil {
+		return nil, err
+	}
+	return NewParser(g, registry), nil
 }
 
 var _ chain.Parser = (*Parser)(nil)
 
 type Parser struct {
-	genesis *genesis.DefaultGenesis
+	genesis  *genesis.DefaultGenesis
+	registry chain.Registry
 }
 
 func (p *Parser) Rules(_ int64) chain.Rules {
 	return p.genesis.Rules
 }
 
-func (*Parser) ActionRegistry() chain.ActionRegistry {
-	return ActionParser
+func (p *Parser) ActionRegistry() chain.ActionRegistry {
+	return p.registry.ActionRegistry()
 }
 
-func (*Parser) OutputRegistry() chain.OutputRegistry {
-	return OutputParser
+func (p *Parser) AuthRegistry() chain.AuthRegistry {
+	return p.registry.AuthRegistry()
 }
 
-func (*Parser) AuthRegistry() chain.AuthRegistry {
-	return AuthParser
+func (p *Parser) OutputRegistry() chain.OutputRegistry {
+	return p.registry.OutputRegistry()
 }
 
 func (*Parser) StateManager() chain.StateManager {
 	return &storage.StateManager{}
 }
 
-func NewParser(genesis *genesis.DefaultGenesis) chain.Parser {
-	return &Parser{genesis: genesis}
+func NewParser(genesis *genesis.DefaultGenesis, registry chain.Registry) chain.Parser {
+	return &Parser{genesis: genesis, registry: registry}
 }
 
 // Used as a lambda function for creating ExternalSubscriberServer parser
@@ -132,5 +137,9 @@ func CreateParser(genesisBytes []byte) (chain.Parser, error) {
 	if err := json.Unmarshal(genesisBytes, &genesis); err != nil {
 		return nil, err
 	}
-	return NewParser(&genesis), nil
+	registry, err := newRegistry()
+	if err != nil {
+		return nil, err
+	}
+	return NewParser(&genesis, registry), nil
 }

examples/morpheusvm/vm/vm.go

@@ -17,46 +17,42 @@ import (
 	"github.com/ava-labs/hypersdk/vm/defaultvm"
 )
 
-var (
-	ActionParser *codec.TypeParser[chain.Action]
-	AuthParser   *codec.TypeParser[chain.Auth]
-	OutputParser *codec.TypeParser[codec.Typed]
-)
-
-// Setup types
-func init() {
-	ActionParser = codec.NewTypeParser[chain.Action]()
-	AuthParser = codec.NewTypeParser[chain.Auth]()
-	OutputParser = codec.NewTypeParser[codec.Typed]()
+func newRegistry() (chain.Registry, error) {
+	actionParser := codec.NewTypeParser[chain.Action]()
+	authParser := codec.NewTypeParser[chain.Auth]()
+	outputParser := codec.NewTypeParser[codec.Typed]()
 
 	errs := &wrappers.Errs{}
 	errs.Add(
 		// When registering new actions, ALWAYS make sure to append at the end.
 		// Pass nil as second argument if manual marshalling isn't needed (if in doubt, you probably don't)
-		ActionParser.Register(&actions.Transfer{}, actions.UnmarshalTransfer),
+		actionParser.Register(&actions.Transfer{}, actions.UnmarshalTransfer),
 
 		// When registering new auth, ALWAYS make sure to append at the end.
-		AuthParser.Register(&auth.ED25519{}, auth.UnmarshalED25519),
-		AuthParser.Register(&auth.SECP256R1{}, auth.UnmarshalSECP256R1),
-		AuthParser.Register(&auth.BLS{}, auth.UnmarshalBLS),
+		authParser.Register(&auth.ED25519{}, auth.UnmarshalED25519),
+		authParser.Register(&auth.SECP256R1{}, auth.UnmarshalSECP256R1),
+		authParser.Register(&auth.BLS{}, auth.UnmarshalBLS),
 
-		OutputParser.Register(&actions.TransferResult{}, nil),
+		outputParser.Register(&actions.TransferResult{}, nil),
 	)
 	if errs.Errored() {
-		panic(errs.Err)
+		return nil, errs.Err
 	}
+	return vm.NewRegistry(actionParser, authParser, outputParser), nil
 }
 
 // NewWithOptions returns a VM with the specified options
 func New(options ...vm.Option) (*vm.VM, error) {
 	options = append(options, With()) // Add MorpheusVM API
+	registry, err := newRegistry()
+	if err != nil {
+		return nil, err
+	}
 	return defaultvm.New(
 		consts.Version,
 		genesis.DefaultGenesisFactory{},
 		&storage.StateManager{},
-		ActionParser,
-		AuthParser,
-		OutputParser,
+		registry,
 		auth.Engines(),
 		options...,
 	)

examples/vmwithcontracts/tests/e2e/e2e_test.go

@@ -42,7 +42,10 @@ var _ = ginkgo.SynchronizedBeforeSuite(func() []byte {
 	genesisBytes, err := json.Marshal(gen)
 	require.NoError(err)
 
-	expectedABI, err := abi.NewABI(vm.ActionParser.GetRegisteredTypes(), vm.OutputParser.GetRegisteredTypes())
+	parser, err := vm.CreateParser(genesisBytes)
+	require.NoError(err)
+
+	expectedABI, err := abi.NewABI((*parser.ActionRegistry()).GetRegisteredTypes(), (*parser.OutputRegistry()).GetRegisteredTypes())
 	require.NoError(err)
 
 	// Import HyperSDK e2e test coverage and inject VMWithContracts name

examples/vmwithcontracts/vm/client.go

@@ -96,37 +96,42 @@ func (cli *JSONRPCClient) Parser(ctx context.Context) (chain.Parser, error) {
 	if err != nil {
 		return nil, err
 	}
-	return NewParser(g), nil
+	registry, err := newRegistry()
+	if err != nil {
+		return nil, err
+	}
+	return NewParser(g, registry), nil
 }
 
 var _ chain.Parser = (*Parser)(nil)
 
 type Parser struct {
-	genesis *genesis.DefaultGenesis
+	genesis  *genesis.DefaultGenesis
+	registry chain.Registry
 }
 
 func (p *Parser) Rules(_ int64) chain.Rules {
 	return p.genesis.Rules
 }
 
-func (*Parser) ActionRegistry() chain.ActionRegistry {
-	return ActionParser
+func (p *Parser) ActionRegistry() chain.ActionRegistry {
+	return p.registry.ActionRegistry()
 }
 
-func (*Parser) OutputRegistry() chain.OutputRegistry {
-	return OutputParser
+func (p *Parser) AuthRegistry() chain.AuthRegistry {
+	return p.registry.AuthRegistry()
 }
 
-func (*Parser) AuthRegistry() chain.AuthRegistry {
-	return AuthParser
+func (p *Parser) OutputRegistry() chain.OutputRegistry {
+	return p.registry.OutputRegistry()
 }
 
 func (*Parser) StateManager() chain.StateManager {
 	return &storage.StateManager{}
 }
 
-func NewParser(genesis *genesis.DefaultGenesis) chain.Parser {
-	return &Parser{genesis: genesis}
+func NewParser(genesis *genesis.DefaultGenesis, registry chain.Registry) chain.Parser {
+	return &Parser{genesis: genesis, registry: registry}
 }
 
 // Used as a lambda function for creating ExternalSubscriberServer parser
@@ -135,7 +140,11 @@ func CreateParser(genesisBytes []byte) (chain.Parser, error) {
 	if err := json.Unmarshal(genesisBytes, &genesis); err != nil {
 		return nil, err
 	}
-	return NewParser(&genesis), nil
+	registry, err := newRegistry()
+	if err != nil {
+		return nil, err
+	}
+	return NewParser(&genesis, registry), nil
 }
 
 func (cli *JSONRPCClient) Simulate(ctx context.Context, callTx actions.Call, actor codec.Address) (state.Keys, uint64, error) {