Langsung ke konten utama
GET
Dapatkan IDL
Parameter jalur, skema respons, dan contoh di halaman ini dibuat dari definisi OpenAPI. Dapatkan IDL mengembalikan IDL program pada suatu slot: versi terbaru yang mulai aktif pada atau sebelum slot. slot tidak harus sama persis dengan suatu versi, sehingga Anda dapat meneruskan titik mana pun dalam riwayat. Untuk mengambil satu versi tertentu, teruskan slot versinya dari Daftar Versi IDL. IDL berasal dari katalog yang sama dengan yang digunakan Parsed Events dan Parsed Streams untuk mendekode instruksi. Penjelajah Orb menggunakan endpoint ini untuk menampilkan IDL program.

Kasus Penggunaan

  • Dekode riwayat dengan antarmuka yang tepat. Teruskan slot transaksi untuk mendapatkan IDL yang berlaku saat transaksi tersebut dieksekusi. Program mengubah instruksi dan akunnya seiring waktu, sehingga IDL saat ini dapat salah membaca transaksi lama.
  • Temukan nama yang tepat untuk filter. Pindai Riwayat Transaksi match.programs[].instructions menerima nama instruksi sesuai dengan penulisannya dalam IDL.
  • Tinjau perubahan antarmuka. Ambil dua versi dan bandingkan instructions untuk melihat apa yang ditambahkan atau dihapus oleh suatu peningkatan. Lihat contoh di Daftar Versi IDL.

Format IDL

Responsnya adalah dokumen IDL sebagaimana disimpan. Program dalam katalog menggunakan salah satu dari dua format Anchor, dan versi-versi dari satu program dapat menggunakan keduanya. Periksa format yang Anda terima sebelum membacanya: Kedua format memiliki instructions. Sebagian besar IDL juga memiliki accounts, types, dan errors, serta banyak yang memiliki events.

Kredit

Setiap permintaan dikenai biaya 10 kredit dan tersedia pada semua paket. Lihat Kredit.

Kesalahan

Kesalahan lainnya mengembalikan isi JSON dengan pesan error, seperti {"error": "no IDL found for program KLend2g3cP87fffoy8q1mQqGKjrxjC8boSyAYavgmjD at or before slot 1"}.

Parameter Permintaan

string
wajib
Alamat program yang dikodekan dengan base58.
number
wajib
Slot yang akan dicari. Slot ini tidak harus sama dengan slot aktivasi suatu versi. Teruskan slot dari Daftar Versi IDL untuk mendapatkan versi tersebut secara tepat, atau slot transaksi untuk mendapatkan IDL yang berlaku saat transaksi tersebut dieksekusi.

Otorisasi

api-key
string
query
wajib

Parameter Path

programId
string
wajib

Alamat program yang dikodekan dengan base58.

Contoh:

"KLend2g3cP87fffoy8q1mQqGKjrxjC8boSyAYavgmjD"

slot
integer<uint64>
wajib

Slot yang akan dicari. Nilainya tidak harus sama dengan slot aktivasi suatu versi. Teruskan slot dari Cantumkan Versi IDL untuk mendapatkan versi tersebut secara tepat, atau slot transaksi untuk mendapatkan IDL yang berlaku saat transaksi dijalankan.

Rentang yang diperlukan: x >= 0
Contoh:

205509752

Respons

Dokumen IDL sebagaimana disimpan. Format Anchor lama dan format Anchor 0.30+ sama-sama dapat ditemukan, jadi periksa format yang Anda terima sebelum membacanya.

Dokumen IDL yang dikembalikan sebagaimana disimpan. Ada dua format:

  • Anchor Lama (sebelum 0.30): name dan version pada tingkat teratas. Akun instruksi menggunakan isMut dan isSigner.
  • Anchor 0.30+: address dan metadata (name, version, spec, description) pada tingkat teratas. Instruksi memiliki discriminator, dan akun instruksi menggunakan writable dan signer.

Kedua format memiliki instructions. Sebagian besar IDL juga memiliki accounts, types, dan errors, serta banyak yang memiliki events. Versi-versi dari satu program dapat menggunakan format yang berbeda.