File: src/Xcm/v5/Instruction/Instruction.sol

Instruction

Kind: source

Structs

struct WithdrawAssetParams

Params for WithdrawAsset.

Field	Type	Description
assets	struct Assets	The asset(s) to be withdrawn into holding.

struct ReserveAssetDepositedParams

Params for ReserveAssetDeposited.

Field	Type	Description
assets	struct Assets	The asset(s) that are minted into holding.

struct ReceiveTeleportedAssetParams

Params for ReceiveTeleportedAsset.

Field	Type	Description
assets	struct Assets	The asset(s) minted into the Holding Register.

struct QueryResponseParams

Params for QueryResponse.

Field	Type	Description
queryId	QueryId	The identifier of the query that resulted in this response.
response	struct Response	The message content.
maxWeight	struct Weight	The maximum weight that handling this response should take.
hasQuerier	bool	Whether `querier` is present.
querier	struct Location	The location responsible for initiating the response, when present.

struct TransferAssetParams

Params for TransferAsset.

Field	Type	Description
assets	struct Assets	The asset(s) to be withdrawn.
beneficiary	struct Location	The new owner for the assets.

struct TransferReserveAssetParams

Params for TransferReserveAsset.

Field	Type	Description
assets	struct Assets	The asset(s) to be withdrawn.
dest	struct Location	The location whose sovereign account will own the assets.
xcm	bytes	Instructions that follow `ReserveAssetDeposited`. SCALE-encoded Xcm<()>.

struct TransactParams

Params for Transact.

Field	Type	Description
originKind	enum OriginKind	The means of expressing message origin as dispatch origin.
hasFallbackMaxWeight	bool	Whether `fallbackMaxWeight` is present.
fallbackMaxWeight	struct Weight	Compatibility fallback weight, corresponding to v4 `require_weight_at_most`.
call	bytes	The raw encoded call bytes (`DoubleEncoded<Call>.encoded`, equivalent to Rust `Vec<u8>`). The `Transact` factory SCALE-encodes this as `Vec<u8>` (Compact length + bytes).

struct HrmpNewChannelOpenRequestParams

Params for HrmpNewChannelOpenRequest.

Field	Type	Description
sender	uint32	The sender in the to-be-opened channel.
maxMessageSize	uint32	The maximum size of a message proposed by the sender.
maxCapacity	uint32	The maximum number of messages that can be queued in the channel.

struct HrmpChannelAcceptedParams

Params for HrmpChannelAccepted.

Field	Type	Description
recipient	uint32	The recipient whose open-channel request was accepted.

struct HrmpChannelClosingParams

Params for HrmpChannelClosing.

Field	Type	Description
initiator	uint32	The party initiating the channel closure.
sender	uint32	The channel sender.
recipient	uint32	The channel recipient.

struct DescendOriginParams

Params for DescendOrigin.

Field	Type	Description
interior	struct Junctions	Interior location to descend origin into.

struct ReportErrorParams

Params for ReportError.

Field	Type	Description
responseInfo	struct QueryResponseInfo	Information for constructing and sending the query response.

struct DepositAssetParams

Params for DepositAsset.

Field	Type	Description
assets	struct AssetFilter	Asset filter selecting assets removed from holding.
beneficiary	struct Location	The new owner for the assets.

struct DepositReserveAssetParams

Params for DepositReserveAsset.

Field	Type	Description
assets	struct AssetFilter	Asset filter selecting assets removed from holding.
dest	struct Location	The location whose sovereign account will own the assets.
xcm	bytes	Orders that follow `ReserveAssetDeposited`. SCALE-encoded Xcm<()>.

struct ExchangeAssetParams

Params for ExchangeAsset.

Field	Type	Description
give	struct AssetFilter	Maximum assets to remove from holding.
want	struct Assets	Minimum assets expected in exchange.
maximal	bool	If true, prefer maximal exchange up to `give`; otherwise minimal exchange satisfying `want`.

struct InitiateReserveWithdrawParams

Params for InitiateReserveWithdraw.

Field	Type	Description
assets	struct AssetFilter	Asset filter selecting assets removed from holding.
reserve	struct Location	Reserve location for all selected assets.
xcm	bytes	Instructions to execute once withdrawn on reserve. SCALE-encoded Xcm<()>.

