For the complete documentation index, see llms.txt. This page is also available as Markdown.

Ekosistem & repos

Setiap repo Rome publik, apa fungsinya, dan bagaimana semuanya tersusun — peta untuk menavigasi permukaannya.

Permukaan publik Rome adalah sekumpulan repositori: beberapa fondasi paket yang Anda bangun di atasnya, sebuah scaffolder, aplikasi referensi untuk dipelajari, dan dua layanan yang dipanggil aplikasi Anda. Halaman ini adalah peta — apa itu setiap repo dan bagaimana semuanya saling terhubung.

Dua tetangga menjawab pertanyaan yang berbeda, dan halaman ini menautkan ke keduanya alih-alih mengulanginya:

  • Arsitektur menjelaskan protokol — bagaimana EVM berjalan di dalam program Solana.

  • Setiap repo menyertakan AGENTS.md (mis. rome-sdk-ts/AGENTS.md) yang mengarahkan berdasarkan apa yang Anda mulai dari (kontrak Solidity, program Solana, greenfield, dari rumah) ke satu contoh yang paling dekat dengan kasus Anda.

Halaman ini adalah tingkat di antaranya: seluruh permukaan dan bagaimana bagian-bagiannya terhubung.

Sekilas tentang permukaan

Fondasi — bangun di atas ini

Repo
Apa itu
Gunakan ini saat

@rome-protocol/registry — proyeksi fakta rantai hidup yang hanya-baca dan digenerasikan (id, RPC, alamat, mint token, program id, feed oracle, ALT).

Anda membutuhkan fakta rantai yang nyata — jangan pernah hardcode.

@rome-protocol/sdk — jalur tulis TypeScript: submitRomeTx + penentuan ukuran fee, kedua jalur, encoder PDA/ATA + CPI, binding precompile, sebuah /bridge client.

Anda sedang menulis kode aplikasi atau frontend.

antarmuka precompile Solidity, wrapper SPL/ERC-20, dan adaptor oracle — toolkit sisi kontrak.

Anda sedang menulis kontrak.

Nama @rome-protocol/… di atas adalah nama paket, tetapi paket-paket itu tidak dipublikasikan ke npm. Instal dari GitHub (perintahnya ada di tiap bagian di bawah Lapisan fondasi, lebih dekat); jalur import dalam kode Anda tetap sama.

Rollup ZK EVM Rome

Repo
Apa itu
Gunakan ini saat

Program rollup ZK, node, prover, dan dokumentasi operator.

Anda menjalankan chain EVM yang diselesaikan di Solana.

Sumber guest batch yang dibangun untuk genesis tiap chain.

Anda sedang membangun guest dan meminta verification key-nya.

Ostia (ZK EVM di Canton)

Repo
Apa itu
Gunakan ini saat

Ostia, sebuah ZK EVM di Canton: setiap blok EVM yang dibuktikan dikomit dengan aksi Canton-nya dalam satu transaksi.

Anda membangun di Ostia DevNet (explorer) atau menjalankan Ostia Anda sendiri. Lihat Canton ZK EVM.

Aplikasi referensi — belajar dari contoh

Repo
Apa itu
Gunakan ini saat

AMM jalur ganda — pool Solana native dengan router EVM tipis.

Membuka jalur lainnya; sebuah native-core contoh.

Peminjaman jalur ganda — core Comet Solidity yang dijangkau pengguna Solana melalui pengirim sintetis.

Membuka jalur lainnya; sebuah Solidity-core contoh.

Pengguna EVM yang menggerakkan dApp Solana (swap/stake/lend/perps) melalui CPI.

Sebuah aplikasi CPI-ke-Solana yang dibahas langkah demi langkah untuk dipelajari.

DeFi lintas-VM yang berfokus pada posisi; pengguna menjangkaunya dari chain asal mereka.

Sebuah from-home aplikasi.

Supply/borrow/repay Aave v3, diterapkan tanpa perubahan.

Aplikasi EVM penuh yang berjalan apa adanya.

