@pythnetwork/pyth-sui-js 2.1.0 → 2.2.0

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2024 Pyth Data Association.
+Copyright 2025 Pyth Data Association.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

package/README.md

@@ -4,16 +4,11 @@
 
 ## Installation
 
-### npm
+### pnpm
 
 ```
-$ npm install --save @pythnetwork/pyth-sui-js
-```
-
-### Yarn
-
-```
-$ yarn add @pythnetwork/pyth-sui-js
+cd to crosschain root
+$ pnpm install
 ```
 
 ## Quickstart
@@ -27,7 +22,7 @@ Pyth prices and submit them to the network:
 
 ```typescript
 const connection = new SuiPriceServiceConnection(
-  "https://hermes-beta.pyth.network"
+  "https://hermes-beta.pyth.network",
 ); // See Hermes endpoints section below for other endpoints
 
 const priceIds = [
@@ -103,12 +98,15 @@ Now in your contract you can consume the price by calling `pyth::get_price` or o
 1. Fetches update data from Hermes for the given price feeds.
 2. Calls the Pyth Sui contract with the update data.
 
-You can run this example with `npm run example-relay`. A full command that updates prices on Sui testnet looks like:
+In order to run the commands, a SUI private key is needed. The commands expects the key to be in the form of hex. You can use `sui keytool convert` to get the hex version of the key, to be used below, if your private key is in the form "suiprivkey...".
+
+You can run this example with `pnpm turbo --filter @pythnetwork/pyth-sui-js run example-relay` from the root of crosschain. Turbo will automatically build any detected dependencies including local ones, and filter is needed to tell it which sub-package to use (Such as this one). A full command that updates prices on Sui testnet looks like:
 
 ```bash
 export SUI_KEY=YOUR_PRIV_KEY;
-npm run example-relay -- --feed-id "5a035d5440f5c163069af66062bac6c79377bf88396fa27e6067bfca8096d280" \
---price-service "https://hermes-beta.pyth.network" \
+pnpm turbo run example-relay --filter @pythnetwork/pyth-sui-js -- \
+--feed-id "5a035d5440f5c163069af66062bac6c79377bf88396fa27e6067bfca8096d280" \
+--hermes "https://hermes-beta.pyth.network" \
 --full-node "https://fullnode.testnet.sui.io:443" \
 --pyth-state-id "0xd3e79c2c083b934e78b3bd58a490ec6b092561954da6e7322e1e2b3c8abfddc0" \
 --wormhole-state-id "0x31358d198147da50db32eda2562951d53973a0c0ad5ed738e9b17d88b213d790"
@@ -139,7 +137,7 @@ This method is useful if you want to show continuously updating real-time prices
 // gets a price update.
 connection.subscribePriceFeedUpdates(priceIds, (priceFeed) => {
   console.log(
-    `Received update for ${priceFeed.id}: ${priceFeed.getPriceNoOlderThan(60)}`
+    `Received update for ${priceFeed.id}: ${priceFeed.getPriceNoOlderThan(60)}`,
   );
 });
 

