Merge pull request #2 from near/base-encode-base-decode

baseEncode and baseDecode added to the library

Author: volovyks

borsh-ts/index.ts

@@ -1,10 +1,22 @@
 import BN from 'bn.js';
+import bs58 from 'bs58';
 
 // TODO: Make sure this polyfill not included when not required
 import * as encoding from 'text-encoding-utf-8';
 const TextDecoder = (typeof (global as any).TextDecoder !== 'function') ? encoding.TextDecoder : (global as any).TextDecoder;
 const textDecoder = new TextDecoder('utf-8', { fatal: true });
 
+export function baseEncode(value: Uint8Array | string): string {
+    if (typeof(value) === 'string') {
+        value = Buffer.from(value, 'utf8');
+    }
+    return bs58.encode(Buffer.from(value));
+}
+
+export function baseDecode(value: string): Buffer {
+    return Buffer.from(bs58.decode(value));
+}
+
 const INITIAL_LENGTH = 1024;
 
 export type Schema = Map<Function, any>;

borsh-ts/test/serialize.test.js

@@ -19,4 +19,26 @@ test('serialize object', async () => {
     expect(newValue.y.toString()).toEqual('20');
     expect(newValue.z).toEqual('123');
     expect(newValue.q).toEqual(new Uint8Array([1, 2, 3]));
+});
+
+test('baseEncode string test', async () => {
+    const encodedValue = borsh.baseEncode("244ZQ9cgj3CQ6bWBdytfrJMuMQ1jdXLFGnr4HhvtCTnM");
+    const expectedValue = "HKk9gqNj4xb4rLdJuzT5zzJbLa4vHBdYCxQT9H99csQh6nz3Hfpqn4jtWA92";
+    expect(encodedValue).toEqual(expectedValue);
+});
+
+test('baseEncode array test', async () => {
+    expect(borsh.baseEncode([1, 2, 3, 4, 5])).toEqual('7bWpTW');
+});
+
+test('baseDecode test', async () => {
+    const value = "HKk9gqNj4xb4rLdJu";
+    const expectedDecodedArray = [3, 96, 254, 84, 10, 240, 93, 199, 52, 244, 164, 240, 6];
+    const expectedBuffer = Buffer.from(expectedDecodedArray);
+    expect(borsh.baseDecode(value)).toEqual(expectedBuffer);
+});
+
+test('base encode and decode test', async () => {
+    const value = '244ZQ9cgj3CQ6bWBdytfrJMuMQ1jdXLFGnr4HhvtCTnM';
+    expect(borsh.baseEncode(borsh.baseDecode(value))).toEqual(value);
 });

lib/index.d.ts

@@ -1,5 +1,7 @@
 /// <reference types="node" />
 import BN from 'bn.js';
+export declare function baseEncode(value: Uint8Array | string): string;
+export declare function baseDecode(value: string): Buffer;
 export declare type Schema = Map<Function, any>;
 export declare class BorshError extends Error {
     originalMessage: string;

lib/index.js

@@ -28,12 +28,24 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deserialize = exports.serialize = exports.BinaryReader = exports.BinaryWriter = exports.BorshError = void 0;
+exports.deserialize = exports.serialize = exports.BinaryReader = exports.BinaryWriter = exports.BorshError = exports.baseDecode = exports.baseEncode = void 0;
 const bn_js_1 = __importDefault(require("bn.js"));
+const bs58_1 = __importDefault(require("bs58"));
 // TODO: Make sure this polyfill not included when not required
 const encoding = __importStar(require("text-encoding-utf-8"));
 const TextDecoder = (typeof global.TextDecoder !== 'function') ? encoding.TextDecoder : global.TextDecoder;
 const textDecoder = new TextDecoder('utf-8', { fatal: true });
+function baseEncode(value) {
+    if (typeof (value) === 'string') {
+        value = Buffer.from(value, 'utf8');
+    }
+    return bs58_1.default.encode(Buffer.from(value));
+}
+exports.baseEncode = baseEncode;
+function baseDecode(value) {
+    return Buffer.from(bs58_1.default.decode(value));
+}
+exports.baseDecode = baseDecode;
 const INITIAL_LENGTH = 1024;
 class BorshError extends Error {
     constructor(message) {

package.json

@@ -47,6 +47,7 @@
   "dependencies": {
     "@types/bn.js": "^4.11.5",
     "bn.js": "^5.0.0",
+    "bs58": "^4.0.0",
     "text-encoding-utf-8": "^1.0.2"
   }
 }