@pythnetwork/pyth-ton-js 0.1.0

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2024 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.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,106 @@
+# Pyth Network TON SDK
+
+This SDK provides a JavaScript interface for interacting with the Pyth Network on the TON blockchain.
+
+## Installation
+
+```bash
+npm install @pythnetwork/pyth-ton-js
+```
+
+## Usage
+
+Here's a basic example of how to use the SDK:
+
+```bash
+npm install @pythnetwork/pyth-ton-js @pythnetwork/hermes-client @ton/core @ton/ton @ton/crypto
+```
+
+```typescript
+import { TonClient, Address, WalletContractV4 } from "@ton/ton";
+import { toNano } from "@ton/core";
+import { mnemonicToPrivateKey } from "@ton/crypto";
+import { HermesClient } from "@pythnetwork/hermes-client";
+import {
+  PythContract,
+  PYTH_CONTRACT_ADDRESS_TESTNET,
+} from "@pythnetwork/pyth-ton-js";
+
+const BTC_PRICE_FEED_ID =
+  "0xe62df6c8b4a85fe1a67db44dc12de5db330f7ac66b72dc658afedf0f4a415b43";
+
+async function main() {
+  const client = new TonClient({
+    endpoint: "https://testnet.toncenter.com/api/v2/jsonRPC",
+    apiKey: "your-api-key-here", // Optional, but note that without api-key you need to send requests once per second
+  });
+
+  const contractAddress = Address.parse(PYTH_CONTRACT_ADDRESS_TESTNET);
+  const contract = client.open(PythContract.createFromAddress(contractAddress));
+
+  const guardianSetIndex = await contract.getCurrentGuardianSetIndex();
+  console.log("Guardian Set Index:", guardianSetIndex);
+
+  const price = await contract.getPriceUnsafe(BTC_PRICE_FEED_ID);
+  console.log("BTC Price from TON contract:", price);
+
+  const hermesEndpoint = "https://hermes.pyth.network";
+  const hermesClient = new HermesClient(hermesEndpoint);
+
+  const priceIds = [BTC_PRICE_FEED_ID];
+  const latestPriceUpdates = await hermesClient.getLatestPriceUpdates(
+    priceIds,
+    {
+      encoding: "hex",
+    }
+  );
+  console.log("Hermes BTC price:", latestPriceUpdates.parsed?.[0].price);
+
+  const updateData = Buffer.from(latestPriceUpdates.binary.data[0], "hex");
+  console.log("Update data:", updateData);
+
+  const updateFee = await contract.getUpdateFee(updateData);
+  console.log("Update fee:", updateFee);
+
+  const mnemonic = "your mnemonic here";
+  const key = await mnemonicToPrivateKey(mnemonic.split(" "));
+  const wallet = WalletContractV4.create({
+    publicKey: key.publicKey,
+    workchain: 0,
+  });
+  const provider = client.open(wallet);
+
+  await contract.sendUpdatePriceFeeds(
+    provider.sender(key.secretKey),
+    updateData,
+    156000000n + BigInt(updateFee) // 156000000 = 390000 (estimated gas used for the transaction, this is defined in contracts/common/gas.fc as UPDATE_PRICE_FEEDS_GAS) * 400 (current settings in basechain are as follows: 1 unit of gas costs 400 nanotons)
+  );
+  console.log("Price feeds updated successfully.");
+
+  const updatedPrice = await contract.getPriceUnsafe(BTC_PRICE_FEED_ID);
+  console.log("Updated BTC Price from TON contract:", updatedPrice);
+}
+
+main().catch(console.error);
+```
+
+## API Reference
+
+### `PythContract`
+
+The main class for interacting with the Pyth contract on TON.
+
+#### Methods:
+
+- `getCurrentGuardianSetIndex(provider: ContractProvider): Promise<number>`
+- `getPriceUnsafe(provider: ContractProvider, priceFeedId: string): Promise<PriceInfo>`
+- `getPriceNoOlderThan(provider: ContractProvider, timePeriod: number, priceFeedId: string): Promise<PriceInfo>`
+- `getEmaPriceUnsafe(provider: ContractProvider, priceFeedId: string): Promise<PriceInfo>`
+- `getEmaPriceNoOlderThan(provider: ContractProvider, timePeriod: number, priceFeedId: string): Promise<PriceInfo>`
+- `getUpdateFee(provider: ContractProvider, vm: Buffer): Promise<number>`
+- `getSingleUpdateFee(provider: ContractProvider): Promise<number>`
+- `sendUpdatePriceFeeds(provider: ContractProvider, via: Sender, updateData: Buffer, updateFee: bigint): Promise<void>`
+
+### Constants
+
+- `PYTH_CONTRACT_ADDRESS_TESTNET`: The address of the Pyth contract on the TON testnet.

package/lib/index.d.ts

