Make vm serializable

.github/workflows/publish.yaml

@@ -1,13 +1,14 @@
 name: Publish package to GitHub Packages
 on:
+  workflow_dispatch: {}
   release:
     types: [created]
 jobs:
   build:
-    runs-on: ubuntu-latest 
-    permissions: 
+    runs-on: ubuntu-latest
+    permissions:
       contents: read
-      packages: write 
+      packages: write
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3

.github/workflows/version.yaml

@@ -1,5 +1,6 @@
 name: Auto-increment patch version number
-on: 
+on:
+  workflow_dispatch: {}
   push:
     branches:
       - main

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@terran-one/cosmwasm-vm-js",
-  "version": "0.1.12",
+  "version": "0.1.13",
   "license": "MIT",
   "author": "TerranOne",
   "main": "dist/index.js",

src/global.d.ts

@@ -0,0 +1,8 @@
+import { eddsa as ellipticEddsa } from "elliptic";
+
+declare global {
+  var _eddsa: ellipticEddsa; // we use a global to prevent serialization issues for the calling class
+  function eddsa(): ellipticEddsa;
+}
+
+export {};

src/index.ts

@@ -1,4 +1,8 @@
+import { eddsa } from 'elliptic';
+
 export * from './memory';
 export * from './backend';
 export * from './instance';
 export * from './environment';
+
+global.eddsa = () => global._eddsa || (global._eddsa = new eddsa('ed25519'));

src/instance.ts

@@ -2,7 +2,6 @@
 import { bech32, BechLib } from 'bech32';
 import { Region } from './memory';
 import { ecdsaRecover, ecdsaVerify } from 'secp256k1';
-import { eddsa } from 'elliptic';
 import { IBackend, Record } from './backend';
 import { toByteArray } from './helpers/byte-array';
 
@@ -16,12 +15,10 @@ export class VMInstance {
   public instance?: WebAssembly.Instance;
   public backend: IBackend;
   public bech32: BechLib;
-  public eddsa: eddsa;
 
   constructor(backend: IBackend) {
     this.backend = backend;
     this.bech32 = bech32;
-    this.eddsa = new eddsa('ed25519');
   }
 
   public async build(wasmByteCode: ArrayBuffer) {
@@ -371,10 +368,10 @@ export class VMInstance {
     const sig = Buffer.from(signature.data).toString('hex');
     const pub = Buffer.from(pubkey.data).toString('hex');
     const msg = Buffer.from(message.data).toString('hex');
-    const _signature = this.eddsa.makeSignature(sig);
-    const _pubkey = this.eddsa.keyFromPublic(pub);
+    const _signature = global.eddsa().makeSignature(sig);
+    const _pubkey = global.eddsa().keyFromPublic(pub);
 
-    const isValidSignature = this.eddsa.verify(msg, _signature, _pubkey);
+    const isValidSignature = global.eddsa().verify(msg, _signature, _pubkey);
 
     if (isValidSignature) {
       return 0;
@@ -410,10 +407,10 @@ export class VMInstance {
       const _sig = Buffer.from(sig).toString('hex');
       const _pub = Buffer.from(pub).toString('hex');
       const _msg = Buffer.from(msg).toString('hex');
-      const _signature = this.eddsa.makeSignature(_sig);
-      const _pubkey = this.eddsa.keyFromPublic(_pub);
+      const _signature = global.eddsa().makeSignature(_sig);
+      const _pubkey = global.eddsa().keyFromPublic(_pub);
 
-      const isValidSignature = this.eddsa.verify(_msg, _signature, _pubkey);
+      const isValidSignature = global.eddsa().verify(_msg, _signature, _pubkey);
 
       if (!isValidSignature) {
         return 1;

test/vm.test.ts

@@ -1,6 +1,8 @@
 import { readFileSync } from 'fs';
 import { BasicKVIterStorage, VMInstance } from '../src';
 import { BasicBackendApi, BasicQuerier, IBackend } from '../src/backend';
+import { writeData } from './common/test-vm';
+import * as testData from './common/test-data';
 
 const wasmByteCode = readFileSync('testdata/v1.0/cosmwasm_vm_test.wasm');
 const backend: IBackend = {
@@ -64,4 +66,33 @@ describe('CosmWasmVM', () => {
     };
     expect(region.json).toEqual(actual);
   });
+
+  it('serializes', async () => {
+    // Arrange
+    await vm.build(wasmByteCode);
+    vm.instantiate(mockEnv, mockInfo, { count: 20 });
+
+    // Act
+    const json = JSON.stringify(vm);
+
+    // Assert
+    expect(json).toBeDefined();
+  });
+
+  it('serializes after edda usage', async () => {
+    // Arrange
+    await vm.build(wasmByteCode);
+    vm.instantiate(mockEnv, mockInfo, { count: 20 });
+
+    const hashPtr = writeData(vm, testData.EDDSA_MSG_HEX);
+    const sigPtr = writeData(vm, testData.EDDSA_SIG_HEX);
+    const pubkeyPtr = writeData(vm, testData.EDDSA_PUBKEY_HEX);
+    vm.do_ed25519_verify(hashPtr, sigPtr, pubkeyPtr);
+
+    // Act
+    const json = JSON.stringify(vm);
+
+    // Assert
+    expect(json).toBeDefined();
+  });
 });

tsconfig.json

@@ -30,6 +30,7 @@
     "downlevelIteration": true,
     "outDir": "dist",
     "rootDir": "src",
+    "skipLibCheck": true,
     "sourceMap": true,
     "strict": true,
     "strictFunctionTypes": true,