Pyth Network

https://docs.pyth.network/
Admin
Pyth Network is a global price layer providing decentralized price feeds, ultra-low latency data,...
Tokens:163,671
Snippets:1,506
Trust Score:9.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Pyth SDK for Foundry

Source: https://docs.pyth.network/price-feeds/core/use-real-time-data/pull-integration/evm

Initialize an NPM project and install the SDK for use in Foundry.

```bash
npm init -y
npm install @pythnetwork/pyth-sdk-solidity
```

--------------------------------

### Clone the Examples Repository

Source: https://docs.pyth.network/price-feeds/pro/getting-started

Clone the Pyth examples repository and navigate to the JavaScript SDK directory.

```bash
git clone https://github.com/pyth-network/pyth-examples.git
cd pyth-examples/lazer/js
```

--------------------------------

### Install Entropy SDK

Source: https://docs.pyth.network/SKILL.md

Install the Pyth Network Entropy SDK for Solidity using npm.

```bash
npm install @pythnetwork/entropy-sdk-solidity
```

--------------------------------

### Initialize Project and Install Dependencies

Source: https://docs.pyth.network/entropy/create-your-first-entropy-app

Run these commands in the app directory to set up the project and install the necessary Web3 and Pyth Entropy libraries.

```bash
npm init -y
npm install web3 @pythnetwork/entropy-sdk-solidity
```

--------------------------------

### Install TypeScript SDK packages

Source: https://docs.pyth.network/price-feeds/core/use-real-time-data/pull-integration/solana

Install the necessary packages for fetching prices and submitting them to the Solana blockchain.

```bash
npm install --save @pythnetwork/hermes-client @pythnetwork/pyth-solana-receiver
```

--------------------------------

### Install Pyth IOTA JavaScript SDK

Source: https://docs.pyth.network/price-feeds/core/use-real-time-data/pull-integration/iota

Use these commands to install the JavaScript SDK for constructing transaction blocks that update price feeds.

```bash
# NPM
npm install --save @pythnetwork/pyth-iota-js

# Yarn

yarn add @pythnetwork/pyth-iota-js
```

--------------------------------

### Run Basic WebSocket Example

Source: https://docs.pyth.network/price-feeds/pro/getting-started

Run the basic example to connect to Pyth Pro and receive price updates. The output shows streaming updates printed to the terminal.

```bash
pnpm run start
```

```bash
got message: {
  type: 'json',
  value: {
    type: 'streamUpdated',
    subscriptionId: 1,
    parsed: { timestampUs: '1758034015200000', priceFeeds: [Array] },
    solana: {
      encoding: 'hex',
      data: 'b9011a82036df6ced259a33949ab9b2c48a61a2d3b0b9436cba24c3ef8a600b72767927d14a459fcc3abce280b3f8194e16e8b32f9322ac0b84a9c0b792e19857962a60180efc1f480c5615af3fb673d42287e993da9fbc3506b6e41dfa32950820c2e6c2a0075d3c79300a3fa30ec3e060003020100000001009053802f790a00000200000001004234106d67000000'
    }
  }
}
stream updated for subscription 1 : [
  { priceFeedId: 1, price: '11515604259728' },
  { priceFeedId: 2, price: '444211409986' }
]
got message: {
  type: 'json',
  value: {
    type: 'streamUpdated',
    subscriptionId: 1,
    parsed: { timestampUs: '1758034015400000', priceFeeds: [Array] },
    solana: {
      encoding: 'hex',
      data: 'b9011a826f5ff7e25ac4056c4ec3a08c428baf38e7b78c46014296ccbcfd5395c38c9f7bc23865a048401c66788e791f0edc3a6701b0ea4a5399f50ec8b1795757854f0180efc1f480c5615af3fb673d42287e993da9fbc3506b6e41dfa32950820c2e6c2a0075d3c79340b0fd30ec3e060003020100000001005821a32f790a00000200000001004334106d67000000'
    }
  }
}
stream updated for subscription 1 : [
  { priceFeedId: 1, price: '11515606540632' },
  { priceFeedId: 2, price: '444211409987' }
]
```

--------------------------------

### Install Dependencies

Source: https://docs.pyth.network/price-feeds/pro/getting-started

Install the required dependencies, including @pythnetwork/pyth-lazer-sdk, using pnpm.

```bash
pnpm install
```

--------------------------------

### Install Pyth Lazer Sui SDK

Source: https://docs.pyth.network/price-feeds/pro/integrate-as-consumer/sui

Install the necessary package to handle verification calls.