@@ -0,0 +1,46 @@
+/// <reference types="node" />
+import { Address, Cell, Contract, Sender } from "@ton/core";
+import { ContractProvider } from "@ton/ton";
+export declare const PYTH_CONTRACT_ADDRESS_TESTNET = "EQDwGkJmcj7MMmWAHmhldnY-lAKI6hcTQ2tAEcapmwCnztQU";
+export declare class PythContract implements Contract {
+    readonly address: Address;
+    readonly init?: {
+        code: Cell;
+        data: Cell;
+    } | undefined;
+    constructor(address: Address, init?: {
+        code: Cell;
+        data: Cell;
+    } | undefined);
+    static createFromAddress(address: Address): PythContract;
+    getCurrentGuardianSetIndex(provider: ContractProvider): Promise<number>;
+    sendUpdatePriceFeeds(provider: ContractProvider, via: Sender, updateData: Buffer, updateFee: bigint): Promise<void>;
+    getPriceUnsafe(provider: ContractProvider, priceFeedId: string): Promise<{
+        price: number;
+        conf: number;
+        expo: number;
+        publishTime: number;
+    }>;
+    getPriceNoOlderThan(provider: ContractProvider, timePeriod: number, priceFeedId: string): Promise<{
+        price: number;
+        conf: number;
+        expo: number;
+        publishTime: number;
+    }>;
+    getEmaPriceUnsafe(provider: ContractProvider, priceFeedId: string): Promise<{
+        price: number;
+        conf: number;
+        expo: number;
+        publishTime: number;
+    }>;
+    getEmaPriceNoOlderThan(provider: ContractProvider, timePeriod: number, priceFeedId: string): Promise<{
+        price: number;
+        conf: number;
+        expo: number;
+        publishTime: number;
+    }>;
+    getUpdateFee(provider: ContractProvider, vm: Buffer): Promise<number>;
+    getSingleUpdateFee(provider: ContractProvider): Promise<number>;
+}
+export declare function createCellChain(buffer: Buffer): Cell;
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,OAAO,EAEP,IAAI,EACJ,QAAQ,EACR,MAAM,EAEP,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5C,eAAO,MAAM,6BAA6B,qDACU,CAAC;AAErD,qBAAa,YAAa,YAAW,QAAQ;IAEzC,QAAQ,CAAC,OAAO,EAAE,OAAO;IACzB,QAAQ,CAAC,IAAI,CAAC;cAAU,IAAI;cAAQ,IAAI;;gBAD/B,OAAO,EAAE,OAAO,EAChB,IAAI,CAAC;cAAU,IAAI;cAAQ,IAAI;iBAAE;IAG5C,MAAM,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO;IAInC,0BAA0B,CAAC,QAAQ,EAAE,gBAAgB;IAMrD,oBAAoB,CACxB,QAAQ,EAAE,gBAAgB,EAC1B,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM;IAcb,cAAc,CAAC,QAAQ,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM;;;;;;IAkB9D,mBAAmB,CACvB,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,MAAM;;;;;;IAoBf,iBAAiB,CAAC,QAAQ,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM;;;;;;IAkBjE,sBAAsB,CAC1B,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,MAAM;;;;;;IAoBf,YAAY,CAAC,QAAQ,EAAE,gBAAgB,EAAE,EAAE,EAAE,MAAM;IAQnD,kBAAkB,CAAC,QAAQ,EAAE,gBAAgB;CAKpD;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAsBpD"}

package/lib/index.js