package/lib/SuiPriceServiceConnection.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { PriceServiceConnection, HexString } from "@pythnetwork/price-service-client";
 import { Buffer } from "buffer";
 export declare class SuiPriceServiceConnection extends PriceServiceConnection {

package/lib/SuiPriceServiceConnection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SuiPriceServiceConnection.d.ts","sourceRoot":"","sources":["../src/SuiPriceServiceConnection.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,sBAAsB,EACtB,SAAS,EACV,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,qBAAa,yBAA0B,SAAQ,sBAAsB;IACnE;;;;;;;OAOG;IACG,uBAAuB,CAAC,QAAQ,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;CAKxE"}
+{"version":3,"file":"SuiPriceServiceConnection.d.ts","sourceRoot":"","sources":["../src/SuiPriceServiceConnection.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,SAAS,EACV,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,qBAAa,yBAA0B,SAAQ,sBAAsB;IACnE;;;;;;;OAOG;IACG,uBAAuB,CAAC,QAAQ,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;CAKxE"}

package/lib/client.d.ts

@@ -1,8 +1,11 @@
-/// <reference types="node" />
 import { SuiClient } from "@mysten/sui/client";
 import { Transaction } from "@mysten/sui/transactions";
 import { HexString } from "@pythnetwork/price-service-client";
 import { Buffer } from "buffer";
+type NestedTransactionResult = {
+    $kind: "NestedResult";
+    NestedResult: [number, number];
+};
 export type ObjectId = string;
 export declare class SuiPythClient {
     provider: SuiClient;
@@ -31,6 +34,8 @@ export declare class SuiPythClient {
         $kind: "NestedResult";
         NestedResult: [number, number];
     }[]>;
+    verifyVaasAndGetHotPotato(tx: Transaction, updates: Buffer[], packageId: string): Promise<NestedTransactionResult>;
+    executePriceFeedUpdates(tx: Transaction, packageId: string, feedIds: HexString[], priceUpdatesHotPotato: any, coins: NestedTransactionResult[]): Promise<string[]>;
     /**
      * Adds the necessary commands for updating the pyth price feeds to the transaction block.
      * @param tx transaction block to add commands to
@@ -38,6 +43,14 @@ export declare class SuiPythClient {
      * @param feedIds array of feed ids to update (in hex format)
      */
     updatePriceFeeds(tx: Transaction, updates: Buffer[], feedIds: HexString[]): Promise<ObjectId[]>;
+    /**
+     * Updates price feeds using the coin input for payment. Coins can be generated by calling splitCoin on tx.gas.
+     * @param tx transaction block to add commands to
+     * @param updates array of price feed updates received from the price service
+     * @param feedIds array of feed ids to update (in hex format)
+     * @param coins array of Coins for payment of update operations
+     */
+    updatePriceFeedsWithCoins(tx: Transaction, updates: Buffer[], feedIds: HexString[], coins: NestedTransactionResult[]): Promise<ObjectId[]>;
     createPriceFeed(tx: Transaction, updates: Buffer[]): Promise<void>;
     /**
      * Get the packageId for the wormhole package if not already cached
@@ -67,4 +80,5 @@ export declare class SuiPythClient {
      */
     extractVaaBytesFromAccumulatorMessage(accumulatorMessage: Buffer): Buffer;
 }
+export {};
 //# sourceMappingURL=client.d.ts.map

package/lib/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE/C,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC;AAC9D,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAGhC,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B,qBAAa,aAAa;IAOf,QAAQ,EAAE,SAAS;IACnB,WAAW,EAAE,QAAQ;IACrB,eAAe,EAAE,QAAQ;IARlC,OAAO,CAAC,aAAa,CAAuB;IAC5C,OAAO,CAAC,iBAAiB,CAAuB;IAChD,OAAO,CAAC,cAAc,CAAoD;IAC1E,OAAO,CAAC,sBAAsB,CAAuC;IACrE,OAAO,CAAC,aAAa,CAAqB;gBAEjC,QAAQ,EAAE,SAAS,EACnB,WAAW,EAAE,QAAQ,EACrB,eAAe,EAAE,QAAQ;IAM5B,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC;IAoBzC;;;;;OAKG;IACG,YAAY,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IA0BzD;;;;OAIG;IACG,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,WAAW;;;;IAwBhD;;;;;OAKG;IACG,gBAAgB,CACpB,EAAE,EAAE,WAAW,EACf,OAAO,EAAE,MAAM,EAAE,EACjB,OAAO,EAAE,SAAS,EAAE,GACnB,OAAO,CAAC,QAAQ,EAAE,CAAC;IA8DhB,eAAe,CAAC,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,EAAE;IA2BxD;;OAEG;IACG,oBAAoB;IAO1B;;OAEG;IACG,gBAAgB;IAOtB;;;OAGG;IACG,oBAAoB,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;IA6B5E;;;OAGG;IACG,iBAAiB,IAAI,OAAO,CAAC;QAAE,EAAE,EAAE,QAAQ,CAAC;QAAC,SAAS,EAAE,QAAQ,CAAA;KAAE,CAAC;IAwBzE;;;;OAIG;IACH,qCAAqC,CAAC,kBAAkB,EAAE,MAAM,GAAG,MAAM;CAY1E"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE/C,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC;AAC9D,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAGhC,KAAK,uBAAuB,GAAG;IAC7B,KAAK,EAAE,cAAc,CAAC;IACtB,YAAY,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAChC,CAAC;AACF,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B,qBAAa,aAAa;IAOf,QAAQ,EAAE,SAAS;IACnB,WAAW,EAAE,QAAQ;IACrB,eAAe,EAAE,QAAQ;IARlC,OAAO,CAAC,aAAa,CAAuB;IAC5C,OAAO,CAAC,iBAAiB,CAAuB;IAChD,OAAO,CAAC,cAAc,CAAoD;IAC1E,OAAO,CAAC,sBAAsB,CAAuC;IACrE,OAAO,CAAC,aAAa,CAAqB;gBAEjC,QAAQ,EAAE,SAAS,EACnB,WAAW,EAAE,QAAQ,EACrB,eAAe,EAAE,QAAQ;IAM5B,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC;IAoBzC;;;;;OAKG;IACG,YAAY,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IA0BzD;;;;OAIG;IACG,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,WAAW;;;;IAwB1C,yBAAyB,CAC7B,EAAE,EAAE,WAAW,EACf,OAAO,EAAE,MAAM,EAAE,EACjB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,uBAAuB,CAAC;IA2B7B,uBAAuB,CAC3B,EAAE,EAAE,WAAW,EACf,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,SAAS,EAAE,EACpB,qBAAqB,EAAE,GAAG,EAC1B,KAAK,EAAE,uBAAuB,EAAE;IAgClC;;;;;OAKG;IACG,gBAAgB,CACpB,EAAE,EAAE,WAAW,EACf,OAAO,EAAE,MAAM,EAAE,EACjB,OAAO,EAAE,SAAS,EAAE,GACnB,OAAO,CAAC,QAAQ,EAAE,CAAC;IAuBtB;;;;;;OAMG;IACG,yBAAyB,CAC7B,EAAE,EAAE,WAAW,EACf,OAAO,EAAE,MAAM,EAAE,EACjB,OAAO,EAAE,SAAS,EAAE,EACpB,KAAK,EAAE,uBAAuB,EAAE,GAC/B,OAAO,CAAC,QAAQ,EAAE,CAAC;IAiBhB,eAAe,CAAC,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,EAAE;IA2BxD;;OAEG;IACG,oBAAoB;IAO1B;;OAEG;IACG,gBAAgB;IAOtB;;;OAGG;IACG,oBAAoB,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;IA6B5E;;;OAGG;IACG,iBAAiB,IAAI,OAAO,CAAC;QAAE,EAAE,EAAE,QAAQ,CAAC;QAAC,SAAS,EAAE,QAAQ,CAAA;KAAE,CAAC;IAwBzE;;;;OAIG;IACH,qCAAqC,CAAC,kBAAkB,EAAE,MAAM,GAAG,MAAM;CAY1E"}

package/lib/client.js

@@ -91,21 +91,13 @@ class SuiPythClient {
         }
         return verifiedVaas;
     }
