Onchain Actions

private/register_bridge_deposit

Reports a Li.Fi bridge into one of the caller's deposit addresses the moment its source transaction is sent, so public/get_pending_deposits shows it as bridging at once with the quoted amount, before Li.Fi indexes it. Takes the source chain and transaction, the quote's transactionId, the deposit address, the source and delivered tokens and the quoted toAmount. Idempotent per source transaction. Display only: nothing is credited from it, and a registration Li.Fi never confirms expires.

post/private/register_bridge_deposit

Request

  • Base URL: https://api.derive.xyz/v3
  • URL: https://api.derive.xyz/v3/private/register_bridge_deposit
  • Auth: none declared

Request body

bridge_tokenstring required

The ERC20 the bridge delivers on the destination chain.

bridge_token_decimalsinteger required

bridge_token's decimals.

deposit_addressstring required

One of the wallet's escrows, from public/register_deposit_address.

expected_amountstring required

What the quote says will arrive, in bridge_token's native units, as a decimal string (Li.Fi: estimate.toAmount).

provider_transfer_idstring nullable

The provider's own id for the transfer, kept if the source transaction is sped up or replaced: Li.Fi's quote transactionId.

railstring required

Bridge protocol: lifi. (layerzero is not registrable yet.)

source_chain_idinteger required

Chain the bridge was sent from.

source_tokenstring required

The ERC20 sent on the source chain.

source_tx_hashstring required

The bridge transaction on that chain.

toolstring nullable

The route the provider chose (Li.Fi: the quote's tool). Internal only.

walletstring required

The session's wallet.

Response

Success

bridge_idstring required

Unique with rail; changes if a registered source tx is replaced, so key on provider_transfer_id when present.

bridge_statusstring required

registered (reported by the client, not yet confirmed by Li.Fi) submitted (in flight) delivered (landed on the destination chain) matched (joined to the L1 deposit) failed (the bridge refunded or could not fill — nothing reached the escrow) expired (unresolved past expires_at_ms; check the source chain) unmatched (delivered, but not credited within 24h; contact support)

delivered_at_msinteger nullable
deposit_addressstring required

The escrow the bridge delivers to.

expected_amountstring required

Quoted amount expected to land, in token units (estimated until quoted); receiving_amount once delivered.

expires_at_msinteger required

When a still-registered or submitted bridge will be marked expired.

provider_transfer_idstring nullable

The provider's own id for the bridge (Li.Fi: the quote's transactionId), stable through its lifecycle.

railstring required

Bridge protocol: lifi or layerzero.

receiving_amountstring nullable

What actually arrived, native units, as a decimal string.

receiving_tokenstring nullable
receiving_tx_hashstring nullable

The bridge's delivery transaction on the destination chain.

source_addressstring nullable

Their wallet on that chain, lower-cased; absent when the rail gave none.

source_chain_idinteger required

Chain the user sent from.

source_tx_hashstring required

Their transaction on that chain.

substatusstring required

The rail's detail, or TOKEN_MISMATCH when the escrow cannot credit the token.

tokenstring required

The ERC20 expected to land in the escrow.

Changes

No recorded changes to this operation across all 1 revision of this API.