Skip to main content
GET
Prepare a transaction to move vault shares to another chain

Authorizations

x-api-key
string
header
required

API key in format: pxl_<public_id>_

Query Parameters

vaultAddress
string
required

BoringVault contract address (0x + 40 hex chars)

Example:

"0x6c6494Fd9962eB98B94ffA48F6679058F820700e"

shareAmount
string
required

Vault share amount to transfer, in share token base units (decimal string)

Example:

"1000000000000000000"

userAddress
string
required

Address sending the transaction. Must hold at least shareAmount on the source chain and be permitted to transfer shares across chains.

Example:

"0x1234567890abcdef1234567890abcdef12345678"

chainId
number
required

Source EVM chain ID

Example:

1

destinationChainId
number
required

EVM chain ID to transfer the shares to. The vault must have a route open to this chain; if it does not, the request returns 400.

Example:

196

destinationChainReceiver
string

Recipient of the minted shares on the destination chain. Defaults to userAddress.

Example:

"0x1234567890abcdef1234567890abcdef12345678"

messageGas
string
required

Gas to request for execution on the destination chain. Must fall within the route’s permitted range; both bounds are returned on the response so a rejected value can be corrected.

Example:

"100000"

responseFormat
enum<string>

Controls response fields. "encoded" (default): ABI-encoded calldata only. "full": calldata + ABI fragment, function name, args. "structured": ABI fragment, function name, args only.

Available options:
encoded,
full,
structured

Response

transaction
object
required
fee
object
required

Fee quote backing transaction.value. Priced at the current block and sensitive to gas conditions — request it again if the transaction is not broadcast promptly, because a stale quote is rejected on-chain.

lane
object
required

The resolved destination route, echoed so the accepted messageGas range is visible.