feat-issues-242: borsh support

.github/workflows/tests.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Setup pnpm
         uses: pnpm/action-setup@v2.2.2
         with:
-          version: 7
+          version: 8
       - name: Setup Node
         uses: actions/setup-node@v3
         with:

examples/__tests__/test-status-message-borsh.ava.js

@@ -0,0 +1,61 @@
+import { Worker } from "near-workspaces";
+import test from "ava";
+
+test.before(async (t) => {
+    // Init the worker and start a Sandbox server
+    const worker = await Worker.init();
+
+    // Prepare sandbox for tests, create accounts, deploy contracts, etx.
+    const root = worker.rootAccount;
+
+    // Deploy the contract.
+    const statusMessage = await root.devDeploy("./build/status-message-borsh.wasm");
+
+    // Create test users
+    const ali = await root.createSubAccount("ali");
+    const bob = await root.createSubAccount("bob");
+    const carl = await root.createSubAccount("carl");
+
+    // Save state for test runs
+    t.context.worker = worker;
+    t.context.accounts = { root, statusMessage, ali, bob, carl };
+});
+
+test.after.always(async (t) => {
+    await t.context.worker.tearDown().catch((error) => {
+        console.log("Failed to tear down the worker:", error);
+    });
+});
+
+test("Root gets null status", async (t) => {
+    const { statusMessage, root } = t.context.accounts;
+    const result = await statusMessage.view("get_status", {
+        account_id: root.accountId,
+    });
+    t.is(result, null);
+});
+
+test("Ali sets then gets status", async (t) => {
+    const { ali, statusMessage } = t.context.accounts;
+    await ali.call(statusMessage, "set_status", { message: "hello" });
+
+    t.is(
+        await statusMessage.view("get_status", { account_id: ali.accountId }),
+        "hello"
+    );
+});
+
+test("Bob and Carl have different statuses", async (t) => {
+    const { statusMessage, bob, carl } = t.context.accounts;
+    await bob.call(statusMessage, "set_status", { message: "hello" });
+    await carl.call(statusMessage, "set_status", { message: "world" });
+
+    const bobStatus = await statusMessage.view("get_status", {
+        account_id: bob.accountId,
+    });
+    const carlStatus = await statusMessage.view("get_status", {
+        account_id: carl.accountId,
+    });
+    t.is(bobStatus, "hello");
+    t.is(carlStatus, "world");
+});

examples/__tests__/test-status-message-deserialize-err.ava.js

@@ -0,0 +1,50 @@
+import { Worker } from "near-workspaces";
+import test from "ava";
+
+test.before(async (t) => {
+    // Init the worker and start a Sandbox server
+    const worker = await Worker.init();
+
+    // Prepare sandbox for tests, create accounts, deploy contracts, etx.
+    const root = worker.rootAccount;
+
+    // Deploy the contract.
+    const statusMessage = await root.devDeploy("./build/status-message-deserialize-err.wasm");
+
+    // Create test users
+    const ali = await root.createSubAccount("ali");
+    const bob = await root.createSubAccount("bob");
+    const carl = await root.createSubAccount("carl");
+
+    // Save state for test runs
+    t.context.worker = worker;
+    t.context.accounts = { root, statusMessage, ali, bob, carl };
+});
+
+test.after.always(async (t) => {
+    await t.context.worker.tearDown().catch((error) => {
+        console.log("Failed to tear down the worker:", error);
+    });
+});
+
+test("Root gets null status", async (t) => {
+    const { statusMessage, root } = t.context.accounts;
+    const result = await statusMessage.view("get_status", {
+        account_id: root.accountId,
+    });
+    t.is(result, null);
+});
+
+test("Ali sets then gets status", async (t) => {
+    const { ali, statusMessage } = t.context.accounts;
+    await ali.call(statusMessage, "set_status", { message: "hello" });
+
+    let res = await ali.callRaw(statusMessage, "get_status", { account_id: ali.accountId });
+
+    t.assert(
+        res.result.status.Failure.ActionError.kind.FunctionCallError.ExecutionError.includes(
+            "Smart contract panicked: deserialize err"
+        )
+    );
+});
+

examples/__tests__/test-status-message-serialize-err.ava.js

@@ -0,0 +1,47 @@
+import { Worker } from "near-workspaces";
+import test from "ava";
+
+test.before(async (t) => {
+    // Init the worker and start a Sandbox server
+    const worker = await Worker.init();
+
+    // Prepare sandbox for tests, create accounts, deploy contracts, etx.
+    const root = worker.rootAccount;
+
+    // Deploy the contract.
+    const statusMessage = await root.devDeploy("./build/status-message-serialize-err.wasm");
+
+    // Create test users
+    const ali = await root.createSubAccount("ali");
+    const bob = await root.createSubAccount("bob");
+    const carl = await root.createSubAccount("carl");
+
+    // Save state for test runs
+    t.context.worker = worker;
+    t.context.accounts = { root, statusMessage, ali, bob, carl };
+});
+
+test.after.always(async (t) => {
+    await t.context.worker.tearDown().catch((error) => {
+        console.log("Failed to tear down the worker:", error);
+    });
+});
+
+test("Root gets null status", async (t) => {
+    const { statusMessage, root } = t.context.accounts;
+    const result = await statusMessage.view("get_status", {
+        account_id: root.accountId,
+    });
+    t.is(result, null);
+});
+
+test("Ali sets status", async (t) => {
+    const { ali, statusMessage } = t.context.accounts;
+    let res = await ali.callRaw(statusMessage, "set_status", { message: "hello" });
+
+    t.assert(
+        res.result.status.Failure.ActionError.kind.FunctionCallError.ExecutionError.includes(
+            "Smart contract panicked: serialize err"
+        )
+    );
+});