Fork kontrak — protokol yang sudah dikenal, diterapkan di Rome

Repo
Apa itu
Gunakan ini saat

Pasar uang Compound III (Comet).

Melakukan fork pada protokol EVM yang dikenal.

Fork kontrak Aave v3.

Melakukan fork pada protokol EVM yang dikenal.

Layanan — aplikasi Anda memanggil ini

Repo
Apa itu
Gunakan ini saat

Orkestrator off-chain + sponsor fee untuk bridge on-chain. Tidak menyimpan kunci apa pun.

Mendanai wallet, atau alur from-home.

Feed harga Solana (Pyth, Switchboard) yang diekspos ke EVM melalui Chainlink AggregatorV3Interface.

Anda membutuhkan feed harga.

Scaffold — mulai dari sini

Repo
Apa itu
Gunakan ini saat

npx github:rome-protocol/create-rome-app — membuat scaffold aplikasi jalur ganda yang sudah terhubung ke registry + SDK, dengan pemeriksaan kedua-jalur yang didanai.

Memulai aplikasi baru.

Cara mereka tersusun

Tulang punggungnya ada tiga fondasi dan satu scaffolder:

  • rome-registry adalah satu-satunya sumber fakta hidup. rome-sdk-ts adalah jalur tulis — dan /bridge subpath-nya adalah client yang dipakai aplikasi Anda untuk berbicara ke rome-bridge-api. rome-solidity adalah apa yang diimpor kontrak Anda (dan fork); adaptor oracle yang rome-oracle-gateway juga menerapkannya di sana. Ketiganya saling independen — pilih yang dibutuhkan aplikasi Anda.

  • create-rome-app menggabungkan dua yang pertama untuk aplikasi baru, sehingga proyek baru sudah mulai dengan membaca registry dan menulis melalui SDK.

Aplikasi referensi adalah pengecualian yang layak diketahui: mereka ada sebelum paket-paket yang diekstrak. cardo menggunakan paket registry; appia memproyeksikan registry ke JSON statis saat build time; dan keduanya menyertakan jalur tulis mereka sendiri alih-alih mengimpor SDK. Bacalah untuk mempelajari polanya — tetapi sebuah baru aplikasi sebaiknya mulai dari create-rome-app + paket-paketnya, bukan dengan mengkloning aplikasi.

Lapisan fondasi, lebih dekat

rome-registry — fakta hidup, publik secara bawaan

Registry ini digenerasikan dari sumber internal Rome: sebuah allowlist hanya mengeluarkan apa yang memang dimaksudkan untuk publik, mengganti endpoint internal dengan padanan publiknya, dan secara default menolak semuanya yang lain — jadi aman untuk publik secara bawaan. Ia menerbitkan, per chain, chain.json / tokens.json / contracts.json / oracle.json / bridge.json / alts.jsonserta Solana program dan deployment aplikasi per-protokol.

Instal dari GitHub, dipin ke tag rilis: npm install github:rome-protocol/rome-registry#v0.2.0. Anda membacanya melalui getter — getChain, getTokens, getContracts, getOracle, getBridge, getAlts, dan getPrograms(network) (program id diberi kunci berdasarkan network, bukan chain id). Paket ini ESM biasa (belum ada tipe TypeScript bawaan saat ini).

Dua hal yang perlu diketahui sebelum Anda menghubungkannya:

  • getTokens() tidak mengembalikan assetRef. Untuk menemukan wrapper sebuah token, cocokkan berdasarkan mint (mintId) — mis. wrapper token gas adalah entri yang berbagi mint-nya.

  • Ia membaca JSON dari disk (node:fs) — ini tidak aman untuk browser. Dalam aplikasi web, proyeksikan nilai yang Anda butuhkan ke file JSON statis saat build time dan impor itu di klien. (Ini persis yang dilakukan create-rome-app dan appia.)

Alamat kontrak kembali sebagai daftar versi per kontrak; pilih yang statusnya status adalah aktif. Membaca daftar kontrak menunjukkan caranya. Fakta yang tidak dibaca live oleh aplikasi Anda juga muncul di referensi Contract Addresses .