```bash
npm install @pythnetwork/pyth-lazer-sui-js
```

--------------------------------

### Install Pyth SDKs

Source: https://docs.pyth.network/SKILL.md

Install the necessary Pyth SDK packages for Solidity and Hermes client via npm.

```bash
npm install @pythnetwork/pyth-sdk-solidity @pythnetwork/hermes-client
```

--------------------------------

### Install Pyth SDK for Truffle/Hardhat

Source: https://docs.pyth.network/price-feeds/core/migrate-an-app-to-pyth/chainlink

Install the Pyth Price Feeds Solidity SDK using NPM for Truffle or Hardhat projects.

```bash
npm install @pythnetwork/pyth-sdk-solidity
```

--------------------------------

### Install Pyth SDK and Configure Foundry

Source: https://docs.pyth.network/price-feeds/core/create-your-first-pyth-app/evm/part-1.mdx

Installs the Pyth SDK for Solidity using npm and creates a remappings.txt file to help Foundry locate the SDK.

```bash
npm init -y
npm install @pythnetwork/pyth-sdk-solidity
```

```bash
echo '@pythnetwork/pyth-sdk-solidity/=node_modules/@pythnetwork/pyth-sdk-solidity' > remappings.txt
```

--------------------------------

### Install Pyth Starknet JavaScript SDK

Source: https://docs.pyth.network/price-feeds/core/use-real-time-data/pull-integration/starknet

Use npm to install the Pyth Starknet JavaScript SDK for interacting with Pyth contracts on Starknet.

```bash
npm install --save @pythnetwork/pyth-starknet-js
```

--------------------------------

### Basic requestV2 implementation example

Source: https://docs.pyth.network/entropy/request-callback-variants

Example of requesting randomness using default settings, including fee verification.

```solidity
function requestBasicRandomNumber() external payable {
    // Get the fee for the default provider and gas limit
    uint256 fee = entropy.getFeeV2();

    require(msg.value >= fee, "Insufficient fee");

    // Request randomness with default settings
    uint64 sequenceNumber = entropy.requestV2{value: fee}();
}
```

--------------------------------

### Install Pyth Sui JavaScript SDK

Source: https://docs.pyth.network/price-feeds/core/use-real-time-data/pull-integration/sui

Use NPM or Yarn to install the @pythnetwork/pyth-sui-js package for constructing transaction blocks that update price feeds.

```bash
# NPM
npm install --save @pythnetwork/pyth-sui-js

# Yarn

yarn add @pythnetwork/pyth-sui-js
```

--------------------------------

### History API OHLC Request Example

Source: https://docs.pyth.network/price-feeds/pro/faq

Example GET request for BTC/USD historical data using the fixed_rate@200ms channel.

```text
https://pyth.dourolabs.app/v1/fixed_rate@200ms/history?symbol=Crypto.BTC/USD&from=<start_timestamp>&to=<end_timestamp>&resolution=1D
```

--------------------------------

### Create and enter the project directory

Source: https://docs.pyth.network/entropy/create-your-first-entropy-app

Initialize the project folder structure.

```bash
mkdir coin-flip
cd coin-flip
```

--------------------------------

### Get All Products Response

Source: https://docs.pyth.network/price-feeds/core/publish-data/pyth-client-websocket-api

Example response structure for the `get_all_products` method. It contains a list of products, each with detailed information including price accounts and publisher data.

```json
{
  "jsonrpc": "2.0",
  "result": [
    {
      "account": "5uKdRzB3FzdmwyCHrqSGq4u2URja617jqtKkM71BVrkw",
      "attr_dict": {
        "asset_type": "Crypto",
        "symbol": "BCH/USD",
        "country": "US",
        "quote_currency": "USD",
        "description": "BCH/USD",
        "tenor": "Spot",
        "generic_symbol": "BCHUSD"
      },
      "price_accounts": [
        {
          "account": "5ALDzwcRJfSyGdGyhP3kP628aqBNHZzLuVww7o9kdspe",
          "price_type": "price",
          "price_exponent": -8,
          "status": "trading",
          "price": 60282000000,
          "conf": 26000000,
          "ema_price": 60321475000,
          "ema_confidence": 22504746,
          "valid_slot": 91402601,
          "pub_slot": 91402604,
          "prev_slot": 91402600,
          "prev_price": 60282000000,
          "prev_conf": 26000000,
          "publisher_accounts": [
            {
              "account": "HekM1hBawXQu6wK6Ah1yw1YXXeMUDD2bfCHEzo25vnEB",
              "status": "trading",
              "price": 60282000000,
              "conf": 26000000,
              "slot": 91402599
            },
            {
              "account": "2V7t5NaKY7aGkwytCWQgvUYZfEr9XMwNChhJEakTExk6",
              "status": "unknown",
              "price": 0,
              "conf": 0,
              "slot": 0
            }
          ]
        }
      ]
    }
  ],
  "id": 1
}
```