struct InitiateTeleportParams

Params for InitiateTeleport.

Field	Type	Description
assets	struct AssetFilter	Asset filter selecting assets removed from holding.
dest	struct Location	Destination location that accepts teleports from this origin.
xcm	bytes	Instructions to execute on destination. SCALE-encoded Xcm<()>.

struct ReportHoldingParams

Params for ReportHolding.

Field	Type	Description
responseInfo	struct QueryResponseInfo	Information for constructing and sending the query response.
assets	struct AssetFilter	Filter over holdings to be reported.

struct BuyExecutionParams

Params for BuyExecution.

Field	Type	Description
fees	struct Asset	The asset(s) used to pay fees.
weightLimit	struct WeightLimit	The maximum amount of weight to purchase.

struct SetErrorHandlerParams

Params for SetErrorHandler.

Field	Type	Description
xcm	bytes	Error handler code. SCALE-encoded Xcm<Call>.

struct SetAppendixParams

Params for SetAppendix.

Field	Type	Description
xcm	bytes	Appendix code executed after program completion. SCALE-encoded Xcm<Call>.

struct ClaimAssetParams

Params for ClaimAsset.

Field	Type	Description
assets	struct Assets	Assets to claim; must exactly match claimable assets for ticket origin.
ticket	struct Location	Ticket identifier used to locate the claimable asset.

struct TrapParams

Params for Trap.

Field	Type	Description
code	uint64	Trap code used as the inner value of the `Trap` error.

struct SubscribeVersionParams

Params for SubscribeVersion.

Field	Type	Description
queryId	QueryId	Query identifier replicated into the response message.
maxResponseWeight	struct Weight	Maximum weight allowed for the responding `QueryResponse` execution.

struct BurnAssetParams

Params for BurnAsset.

Field	Type	Description
assets	struct Assets	Assets to burn from holding up to the provided amount.

struct ExpectAssetParams

Params for ExpectAsset.

Field	Type	Description
assets	struct Assets	Assets that must be present in holding.

struct ExpectOriginParams

Params for ExpectOrigin.

Field	Type	Description
hasOrigin	bool	Whether an expected origin is provided.
origin	struct Location	Expected origin location when `hasOrigin` is true.

struct ExpectErrorParams

Params for ExpectError.

Field	Type	Description
hasError	bool	Whether an expected error tuple is provided.
index	uint32	Expected instruction index when `hasError` is true.
err	struct XcmError	Expected XCM error when `hasError` is true.

struct ExpectTransactStatusParams

Params for ExpectTransactStatus.

Field	Type	Description
transactStatus	struct MaybeErrorCode	Expected transact status register value.

struct QueryPalletParams

Params for QueryPallet.

Field	Type	Description
moduleName	bytes	Pallet module name to query.
responseInfo	struct QueryResponseInfo	Information for constructing and sending the query response.

struct ExpectPalletParams

Params for ExpectPallet.

Field	Type	Description
index	uint32	Expected pallet index.
name	bytes	Expected pallet name.
moduleName	bytes	Expected pallet module name.
crateMajor	uint32	Expected crate major version.
minCrateMinor	uint32	Minimum acceptable crate minor version.

struct ReportTransactStatusParams

Params for ReportTransactStatus.

Field	Type	Description
responseInfo	struct QueryResponseInfo	Information for constructing and sending the query response.

struct UniversalOriginParams

Params for UniversalOrigin.

Field	Type	Description
junction	struct Junction	Child junction of the Universal Ancestor to set as origin.

struct ExportMessageParams

Params for ExportMessage.

Field	Type	Description
network	struct NetworkId	Remote consensus system to export to.
destination	struct Junctions	Destination interior location relative to the remote consensus system.
xcm	bytes	Message to export. SCALE-encoded Xcm<()>.

struct LockAssetParams

Params for LockAsset.

Field	Type	Description
asset	struct Asset	Asset to lock.
unlocker	struct Location	Origin required to unlock via a corresponding `UnlockAsset`.

struct UnlockAssetParams

Params for UnlockAsset.

