feat(price-service-sdk) implement accumulator update data deserialization (#1308)

* Export

* Cleanup sui

*  Add comment

* Bump packages

Author: guibescos

price_service/client/js/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pythnetwork/price-service-client",
-  "version": "1.8.2",
+  "version": "1.9.0",
   "description": "Pyth price service client",
   "author": {
     "name": "Pyth Data Association"

price_service/client/js/src/index.ts

@@ -10,4 +10,7 @@ export {
   PriceFeed,
   Price,
   UnixTimestamp,
+  isAccumulatorUpdateData,
+  parseAccumulatorUpdateData,
+  AccumulatorUpdateData,
 } from "@pythnetwork/price-service-sdk";

price_service/sdk/js/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pythnetwork/price-service-sdk",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "Pyth price service SDK",
   "homepage": "https://pyth.network",
   "main": "lib/index.js",

price_service/sdk/js/src/AccumulatorUpdateData.ts

@@ -0,0 +1,65 @@
+const ACCUMULATOR_MAGIC = "504e4155";
+const MAJOR_VERSION = 1;
+const MINOR_VERSION = 0;
+const KECCAK160_HASH_SIZE = 20;
+
+export type AccumulatorUpdateData = {
+  vaa: Buffer;
+  updates: { message: Buffer; proof: Buffer[] }[];
+};
+
+export function isAccumulatorUpdateData(updateBytes: Buffer): boolean {
+  return (
+    updateBytes.toString("hex").slice(0, 8) === ACCUMULATOR_MAGIC &&
+    updateBytes[4] === MAJOR_VERSION &&
+    updateBytes[5] === MINOR_VERSION
+  );
+}
+
+export function parseAccumulatorUpdateData(
+  data: Buffer
+): AccumulatorUpdateData {
+  if (!isAccumulatorUpdateData(data)) {
+    throw new Error("Invalid accumulator message");
+  }
+
+  let cursor = 6;
+  const trailingPayloadSize = data.readUint8(cursor);
+  cursor += 1 + trailingPayloadSize;
+
+  // const proofType = data.readUint8(cursor);
+  cursor += 1;
+
+  const vaaSize = data.readUint16BE(cursor);
+  cursor += 2;
+
+  const vaa = data.subarray(cursor, cursor + vaaSize);
+  cursor += vaaSize;
+
+  const numUpdates = data.readUInt8(cursor);
+  const updates = [];
+  cursor += 1;
+
+  for (let i = 0; i < numUpdates; i++) {
+    const messageSize = data.readUint16BE(cursor);
+    cursor += 2;
+    const message = data.subarray(cursor, cursor + messageSize);
+    cursor += messageSize;
+
+    const numProofs = data.readUInt8(cursor);
+    cursor += 1;
+    const proof = [];
+    for (let j = 0; j < numProofs; j++) {
+      proof.push(data.subarray(cursor, cursor + KECCAK160_HASH_SIZE));
+      cursor += KECCAK160_HASH_SIZE;
+    }
+
+    updates.push({ message, proof });
+  }
+
+  if (cursor !== data.length) {
+    throw new Error("Didn't reach the end of the message");
+  }
+
+  return { vaa, updates };
+}

price_service/sdk/js/src/__tests__/AccumulatorUpdateData.test.ts

@@ -0,0 +1,21 @@
+import { parseAccumulatorUpdateData } from "../AccumulatorUpdateData";
+
+// This is just a sample update data from hermes
+const TEST_ACCUMULATOR_UPDATE_DATA =
+  "UE5BVQEAAAADuAEAAAADDQCRWcud7VE0FQkptV7iZh1Ls8O4dszQ4HmdOZLNDVQiQnMB5Q9jVd52Y9IMI8k1QhOhT2xn82hveqZ6AIn+c6vPAQL4nN+ynbzaJnbGFpWW5ysEA811BblKr+DXO5I5tD3SgEjPmByPIEVPHRqdgnq7M8r6AG4q8qfbmeonROr67i4eAAPVteKrUXD6f13GG/Qj0xHcJ/NuR+xwrbs6KGmYZHq0fHv4m0C3LPIOgVo9iy2ednK5IB/pAEMoaGK/fwoL2ouSAQSulF0XQGZ0J5oFKvCwPBSZOYtITwEQSicnwIWu9a+j7SjMh/zF4vtqWFAqfkFatVMZI6/dkQkmwlcMkEkGHvN5AQZYiYD8teZVpmCzn9jxZo/qTF4qrWgrHWv3/i4kZsXmkDSq1QTiYd7ikQQVWVxgH3PKl03SPFvqoc7SmwKIZKyyAQjfPTwpqeTTi0zFRyyb9HKMYjcbXEcuRXn7uOaNF83ry1s+cudCcWsiaCNYEPzv1BvHxgYYXcx2MkNxUbXiLlmoAQpQSpOkNb9780k2EsrUjZd/ieD+sTQA6P0iZWL5jA8ONEi46mAufCfRlAO2a5jfUvjuN4Z/ZOklgT9eZ7v3JoleAAv/2wkZ5rQx+cl/jlL9k6rbzrDU8sYLTJnlFTsuOr66/iVUqCe0Clwv682NgvH8yLbtw9He/vdn3OeLn19eDU0qAQxk47DIhc9EAtNrdhFSyAoEBtQtgcxRvSnjIIMPTGIhIzv52WFY/I2CwyKcQLhERdjjfh7EhZvBUXHTFRk2xjc2AA3wNaGbjUXsJqL8VyBQg7t0dILbUQ8AiOZJQVfx+L+1mFVZAc4v8/0BWsIF5b7+YmoN6psArWCvZcd9Hkjuxda4AQ5Rxgs32U2Jm43W4voTk42MibgvPMas3xQbuCW88pH1skdSTfvtgoIOa6BdoS3YEUJu78a0X3AiIUem1fDOdOs7AA/lHyqNz4vwuTNs8U6G51VqO2g1yEJyRwrMqsjEvK9VC0EjieacqPBwPL9/DMssbHU01bL+YzEY5XTxi1QiBeyFABJuE+6jHgEh9WvwaPDZe7me9sl5EiPDUxAAryErsB0LDTrnzls7qgDymCp+MSJur8U4I08ul/mL1rVesK3uUqqtAGV20Z0AAAAAABrhAfrtrFhR4yubI7X5QRqMK6xKrj7U3XuBHdGnLqSqcQAAAAAB1IYyAUFVV1YAAAAAAAbbm1gAACcQralfDHbB9c321F6ngWz+RspcmdsBAFUAyWRY05P+net6fWOgrEHiiYpnp3UNvRZmcyeeBsho3woAAAAAAFEIJAAAAAAAAAxT////+AAAAABldtGcAAAAAGV20ZsAAAAAAFEWJQAAAAAAAAu6CqMvc3++cZquwewCu6kJe8aPB1SFPI41uwi10MgNwqRbCue30EvorUjF4mKpFB+Cwx8KH5bFnAAX13DPmu7OCbX7k0LdKtr9pb8zPVsXwlx+BteFyBWNtJmeLIx7tG88H2uARL/B+MJw2GcVujs6qdnIQkIjjBdDIR3XRtY2zMfK58eeXuiAkJDHIQ3H41GmYRAVe8FtPvtMWTY51Q63Tkmfq60qsB1yy4Srd5QI/x60eBnOlAYC67+gjB0sGHLrjSapbXzGUf//";
+
+describe("Test parse accumulator update", () => {
+  test("Happy path", async () => {
+    parseAccumulatorUpdateData(
+      Buffer.from(TEST_ACCUMULATOR_UPDATE_DATA, "base64")
+    );
+  });
+
+  test("Wrong magic number", async () => {
+    const data = Buffer.from(TEST_ACCUMULATOR_UPDATE_DATA, "base64");
+    data[0] = 0;
+    expect(() => parseAccumulatorUpdateData(data)).toThrow(
+      "Invalid accumulator message"
+    );
+  });
+});

price_service/sdk/js/src/index.ts

@@ -1,3 +1,4 @@
+import { isAccumulatorUpdateData } from "./AccumulatorUpdateData";
 import {
   Convert,
   Price as JsonPrice,
@@ -9,6 +10,12 @@ export type UnixTimestamp = number;
 export type DurationInSeconds = number;
 export type HexString = string;
 
+export {
+  isAccumulatorUpdateData,
+  parseAccumulatorUpdateData,
+  AccumulatorUpdateData,
+} from "./AccumulatorUpdateData";
+
 /**
  * A Pyth Price represented as `${price} ± ${conf} * 10^${expo}` published at `publishTime`.
  */

target_chains/sui/sdk/js/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pythnetwork/pyth-sui-js",
-  "version": "1.2.4",
+  "version": "1.2.5",
   "description": "Pyth Network Sui Utilities",
   "homepage": "https://pyth.network",
   "author": {

target_chains/sui/sdk/js/src/client.ts

@@ -5,7 +5,11 @@ import {
   SUI_CLOCK_OBJECT_ID,
   TransactionBlock,
 } from "@mysten/sui.js";
-import { HexString } from "@pythnetwork/price-service-client";
+import {
+  HexString,
+  isAccumulatorUpdateData,
+  parseAccumulatorUpdateData,
+} from "@pythnetwork/price-service-client";
 import { Buffer } from "buffer";
 
 const MAX_ARGUMENT_SIZE = 16 * 1024;
@@ -115,13 +119,13 @@ export class SuiPythClient {
     const packageId = await this.getPythPackageId();
 
     let priceUpdatesHotPotato;
-    if (updates.every((update) => this.isAccumulatorMsg(update))) {
+    if (updates.every((update) => isAccumulatorUpdateData(update))) {
       if (updates.length > 1) {
         throw new Error(
           "SDK does not support sending multiple accumulator messages in a single transaction"
         );
       }
-      const vaa = this.extractVaaBytesFromAccumulatorMessage(updates[0]);
+      const vaa = parseAccumulatorUpdateData(updates[0]).vaa;
       const verifiedVaas = await this.verifyVaas([vaa], tx);
       [priceUpdatesHotPotato] = tx.moveCall({
         target: `${packageId}::pyth::create_authenticated_price_infos_using_accumulator`,
@@ -138,7 +142,7 @@ export class SuiPythClient {
           tx.object(SUI_CLOCK_OBJECT_ID),
         ],
       });
-    } else if (updates.every((vaa) => !this.isAccumulatorMsg(vaa))) {
+    } else if (updates.every((vaa) => !isAccumulatorUpdateData(vaa))) {
       const verifiedVaas = await this.verifyVaas(updates, tx);
       [priceUpdatesHotPotato] = tx.moveCall({
         target: `${packageId}::pyth::create_price_infos_hot_potato`,
@@ -192,13 +196,13 @@ export class SuiPythClient {
   async createPriceFeed(tx: TransactionBlock, updates: Buffer[]) {
     const wormholePackageId = await this.getWormholePackageId();
     const packageId = await this.getPythPackageId();
-    if (updates.every((update) => this.isAccumulatorMsg(update))) {
+    if (updates.every((update) => isAccumulatorUpdateData(update))) {
       if (updates.length > 1) {
         throw new Error(
           "SDK does not support sending multiple accumulator messages in a single transaction"
         );
       }
-      const vaa = this.extractVaaBytesFromAccumulatorMessage(updates[0]);
+      const vaa = parseAccumulatorUpdateData(updates[0]).vaa;
       const verifiedVaas = await this.verifyVaas([vaa], tx);
       tx.moveCall({
         target: `${packageId}::pyth::create_price_feeds_using_accumulator`,
@@ -215,7 +219,7 @@ export class SuiPythClient {
           tx.object(SUI_CLOCK_OBJECT_ID),
         ],
       });
-    } else if (updates.every((vaa) => !this.isAccumulatorMsg(vaa))) {
+    } else if (updates.every((vaa) => !isAccumulatorUpdateData(vaa))) {
       const verifiedVaas = await this.verifyVaas(updates, tx);
       tx.moveCall({
         target: `${packageId}::pyth::create_price_feeds`,
@@ -311,34 +315,4 @@ export class SuiPythClient {
     }
     return this.priceTableInfo;
   }
-
-  /**
-   * Checks if a message is an accumulator message or not
-   * @param msg - update message from price service
-   */
-  isAccumulatorMsg(msg: Buffer) {
-    const ACCUMULATOR_MAGIC = "504e4155";
-    return msg.toString("hex").slice(0, 8) === ACCUMULATOR_MAGIC;
-  }
-
-  /**
-   * Obtains the vaa bytes embedded in an accumulator message.
-   * @param accumulatorMessage - the accumulator price update message
-   * @returns vaa bytes as a uint8 array
-   */
-  extractVaaBytesFromAccumulatorMessage(accumulatorMessage: Buffer): Buffer {
-    if (!this.isAccumulatorMsg(accumulatorMessage)) {
-      throw new Error("Not an accumulator message");
-    }
-    // the first 6 bytes in the accumulator message encode the header, major, and minor bytes
-    // we ignore them, since we are only interested in the VAA bytes
-    const trailingPayloadSize = accumulatorMessage.readUint8(6);
-    const vaaSizeOffset =
-      7 + // header bytes (header(4) + major(1) + minor(1) + trailing payload size(1))
-      trailingPayloadSize + // trailing payload (variable number of bytes)
-      1; // proof_type (1 byte)
-    const vaaSize = accumulatorMessage.readUint16BE(vaaSizeOffset);
-    const vaaOffset = vaaSizeOffset + 2;
-    return accumulatorMessage.subarray(vaaOffset, vaaOffset + vaaSize);
-  }
 }