--------------------------------

### Get Product List Response

Source: https://docs.pyth.network/price-feeds/core/publish-data/pyth-client-websocket-api

This is an example response from the Pyth-Agent WebSocket API after a `get_product_list` request. It includes details about a product, its attributes, and price feed information.

```json
{
  "jsonrpc": "2.0",
  "result": [
    {
      "account": "9F6eBgAfktth93C9zmtKDXFXNjZkq6JwJR56VPKqWmJm",
      "attr_dict": {
        "symbol": "SYMBOL1/USD",
        "asset_type": "Equity",
        "country": "USA",
        "description": "pyth example product #1",
        "quote_currency": "USD",
        "tenor": "Spot",
        "cms_symbol": "SYMBOL1",
        "cqs_symbol": "SYMBOL1",
        "nasdaq_symbol": "SYMBOL1"
      },
      "price": [
        {
          "account": "CrZCEEt3awgkGLnVbsv45Pp4aLhr7fZfZr3ubzrbNXaq",
          "price_exponent": -4,
          "price_type": "price"
        }
      ]
    }
  ],
  "id": null
}
```

--------------------------------

### Example deployment output

Source: https://docs.pyth.network/entropy/create-your-first-entropy-app

Shows the compilation and deployment status, including the contract address and transaction hash.

```text
[⠢] Compiling...
[⠔] Compiling 28 files with 0.8.23
[⠑] Solc 0.8.23 finished in 3.40s
Compiler run successful!
Deployer: 0xfa57d0f2CBDA2729273F2a431E4FeDAc656d0402
Deployed to: 0x8676ba0Dd492AB9813BC21D5Dce318427d1d73ae
Transaction hash: 0x2178aa6d402c94166a93e81822248d00dd003827675ebd49b3c542970f5a0189
```

--------------------------------

### NPM Installation Command

Source: https://docs.pyth.network/llms-price-feeds-pro.txt

Install the required SDK package for TypeScript integration.

```bash
npm install @pythnetwork/pyth-lazer-sdk
```

--------------------------------

### Install near-cli-rs

Source: https://docs.pyth.network/price-feeds/use-real-time-data/pull-integration/near

Install the NEAR command-line interface to manage accounts and interact with contracts.

```bash
npm install -g near-cli-rs@latest
```

--------------------------------

### Install near-js Dependencies

Source: https://docs.pyth.network/price-feeds/use-real-time-data/pull-integration/near

Install the required near-js client and keystore packages for your Node.js project.

```bash
npm install @near-js/client @near-js/keystores-node
```

--------------------------------

### Example output of wallet creation

Source: https://docs.pyth.network/entropy/create-your-first-entropy-app

Displays the address and private key generated by the wallet creation command.

```text
Successfully created new keypair.
Address:     0xB806824fdA4b2b6631e9B87a86d42C9dfd04D129
Private key: 0x0d510c72fd2279155c717eb433ae598a83cfb34b09c2ada86bc424b481082023
```

--------------------------------

### Understand the Example Code

Source: https://docs.pyth.network/price-feeds/pro/getting-started

The core integration pattern using PythLazerClient to connect, listen for messages, and subscribe to specific price feeds.

```typescript
import { PythLazerClient } from "@pythnetwork/pyth-lazer-sdk";

const client = await PythLazerClient.create({
  urls: [
    "wss://pyth-lazer-0.dourolabs.app/v1/stream",
    "wss://pyth-lazer-1.dourolabs.app/v1/stream",
    "wss://pyth-lazer-2.dourolabs.app/v1/stream",
  ],
  token: process.env.ACCESS_TOKEN!,
});

// The message listener is called every time a new message is received.
client.addMessageListener((message) => {
  // Add your logic to consume messages here
  console.log("got message:", message);
});

// Subscribe to price feeds
client.subscribe({
  type: "subscribe",
  subscriptionId: 1,
  priceFeedIds: [1, 2],
  properties: ["price"],
  formats: ["solana"],
  deliveryFormat: "json",
  channel: "fixed_rate@200ms",
  jsonBinaryEncoding: "hex",
});
```

--------------------------------

### Product Account Example (BTC/USD)