Field	Type	Description
asset	struct Asset	Asset to unlock.
target	struct Location	Asset owner on the local chain.

struct NoteUnlockableParams

Params for NoteUnlockable.

Field	Type	Description
asset	struct Asset	Asset that is now unlockable from this origin.
owner	struct Location	Owner of the asset on the chain where it was locked.

struct RequestUnlockParams

Params for RequestUnlock.

Field	Type	Description
asset	struct Asset	Asset requested for unlock.
locker	struct Location	Location of the locker from prior `NoteUnlockable`.

struct SetFeesModeParams

Params for SetFeesMode.

Field	Type	Description
jitWithdraw	bool	If true, fees are withdrawn just-in-time for instructions.

struct SetTopicParams

Params for SetTopic.

Field	Type	Description
topic	bytes32	32-byte topic identifier.

struct AliasOriginParams

Params for AliasOrigin.

Field	Type	Description
location	struct Location	New origin to alias to.

struct UnpaidExecutionParams

Params for UnpaidExecution.

Field	Type	Description
weightLimit	struct WeightLimit	Free-execution weight limit.
hasCheckOrigin	bool	Whether a specific origin check is required.
checkOrigin	struct Location	Expected origin when `hasCheckOrigin` is true.

struct PayFeesParams

Params for PayFees.

Field	Type	Description
asset	struct Asset	Asset used to pay execution fees.

struct InitiateTransferParams

Params for InitiateTransfer.

Field	Type	Description
destination	struct Location	Location of the program next hop.
hasRemoteFees	bool	Whether `remoteFees` is provided.
remoteFees	struct AssetTransferFilter	Optional fee-reserved transfer filter used first on remote side.
preserveOrigin	bool	Whether to preserve origin (`AliasOrigin`) instead of clearing it.
assets	struct AssetTransferFilter\[\]	Transfer filters matched against holding assets for this leg.
remoteXcm	bytes	Custom instructions to run on destination. SCALE-encoded Xcm<()>.

struct ExecuteWithOriginParams

Params for ExecuteWithOrigin.

Field	Type	Description
hasDescendantOrigin	bool	Whether `descendantOrigin` is provided.
descendantOrigin	struct Junctions	Optional descendant origin for executing inner XCM.
xcm	bytes	Inner instructions executed under the derived origin. SCALE-encoded Xcm<Call>.

struct SetHintsParams

Params for SetHints.

Field	Type	Description
hints	struct Hint\[\]	A bounded vector of execution hints.

struct Instruction

Cross-Consensus Message: A message from one consensus system to another.

Field	Type	Description
variant	enum InstructionVariant	The type of the instruction. See `InstructionVariant` enum for possible values.
payload	bytes	SCALE-encoded instruction parameters. The type of the parameters depends on the instruction type; see the corresponding `Params` struct for each variant.

Enums

enum InstructionVariant

Discriminant for the Instruction enum, representing the type of instruction being executed.