rome-sdk-ts — jalur tulis, kedua jalur

Instal dari GitHub: npm install github:rome-protocol/rome-sdk-ts#v0.4.0.

@rome-protocol/sdk (v0.4.0) membungkus semua yang dibutuhkan untuk write Rome sehingga Anda tidak perlu merakit calldata atau fee secara manual:

  • submitRomeTx — jalur tulis lane EVM: mengukur gas dari eth_estimateGas (ditambah, dengan batas cadangan saat estimasi gagal) dan menyediakan fee EIP-1559.

  • submitRomeTxV1 — sama, untuk wallet Solana yang menggerakkan aplikasi EVM Anda: satu transaksi Solana v1 per panggilan, dua prompt wallet. Pengirim sintetis tidak menyimpan apa pun saat diam; buildFundLeg/buildSweepLeg memindahkan nilai masuk dan keluar sebagai ERC-20 (wUSDC), bukan native msg.value; instruksi Solana biasa di sekitar sebuah panggilan (leg pendanaan, pembuatan token-account wallet sebelum sweep) melewati submitSolanaInstructionsV1 sebagai transaksi v1 juga. submitRomeTxSolanaLane adalah jalur yang lebih awal, yang membangun transaksi Solana legacy di klien dan secara otomatis menyiapkan sintetis baru (create_pda) pada penggunaan pertama.

  • Derivasi PDA/ATA, CPI invoke/invoke_signed encoder, binding precompile, dan sebuah /bridge subpath (@rome-protocol/sdk/bridge) — client bridge quote-first.

API lengkap + contoh: Rome SDK, dan panduan Panggil Solana dari EVM, Panggil EVM dari Solana, dan Bangun aplikasi jalur ganda.

rome-solidity — toolkit sisi kontrak

Instal dari GitHub, bukan npm. Dengan npm atau Hardhat: npm install github:rome-protocol/rome-solidity. Dengan Foundry: forge install rome-protocol/rome-solidity, lalu tambahkan remapping @rome-protocol/rome-solidity/=lib/rome-solidity/ ke foundry.toml (di bawah [profile.default], sebagai remappings = [...]agar @rome-protocol/rome-solidity/contracts/interface.sol terselesaikan. Nama paket di package.json adalah @rome-protocol/rome-solidity, sehingga jalur import yang sama berfungsi untuk keduanya.

Apa yang diimpor kontrak Anda:

  • contracts/interface.sol — antarmuka precompile yang terikat ke alamatnya: CPI ICrossProgramInvocation (0xFF…08), Helper IHelperProgram (0xFF…09pembuatan ATA/PDA, transfer SPL, gas↔lamports), Withdraw IWithdraw (0x42…16), dan System (0xFF…07). Sebuah keluarga cached yang dioptimalkan untuk gas juga ada di sini; sebuah kontrak menggunakan satu jalur secara konsisten. Tabel alamat lengkap: Contract Addresses.

  • Wrapper SPL/ERC-20 — SPL_ERC20 (berbasis CPI) dan SPL_ERC20_cached (jalur cached, digunakan di devnet); setiap mint SPL sudah menjadi ERC-20 melalui ini.

  • Adaptor oracle (contracts/oracle/) — adaptor Pyth/Switchboard rome-oracle-gateway menerapkan, dibaca melalui IAggregatorV3Interface.

  • Contoh yang dibahas dalam contracts/examples/.

Bagian Solidity SDK dari Rome SDK menunjukkan pola import dan binding precompile di dalam kode.

Langkah berikutnya

  • Pilih core Anda — sisi mana yang menyimpan logika Anda.

  • Quickstart — deploy kontrak pertama Anda.

  • create-rome-app — buat scaffold aplikasi jalur ganda.

  • Setiap repo AGENTS.md — rute berdasarkan titik awal ke contoh terdekat.

Terakhir diperbarui

Apakah ini membantu?