-    /**
-     * Adds the necessary commands for updating the pyth price feeds to the transaction block.
-     * @param tx transaction block to add commands to
-     * @param updates array of price feed updates received from the price service
-     * @param feedIds array of feed ids to update (in hex format)
-     */
-    async updatePriceFeeds(tx, updates, feedIds) {
-        const packageId = await this.getPythPackageId();
-        let priceUpdatesHotPotato;
+    async verifyVaasAndGetHotPotato(tx, updates, packageId) {
         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 verifiedVaas = await this.verifyVaas([vaa], tx);
-        [priceUpdatesHotPotato] = tx.moveCall({
+        const [priceUpdatesHotPotato] = tx.moveCall({
             target: `${packageId}::pyth::create_authenticated_price_infos_using_accumulator`,
             arguments: [
                 tx.object(this.pythStateId),
@@ -119,9 +111,10 @@ class SuiPythClient {
                 tx.object(utils_1.SUI_CLOCK_OBJECT_ID),
             ],
         });
+        return priceUpdatesHotPotato;
+    }
+    async executePriceFeedUpdates(tx, packageId, feedIds, priceUpdatesHotPotato, coins) {
         const priceInfoObjects = [];
-        const baseUpdateFee = await this.getBaseUpdateFee();
-        const coins = tx.splitCoins(tx.gas, feedIds.map(() => tx.pure.u64(baseUpdateFee)));
         let coinId = 0;
         for (const feedId of feedIds) {
             const priceInfoObjectId = await this.getPriceFeedObjectId(feedId);
@@ -148,6 +141,31 @@ class SuiPythClient {
         });
         return priceInfoObjects;
     }
+    /**
+     * Adds the necessary commands for updating the pyth price feeds to the transaction block.
+     * @param tx transaction block to add commands to
+     * @param updates array of price feed updates received from the price service
+     * @param feedIds array of feed ids to update (in hex format)
+     */
+    async updatePriceFeeds(tx, updates, feedIds) {
+        const packageId = await this.getPythPackageId();
+        const priceUpdatesHotPotato = await this.verifyVaasAndGetHotPotato(tx, updates, packageId);
+        const baseUpdateFee = await this.getBaseUpdateFee();
+        const coins = tx.splitCoins(tx.gas, feedIds.map(() => tx.pure.u64(baseUpdateFee)));
+        return await this.executePriceFeedUpdates(tx, packageId, feedIds, priceUpdatesHotPotato, coins);
+    }
+    /**
+     * Updates price feeds using the coin input for payment. Coins can be generated by calling splitCoin on tx.gas.
+     * @param tx transaction block to add commands to
+     * @param updates array of price feed updates received from the price service
+     * @param feedIds array of feed ids to update (in hex format)
+     * @param coins array of Coins for payment of update operations
+     */
+    async updatePriceFeedsWithCoins(tx, updates, feedIds, coins) {
+        const packageId = await this.getPythPackageId();
+        const priceUpdatesHotPotato = await this.verifyVaasAndGetHotPotato(tx, updates, packageId);
+        return await this.executePriceFeedUpdates(tx, packageId, feedIds, priceUpdatesHotPotato, coins);
+    }
     async createPriceFeed(tx, updates) {
         const packageId = await this.getPythPackageId();
         if (updates.length > 1) {

package/lib/examples/SuiRelay.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SuiRelay.d.ts","sourceRoot":"","sources":["../../src/examples/SuiRelay.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAqC/C,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,aAEtC"}
+{"version":3,"file":"SuiRelay.d.ts","sourceRoot":"","sources":["../../src/examples/SuiRelay.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAsC/C,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,aAEtC"}

package/lib/examples/SuiRelay.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getProvider = void 0;
+exports.getProvider = getProvider;
 const yargs_1 = __importDefault(require("yargs"));
 const helpers_1 = require("yargs/helpers");
 const client_1 = require("@mysten/sui/client");
@@ -15,6 +15,7 @@ const index_1 = require("../index");
 const argvPromise = (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
     .option("feed-id", {
     description: "Price feed ids to update without the leading 0x (e.g f9c0172ba10dfa4d19088d94f5bf61d3b54d5bd7483a322a982e1373ee8ea31b). Can be provided multiple times for multiple feed updates",
+    string: true,
     type: "array",
     demandOption: true,
 })
@@ -41,7 +42,6 @@ const argvPromise = (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
 function getProvider(url) {
     return new client_1.SuiClient({ url });
 }
-exports.getProvider = getProvider;
 async function run() {
     if (process.env.SUI_KEY === undefined) {
         throw new Error(`SUI_KEY environment variable should be set.`);
@@ -50,6 +50,9 @@ async function run() {
     // Fetch the latest price feed update data from the Price Service
     const connection = new index_1.SuiPriceServiceConnection(argv["hermes"]);
     const feeds = argv["feed-id"];
+    if (!Array.isArray(feeds)) {
+        throw new Error("Not a valid input!");
+    }
     const provider = getProvider(argv["full-node"]);
     const wormholeStateId = argv["wormhole-state-id"];
     const pythStateId = argv["pyth-state-id"];
@@ -57,6 +60,9 @@ async function run() {
     const newFeeds = [];
     const existingFeeds = [];
     for (const feed of feeds) {
+        if (typeof feed !== "string") {
+            throw new Error(`Not a valid string input ${feed}`);
+        }
         if ((await client.getPriceFeedObjectId(feed)) == undefined) {
             newFeeds.push(feed);
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pythnetwork/pyth-sui-js",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Pyth Network Sui Utilities",
   "homepage": "https://pyth.network",
   "author": {
@@ -19,16 +19,6 @@
   "publishConfig": {
     "access": "public"
   },
-  "scripts": {
-    "test": "jest --passWithNoTests",
-    "build": "tsc",
-    "example-relay": "pnpm run build && node lib/examples/SuiRelay.js",
-    "format": "prettier --write \"src/**/*.ts\"",
-    "lint": "eslint src/",
-    "prepublishOnly": "pnpm run build && pnpm test && pnpm run lint",
-    "preversion": "pnpm run lint",
-    "version": "pnpm run format && git add -A src"
-  },
   "keywords": [
     "pyth",
     "oracle",
@@ -46,7 +36,7 @@
     "@typescript-eslint/parser": "^6.0.0",
     "eslint": "^8.14.0",
     "jest": "^29.4.1",
-    "prettier": "^2.6.2",
+    "prettier": "^3.5.3",
     "ts-jest": "^29.0.5",
     "typescript": "^5.3.3",
     "web3": "^1.8.2",
@@ -54,8 +44,17 @@
   },
   "dependencies": {
     "@mysten/sui": "^1.3.0",
-    "@pythnetwork/price-service-client": "1.9.0",
-    "buffer": "^6.0.3"
+    "buffer": "^6.0.3",
+    "@pythnetwork/price-service-client": "1.9.0"
   },
-  "gitHead": "9a31948be215682091abe580a68666909b976462"
-}
+  "scripts": {
+    "build": "tsc",
+    "example-relay": "node lib/examples/SuiRelay.js",
+    "test:lint": "eslint src/ --max-warnings 0",
+    "test:format": "prettier --check \"src/**/*.ts\"",
+    "fix:lint": "eslint src/ --fix --max-warnings 0",
+    "fix:format": "prettier --write \"src/**/*.ts\"",
+    "preversion": "pnpm run test:lint",
+    "version": "pnpm run format && git add -A src"
+  }
+}