Variant	Description
WithdrawAsset	Withdraw asset(s) from the ownership of `origin` and place them into the Holding Register.
ReserveAssetDeposited	Asset(s) have been received into the ownership of this system on the `origin` system and equivalent derivatives should be placed into the Holding Register.
ReceiveTeleportedAsset	Asset(s) have been destroyed on the `origin` system and equivalent assets should be created and placed into the Holding Register.
QueryResponse	Respond with information that the local system is expecting.
TransferAsset	Withdraw asset(s) from the ownership of `origin` and place equivalent assets under the ownership of `beneficiary`.
TransferReserveAsset	Withdraw asset(s) from the ownership of `origin` and place equivalent assets under the ownership of `dest` within this consensus system.
Transact	Apply the encoded transaction `call`, whose dispatch-origin should be `origin` as expressed by the kind of origin `origin_kind`.
HrmpNewChannelOpenRequest	A message to notify about a new incoming HRMP channel.
HrmpChannelAccepted	A message to notify about that a previously sent open channel request has been accepted by the recipient.
HrmpChannelClosing	A message to notify that the other party in an open channel decided to close it.
ClearOrigin	Clear the origin.
DescendOrigin	Mutate the origin to some interior location.
ReportError	Immediately report the contents of the Error Register to the given destination via XCM.
DepositAsset	Remove the asset(s) from the Holding Register and place equivalent assets under the ownership of `beneficiary`.
DepositReserveAsset	Remove the asset(s) from the Holding Register and place equivalent assets under the ownership of `dest`, then send a `ReserveAssetDeposited` onward message.
ExchangeAsset	Remove the asset(s) from the Holding Register and replace them with alternative assets.
InitiateReserveWithdraw	Remove the asset(s) from holding and send a `WithdrawAsset` XCM message to a reserve location.
InitiateTeleport	Remove the asset(s) from holding and send a `ReceiveTeleportedAsset` XCM message to a `dest` location.
ReportHolding	Report to a given destination the contents of the Holding Register.
BuyExecution	Pay for the execution of some XCM with up to `weight` picoseconds of execution time, paying with up to `fees` from the Holding Register.
RefundSurplus	Refund any surplus weight previously bought with `BuyExecution`.
SetErrorHandler	Set the Error Handler Register to code that should be called in the case of an error.
SetAppendix	Set the Appendix Register to code that should be called after execution (including error handler) is finished.
ClearError	Clear the Error Register.
ClaimAsset	Create some assets which are being held on behalf of the origin.
Trap	Always throws an error of type `Trap`.
SubscribeVersion	Ask the destination system to respond with the most recent version of XCM that they support.
UnsubscribeVersion	Cancel the effect of a previous `SubscribeVersion` instruction.
BurnAsset	Reduce Holding by up to the given assets.
ExpectAsset	Throw an error if Holding does not contain at least the given assets.
ExpectOrigin	Ensure that the Origin Register equals some given value and throw an error if not.
ExpectError	Ensure that the Error Register equals some given value and throw an error if not.
ExpectTransactStatus	Ensure that the Transact Status Register equals some given value and throw an error if not.
QueryPallet	Query the existence of a particular pallet type.
ExpectPallet	Ensure that a particular pallet with a particular version exists.
ReportTransactStatus	Send a `QueryResponse` message containing the value of the Transact Status Register to some destination.
ClearTransactStatus	Set the Transact Status Register to its default, cleared, value.
UniversalOrigin	Set the Origin Register to be some child of the Universal Ancestor.
ExportMessage	Send a message on to Non-Local Consensus system.
LockAsset	Lock the locally held asset and prevent further transfer or withdrawal.
UnlockAsset	Remove the lock over `asset` on this chain and allow the asset to be transferred.
NoteUnlockable	Asset has been locked on the `origin` system and may not be transferred.
RequestUnlock	Send an `UnlockAsset` instruction to the `locker` for the given `asset`.
SetFeesMode	Sets the Fees Mode Register.
SetTopic	Set the Topic Register.
ClearTopic	Clear the Topic Register.
AliasOrigin	Alter the current Origin to another given origin.
UnpaidExecution	A directive to indicate that the origin expects free execution of the message.
PayFees	Takes an asset, uses it to pay for execution and puts the rest in the fees register. Successor to `BuyExecution`.
InitiateTransfer	Initiates cross-chain transfer of assets in the holding register using specified asset transfer filters.
ExecuteWithOrigin	Executes inner `xcm` with origin set to the provided `descendant_origin`, then restores the original origin.
SetHints	Set hints for XCM execution, changing the behaviour of the XCM program.

Top-Level Functions

