@pythnetwork/pyth-lazer-sui-js 0.1.2 → 0.3.0

package/README.md

@@ -20,16 +20,22 @@ A runnable example is provided at `examples/FetchAndVerifyUpdate.ts`. It:
 
 ### Run the example
 
-Install `tsx` to run TypeScript scripts:
-
 ```sh
-npm install -g tsx
-```
+# Your Sui private key in Bech32 format
+# SUI_KEY=
 
-Execute the example script:
+# Lazer contract state ID
+# STATE_ID=
 
-```sh
-SUI_KEY=<YOUR_SUI_PRIVATE_KEY> pnpm -F @pythnetwork/pyth-lazer-sui-js example:fetch-and-verify --fullnodeUrl <SUI_FULLNODE_URL> --packageId <PYTH_LAZER_PACKAGE_ID> --stateObjectId <PYTH_LAZER_STATE_OBJECT_ID> --token <LAZER_TOKEN>
+# Your Lazer API token
+# LAZER_TOKEN=
+
+SUI_FULLNODE_URL="https://fullnode.mainnet.sui.io:443"
+
+pnpm run example:fetch-and-verify \
+  --fullnode-url "$SUI_FULLNODE_URL" \
+  --state-id "$STATE_ID" \
+  --lazer-token "$LAZER_TOKEN"
 ```
 
 The script's core logic is summarized below:
@@ -37,38 +43,40 @@ The script's core logic is summarized below:
 ```ts
 import { SuiClient } from "@mysten/sui/client";
 import { Transaction } from "@mysten/sui/transactions";
-import { SuiLazerClient } from "@pythnetwork/pyth-lazer-sui-js";
-
-// Prepare Mysten Sui client
-const provider = new SuiClient({ url: "<sui-fullnode-url>" });
-
-// Create SDK client
-const client = new SuiLazerClient(provider);
-
-// Obtain a Lazer leEcdsa payload using @pythnetwork/pyth-lazer-sdk.
-// See examples/FetchAndVerifyUpdate.ts for a runnable end-to-end example.
-const leEcdsa: Buffer = /* fetch via @pythnetwork/pyth-lazer-sdk */ Buffer.from(
-  [],
-);
+import { PythLazerClient } from "@pythnetwork/pyth-lazer-sdk";
+import { addParseAndVerifyLeEcdsaUpdateCall } from "@pythnetwork/pyth-lazer-sui-js";
+
+// 1. Fetch the price update from Pyth Lazer in "leEcdsa" format:
+const lazer = await PythLazerClient.create({ token: lazerToken });
+const latestPrice = await lazer.getLatestPrice({
+  priceFeedIds: [1],
+  properties: ["price", "bestBidPrice", "bestAskPrice", "exponent"],
+  formats: ["leEcdsa"],
+  channel: "fixed_rate@200ms",
+  jsonBinaryEncoding: "hex",
+});
+const update = Buffer.from(latestPrice.leEcdsa?.data ?? "", "hex");
 
-// Build transaction calling parse_and_verify_le_ecdsa_update
+// 2. Create a new Sui transaction:
+const client = new SuiClient({ url: fullnodeUrl });
 const tx = new Transaction();
-const packageId = "<pyth_lazer_package_id>";
-const stateObjectId = "<pyth_lazer_state_object_id>";
 
-const updateVal = client.addParseAndVerifyLeEcdsaUpdateCall({
+// 3. Add the parse and verify call:
+const verifiedUpdate = await addParseAndVerifyLeEcdsaUpdateCall({
+  client,
   tx,
-  packageId,
-  stateObjectId,
-  updateBytes: leEcdsa,
+  stateObjectId: stateId,
+  update,
 });
 
-// Sign and execute the transaction using your signer.
-```
-
-## Notes
+// 4. Consume `verifiedUpdate` in your own contract with additional calls...
 
