Reference
Addresses and instructions
The Ferry program, its accounts and what each instruction does.
On this page
| Account | Address |
|---|
| Ferry program | 92EDfudNaS6RqERAh4G5NyK6PAZPyjqjR5P516RD6P4p |
| Config | 98iyq8SFJ7PzsgWWSU3omrTpo9pfawF6wddjyF18gC35 |
| USDC pool | 9YTx5et2HgLTB42APDeGazFXaqRHiV4UiNZ2ma58iMQ1 |
| EURC pool | 7ec15vdeMsFxU8kBXXMLusJ4o7AQwnW6Qmm2TzwJGrir |
| Pyth receiver | rec2HHDDnjLfj4kE7VyEtFA1HPGQLK33259532cRyHp |
| Jupiter | JUP6LkbZbjS1jKKwapdHNy74zcZ3tLUZoi5QNyVTaV4 |
Every Ferry account is derived from the program's address: Config from the program alone, a pool from the program and its token's mint.
| Account | Seeds | Holds |
|---|
| Config | config | Parameters, the admin and the protocol treasury |
| Pool | pool, mint | One currency's balance, shares and protocol fees |
| Vault | vault, pool | The pool's token account |
| Position | position, pool, wallet | A wallet's shares in a pool |
| Receipt | receipt, wallet, nonce | The record of one send, order, deposit or withdrawal |
| Bucket | bucket, pool A, pool B, fixing time | One pair's fixing cohort |
| Escrow | escrow, bucket, mint | A cohort's escrowed tokens |
| Instruction | Signed by | What it does |
|---|
send | Sender | Pays the exact quoted amount through a market route, in one transaction |
enqueue | Sender | Moves a fixing order's input into escrow for the next fixing |
cancel | Sender | Returns an order's escrow before its fixing |
settle | Anyone | Crosses a fixing cohort at its signed fixing price and pays or refunds every order |
expire | Anyone | Returns an order's escrow to its sender after the settlement window |
deposit | Depositor | Adds a token to its pool and mints shares |
withdraw | Share owner | Burns shares for the pool's token |
collect_protocol_fees | Admin | Moves protocol fees to the treasury |
set_paused | Admin | Pauses or resumes sends, deposits, fixing orders and settlement; withdrawals, cancellations and returns stay open |
| Value | Meaning |
|---|
| 1 | Queued for a fixing |
| 2 | Paid, settled or done |
| 3 | Returned: cancelled or reclaimed |
| 4 | Refunded at the fixing |