IDL バージョンを一覧表示

GET

parsed-events

idl

{programId}

IDL バージョンの一覧表示

curl --request GET \
  --url 'https://mainnet.helius-rpc.com/v1/parsed-events/idl/{programId}?api-key='

const options = {method: 'GET'};

fetch('https://mainnet.helius-rpc.com/v1/parsed-events/idl/{programId}?api-key=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://mainnet.helius-rpc.com/v1/parsed-events/idl/{programId}?api-key=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://mainnet.helius-rpc.com/v1/parsed-events/idl/{programId}?api-key="

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://mainnet.helius-rpc.com/v1/parsed-events/idl/{programId}?api-key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

[
  {
    "slot": 182747476,
    "sources": [
      "anchor"
    ]
  },
  {
    "slot": 205509752,
    "sources": [
      "anchor"
    ]
  },
  {
    "slot": 206074074,
    "sources": [
      "anchor"
    ]
  }
]

{
  "error": "invalid program id: notanaddress: String is the wrong size"
}

Unauthorized

{
  "error": "no IDLs found for program TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"
}

このページのパスパラメータ、レスポンススキーマ、例は OpenAPI 定義から生成されています。 List IDL Versions は、Parsed Events と Parsed Streams が命令のデコードに使用する IDL カタログから、プログラムのインターフェース履歴を返します。各項目は 1 つのバージョンを表し、そのバージョンが有効になったスロットによって識別されます。項目は古い順に並ぶため、最後の項目が現在のバージョンです。レスポンス内の任意の slot を Get IDL に渡すと、そのバージョンの IDL ドキュメントを取得できます。Orb explorer は、これらのエンドポイントを使用してプログラムの IDL を表示します。

ユースケース

インターフェースの変更を追跡します。 依存しているプログラムについて、List IDL Versions をポーリングします。新しいバージョンが追加されたら、Get IDL でそのバージョンと直前のバージョンを取得し、それぞれの instructions を比較します。新しい管理者命令や権限命令が追加された場合は、セキュリティレビューを行う価値があります。
カタログの対応範囲を確認します。 404 は、カタログにそのプログラムの IDL がないことを示します。SPL Token などのプログラムは、代わりに組み込みデコーダーによってデコードされ、同様に 404 を返します。

例：新しい IDL バージョンを検出する

このスクリプトは、プログラムの IDL バージョンを一覧表示し、最新の 2 つを取得して、追加または削除された命令を出力します。

diff-idl-versions.js

const API_KEY = process.env.HELIUS_API_KEY;

if (!API_KEY) {
  console.error("Missing HELIUS_API_KEY.");
  process.exit(1);
}

const BASE = "https://mainnet.helius-rpc.com/v1/parsed-events/idl";
const PROGRAM_ID = "KLend2g3cP87fffoy8q1mQqGKjrxjC8boSyAYavgmjD";

async function get(path) {
  const response = await fetch(`${BASE}/${path}?api-key=${API_KEY}`);
  if (!response.ok) {
    throw new Error(`HTTP ${response.status}: ${await response.text()}`);
  }
  return response.json();
}

const versions = await get(PROGRAM_ID);
if (versions.length < 2) {
  console.log("Fewer than two IDL versions; nothing to compare.");
  process.exit(0);
}

const [previous, latest] = versions.slice(-2);
const [before, after] = await Promise.all([
  get(`${PROGRAM_ID}/${previous.slot}`),
  get(`${PROGRAM_ID}/${latest.slot}`),
]);

const names = (idl) => new Set(idl.instructions.map((ix) => ix.name));
const beforeNames = names(before);
const afterNames = names(after);

console.log(`Comparing slot ${previous.slot} with slot ${latest.slot}`);
console.log("Added:", [...afterNames].filter((name) => !beforeNames.has(name)));
console.log("Removed:", [...beforeNames].filter((name) => !afterNames.has(name)));

時間の経過に伴う変更を検出するには、最後に確認したバージョンの slot を保存し、ポーリングのたびに比較します。

クレジット

各リクエストのコストは 10 クレジットで、すべてのプランで利用できます。上記の例では 3 回リクエストするため、コストは 30 クレジットです。詳しくはクレジットを参照してください。

エラー

ステータス	発生条件
`400`	`programId` が有効な base58 アドレスではありません。
`401`	API キーがないか、無効です。本文はプレーンテキストです：`Unauthorized`。
`404`	カタログにそのプログラムの IDL がありません。

その他のエラーでは、{"error": "no IDLs found for program TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"} などの error メッセージを含む JSON 本文が返されます。

リクエストパラメータ

string

必須

base58 でエンコードされたプログラムアドレス。

承認

api-key

string

query

必須

パスパラメータ

programId

string

必須

base58 でエンコードされたプログラムアドレスです。

例:

"KLend2g3cP87fffoy8q1mQqGKjrxjC8boSyAYavgmjD"

レスポンス

プログラムの IDL バージョン。slot の昇順で並べ替えられています。

slot

integer<uint64>

必須

この IDL バージョンが有効になったスロットです。このバージョンを取得するには、IDL の取得に渡してください。

sources

string[]

必須

解析済みイベントがこのバージョンを検出した場所です。値には anchor、program_metadata、github などがあり、今後さらに追加される可能性があります。1 つのバージョンに複数のソースがある場合があります。

⌘I

IDL バージョンの一覧表示

curl --request GET \
  --url 'https://mainnet.helius-rpc.com/v1/parsed-events/idl/{programId}?api-key='

const options = {method: 'GET'};

fetch('https://mainnet.helius-rpc.com/v1/parsed-events/idl/{programId}?api-key=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://mainnet.helius-rpc.com/v1/parsed-events/idl/{programId}?api-key=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://mainnet.helius-rpc.com/v1/parsed-events/idl/{programId}?api-key="

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://mainnet.helius-rpc.com/v1/parsed-events/idl/{programId}?api-key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

[
  {
    "slot": 182747476,
    "sources": [
      "anchor"
    ]
  },
  {
    "slot": 205509752,
    "sources": [
      "anchor"
    ]
  },
  {
    "slot": 206074074,
    "sources": [
      "anchor"
    ]
  }
]

{
  "error": "invalid program id: notanaddress: String is the wrong size"
}

Unauthorized

{
  "error": "no IDLs found for program TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"
}

はじめに

取引

トランザクションの送信

アカウント管理

IDL バージョンを一覧表示

ユースケース

例：新しい IDL バージョンを検出する

クレジット

エラー

リクエストパラメータ

承認

パスパラメータ

レスポンス

​ユースケース

​例：新しい IDL バージョンを検出する

​クレジット

​エラー

​リクエストパラメータ

承認

パスパラメータ

レスポンス

ユースケース

例：新しい IDL バージョンを検出する

クレジット

エラー

リクエストパラメータ