-- FIXME: Automatic `packageId` management is coming soon. The Lazer contract doesn't support upgradeability yet.
+// 5. Sign and execute the transaction:
+const result = await client.signAndExecuteTransaction({
+  transaction: tx,
+  signer,
+});
+```
 
 ## References
 

package/dist/cjs/index.cjs

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "addParseAndVerifyLeEcdsaUpdateCall", {
+    enumerable: true,
+    get: function() {
+        return addParseAndVerifyLeEcdsaUpdateCall;
+    }
+});
+async function addParseAndVerifyLeEcdsaUpdateCall(opts) {
+    const { client, tx, stateObjectId, update } = opts;
+    const latestPackageId = await getLatestPackageId(client, stateObjectId);
+    return tx.moveCall({
+        target: `${latestPackageId}::pyth_lazer::parse_and_verify_le_ecdsa_update`,
+        arguments: [
+            tx.object(stateObjectId),
+            tx.object.clock(),
+            tx.pure.vector("u8", update)
+        ]
+    });
+}
+async function getLatestPackageId(client, stateObjectId) {
+    const { data: stateObject, error } = await client.getObject({
+        id: stateObjectId,
+        options: {
+            showContent: true
+        }
+    });
+    if (!stateObject?.content || error) {
+        throw new Error(`Failed to get Sui Lazer State: ${error?.code ?? "undefined"}`);
+    }
+    if (stateObject.content.dataType !== "moveObject") {
+        throw new Error(`Sui Lazer State must be an object, got: ${stateObject.content.dataType}`);
+    }
+    const state = stateObject.content;
+    if (!hasStructField(state, "upgrade_cap")) {
+        throw new Error("Missing 'upgrade_cap' in Sui Lazer State");
+    }
+    const upgradeCap = state.fields.upgrade_cap;
+    if (!hasStructField(upgradeCap, "package") || typeof upgradeCap.fields.package !== "string") {
+        throw new Error("Could not find 'package' string in Sui Lazer UpgradeCap");
+    }
+    return upgradeCap.fields.package;
+}
+function hasStructField(value, name) {
+    return hasProperty(value, "fields") && hasProperty(value.fields, name);
+}
+function hasProperty(value, name) {
+    return typeof value === "object" && !!value && name in value;
+}

package/dist/cjs/index.d.ts

@@ -0,0 +1,8 @@
+import type { SuiClient } from "@mysten/sui/client";
+import { Transaction } from "@mysten/sui/transactions";
+export declare function addParseAndVerifyLeEcdsaUpdateCall(opts: {
+    client: SuiClient;
+    tx: Transaction;
+    stateObjectId: string;
+    update: Uint8Array;
+}): Promise<import("@mysten/sui/transactions").TransactionResult>;

package/dist/cjs/package.json

@@ -1 +1 @@
-{"type":"commonjs"}
+{ "type": "commonjs" }

package/dist/esm/index.d.ts

@@ -0,0 +1,8 @@
+import type { SuiClient } from "@mysten/sui/client";
+import { Transaction } from "@mysten/sui/transactions";
+export declare function addParseAndVerifyLeEcdsaUpdateCall(opts: {
+    client: SuiClient;
+    tx: Transaction;
+    stateObjectId: string;
+    update: Uint8Array;
+}): Promise<import("@mysten/sui/transactions").TransactionResult>;

package/dist/esm/index.mjs

@@ -0,0 +1,41 @@
+export async function addParseAndVerifyLeEcdsaUpdateCall(opts) {
+    const { client, tx, stateObjectId, update } = opts;
+    const latestPackageId = await getLatestPackageId(client, stateObjectId);
+    return tx.moveCall({
+        target: `${latestPackageId}::pyth_lazer::parse_and_verify_le_ecdsa_update`,
+        arguments: [
+            tx.object(stateObjectId),
+            tx.object.clock(),
+            tx.pure.vector("u8", update)
+        ]
+    });
+}
+async function getLatestPackageId(client, stateObjectId) {
+    const { data: stateObject, error } = await client.getObject({
+        id: stateObjectId,
+        options: {
+            showContent: true
+        }
+    });
+    if (!stateObject?.content || error) {
+        throw new Error(`Failed to get Sui Lazer State: ${error?.code ?? "undefined"}`);
+    }
+    if (stateObject.content.dataType !== "moveObject") {
+        throw new Error(`Sui Lazer State must be an object, got: ${stateObject.content.dataType}`);
+    }
+    const state = stateObject.content;
+    if (!hasStructField(state, "upgrade_cap")) {
+        throw new Error("Missing 'upgrade_cap' in Sui Lazer State");
+    }
+    const upgradeCap = state.fields.upgrade_cap;
+    if (!hasStructField(upgradeCap, "package") || typeof upgradeCap.fields.package !== "string") {
+        throw new Error("Could not find 'package' string in Sui Lazer UpgradeCap");
+    }
+    return upgradeCap.fields.package;
+}
+function hasStructField(value, name) {
+    return hasProperty(value, "fields") && hasProperty(value.fields, name);
+}
+function hasProperty(value, name) {
+    return typeof value === "object" && !!value && name in value;
+}

package/dist/esm/package.json

@@ -1 +1 @@
-{"type":"module"}
+{ "type": "module" }

package/package.json

@@ -1,53 +1,67 @@
 {
   "name": "@pythnetwork/pyth-lazer-sui-js",
-  "version": "0.1.2",
+  "version": "0.3.0",
   "description": "TypeScript SDK for the Pyth Lazer Sui contract",
   "license": "Apache-2.0",
   "type": "module",
-  "engines": {
-    "node": "22"
-  },
   "files": [
-    "dist"
+    "dist/**"
   ],
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./dist/esm/client.d.ts",
-        "default": "./dist/esm/client.js"
-      },
-      "require": {
-        "types": "./dist/cjs/client.d.ts",
-        "default": "./dist/cjs/client.js"
-      }
-    }
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pyth-network/pyth-crosschain",
+    "directory": "lazer/contracts/pyth-lazer-sui-js"
   },
-  "sideEffects": false,
-  "dependencies": {
-    "@mysten/sui": "^1.3.0",
-    "@types/yargs": "^17.0.33",
-    "yargs": "^18.0.0",
-    "@pythnetwork/pyth-lazer-sdk": "4.0.0"
+  "engines": {
+    "node": "^24.0.0"
   },
+  "sideEffects": false,
   "devDependencies": {
     "@cprussin/eslint-config": "^4.0.2",
+    "@cprussin/prettier-config": "^2.2.2",
     "@cprussin/tsconfig": "^3.1.2",
+    "@pythnetwork/jest-config": "",
+    "@types/jest": "^29.5.14",
     "@types/node": "^22.14.0",
+    "@types/yargs": "^17.0.33",
     "eslint": "^9.23.0",
-    "prettier": "^3.5.3",
-    "typescript": "^5.8.2"
+    "jest": "^29.7.0",
+    "tsx": "4.20.6",
+    "yargs": "^18.0.0",
+    "@pythnetwork/pyth-lazer-sdk": "5.2.1"
+  },
+  "dependencies": {
+    "@mysten/sui": "^1.3.0"
   },
+  "private": false,
   "publishConfig": {
     "access": "public"
   },
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.cjs"
+      },
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.mjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "module": "./dist/esm/index.mjs",
+  "types": "./dist/cjs/index.d.ts",
+  "main": "./dist/cjs/index.cjs",
   "scripts": {
-    "build:cjs": "tsc --project tsconfig.build.json --verbatimModuleSyntax false --module commonjs --outDir ./dist/cjs && echo '{\"type\":\"commonjs\"}' > dist/cjs/package.json",
-    "build:esm": "tsc --project tsconfig.build.json --outDir ./dist/esm && echo '{\"type\":\"module\"}' > dist/esm/package.json",
+    "build": "ts-duality --copyOtherFiles",
+    "clean": "rm -rf ./dist",
+    "fix:lint": "eslint --fix . --max-warnings 0",
     "fix:format": "prettier --write .",
-    "fix:lint": "eslint --fix .",
-    "test:format": "prettier --check .",
     "test:lint": "eslint . --max-warnings 0",
+    "test:format": "prettier --check .",
     "test:types": "tsc",
-    "example:fetch-and-verify": "tsx examples/fetch-and-verify-update.ts"
+    "test:unit": "test-unit",
+    "example:fetch-and-verify": "tsx src/examples/fetch-and-verify.ts"
   }
 }

package/dist/cjs/examples/fetch-and-verify-update.d.ts

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

package/dist/cjs/examples/fetch-and-verify-update.js

@@ -1,91 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const client_1 = require("@mysten/sui/client");
-const ed25519_1 = require("@mysten/sui/keypairs/ed25519");
-const transactions_1 = require("@mysten/sui/transactions");
-const pyth_lazer_sdk_1 = require("@pythnetwork/pyth-lazer-sdk");
-const yargs_1 = __importDefault(require("yargs"));
-const helpers_1 = require("yargs/helpers");
-const client_js_1 = require("../src/client.js");
-async function getOneLeEcdsaUpdate(token) {
-    const lazer = await pyth_lazer_sdk_1.PythLazerClient.create({
-        token,
-    });
-    const latestPrice = await lazer.getLatestPrice({
-        priceFeedIds: [1],
-        properties: ["price", "bestBidPrice", "bestAskPrice", "exponent"],
-        formats: ["leEcdsa"],
-        channel: "fixed_rate@200ms",
-        jsonBinaryEncoding: "hex",
-    });
-    return latestPrice;
-}
-async function main() {
-    const args = await (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
-        .option("fullnodeUrl", {
-        type: "string",
-        description: "URL of the full Sui node RPC endpoint. e.g: https://fullnode.testnet.sui.io:443",
-        demandOption: true,
-    })
-        .option("packageId", {
-        type: "string",
-        description: "Lazer contract package ID",
-        demandOption: true,
-    })
-        .option("stateObjectId", {
-        type: "string",
-        description: "Lazer contract shared State object ID",
-        demandOption: true,
-    })
-        .option("lazerUrls", {
-        type: "array",
-        string: true,
-        description: "Lazer WebSocket URLs",
-        default: [
-            "wss://pyth-lazer-0.dourolabs.app/v1/stream",
-            "wss://pyth-lazer-1.dourolabs.app/v1/stream",
-        ],
-    })
-        .option("lazerToken", {
-        type: "string",
-        description: "Lazer authentication token",
-        demandOption: true,
-    })
-        .help()
-        .parseAsync();
-    // Defined as a dependency in turbo.json
-    // eslint-disable-next-line n/no-process-env
-    if (process.env.SUI_KEY === undefined) {
-        throw new Error(`SUI_KEY environment variable should be set to your Sui private key in hex format.`);
-    }
-    const provider = new client_1.SuiClient({ url: args.fullnodeUrl });
-    // Fetch the price update
-    const update = await getOneLeEcdsaUpdate(args.lazerToken);
-    // Build the Sui transaction
-    const tx = new transactions_1.Transaction();
-    // Add the parse and verify call
-    (0, client_js_1.addParseAndVerifyLeEcdsaUpdateCall)({
-        tx,
-        packageId: args.packageId,
-        stateObjectId: args.stateObjectId,
-        updateBytes: Buffer.from(update.leEcdsa?.data ?? "", "hex"),
-    });
-    // --- You can add more calls to the transaction that consume the parsed update here ---
-    const wallet = ed25519_1.Ed25519Keypair.fromSecretKey(
-    // eslint-disable-next-line n/no-process-env
-    Buffer.from(process.env.SUI_KEY, "hex"));
-    const res = await provider.signAndExecuteTransaction({
-        signer: wallet,
-        transaction: tx,
-        options: { showEffects: true, showEvents: true },
-    });
-    // eslint-disable-next-line no-console
-    console.log("Execution result:", JSON.stringify(res, undefined, 2));
-}
-// eslint-disable-next-line unicorn/prefer-top-level-await
-main().catch((error) => {
-    throw error;
-});

package/dist/cjs/src/client.d.ts

@@ -1,10 +0,0 @@
-import { Transaction } from "@mysten/sui/transactions";
-export declare function addParseAndVerifyLeEcdsaUpdateCall({ tx, packageId, stateObjectId, updateBytes, }: {
-    tx: Transaction;
-    packageId: string;
-    stateObjectId: string;
-    updateBytes: Uint8Array;
-}): {
-    $kind: "NestedResult";
-    NestedResult: [number, number];
-} | undefined;

package/dist/cjs/src/client.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.addParseAndVerifyLeEcdsaUpdateCall = addParseAndVerifyLeEcdsaUpdateCall;
-const bcs_1 = require("@mysten/sui/bcs");
-const utils_1 = require("@mysten/sui/utils");
-function addParseAndVerifyLeEcdsaUpdateCall({ tx, packageId, stateObjectId, updateBytes, }) {
-    const [updateObj] = tx.moveCall({
-        target: `${packageId}::pyth_lazer::parse_and_verify_le_ecdsa_update`,
-        arguments: [
-            tx.object(stateObjectId),
-            tx.object(utils_1.SUI_CLOCK_OBJECT_ID),
-            tx.pure(bcs_1.bcs.vector(bcs_1.bcs.U8).serialize(updateBytes).toBytes()),
-        ],
-    });
-    return updateObj;
-}

package/dist/esm/examples/fetch-and-verify-update.d.ts

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

package/dist/esm/examples/fetch-and-verify-update.js

@@ -1,86 +0,0 @@
-import { SuiClient } from "@mysten/sui/client";
-import { Ed25519Keypair } from "@mysten/sui/keypairs/ed25519";
-import { Transaction } from "@mysten/sui/transactions";
-import { PythLazerClient } from "@pythnetwork/pyth-lazer-sdk";
-import yargs from "yargs";
-import { hideBin } from "yargs/helpers";
-import { addParseAndVerifyLeEcdsaUpdateCall } from "../src/client.js";
-async function getOneLeEcdsaUpdate(token) {
-    const lazer = await PythLazerClient.create({
-        token,
-    });
-    const latestPrice = await lazer.getLatestPrice({
-        priceFeedIds: [1],
-        properties: ["price", "bestBidPrice", "bestAskPrice", "exponent"],
-        formats: ["leEcdsa"],
-        channel: "fixed_rate@200ms",
-        jsonBinaryEncoding: "hex",
-    });
-    return latestPrice;
-}
-async function main() {
-    const args = await yargs(hideBin(process.argv))
-        .option("fullnodeUrl", {
-        type: "string",
-        description: "URL of the full Sui node RPC endpoint. e.g: https://fullnode.testnet.sui.io:443",
-        demandOption: true,
-    })
-        .option("packageId", {
-        type: "string",
-        description: "Lazer contract package ID",
-        demandOption: true,
-    })
-        .option("stateObjectId", {
-        type: "string",
-        description: "Lazer contract shared State object ID",
-        demandOption: true,
-    })
-        .option("lazerUrls", {
-        type: "array",
-        string: true,
-        description: "Lazer WebSocket URLs",
-        default: [
-            "wss://pyth-lazer-0.dourolabs.app/v1/stream",
-            "wss://pyth-lazer-1.dourolabs.app/v1/stream",
-        ],
-    })
-        .option("lazerToken", {
-        type: "string",
-        description: "Lazer authentication token",
-        demandOption: true,
-    })
-        .help()
-        .parseAsync();
-    // Defined as a dependency in turbo.json
-    // eslint-disable-next-line n/no-process-env
-    if (process.env.SUI_KEY === undefined) {
-        throw new Error(`SUI_KEY environment variable should be set to your Sui private key in hex format.`);
-    }
-    const provider = new SuiClient({ url: args.fullnodeUrl });
-    // Fetch the price update
-    const update = await getOneLeEcdsaUpdate(args.lazerToken);
-    // Build the Sui transaction
-    const tx = new Transaction();
-    // Add the parse and verify call
-    addParseAndVerifyLeEcdsaUpdateCall({
-        tx,
-        packageId: args.packageId,
-        stateObjectId: args.stateObjectId,
-        updateBytes: Buffer.from(update.leEcdsa?.data ?? "", "hex"),
-    });
-    // --- You can add more calls to the transaction that consume the parsed update here ---
-    const wallet = Ed25519Keypair.fromSecretKey(
-    // eslint-disable-next-line n/no-process-env
-    Buffer.from(process.env.SUI_KEY, "hex"));
-    const res = await provider.signAndExecuteTransaction({
-        signer: wallet,
-        transaction: tx,
-        options: { showEffects: true, showEvents: true },
-    });
-    // eslint-disable-next-line no-console
-    console.log("Execution result:", JSON.stringify(res, undefined, 2));
-}
-// eslint-disable-next-line unicorn/prefer-top-level-await
-main().catch((error) => {
-    throw error;
-});

package/dist/esm/src/client.d.ts

@@ -1,10 +0,0 @@
-import { Transaction } from "@mysten/sui/transactions";
-export declare function addParseAndVerifyLeEcdsaUpdateCall({ tx, packageId, stateObjectId, updateBytes, }: {
-    tx: Transaction;
-    packageId: string;
-    stateObjectId: string;
-    updateBytes: Uint8Array;
-}): {
-    $kind: "NestedResult";
-    NestedResult: [number, number];
-} | undefined;

package/dist/esm/src/client.js

@@ -1,14 +0,0 @@
-import { bcs } from "@mysten/sui/bcs";
-import { Transaction } from "@mysten/sui/transactions";
-import { SUI_CLOCK_OBJECT_ID } from "@mysten/sui/utils";
-export function addParseAndVerifyLeEcdsaUpdateCall({ tx, packageId, stateObjectId, updateBytes, }) {
-    const [updateObj] = tx.moveCall({
-        target: `${packageId}::pyth_lazer::parse_and_verify_le_ecdsa_update`,
-        arguments: [
-            tx.object(stateObjectId),
-            tx.object(SUI_CLOCK_OBJECT_ID),
-            tx.pure(bcs.vector(bcs.U8).serialize(updateBytes).toBytes()),
-        ],
-    });
-    return updateObj;
-}