Source: https://docs.pyth.network/price-feeds/core/pythnet-reference/account-structure

Shows the reference attributes for the BTC/USD product account, illustrating common fields for cryptocurrency assets.

```sh
product_account .. 3m1y5h2uv7EQL3KaJZehvAJa4yDNvgc5yAdL9KPMKwvk
  symbol.......... Crypto.BTC/USD
  asset_type...... Crypto
  quote_currency.. USD
  description..... BTC/USD
  generic_symbol.. BTCUSD
  base............ BTC
  price_account .. HovQMDrbAgAYPCmHVSrezcSmkMtXSSUsLDFANExrZh2J
```

--------------------------------

### Install Pyth Lazer SDK

Source: https://docs.pyth.network/price-feeds/pro/subscribe-to-prices

Command to install the official Pyth Lazer SDK via npm.

```bash
npm install --save @pythnetwork/pyth-lazer-sdk
```

--------------------------------

### Initialize Web3 Contracts in script.js

Source: https://docs.pyth.network/entropy/create-your-first-entropy-app

Create a script.js file to initialize the Web3 provider and the CoinFlip and Entropy contract instances.

```javascript
const { Web3 } = require("web3");
const CoinFlipAbi = require("../contracts/out/CoinFlip.sol/CoinFlip.json");
const EntropyAbi = require("@pythnetwork/entropy-sdk-solidity/abis/IEntropyV2.json");

async function main() {
  const web3 = new Web3(process.env["RPC_URL"]);
  const { address } = web3.eth.accounts.wallet.add(
    process.env["PRIVATE_KEY"],
  )[0];

  web3.eth.defaultBlock = "finalized";

  const coinFlipContract = new web3.eth.Contract(
    CoinFlipAbi.abi,
    process.env["COINFLIP_ADDRESS"],
  );

  const entropyContract = new web3.eth.Contract(
    EntropyAbi,
    process.env["ENTROPY_ADDRESS"],
  );
}

main();
```

--------------------------------

### Install Pyth TON SDK dependencies

Source: https://docs.pyth.network/price-feeds/core/use-real-time-data/pull-integration/ton

Install the required Pyth and TON packages using npm.

```bash
npm install @pythnetwork/pyth-ton-js @pythnetwork/hermes-client @ton/core @ton/ton @ton/crypto
```

--------------------------------

### Install NEAR-JS Client

Source: https://docs.pyth.network/price-feeds/core/use-real-time-data/pull-integration/near

Install the necessary NEAR-JS client library for your Node.js project to interact with NEAR contracts.

```bash
npm install @near-js/client

```

--------------------------------

### Initialize Foundry project

Source: https://docs.pyth.network/entropy/create-your-first-entropy-app

Create a new Foundry project within the directory.

```bash
forge init contracts
```

--------------------------------

### Sample EVM Contract for Push Integration

Source: https://docs.pyth.network/price-feeds/core/use-real-time-data/push-integration

A complete example showing how to instantiate the IPyth interface and use it within a contract to fetch a price feed.

```solidity
pragma solidity ^0.8.0;

import "@pythnetwork/pyth-sdk-solidity/IPyth.sol";
import "@pythnetwork/pyth-sdk-solidity/PythStructs.sol";

contract SomeContract {
  IPyth pyth;

  /**
   * @param pythContract The address of the Pyth contract
   */
  constructor(address pythContract) {
    // The IPyth interface from pyth-sdk-solidity provides the methods to interact with the Pyth contract.
    // Instantiate it with the Pyth contract address from https://docs.pyth.network/price-feeds/core/contract-addresses/evm
    pyth = IPyth(pythContract);
  }

  /**
   * This method is an example of how to interact with the Pyth contract using Push Integration.
   */
  function exampleMethod() public {
    // Read the current price from a price feed if it is less than 60 seconds old.
    // Each price feed (e.g., ETH/USD) is identified by a price feed ID.
    // The complete list of feed IDs is available at https://docs.pyth.network/price-feeds/core/price-feeds
    bytes32 priceFeedId = 0xff61491a931112ddf1bd8147cd1b641375f79f5825126d665480874634fd0ace; // ETH/USD
    PythStructs.Price memory price = pyth.getPriceNoOlderThan(priceFeedId, 60);
  }
}
```

--------------------------------

### Install Pyth Lazer SDK via Forge

Source: https://docs.pyth.network/price-feeds/pro/integrate-as-consumer/evm

Use the Forge package manager to install the Pyth crosschain repository.

```bash
forge install pyth-network/pyth-crosschain
```
Tokens:
Raw