@@ -0,0 +1,135 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createCellChain = exports.PythContract = exports.PYTH_CONTRACT_ADDRESS_TESTNET = void 0;
+const core_1 = require("@ton/core");
+exports.PYTH_CONTRACT_ADDRESS_TESTNET = "EQDwGkJmcj7MMmWAHmhldnY-lAKI6hcTQ2tAEcapmwCnztQU";
+class PythContract {
+    address;
+    init;
+    constructor(address, init) {
+        this.address = address;
+        this.init = init;
+    }
+    static createFromAddress(address) {
+        return new PythContract(address);
+    }
+    async getCurrentGuardianSetIndex(provider) {
+        const result = await provider.get("get_current_guardian_set_index", []);
+        return result.stack.readNumber();
+    }
+    async sendUpdatePriceFeeds(provider, via, updateData, updateFee) {
+        const messageBody = (0, core_1.beginCell)()
+            .storeUint(2, 32) // OP_UPDATE_PRICE_FEEDS
+            .storeRef(createCellChain(updateData))
+            .endCell();
+        await provider.internal(via, {
+            value: updateFee,
+            sendMode: core_1.SendMode.PAY_GAS_SEPARATELY,
+            body: messageBody,
+        });
+    }
+    async getPriceUnsafe(provider, priceFeedId) {
+        const result = await provider.get("get_price_unsafe", [
+            { type: "int", value: BigInt(priceFeedId) },
+        ]);
+        const price = result.stack.readNumber();
+        const conf = result.stack.readNumber();
+        const expo = result.stack.readNumber();
+        const publishTime = result.stack.readNumber();
+        return {
+            price,
+            conf,
+            expo,
+            publishTime,
+        };
+    }
+    async getPriceNoOlderThan(provider, timePeriod, priceFeedId) {
+        const result = await provider.get("get_price_no_older_than", [
+            { type: "int", value: BigInt(timePeriod) },
+            { type: "int", value: BigInt(priceFeedId) },
+        ]);
+        const price = result.stack.readNumber();
+        const conf = result.stack.readNumber();
+        const expo = result.stack.readNumber();
+        const publishTime = result.stack.readNumber();
+        return {
+            price,
+            conf,
+            expo,
+            publishTime,
+        };
+    }
+    async getEmaPriceUnsafe(provider, priceFeedId) {
+        const result = await provider.get("get_ema_price_unsafe", [
+            { type: "int", value: BigInt(priceFeedId) },
+        ]);
+        const price = result.stack.readNumber();
+        const conf = result.stack.readNumber();
+        const expo = result.stack.readNumber();
+        const publishTime = result.stack.readNumber();
+        return {
+            price,
+            conf,
+            expo,
+            publishTime,
+        };
+    }
+    async getEmaPriceNoOlderThan(provider, timePeriod, priceFeedId) {
+        const result = await provider.get("get_ema_price_no_older_than", [
+            { type: "int", value: BigInt(timePeriod) },
+            { type: "int", value: BigInt(priceFeedId) },
+        ]);
+        const price = result.stack.readNumber();
+        const conf = result.stack.readNumber();
+        const expo = result.stack.readNumber();
+        const publishTime = result.stack.readNumber();
+        return {
+            price,
+            conf,
+            expo,
+            publishTime,
+        };
+    }
+    async getUpdateFee(provider, vm) {
+        const result = await provider.get("get_update_fee", [
+            { type: "slice", cell: createCellChain(vm) },
+        ]);
+        return result.stack.readNumber();
+    }
+    async getSingleUpdateFee(provider) {
+        const result = await provider.get("get_single_update_fee", []);
+        return result.stack.readNumber();
+    }
+}
+exports.PythContract = PythContract;
+function createCellChain(buffer) {
+    const chunks = bufferToChunks(buffer, 127);
+    let lastCell = null;
+    // Iterate through chunks in reverse order
+    for (let i = chunks.length - 1; i >= 0; i--) {
+        const chunk = chunks[i];
+        const cellBuilder = (0, core_1.beginCell)();
+        const buffer = Buffer.from(chunk);
+        cellBuilder.storeBuffer(buffer);
+        if (lastCell) {
+            cellBuilder.storeRef(lastCell);
+        }
+        lastCell = cellBuilder.endCell();
+    }
+    // lastCell will be the root cell of our chain
+    if (!lastCell) {
+        throw new Error("Failed to create cell chain");
+    }
+    return lastCell;
+}
+exports.createCellChain = createCellChain;
+function bufferToChunks(buff, chunkSizeBytes = 127) {
+    const chunks = [];
+    const uint8Array = new Uint8Array(buff.buffer, buff.byteOffset, buff.byteLength);
+    for (let offset = 0; offset < uint8Array.length; offset += chunkSizeBytes) {
+        const remainingBytes = Math.min(chunkSizeBytes, uint8Array.length - offset);
+        const chunk = uint8Array.subarray(offset, offset + remainingBytes);
+        chunks.push(chunk);
+    }
+    return chunks;
+}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@pythnetwork/pyth-ton-js",
+  "version": "0.1.0",
+  "description": "Pyth Network TON Utilities",
+  "homepage": "https://pyth.network",
+  "author": {
+    "name": "Pyth Data Association"
+  },
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib/**/*"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pyth-network/pyth-crosschain",
+    "directory": "target_chains/ton/sdk/js"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "test": "jest --passWithNoTests",
+    "build": "tsc",
+    "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"
+  ],
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "@ton/core": "^0.59.0",
+    "@ton/crypto": "^3.3.0",
+    "@ton/ton": "^15.1.0",
+    "@types/node": "^18.11.18",
+    "@typescript-eslint/eslint-plugin": "^5.21.0",
+    "@typescript-eslint/parser": "^5.21.0",
+    "eslint": "^8.14.0",
+    "jest": "^29.4.1",
+    "prettier": "^2.6.2",
+    "ts-jest": "^29.0.5",
+    "ts-node": "^10.9.2",
+    "typescript": "^4.6.3"
+  },
+  "gitHead": "29e5c9bc62a0234819540fccfb509165cd89b6a2"
+}