examples/package.json

@@ -7,6 +7,9 @@
   "scripts": {
     "build": "run-s build:*",
     "build:status-message": "near-sdk-js build src/status-message.js build/status-message.wasm",
+    "build:status-message-borsh": "near-sdk-js build src/status-message-borsh.js build/status-message-borsh.wasm",
+    "build:status-message-serialize-err": "near-sdk-js build src/status-message-serialize-err.js build/status-message-serialize-err.wasm",
+    "build:status-message-deserialize-err": "near-sdk-js build src/status-message-deserialize-err.js build/status-message-deserialize-err.wasm",
     "build:clean-state": "near-sdk-js build src/clean-state.js build/clean-state.wasm",
     "build:counter": "near-sdk-js build src/counter.js build/counter.wasm",
     "build:counter-lowlevel": "near-sdk-js build src/counter-lowlevel.js build/counter-lowlevel.wasm",
@@ -45,15 +48,19 @@
     "test:parking-lot": "ava __tests__/test-parking-lot.ava.js",
     "test:programmatic-update": "ava __tests__/test-programmatic-update.ava.js",
     "test:state-migration": "ava __tests__/test-state-migration.ava.js",
-    "test:nested-collections": "ava __tests__/test-nested-collections.ava.js"
+    "test:nested-collections": "ava __tests__/test-nested-collections.ava.js",
+    "test:status-message-borsh": "ava __tests__/test-status-message-borsh.ava.js",
+    "test:status-message-serialize-err": "ava __tests__/test-status-message-serialize-err.ava.js",
+    "test:status-message-deserialize-err": "ava __tests__/test-status-message-deserialize-err.ava.js"
   },
   "author": "Near Inc <hello@nearprotocol.com>",
   "license": "Apache-2.0",
   "dependencies": {
     "lodash-es": "^4.17.21",
     "near-contract-standards": "workspace:*",
     "near-sdk-js": "workspace:*",
-    "typescript": "^4.7.4"
+    "typescript": "^4.7.4",
+    "borsh": "^v1.0.0"
   },
   "devDependencies": {
     "@types/lodash-es": "^4.17.6",

examples/src/status-message-borsh.js

@@ -0,0 +1,33 @@
+import {NearBindgen, call, view, near} from "near-sdk-js";
+import * as borsh from 'borsh';
+
+const schema = {
+    struct: { records: {map: { key: 'string', value: 'string' }} }
+};
+
+@NearBindgen({
+    serializer(statusMessage) {
+        return borsh.serialize(schema, statusMessage);
+    },
+    deserializer(value) {
+        return borsh.deserialize(schema, value);
+    }
+})
+export class StatusMessage {
+    constructor() {
+        this.records = new Map()
+    }
+
+    @call({})
+    set_status({ message }) {
+        let account_id = near.signerAccountId()
+        env.log(`${account_id} set_status with message ${message}`)
+        this.records.set(account_id, message)
+    }
+
+    @view({})
+    get_status({ account_id }) {
+        env.log(`get_status for account_id ${account_id}`)
+        return this.records.get(account_id) || null
+    }
+}

examples/src/status-message-deserialize-err.js

@@ -0,0 +1,25 @@
+import {NearBindgen, call, view, near} from "near-sdk-js";
+
+@NearBindgen({
+    deserializer(_value) {
+        throw new Error('deserialize err')
+    },
+})
+export class StatusMessage {
+    constructor() {
+        this.records = new Map()
+    }
+
+    @call({})
+    set_status({ message }) {
+        let account_id = near.signerAccountId()
+        env.log(`${account_id} set_status with message ${message}`)
+        this.records.set(account_id, message)
+    }
+
+    @view({})
+    get_status({ account_id }) {
+        env.log(`get_status for account_id ${account_id}`)
+        return this.records.get(account_id) || null
+    }
+}

examples/src/status-message-serialize-err.js

@@ -0,0 +1,25 @@
+import {NearBindgen, call, view, near} from "near-sdk-js";
+
+@NearBindgen({
+    serializer(_value) {
+        throw new Error('serialize err')
+    },
+})
+export class StatusMessage {
+    constructor() {
+        this.records = new Map()
+    }
+
+    @call({})
+    set_status({ message }) {
+        let account_id = near.signerAccountId()
+        env.log(`${account_id} set_status with message ${message}`)
+        this.records.set(account_id, message)
+    }
+
+    @view({})
+    get_status({ account_id }) {
+        env.log(`get_status for account_id ${account_id}`)
+        return this.records.get(account_id) || null
+    }
+}