On this page

ABI reference

Use the release-specific downloadable ABIs for encoding, simulation and event decoding. These signatures are generated from the same ABIs used by the web app, not maintained by hand.

Read the quickstart before calling functions. A listed method is not permissionless: router send methods are facade-only, owner actions require the permanent origin creator, and protocol administration requires its administrator. OFT administration stubs such as setPeer and transferOwnership always revert. See compatibility.

Router ABI · OFT ABI · Adapter ABI · Lens ABI

Router

BPS_DENOMINATOR()
COMPLIANCE_RECEIVE_GAS()
GAS_OWNER()
GAS_SYNC()
GAS_TRANSFER()
GAS_TRANSFER_DEPLOY()
MAX_FEE_BPS()
MAX_MIN_GAS()
MAX_PEERS()
MAX_ROUTE_THRESHOLD()
PROTOCOL_BPS_FEE_SHARE_BPS()
PROTOCOL_FLAT_FEE_SHARE_BPS()
RESTORE_GRACE_PERIOD()
ROUTE_ACTIVATION_DELAY()
SYNC_GAS_PER_CHAIN()
VM_EVM()
acceptOwnership()
adapterImplementation()
allowInitializePath((uint32,bytes32,uint64))
assetIdOf(address)
assetOf(address,address)
assetPeer(bytes32,uint32)
claimFees(bytes32,address)
claimProtocolFees(bytes32[])
claimProtocolNativeFees()
combineOptions(uint32,bytes)
configNonce(bytes32,uint8)
createAsset(address,address)
descriptorOf(bytes32)
descriptorSent(bytes32,uint32)
enableChain(bytes32,uint32,bytes32,bytes)
enabledEids(bytes32)
endpoint()
enforcedOptions(uint32)
failedMessages(bytes32)
freezeRouteConfig(uint32,bytes32)
getAsset(bytes32)
handleMessage(uint32,uint64,bytes32,bytes,bool)
isChainEnabled(bytes32,uint32)
isComposeMsgSender((uint32,bytes32,uint64),bytes,address)
localEid()
lzReceive((uint32,bytes32,uint64),bytes32,bytes,address,bytes)
maxFlatFee()
minFlatFee()
minGas(uint32,uint8)
nextNonce(uint32,bytes32)
oftImplementation()
owner()
ownerNativeFees(bytes32)
ownerTokenFees(bytes32)
peerEids()
peerVm(uint32)
peers(uint32)
pendingOwner()
preEnabledEids(bytes32)
predictAdapter(bytes32)
predictOFT(bytes32)
protocolNativeFees()
protocolTokenFees(bytes32)
quoteOFT((uint32,bytes32,uint256,uint256,bytes,bytes,bytes))
quoteSend(address,(uint32,bytes32,uint256,uint256,bytes,bytes,bytes),bool)
receiveGas(bytes32,uint32,uint8)
receiveValue(uint32)
renounceOwnership()
restore(bytes32,bytes,bytes)
retry(bytes32,bytes)
routeConfigHash(uint32)
routeFrozen(uint32)
routeFrozenAt(uint32)
send(address,(uint32,bytes32,uint256,uint256,bytes,bytes,bytes),(uint256,uint256),address)
setCompliance(bytes32,address)
setFees(bytes32,uint128,uint16)
setMinGas(uint32,uint8,uint128)
setPeer(uint32,bytes32,uint8)
setReceiveValue(uint32,uint128)
setRemoteCompliance(bytes32,uint32,bytes32,bytes)
setRemoteFees(bytes32,uint32,uint128,uint16,bytes)
setRouteConfig(uint32,(address,address,address,uint32,uint64,uint64,address[]))
setRouteThreshold(uint32,uint8)
setTreasury(address)
syncAsset(bytes32,uint32,bytes)
transferOwnership(address)
treasury()
vault()
withdrawRemoteFees(bytes32,uint32,bytes32,bytes)

OFT

DOMAIN_SEPARATOR()
SEND()
SEND_AND_CALL()
allowance(address,address)
approvalRequired()
approve(address,uint256)
assetId()
balanceOf(address)
bridgeTransfer(address,address,uint256)
burn(address,uint256)
combineOptions(uint32,uint16,bytes)
compliance()
complianceMode()
creator()
decimalConversionRate()
decimals()
eip712Domain()
endpoint()
enforcedOptions(uint32,uint16)
initialize(address,bytes32,uint32,uint32,bytes32,string,string,uint8,uint8,bool)
isPeer(uint32,bytes32)
localEid()
mint(address,uint256)
msgInspector()
name()
nonces(address)
notifyReceived(bytes32,uint32,address,uint256)
oAppVersion()
oftVersion()
omnisea()
originEid()
owner()
peers(uint32)
permit(address,address,uint256,uint256,uint8,bytes32,bytes32)
preCrime()
queueCompose(address,bytes32,bytes)
quoteOFT((uint32,bytes32,uint256,uint256,bytes,bytes,bytes))
quoteSend((uint32,bytes32,uint256,uint256,bytes,bytes,bytes),bool)
renounceOwnership()
send((uint32,bytes32,uint256,uint256,bytes,bytes,bytes),(uint256,uint256),address)
setCompliance(address)
setDelegate(address)
setEnforcedOptions((uint32,uint16,bytes)[])
setMsgInspector(address)
setPeer(uint32,bytes32)
setPreCrime(address)
sharedDecimals()
symbol()
token()
totalSupply()
transfer(address,uint256)
transferFrom(address,address,uint256)
transferOwnership(address)

OFTAdapter

SEND()
SEND_AND_CALL()
approvalRequired()
assetId()
combineOptions(uint32,uint16,bytes)
creator()
decimalConversionRate()
decimals()
endpoint()
enforcedOptions(uint32,uint16)
initialize(address,bytes32,uint32,bytes32,address,string,string,uint8,uint8)
isPeer(uint32,bytes32)
msgInspector()
name()
notifyReceived(bytes32,uint32,address,uint256)
oAppVersion()
oftVersion()
omnisea()
originEid()
owner()
peers(uint32)
preCrime()
pullToVault(address,address,uint256)
queueCompose(address,bytes32,bytes)
quoteOFT((uint32,bytes32,uint256,uint256,bytes,bytes,bytes))
quoteSend((uint32,bytes32,uint256,uint256,bytes,bytes,bytes),bool)
renounceOwnership()
send((uint32,bytes32,uint256,uint256,bytes,bytes,bytes),(uint256,uint256),address)
setDelegate(address)
setEnforcedOptions((uint32,uint16,bytes)[])
setMsgInspector(address)
setPeer(uint32,bytes32)
setPreCrime(address)
sharedDecimals()
symbol()
token()
transferOwnership(address)
underlying()

Lens

activePeerEids(address)
quoteRestore(address,bytes32,bytes,bytes)
quoteSetRemoteFees(address,bytes32,uint32,uint128,uint16,bytes)
quoteSync(address,bytes32,uint32,bytes32,bytes)
quoteWithdrawRemoteFees(address,bytes32,uint32,bytes32,bytes)
restoreMessageOf(bytes)