chore(lib/runtime): stub v0.9.8 runtime funcs, partially implement st…

…orage ext_ funcs (ChainSafe#1710)

lib/runtime/constants.go

@@ -24,11 +24,16 @@ var runtimes = []string{HOST_API_TEST_RUNTIME, POLKADOT_RUNTIME, NODE_RUNTIME, D
 
 //nolint
 const (
-	// v0.8 substrate runtime
+	// v0.9 substrate runtime
 	NODE_RUNTIME     = "node_runtime"
 	NODE_RUNTIME_FP  = "node_runtime.compact.wasm"
 	NODE_RUNTIME_URL = "https://github.com/noot/substrate/blob/noot/v0.9/target/debug/wbuild/node-runtime/node_runtime.compact.wasm?raw=true"
 
+	// v0.9.8 substrate runtime
+	NODE_RUNTIME_v098     = "node_runtime-v0.9.8"
+	NODE_RUNTIME_FP_v098  = "node_runtime-v0.9.8.compact.wasm"
+	NODE_RUNTIME_URL_v098 = "https://github.com/noot/substrate/blob/noot/v0.9.8/target/debug/wbuild/node-runtime/node_runtime.compact.wasm?raw=true"
+
 	// v0.8 polkadot runtime
 	POLKADOT_RUNTIME     = "polkadot_runtime"
 	POLKADOT_RUNTIME_FP  = "polkadot_runtime.compact.wasm"

lib/runtime/test_helpers.go

@@ -52,21 +52,20 @@ func NewInMemoryDB(t *testing.T) chaindb.Database {
 
 // GetRuntimeVars returns the testRuntimeFilePath and testRuntimeURL
 func GetRuntimeVars(targetRuntime string) (string, string) {
-	var testRuntimeFilePath string
-	var testRuntimeURL string
-
 	switch targetRuntime {
 	case NODE_RUNTIME:
-		testRuntimeFilePath, testRuntimeURL = GetAbsolutePath(NODE_RUNTIME_FP), NODE_RUNTIME_URL
+		return GetAbsolutePath(NODE_RUNTIME_FP), NODE_RUNTIME_URL
+	case NODE_RUNTIME_v098:
+		return GetAbsolutePath(NODE_RUNTIME_FP_v098), NODE_RUNTIME_URL_v098
 	case POLKADOT_RUNTIME:
-		testRuntimeFilePath, testRuntimeURL = GetAbsolutePath(POLKADOT_RUNTIME_FP), POLKADOT_RUNTIME_URL
+		return GetAbsolutePath(POLKADOT_RUNTIME_FP), POLKADOT_RUNTIME_URL
 	case HOST_API_TEST_RUNTIME:
-		testRuntimeFilePath, testRuntimeURL = GetAbsolutePath(HOST_API_TEST_RUNTIME_FP), HOST_API_TEST_RUNTIME_URL
+		return GetAbsolutePath(HOST_API_TEST_RUNTIME_FP), HOST_API_TEST_RUNTIME_URL
 	case DEV_RUNTIME:
-		testRuntimeFilePath, testRuntimeURL = GetAbsolutePath(DEV_RUNTIME_FP), DEV_RUNTIME_URL
+		return GetAbsolutePath(DEV_RUNTIME_FP), DEV_RUNTIME_URL
+	default:
+		return "", ""
 	}
-
-	return testRuntimeFilePath, testRuntimeURL
 }
 
 // GetAbsolutePath returns the completePath for a given targetDir

lib/runtime/wasmer/exports_test.go

@@ -63,6 +63,38 @@ func createTestExtrinsic(t *testing.T, rt runtime.Instance, genHash common.Hash,
 	return types.Extrinsic(common.MustHexToBytes(extEnc))
 }
 
+func TestInstance_Version_NodeRuntime_v098(t *testing.T) {
+	expected := runtime.NewVersionData(
+		[]byte("node"),
+		[]byte("substrate-node"),
+		10,
+		267,
+		0,
+		nil,
+		2,
+	)
+
+	instance := NewTestInstance(t, runtime.NODE_RUNTIME_v098)
+
+	version, err := instance.Version()
+	require.Nil(t, err)
+
+	t.Logf("SpecName: %s\n", version.SpecName())
+	t.Logf("ImplName: %s\n", version.ImplName())
+	t.Logf("AuthoringVersion: %d\n", version.AuthoringVersion())
+	t.Logf("SpecVersion: %d\n", version.SpecVersion())
+	t.Logf("ImplVersion: %d\n", version.ImplVersion())
+	t.Logf("TransactionVersion: %d\n", version.TransactionVersion())
+
+	require.Equal(t, 13, len(version.APIItems()))
+	require.Equal(t, expected.SpecName(), version.SpecName())
+	require.Equal(t, expected.ImplName(), version.ImplName())
+	require.Equal(t, expected.AuthoringVersion(), version.AuthoringVersion())
+	require.Equal(t, expected.SpecVersion(), version.SpecVersion())
+	require.Equal(t, expected.ImplVersion(), version.ImplVersion())
+	require.Equal(t, expected.TransactionVersion(), version.TransactionVersion())
+}
+
 func TestInstance_Version_PolkadotRuntime(t *testing.T) {
 	expected := runtime.NewVersionData(
 		[]byte("polkadot"),

lib/runtime/wasmer/imports.go

@@ -45,11 +45,12 @@ package wasmer
 //
 // extern int32_t ext_trie_blake2_256_root_version_1(void *context, int64_t a);
 // extern int32_t ext_trie_blake2_256_ordered_root_version_1(void *context, int64_t a);
+// extern int32_t ext_trie_blake2_256_verify_proof_version_1(void *context, int32_t a, int64_t b, int64_t c, int64_t d);
 //
+// extern int64_t ext_misc_runtime_version_version_1(void *context, int64_t a);
 // extern void ext_misc_print_hex_version_1(void *context, int64_t a);
 // extern void ext_misc_print_num_version_1(void *context, int64_t a);
 // extern void ext_misc_print_utf8_version_1(void *context, int64_t a);
-// extern int64_t ext_misc_runtime_version_version_1(void *context, int64_t a);
 //
 // extern void ext_default_child_storage_clear_version_1(void *context, int64_t a, int64_t b);
 // extern int64_t ext_default_child_storage_get_version_1(void *context, int64_t a, int64_t b);
@@ -59,6 +60,7 @@ package wasmer
 // extern void ext_default_child_storage_set_version_1(void *context, int64_t a, int64_t b, int64_t c);
 // extern void ext_default_child_storage_storage_kill_version_1(void *context, int64_t a);
 // extern int32_t ext_default_child_storage_storage_kill_version_2(void *context, int64_t a, int64_t b);
+// extern int64_t ext_default_child_storage_storage_kill_version_3(void *context, int64_t a, int64_t b);
 // extern void ext_default_child_storage_clear_prefix_version_1(void *context, int64_t a, int64_t b);
 // extern int32_t ext_default_child_storage_exists_version_1(void *context, int64_t a, int64_t b);
 //
@@ -75,17 +77,20 @@ package wasmer
 //
 // extern void ext_offchain_index_set_version_1(void *context, int64_t a, int64_t b);
 // extern int32_t ext_offchain_is_validator_version_1(void *context);
+// extern void ext_offchain_local_storage_clear_version_1(void *context, int32_t a, int64_t b);
 // extern int32_t ext_offchain_local_storage_compare_and_set_version_1(void *context, int32_t a, int64_t b, int64_t c, int64_t d);
 // extern int64_t ext_offchain_local_storage_get_version_1(void *context, int32_t a, int64_t b);
 // extern void ext_offchain_local_storage_set_version_1(void *context, int32_t a, int64_t b, int64_t c);
 // extern int64_t ext_offchain_network_state_version_1(void *context);
 // extern int32_t ext_offchain_random_seed_version_1(void *context);
 // extern int64_t ext_offchain_submit_transaction_version_1(void *context, int64_t a);
+// extern int64_t ext_offchain_timestamp_version_1(void *context);
 //
 // extern void ext_storage_append_version_1(void *context, int64_t a, int64_t b);
 // extern int64_t ext_storage_changes_root_version_1(void *context, int64_t a);
 // extern void ext_storage_clear_version_1(void *context, int64_t a);
 // extern void ext_storage_clear_prefix_version_1(void *context, int64_t a);
+// extern int64_t ext_storage_clear_prefix_version_2(void *context, int64_t a, int64_t b);
 // extern void ext_storage_commit_transaction_version_1(void *context);
 // extern int32_t ext_storage_exists_version_1(void *context, int64_t a);
 // extern int64_t ext_storage_get_version_1(void *context, int64_t a);
@@ -95,6 +100,9 @@ package wasmer
 // extern int64_t ext_storage_root_version_1(void *context);
 // extern void ext_storage_set_version_1(void *context, int64_t a, int64_t b);
 // extern void ext_storage_start_transaction_version_1(void *context);
+//
+// extern void ext_transaction_index_index_version_1(void *context, int32_t a, int32_t b, int32_t c);
+// extern void ext_transaction_index_renew_version_1(void *context, int32_t a, int32_t b);
 import "C"
 
 import (
@@ -154,6 +162,18 @@ func ext_logging_max_level_version_1(context unsafe.Pointer) C.int32_t {
 	return 4
 }
 
+//export ext_transaction_index_index_version_1
+func ext_transaction_index_index_version_1(context unsafe.Pointer, a, b, c C.int32_t) {
+	logger.Trace("[ext_transaction_index_index_version_1] executing...")
+	logger.Warn("[ext_transaction_index_index_version_1] unimplemented")
+}
+
+//export ext_transaction_index_renew_version_1
+func ext_transaction_index_renew_version_1(context unsafe.Pointer, a, b C.int32_t) {
+	logger.Trace("[ext_transaction_index_renew_version_1] executing...")
+	logger.Warn("[ext_transaction_index_renew_version_1] unimplemented")
+}
+
 //export ext_sandbox_instance_teardown_version_1
 func ext_sandbox_instance_teardown_version_1(context unsafe.Pointer, a C.int32_t) {
 	logger.Trace("[ext_sandbox_instance_teardown_version_1] executing...")
@@ -835,6 +855,13 @@ func ext_trie_blake2_256_ordered_root_version_1(context unsafe.Pointer, dataSpan
 	return C.int32_t(ptr)
 }
 
+//export ext_trie_blake2_256_verify_proof_version_1
+func ext_trie_blake2_256_verify_proof_version_1(context unsafe.Pointer, a C.int32_t, b, c, d C.int64_t) C.int32_t {
+	logger.Debug("[ext_trie_blake2_256_verify_proof_version_1] executing...")
+	logger.Warn("[ext_trie_blake2_256_verify_proof_version_1] unimplemented")
+	return 0
+}
+
 //export ext_misc_print_hex_version_1
 func ext_misc_print_hex_version_1(context unsafe.Pointer, dataSpan C.int64_t) {
 	logger.Trace("[ext_misc_print_hex_version_1] executing...")
@@ -1093,9 +1120,36 @@ func ext_default_child_storage_storage_kill_version_1(context unsafe.Pointer, ch
 }
 
 //export ext_default_child_storage_storage_kill_version_2
-func ext_default_child_storage_storage_kill_version_2(context unsafe.Pointer, a, b C.int64_t) C.int32_t {
+func ext_default_child_storage_storage_kill_version_2(context unsafe.Pointer, childStorageKeySpan, _ C.int64_t) C.int32_t {
 	logger.Debug("[ext_default_child_storage_storage_kill_version_2] executing...")
-	logger.Warn("[ext_default_child_storage_storage_kill_version_2] unimplemented")
+	logger.Warn("[ext_default_child_storage_storage_kill_version_2] somewhat unimplemented")
+	// TODO: need to use `limit` parameter
+
+	instanceContext := wasm.IntoInstanceContext(context)
+	ctx := instanceContext.Data().(*runtime.Context)
+	storage := ctx.Storage
+
+	childStorageKey := asMemorySlice(instanceContext, childStorageKeySpan)
+	storage.DeleteChild(childStorageKey)
+
+	// note: this function always returns `KillStorageResult::AllRemoved`, which is 0
+	return 0
+}
+
+//export ext_default_child_storage_storage_kill_version_3
+func ext_default_child_storage_storage_kill_version_3(context unsafe.Pointer, childStorageKeySpan, _ C.int64_t) C.int64_t {
+	logger.Debug("[ext_default_child_storage_storage_kill_version_3] executing...")
+	logger.Warn("[ext_default_child_storage_storage_kill_version_3] somewhat unimplemented")
+	// TODO: need to use `limit` parameter
+
+	instanceContext := wasm.IntoInstanceContext(context)
+	ctx := instanceContext.Data().(*runtime.Context)
+	storage := ctx.Storage
+
+	childStorageKey := asMemorySlice(instanceContext, childStorageKeySpan)
+	storage.DeleteChild(childStorageKey)
+
+	// TODO: this function returns a `KillStorageResult` which may be `AllRemoved` (0) or `SomeRemaining` (1)
 	return 0
 }
 
@@ -1297,6 +1351,12 @@ func ext_offchain_index_set_version_1(context unsafe.Pointer, keySpan, valueSpan
 	logger.Warn("[ext_offchain_index_set_version_1] unimplemented")
 }
 
+//export ext_offchain_local_storage_clear_version_1
+func ext_offchain_local_storage_clear_version_1(context unsafe.Pointer, a C.int32_t, b C.int64_t) {
+	logger.Trace("[ext_offchain_local_storage_clear_version_1] executing...")
+	logger.Warn("[ext_offchain_local_storage_clear_version_1] unimplemented")
+}
+
 //export ext_offchain_is_validator_version_1
 func ext_offchain_is_validator_version_1(context unsafe.Pointer) C.int32_t {
 	logger.Debug("[ext_offchain_is_validator_version_1] executing...")
@@ -1478,6 +1538,13 @@ func ext_offchain_submit_transaction_version_1(context unsafe.Pointer, data C.in
 	return C.int64_t(ptr)
 }
 
+//export ext_offchain_timestamp_version_1
+func ext_offchain_timestamp_version_1(context unsafe.Pointer) C.int64_t {
+	logger.Trace("[ext_offchain_timestamp_version_1] executing...")
+	logger.Warn("[ext_offchain_timestamp_version_1] unimplemented")
+	return 0
+}
+
 func storageAppend(storage runtime.Storage, key, valueToAppend []byte) error {
 	nextLength := big.NewInt(1)
 	var valueRes []byte
@@ -1584,6 +1651,27 @@ func ext_storage_clear_prefix_version_1(context unsafe.Pointer, prefixSpan C.int
 	}
 }
 
+//export ext_storage_clear_prefix_version_2
+func ext_storage_clear_prefix_version_2(context unsafe.Pointer, prefixSpan, _ C.int64_t) C.int64_t {
+	logger.Trace("[ext_storage_clear_prefix_version_2] executing...")
+	logger.Warn("[ext_storage_clear_prefix_version_2] somewhat unimplemented")
+	// TODO: need to use unused `limit` parameter
+
+	instanceContext := wasm.IntoInstanceContext(context)
+	ctx := instanceContext.Data().(*runtime.Context)
+	storage := ctx.Storage
+
+	prefix := asMemorySlice(instanceContext, prefixSpan)
+	logger.Debug("[ext_storage_clear_prefix_version_1]", "prefix", fmt.Sprintf("0x%x", prefix))
+
+	err := storage.ClearPrefix(prefix)
+	if err != nil {
+		logger.Error("[ext_storage_clear_prefix_version_1]", "error", err)
+	}
+
+	return 1
+}
+
 //export ext_storage_exists_version_1
 func ext_storage_exists_version_1(context unsafe.Pointer, keySpan C.int64_t) C.int32_t {
 	logger.Trace("[ext_storage_exists_version_1] executing...")
@@ -1961,6 +2049,10 @@ func ImportsNodeRuntime() (*wasm.Imports, error) { //nolint
 	if err != nil {
 		return nil, err
 	}
+	_, err = imports.Append("ext_default_child_storage_storage_kill_version_3", ext_default_child_storage_storage_kill_version_3, C.ext_default_child_storage_storage_kill_version_3)
+	if err != nil {
+		return nil, err
+	}
 
 	_, err = imports.Append("ext_hashing_blake2_128_version_1", ext_hashing_blake2_128_version_1, C.ext_hashing_blake2_128_version_1)
 	if err != nil {
@@ -2025,6 +2117,10 @@ func ImportsNodeRuntime() (*wasm.Imports, error) { //nolint
 	if err != nil {
 		return nil, err
 	}
+	_, err = imports.Append("ext_offchain_local_storage_clear_version_1", ext_offchain_local_storage_clear_version_1, C.ext_offchain_local_storage_clear_version_1)
+	if err != nil {
+		return nil, err
+	}
 	_, err = imports.Append("ext_offchain_local_storage_compare_and_set_version_1", ext_offchain_local_storage_compare_and_set_version_1, C.ext_offchain_local_storage_compare_and_set_version_1)
 	if err != nil {
 		return nil, err
@@ -2049,6 +2145,10 @@ func ImportsNodeRuntime() (*wasm.Imports, error) { //nolint
 	if err != nil {
 		return nil, err
 	}
+	_, err = imports.Append("ext_offchain_timestamp_version_1", ext_offchain_timestamp_version_1, C.ext_offchain_timestamp_version_1)
+	if err != nil {
+		return nil, err
+	}
 
 	_, err = imports.Append("ext_sandbox_instance_teardown_version_1", ext_sandbox_instance_teardown_version_1, C.ext_sandbox_instance_teardown_version_1)
 	if err != nil {
@@ -2095,6 +2195,10 @@ func ImportsNodeRuntime() (*wasm.Imports, error) { //nolint
 	if err != nil {
 		return nil, err
 	}
+	_, err = imports.Append("ext_storage_clear_prefix_version_2", ext_storage_clear_prefix_version_2, C.ext_storage_clear_prefix_version_2)
+	if err != nil {
+		return nil, err
+	}
 	_, err = imports.Append("ext_storage_commit_transaction_version_1", ext_storage_commit_transaction_version_1, C.ext_storage_commit_transaction_version_1)
 	if err != nil {
 		return nil, err
@@ -2140,6 +2244,19 @@ func ImportsNodeRuntime() (*wasm.Imports, error) { //nolint
 	if err != nil {
 		return nil, err
 	}
+	_, err = imports.Append("ext_trie_blake2_256_verify_proof_version_1", ext_trie_blake2_256_verify_proof_version_1, C.ext_trie_blake2_256_verify_proof_version_1)
+	if err != nil {
+		return nil, err
+	}
+
+	_, err = imports.Append("ext_transaction_index_index_version_1", ext_transaction_index_index_version_1, C.ext_transaction_index_index_version_1)
+	if err != nil {
+		return nil, err
+	}
+	_, err = imports.Append("ext_transaction_index_renew_version_1", ext_transaction_index_renew_version_1, C.ext_transaction_index_renew_version_1)
+	if err != nil {
+		return nil, err
+	}
 
 	return imports, nil
 }

lib/runtime/wasmer/test_helpers.go

@@ -28,7 +28,6 @@ import (
 	log "github.com/ChainSafe/log15"
 	"github.com/stretchr/testify/mock"
 	"github.com/stretchr/testify/require"
-	wasm "github.com/wasmerio/go-ext-wasm/wasmer"
 )
 
 // DefaultTestLogLvl is the log level used for test runtime instances
@@ -57,27 +56,8 @@ func NewTestInstanceWithRole(t *testing.T, targetRuntime string, role byte) *Ins
 	return r
 }
 
-// GetRuntimeImports ...
-func GetRuntimeImports(targetRuntime string) func() (*wasm.Imports, error) {
-	var registerImports func() (*wasm.Imports, error)
-
-	switch targetRuntime {
-	case runtime.NODE_RUNTIME:
-		registerImports = ImportsNodeRuntime
-	case runtime.POLKADOT_RUNTIME:
-		registerImports = ImportsNodeRuntime
-	case runtime.HOST_API_TEST_RUNTIME:
-		registerImports = ImportsNodeRuntime
-	default:
-		registerImports = ImportsNodeRuntime
-	}
-
-	return registerImports
-}
-
 func setupConfig(t *testing.T, targetRuntime string, tt *trie.Trie, lvl log.Lvl, role byte) (string, *Config) {
 	testRuntimeFilePath, testRuntimeURL := runtime.GetRuntimeVars(targetRuntime)
-	importsFunc := GetRuntimeImports(targetRuntime)
 
 	_, err := runtime.GetRuntimeBlob(testRuntimeFilePath, testRuntimeURL)
 	require.Nil(t, err, "Fail: could not get runtime", "targetRuntime", targetRuntime)
@@ -93,7 +73,7 @@ func setupConfig(t *testing.T, targetRuntime string, tt *trie.Trie, lvl log.Lvl,
 		PersistentStorage: runtime.NewInMemoryDB(t), // we're using a local storage here since this is a test runtime
 	}
 	cfg := &Config{
-		Imports: importsFunc,
+		Imports: ImportsNodeRuntime,
 	}
 	cfg.Storage = s
 	cfg.Keystore = keystore.NewGlobalKeystore()