trezoa-sas-lib 1.0.11

package/dist/src/utils.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deserializeAttestationData = exports.serializeAttestationData = exports.convertSasSchemaToBorshSchema = void 0;
+const borsher_1 = require("borsher");
+// A char type does not exist on BorshSchema, so we (de)serialize
+// using the 4 byte representation.
+const CHAR_SCHEMA = borsher_1.BorshSchema.Array(borsher_1.BorshSchema.u8, 4);
+/**
+ * Maps the SAS compact byte layout to the equivalent data type.
+ */
+const compactLayoutMapping = {
+    0: borsher_1.BorshSchema.u8,
+    1: borsher_1.BorshSchema.u16,
+    2: borsher_1.BorshSchema.u32,
+    3: borsher_1.BorshSchema.u64,
+    4: borsher_1.BorshSchema.u128,
+    5: borsher_1.BorshSchema.i8,
+    6: borsher_1.BorshSchema.i16,
+    7: borsher_1.BorshSchema.i32,
+    8: borsher_1.BorshSchema.i64,
+    9: borsher_1.BorshSchema.i128,
+    10: borsher_1.BorshSchema.bool,
+    11: CHAR_SCHEMA,
+    12: borsher_1.BorshSchema.String,
+    13: borsher_1.BorshSchema.Vec(borsher_1.BorshSchema.u8),
+    14: borsher_1.BorshSchema.Vec(borsher_1.BorshSchema.u16),
+    15: borsher_1.BorshSchema.Vec(borsher_1.BorshSchema.u32),
+    16: borsher_1.BorshSchema.Vec(borsher_1.BorshSchema.u64),
+    17: borsher_1.BorshSchema.Vec(borsher_1.BorshSchema.u128),
+    18: borsher_1.BorshSchema.Vec(borsher_1.BorshSchema.i8),
+    19: borsher_1.BorshSchema.Vec(borsher_1.BorshSchema.i16),
+    20: borsher_1.BorshSchema.Vec(borsher_1.BorshSchema.i32),
+    21: borsher_1.BorshSchema.Vec(borsher_1.BorshSchema.i64),
+    22: borsher_1.BorshSchema.Vec(borsher_1.BorshSchema.i128),
+    23: borsher_1.BorshSchema.Vec(borsher_1.BorshSchema.bool),
+    24: borsher_1.BorshSchema.Vec(borsher_1.BorshSchema.String),
+    25: CHAR_SCHEMA,
+};
+const MAX_LAYOUT_VALUE = 25;
+/**
+ * Given the onchain representation of a Schema, we generate a Borsh schema
+ * for (de)serialization.
+ * @param schema
+ * @returns
+ */
+const convertSasSchemaToBorshSchema = (schema) => {
+    const textDecoder = new TextDecoder();
+    const fields = splitJoinedVecs(Uint8Array.from(schema.fieldNames)).map((f) => textDecoder.decode(Uint8Array.from(f)));
+    if (fields.length !== schema.layout.length) {
+        throw new Error("Schema field names and layout do not match");
+    }
+    return borsher_1.BorshSchema.Struct(fields.reduce((acc, field, index) => {
+        const layoutByte = schema.layout[index];
+        if (layoutByte > MAX_LAYOUT_VALUE) {
+            throw new Error("Invalid Schema layout value");
+        }
+        acc[field] = compactLayoutMapping[layoutByte];
+        return acc;
+    }, {}));
+};
+exports.convertSasSchemaToBorshSchema = convertSasSchemaToBorshSchema;
+/**
+ * Given a SAS Schema and an object that represents the Attestation data,
+ * serialize the Attestation data to valid byte array.
+ * @param schema
+ */
+const serializeAttestationData = (schema, data) => {
+    const borshSchema = (0, exports.convertSasSchemaToBorshSchema)(schema);
+    return borshSchema.serialize(data);
+};
+exports.serializeAttestationData = serializeAttestationData;
+/**
+ * Given a SAS Schema and a byte array of Attestation data,
+ * deserialize the Attestation data to an object.
+ * @param schema
+ */
+const deserializeAttestationData = (schema, data) => {
+    const borshSchema = (0, exports.convertSasSchemaToBorshSchema)(schema);
+    return borshSchema.deserialize(data);
+};
+exports.deserializeAttestationData = deserializeAttestationData;
+const splitJoinedVecs = (bytes) => {
+    let offset = 0;
+    const ret = [];
+    while (offset < bytes.length) {
+        const len = u32FromLeBytes(bytes.slice(offset, offset + 4));
+        offset += 4;
+        ret.push(bytes.slice(offset, offset + len));
+        offset += len;
+    }
+    return ret;
+};
+const u32FromLeBytes = (bytes) => {
+    if (bytes.length !== 4) {
+        throw new Error("Input must be a 4-byte array");
+    }
+    return ((bytes[0] << 0) | (bytes[1] << 8) | (bytes[2] << 16) | (bytes[3] << 24));
+};

