rename ABF to TypedEncoding

src/transaction_builder.ts

@@ -18,7 +18,7 @@ import {
     toByteArray,
     uint8ArrayToHex
 } from "./utils.js";
-import ABF from "./abf.js"
+import TE from "./typed_encoding.js"
 import { deriveAddress, deriveKeyPair, sign } from "./crypto.js";
 
 const VERSION = 3
@@ -360,7 +360,7 @@ export default class TransactionBuilder {
                     // address
                     address)
             } else {
-                const serializedArgs = args.map((arg) => ABF.serialize(arg))
+                const serializedArgs = args.map((arg) => TE.serialize(arg))
 
                 return concatUint8Arrays(
                     // 1 = named action

src/abf.ts → src/typed_encoding.ts

@@ -1,5 +1,3 @@
-// ABF stands for Archethic Binary Format
-
 import {
     concatUint8Arrays,
     toBigInt,
@@ -27,7 +25,7 @@ function serialize(data: any): Uint8Array {
     data = sortObjectKeysASC(data)
 
     return concatUint8Arrays(
-        // abf version 1
+        // version 1
         Uint8Array.from([1]),
         do_serialize_v1(data)
     )

tests/transaction_builder.test.ts

@@ -9,7 +9,7 @@ import {
     uint8ArrayToHex,
 } from "../src/utils";
 import { Curve } from "../src/types";
-import ABF from "../src/abf";
+import TE from "../src/typed_encoding";
 
 const VERSION = 3
 
@@ -401,7 +401,7 @@ describe("Transaction builder", () => {
                 // args size
                 Uint8Array.from([1]),
                 // args value
-                ABF.serialize("Ms. Smith")
+                TE.serialize("Ms. Smith")
             );
             expect(payload).toEqual(expected_binary);
 
@@ -460,7 +460,7 @@ describe("Transaction builder", () => {
                 // args size
                 Uint8Array.from([1]),
                 // args value
-                ABF.serialize({ "lng": 2, "lat": 1 })
+                TE.serialize({ "lng": 2, "lat": 1 })
             );
             expect(payload).toEqual(expected_binary);
 

tests/typed_encoding.test.ts

@@ -0,0 +1,40 @@
+import TE from "../src/typed_encoding"
+
+describe("TE", () => {
+    it("should serialize/deserialize a null", () => {
+        expect(TE.deserialize(TE.serialize(null))).toBeNull()
+    })
+    it("should serialize/deserialize a bool", () => {
+        expect(TE.deserialize(TE.serialize(true))).toBe(true)
+        expect(TE.deserialize(TE.serialize(false))).toBe(false)
+    })
+    it("should serialize/deserialize an integer", () => {
+        expect(TE.deserialize(TE.serialize(0))).toBe(0)
+        expect(TE.deserialize(TE.serialize(1))).toBe(1)
+        expect(TE.deserialize(TE.serialize(2 ** 40))).toBe(2 ** 40)
+    })
+    it("should serialize/deserialize a float", () => {
+        expect(TE.deserialize(TE.serialize(1.00000001))).toBe(1.00000001)
+        expect(TE.deserialize(TE.serialize(1.99999999))).toBe(1.99999999)
+    })
+    it("should serialize/deserialize a str", () => {
+        expect(TE.deserialize(TE.serialize("hello"))).toBe("hello")
+        expect(TE.deserialize(TE.serialize("world"))).toBe("world")
+    })
+
+    it("should serialize/deserialize a list", () => {
+        expect(TE.deserialize(TE.serialize([]))).toStrictEqual([])
+        expect(TE.deserialize(TE.serialize([1, 2, 3]))).toStrictEqual([1, 2, 3])
+        expect(TE.deserialize(TE.serialize(["1", true, 14]))).toStrictEqual(["1", true, 14])
+    })
+    it("should serialize/deserialize an object", () => {
+        expect(TE.deserialize(TE.serialize({}))).toStrictEqual({})
+        expect(TE.deserialize(TE.serialize({ a: 1, foo: "bar" }))).toStrictEqual({ a: 1, foo: "bar" })
+    })
+    it("should serialize/deserialize a map", () => {
+        let map = new Map()
+        map.set({ oooo: "iii" }, 44)
+        map.set(["aaaaa", "bbbbb"], 45)
+        expect(TE.deserialize(TE.serialize(map))).toStrictEqual(map)
+    })
+})