• function withdrawAsset(struct WithdrawAssetParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the WithdrawAsset variant with the provided params.
• function reserveAssetDeposited(struct ReserveAssetDepositedParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the ReserveAssetDeposited variant with the provided params.
• function receiveTeleportedAsset(struct ReceiveTeleportedAssetParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the ReceiveTeleportedAsset variant with the provided params.
• function queryResponse(struct QueryResponseParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the QueryResponse variant with the provided params.
• function transferAsset(struct TransferAssetParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the TransferAsset variant with the provided params.
• function transferReserveAsset(struct TransferReserveAssetParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the TransferReserveAsset variant with the provided params.
• function transact(struct TransactParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the Transact variant with the provided params.
• function hrmpNewChannelOpenRequest(struct HrmpNewChannelOpenRequestParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the HrmpNewChannelOpenRequest variant with the provided params.
• function hrmpChannelAccepted(struct HrmpChannelAcceptedParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the HrmpChannelAccepted variant with the provided params.
• function hrmpChannelClosing(struct HrmpChannelClosingParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the HrmpChannelClosing variant with the provided params.
• function clearOrigin() internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the ClearOrigin variant.
• function descendOrigin(struct DescendOriginParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the DescendOrigin variant with the provided params.
• function reportError(struct ReportErrorParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the ReportError variant with the provided params.
• function depositAsset(struct DepositAssetParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the DepositAsset variant with the provided params.
• function depositReserveAsset(struct DepositReserveAssetParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the DepositReserveAsset variant with the provided params.
• function exchangeAsset(struct ExchangeAssetParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the ExchangeAsset variant with the provided params.
• function initiateReserveWithdraw(struct InitiateReserveWithdrawParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the InitiateReserveWithdraw variant with the provided params.
• function initiateTeleport(struct InitiateTeleportParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the InitiateTeleport variant with the provided params.
• function reportHolding(struct ReportHoldingParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the ReportHolding variant with the provided params.
• function buyExecution(struct BuyExecutionParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the BuyExecution variant with the provided params.
• function refundSurplus() internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the RefundSurplus variant.
• function setErrorHandler(struct SetErrorHandlerParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the SetErrorHandler variant with the provided params.
• function setAppendix(struct SetAppendixParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the SetAppendix variant with the provided params.
• function clearError() internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the ClearError variant.
• function claimAsset(struct ClaimAssetParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the ClaimAsset variant with the provided params.
• function trap(struct TrapParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the Trap variant with the provided params.
• function subscribeVersion(struct SubscribeVersionParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the SubscribeVersion variant with the provided params.
• function unsubscribeVersion() internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the UnsubscribeVersion variant.
• function burnAsset(struct BurnAssetParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the BurnAsset variant with the provided params.
• function expectAsset(struct ExpectAssetParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the ExpectAsset variant with the provided params.
• function expectOrigin(struct ExpectOriginParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the ExpectOrigin variant with the provided params.
• function expectError(struct ExpectErrorParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the ExpectError variant with the provided params.
• function expectTransactStatus(struct ExpectTransactStatusParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the ExpectTransactStatus variant with the provided params.
• function queryPallet(struct QueryPalletParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the QueryPallet variant with the provided params.
• function expectPallet(struct ExpectPalletParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the ExpectPallet variant with the provided params.
• function reportTransactStatus(struct ReportTransactStatusParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the ReportTransactStatus variant with the provided params.
• function clearTransactStatus() internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the ClearTransactStatus variant.
• function universalOrigin(struct UniversalOriginParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the UniversalOrigin variant with the provided params.
• function exportMessage(struct ExportMessageParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the ExportMessage variant with the provided params.
• function lockAsset(struct LockAssetParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the LockAsset variant with the provided params.
• function unlockAsset(struct UnlockAssetParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the UnlockAsset variant with the provided params.
• function noteUnlockable(struct NoteUnlockableParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the NoteUnlockable variant with the provided params.
• function requestUnlock(struct RequestUnlockParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the RequestUnlock variant with the provided params.
• function setFeesMode(struct SetFeesModeParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the SetFeesMode variant with the provided params.
• function setTopic(struct SetTopicParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the SetTopic variant with the provided params.
• function clearTopic() internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the ClearTopic variant.
• function aliasOrigin(struct AliasOriginParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the AliasOrigin variant with the provided params.
• function unpaidExecution(struct UnpaidExecutionParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the UnpaidExecution variant with the provided params.
• function payFees(struct PayFeesParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the PayFees variant with the provided params.
• function initiateTransfer(struct InitiateTransferParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the InitiateTransfer variant with the provided params.
• function executeWithOrigin(struct ExecuteWithOriginParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the ExecuteWithOrigin variant with the provided params.
• function setHints(struct SetHintsParams params) internal pure returns (struct Instruction)
  • Creates an Instruction struct representing the SetHints variant with the provided params.