package/dist/test/pdas.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/pdas.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const kit_1 = require("@trezoa/kit");
+const src_1 = require("../src");
+describe("PDAs", () => {
+    describe("PDA derivation", () => {
+        it("should derive a credential PDA", async () => {
+            const issuer = (0, kit_1.address)('E15NNEiGt7BQvuyXpVeCsbS3uQY7jd8QtrUrWc1fH425');
+            const credentialName = 'test';
+            const expectedPda = ['98ay9m4KXXbQktfg5w1DSgbcyyjyHecvNtqcMn2BwL5M', 254];
+            const testPda = await (0, src_1.deriveCredentialPda)({ authority: issuer, name: credentialName });
+            chai_1.assert.deepEqual(testPda, expectedPda);
+        });
+        it("should derive a schema PDA", async () => {
+            const credential = (0, kit_1.address)('A1ghCNKvMCPKqzjdvnjYk3YFR13RiP8dh9HxBetr9kon');
+            const schemaName = 'test';
+            const version = 1;
+            const expectedPda = ['DKc1A7uuVyKsY3jCmQAKzdcAp16g5pUKJshAszdRQFbw', 254];
+            const testPda = await (0, src_1.deriveSchemaPda)({
+                credential,
+                version,
+                name: schemaName
+            });
+            chai_1.assert.deepEqual(testPda, expectedPda);
+        });
+        it("should derive an attestation PDA", async () => {
+            const credential = (0, kit_1.address)('FMdNo2Rfg6DUCdHCwZCC3wLkYn53JQCoMgzfXfqTH5Uv');
+            const schema = (0, kit_1.address)('BdaSyg8ZJRbbMpx24i2ugFcYaPagQBtpHUqBfcZaF9LJ');
+            const nonce = (0, kit_1.address)('3axwvYuBmgFPc1pexoccctra5LkUxZGXEjyakAMMtm5m');
+            const expectedPda = ['3e3K3DfNNNfgMTKeWuRA3VPKkpTEHVHbfpJz3BJHpmKB', 255];
+            const testPda = await (0, src_1.deriveAttestationPda)({
+                credential,
+                schema,
+                nonce
+            });
+            chai_1.assert.deepEqual(testPda, expectedPda);
+        });
+        it("should derive a schema mint PDA", async () => {
+            const schema = (0, kit_1.address)('7Wks2GbXrr22HkVzgLbfJ9z6pacZGHYk7p5B9amoCSDW');
+            const expectedPda = ['8UKqFzWzgrakFaJijkabRbkKCom2KbJGJjbu3SX7t1Qq', 254];
+            const testPda = await (0, src_1.deriveSchemaMintPda)({
+                schema,
+            });
+            chai_1.assert.deepEqual(testPda, expectedPda);
+        });
+        it("should derive an attestation mint PDA", async () => {
+            const attestation = (0, kit_1.address)('99Ui29EecR3uVZ9oLJzX4XdWDeKvoYUpK1dMupc3eAgn');
+            const expectedPda = ['B5TxRjVzoyLoRNq83BRg7g63dUAKrD3XCCoMxBxsfZUk', 253];
+            const testPda = await (0, src_1.deriveAttestationMintPda)({
+                attestation,
+            });
+            chai_1.assert.deepEqual(testPda, expectedPda);
+        });
+        it("should derive event authority pda PDA", async () => {
+            const expectedPda = '9qmfijJ9MX4XVGdgWB64UuGUb19guVXrpn1HxweCybVb';
+            const testPda = await (0, src_1.deriveEventAuthorityAddress)();
+            chai_1.assert.deepEqual(testPda, expectedPda);
+        });
+    });
+});

package/dist/test/utils.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/utils.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const generated_1 = require("../src/generated");
+const utils_1 = require("../src/utils");
+describe("Utils", () => {
+    const schemaAccountBytes = Uint8Array.from([
+        1, 147, 244, 210, 208, 208, 76, 164, 106, 193, 96, 129, 24, 152, 59, 215,
+        13, 112, 136, 111, 235, 117, 29, 128, 253, 99, 200, 171, 204, 126, 178, 74,
+        175, 9, 0, 0, 0, 116, 101, 115, 116, 95, 100, 97, 116, 97, 20, 0, 0, 0, 115,
+        99, 104, 101, 109, 97, 32, 102, 111, 114, 32, 116, 101, 115, 116, 32, 100,
+        97, 116, 97, 2, 0, 0, 0, 12, 0, 20, 0, 0, 0, 4, 0, 0, 0, 110, 97, 109, 101,
+        8, 0, 0, 0, 108, 111, 99, 97, 116, 105, 111, 110, 0, 1,
+    ]);
+    describe("convertSasSchemaToBorshSchema", () => {
+        it("should convert SAS Schema to a proper BorshSchema", () => {
+            const decoder = (0, generated_1.getSchemaDecoder)();
+            const schema = decoder.decode(schemaAccountBytes);
+            const borshSchema = (0, utils_1.convertSasSchemaToBorshSchema)(schema);
+            const testData = {
+                name: "hello",
+                location: 10,
+            };
+            const serialized = borshSchema.serialize(testData);
+            const deserialized = borshSchema.deserialize(serialized);
+            chai_1.assert.deepEqual(testData, deserialized);
+        });
+    });
+});

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "trezoa-sas-lib",
+  "version": "1.0.11",
+  "repository": "git@github.com:trzledgerfoundation/trezoa-attestation-service.git",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@types/chai": "^5.2.2",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^20.11.24",
+    "chai": "^4.4.1",
+    "mocha": "^10.8.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.0.0"
+  },
+  "dependencies": {
+    "@trezoa/addresses": "^5.1.1",
+    "@trezoa/kit": "^5.1.0",
+    "borsh": "^2.0.0",
+    "borsher": "^4.0.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "mocha --require ts-node/register 'test/**/*'"
+  }
+}