Msgport API

Note

If you want to delve deeper into the workings of the Msgport API, you can find Msgport Examples available for your use. These practical examples serve as a great resource to observe the functionality of the Msgport API in real-time.

The Msgport API serves as a specialized tool to assist Msgport Apps in acquiring additional information necessary for the message delivery process. Its primary role is to provide an estimation of the cross-chain fee in the native token of the source chain. This fee covers the various cross-chain expenses that Dapps are responsible for, encapsulating the costs associated with handling token value differences between chains and the delivery and execution fees incurred on both the source and destination chains. By offering the fee estimation in the source chain's native currency, the Msgport API simplifies these complexities, resulting in a seamless user experience. Users benefit from this approach as it eliminates the need for them to possess any tokens from the target chain to facilitate cross-chain transactions.

Beyond providing fee information, the API also delivers associated parameter data. These parameters are necessary for the messaging layer, which is the cross-chain messaging protocol employed by Msgport. Simply put, these parameters are the directives required by the messaging protocol's relayer to carry out cross-chain operations on the destination chain.

Request and Response

Click on the Msgport API and give it a try.

Request Example:

The request explained below:

• API Default URL: https://api.msgport.xyz/v2/fee_with_options
• Request Method: Post

• Params:

  Parameter	Description
  fromChainId	The source chain ID.
  toChainId	The destination chain ID.
  fromAddress	The application address in the source chain.
  toAddress	The application address in the destination chain.
  message	The eth-abi-encoded function call, which represents the cross-chain message.
  refundAddress	The account that receive the potential cross-chain fee refund.

Response Example:

The response explained below:

Parameter	Description
code	Indicates the success of the query.
fee	Represents the estimated fee in the native token of the source chain, utilized when calling the send() method in the source application.
params	Denotes the specific parameters required by the messaging protocol, used as the last parameter in the send(uint256 toChainId, address toDapp, bytes calldata message, bytes calldata params) method in the source application.
gas	Reflects the gas cost for the cross-chain message transition.