import "solidity-scale-codec/src/Xcm/v5/Instruction/Instruction.sol";

File-Level Functions

• function withdrawAsset(struct WithdrawAssetParams params) internal pure returns (struct Instruction)

• function reserveAssetDeposited(struct ReserveAssetDepositedParams params) internal pure returns (struct Instruction)

• function receiveTeleportedAsset(struct ReceiveTeleportedAssetParams params) internal pure returns (struct Instruction)

• function queryResponse(struct QueryResponseParams params) internal pure returns (struct Instruction)

• function transferAsset(struct TransferAssetParams params) internal pure returns (struct Instruction)

• function transferReserveAsset(struct TransferReserveAssetParams params) internal pure returns (struct Instruction)

• function transact(struct TransactParams params) internal pure returns (struct Instruction)

• function hrmpNewChannelOpenRequest(struct HrmpNewChannelOpenRequestParams params) internal pure returns (struct Instruction)

• function hrmpChannelAccepted(struct HrmpChannelAcceptedParams params) internal pure returns (struct Instruction)

• function hrmpChannelClosing(struct HrmpChannelClosingParams params) internal pure returns (struct Instruction)

• function clearOrigin() internal pure returns (struct Instruction)

• function descendOrigin(struct DescendOriginParams params) internal pure returns (struct Instruction)

• function reportError(struct ReportErrorParams params) internal pure returns (struct Instruction)

• function depositAsset(struct DepositAssetParams params) internal pure returns (struct Instruction)

• function depositReserveAsset(struct DepositReserveAssetParams params) internal pure returns (struct Instruction)

• function exchangeAsset(struct ExchangeAssetParams params) internal pure returns (struct Instruction)

• function initiateReserveWithdraw(struct InitiateReserveWithdrawParams params) internal pure returns (struct Instruction)

• function initiateTeleport(struct InitiateTeleportParams params) internal pure returns (struct Instruction)

• function reportHolding(struct ReportHoldingParams params) internal pure returns (struct Instruction)

• function buyExecution(struct BuyExecutionParams params) internal pure returns (struct Instruction)

• function refundSurplus() internal pure returns (struct Instruction)

• function setErrorHandler(struct SetErrorHandlerParams params) internal pure returns (struct Instruction)

• function setAppendix(struct SetAppendixParams params) internal pure returns (struct Instruction)

• function clearError() internal pure returns (struct Instruction)

• function claimAsset(struct ClaimAssetParams params) internal pure returns (struct Instruction)

• function trap(struct TrapParams params) internal pure returns (struct Instruction)

• function subscribeVersion(struct SubscribeVersionParams params) internal pure returns (struct Instruction)

• function unsubscribeVersion() internal pure returns (struct Instruction)

• function burnAsset(struct BurnAssetParams params) internal pure returns (struct Instruction)

• function expectAsset(struct ExpectAssetParams params) internal pure returns (struct Instruction)

• function expectOrigin(struct ExpectOriginParams params) internal pure returns (struct Instruction)

• function expectError(struct ExpectErrorParams params) internal pure returns (struct Instruction)

• function expectTransactStatus(struct ExpectTransactStatusParams params) internal pure returns (struct Instruction)

• function queryPallet(struct QueryPalletParams params) internal pure returns (struct Instruction)

• function expectPallet(struct ExpectPalletParams params) internal pure returns (struct Instruction)

• function reportTransactStatus(struct ReportTransactStatusParams params) internal pure returns (struct Instruction)

• function clearTransactStatus() internal pure returns (struct Instruction)

• function universalOrigin(struct UniversalOriginParams params) internal pure returns (struct Instruction)

• function exportMessage(struct ExportMessageParams params) internal pure returns (struct Instruction)

• function lockAsset(struct LockAssetParams params) internal pure returns (struct Instruction)

• function unlockAsset(struct UnlockAssetParams params) internal pure returns (struct Instruction)

• function noteUnlockable(struct NoteUnlockableParams params) internal pure returns (struct Instruction)

• function requestUnlock(struct RequestUnlockParams params) internal pure returns (struct Instruction)

• function setFeesMode(struct SetFeesModeParams params) internal pure returns (struct Instruction)

• function setTopic(struct SetTopicParams params) internal pure returns (struct Instruction)

• function clearTopic() internal pure returns (struct Instruction)

• function aliasOrigin(struct AliasOriginParams params) internal pure returns (struct Instruction)

• function unpaidExecution(struct UnpaidExecutionParams params) internal pure returns (struct Instruction)

• function payFees(struct PayFeesParams params) internal pure returns (struct Instruction)

• function initiateTransfer(struct InitiateTransferParams params) internal pure returns (struct Instruction)

• function executeWithOrigin(struct ExecuteWithOriginParams params) internal pure returns (struct Instruction)

• function setHints(struct SetHintsParams params) internal pure returns (struct Instruction)

withdrawAsset(struct WithdrawAssetParams params)

function withdrawAsset(struct WithdrawAssetParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `WithdrawAsset` variant with the provided `params`.

reserveAssetDeposited(struct ReserveAssetDepositedParams params)

function reserveAssetDeposited(struct ReserveAssetDepositedParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `ReserveAssetDeposited` variant with the provided `params`.

receiveTeleportedAsset(struct ReceiveTeleportedAssetParams params)

function receiveTeleportedAsset(struct ReceiveTeleportedAssetParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `ReceiveTeleportedAsset` variant with the provided `params`.

queryResponse(struct QueryResponseParams params)

function queryResponse(struct QueryResponseParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `QueryResponse` variant with the provided `params`.

transferAsset(struct TransferAssetParams params)

function transferAsset(struct TransferAssetParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `TransferAsset` variant with the provided `params`.

transferReserveAsset(struct TransferReserveAssetParams params)

function transferReserveAsset(struct TransferReserveAssetParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `TransferReserveAsset` variant with the provided `params`.

transact(struct TransactParams params)

function transact(struct TransactParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `Transact` variant with the provided `params`.

hrmpNewChannelOpenRequest(struct HrmpNewChannelOpenRequestParams params)

function hrmpNewChannelOpenRequest(struct HrmpNewChannelOpenRequestParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `HrmpNewChannelOpenRequest` variant with the provided `params`.

hrmpChannelAccepted(struct HrmpChannelAcceptedParams params)

function hrmpChannelAccepted(struct HrmpChannelAcceptedParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `HrmpChannelAccepted` variant with the provided `params`.

hrmpChannelClosing(struct HrmpChannelClosingParams params)

function hrmpChannelClosing(struct HrmpChannelClosingParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `HrmpChannelClosing` variant with the provided `params`.

clearOrigin()

function clearOrigin() internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `ClearOrigin` variant.

descendOrigin(struct DescendOriginParams params)

function descendOrigin(struct DescendOriginParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `DescendOrigin` variant with the provided `params`.

reportError(struct ReportErrorParams params)

function reportError(struct ReportErrorParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `ReportError` variant with the provided `params`.

depositAsset(struct DepositAssetParams params)

function depositAsset(struct DepositAssetParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `DepositAsset` variant with the provided `params`.

depositReserveAsset(struct DepositReserveAssetParams params)

function depositReserveAsset(struct DepositReserveAssetParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `DepositReserveAsset` variant with the provided `params`.

exchangeAsset(struct ExchangeAssetParams params)

function exchangeAsset(struct ExchangeAssetParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `ExchangeAsset` variant with the provided `params`.

initiateReserveWithdraw(struct InitiateReserveWithdrawParams params)

function initiateReserveWithdraw(struct InitiateReserveWithdrawParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `InitiateReserveWithdraw` variant with the provided `params`.

initiateTeleport(struct InitiateTeleportParams params)

function initiateTeleport(struct InitiateTeleportParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `InitiateTeleport` variant with the provided `params`.

reportHolding(struct ReportHoldingParams params)

function reportHolding(struct ReportHoldingParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `ReportHolding` variant with the provided `params`.

buyExecution(struct BuyExecutionParams params)

function buyExecution(struct BuyExecutionParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `BuyExecution` variant with the provided `params`.

refundSurplus()

function refundSurplus() internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `RefundSurplus` variant.

setErrorHandler(struct SetErrorHandlerParams params)

function setErrorHandler(struct SetErrorHandlerParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `SetErrorHandler` variant with the provided `params`.

setAppendix(struct SetAppendixParams params)

function setAppendix(struct SetAppendixParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `SetAppendix` variant with the provided `params`.

clearError()

function clearError() internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `ClearError` variant.

claimAsset(struct ClaimAssetParams params)

function claimAsset(struct ClaimAssetParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `ClaimAsset` variant with the provided `params`.

trap(struct TrapParams params)

function trap(struct TrapParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `Trap` variant with the provided `params`.

subscribeVersion(struct SubscribeVersionParams params)

function subscribeVersion(struct SubscribeVersionParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `SubscribeVersion` variant with the provided `params`.

unsubscribeVersion()

function unsubscribeVersion() internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `UnsubscribeVersion` variant.

burnAsset(struct BurnAssetParams params)

function burnAsset(struct BurnAssetParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `BurnAsset` variant with the provided `params`.

expectAsset(struct ExpectAssetParams params)

function expectAsset(struct ExpectAssetParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `ExpectAsset` variant with the provided `params`.

expectOrigin(struct ExpectOriginParams params)

function expectOrigin(struct ExpectOriginParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `ExpectOrigin` variant with the provided `params`.

expectError(struct ExpectErrorParams params)

function expectError(struct ExpectErrorParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `ExpectError` variant with the provided `params`.

expectTransactStatus(struct ExpectTransactStatusParams params)

function expectTransactStatus(struct ExpectTransactStatusParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `ExpectTransactStatus` variant with the provided `params`.

queryPallet(struct QueryPalletParams params)

function queryPallet(struct QueryPalletParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `QueryPallet` variant with the provided `params`.

expectPallet(struct ExpectPalletParams params)

function expectPallet(struct ExpectPalletParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `ExpectPallet` variant with the provided `params`.

reportTransactStatus(struct ReportTransactStatusParams params)

function reportTransactStatus(struct ReportTransactStatusParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `ReportTransactStatus` variant with the provided `params`.

clearTransactStatus()

function clearTransactStatus() internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `ClearTransactStatus` variant.

universalOrigin(struct UniversalOriginParams params)

function universalOrigin(struct UniversalOriginParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `UniversalOrigin` variant with the provided `params`.

exportMessage(struct ExportMessageParams params)

function exportMessage(struct ExportMessageParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `ExportMessage` variant with the provided `params`.

lockAsset(struct LockAssetParams params)

function lockAsset(struct LockAssetParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `LockAsset` variant with the provided `params`.

unlockAsset(struct UnlockAssetParams params)

function unlockAsset(struct UnlockAssetParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `UnlockAsset` variant with the provided `params`.

noteUnlockable(struct NoteUnlockableParams params)

function noteUnlockable(struct NoteUnlockableParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `NoteUnlockable` variant with the provided `params`.

requestUnlock(struct RequestUnlockParams params)

function requestUnlock(struct RequestUnlockParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `RequestUnlock` variant with the provided `params`.

setFeesMode(struct SetFeesModeParams params)

function setFeesMode(struct SetFeesModeParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `SetFeesMode` variant with the provided `params`.

setTopic(struct SetTopicParams params)

function setTopic(struct SetTopicParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `SetTopic` variant with the provided `params`.

clearTopic()

function clearTopic() internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `ClearTopic` variant.

aliasOrigin(struct AliasOriginParams params)

function aliasOrigin(struct AliasOriginParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `AliasOrigin` variant with the provided `params`.

unpaidExecution(struct UnpaidExecutionParams params)

function unpaidExecution(struct UnpaidExecutionParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `UnpaidExecution` variant with the provided `params`.

payFees(struct PayFeesParams params)

function payFees(struct PayFeesParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `PayFees` variant with the provided `params`.

initiateTransfer(struct InitiateTransferParams params)

function initiateTransfer(struct InitiateTransferParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `InitiateTransfer` variant with the provided `params`.

executeWithOrigin(struct ExecuteWithOriginParams params)

function executeWithOrigin(struct ExecuteWithOriginParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `ExecuteWithOrigin` variant with the provided `params`.

setHints(struct SetHintsParams params)

function setHints(struct SetHintsParams params) internal pure returns (struct Instruction)

Creates an `Instruction` struct representing the `SetHints` variant with the provided `params`.

File-Level Structs

• WithdrawAssetParams

• ReserveAssetDepositedParams

• ReceiveTeleportedAssetParams

• QueryResponseParams

• TransferAssetParams

• TransferReserveAssetParams

• TransactParams

• HrmpNewChannelOpenRequestParams

• HrmpChannelAcceptedParams

• HrmpChannelClosingParams

• DescendOriginParams

• ReportErrorParams

• DepositAssetParams

• DepositReserveAssetParams

• ExchangeAssetParams

• InitiateReserveWithdrawParams

• InitiateTeleportParams

• ReportHoldingParams

• BuyExecutionParams

• SetErrorHandlerParams

• SetAppendixParams

• ClaimAssetParams

• TrapParams

• SubscribeVersionParams

• BurnAssetParams

• ExpectAssetParams

• ExpectOriginParams

• ExpectErrorParams

• ExpectTransactStatusParams

• QueryPalletParams

• ExpectPalletParams

• ReportTransactStatusParams

• UniversalOriginParams

• ExportMessageParams

• LockAssetParams

• UnlockAssetParams

• NoteUnlockableParams

• RequestUnlockParams

• SetFeesModeParams

• SetTopicParams

• AliasOriginParams

• UnpaidExecutionParams

• PayFeesParams

• InitiateTransferParams

• ExecuteWithOriginParams

• SetHintsParams

• Instruction

WithdrawAssetParams

struct WithdrawAssetParams

Params for `WithdrawAsset`.

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

ReserveAssetDepositedParams

struct ReserveAssetDepositedParams

Params for `ReserveAssetDeposited`.

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

ReceiveTeleportedAssetParams

struct ReceiveTeleportedAssetParams

Params for `ReceiveTeleportedAsset`.

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

QueryResponseParams

struct QueryResponseParams

Params for `QueryResponse`.

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

TransferAssetParams

struct TransferAssetParams

Params for `TransferAsset`.

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

TransferReserveAssetParams

struct TransferReserveAssetParams

Params for `TransferReserveAsset`.

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

TransactParams

struct TransactParams

Params for `Transact`.

Field	Type	Description
originKind	OriginKind	The means of expressing message origin as dispatch origin.
hasFallbackMaxWeight	bool	Whether `fallbackMaxWeight` is present.
fallbackMaxWeight	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).

HrmpNewChannelOpenRequestParams

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.

HrmpChannelAcceptedParams

struct HrmpChannelAcceptedParams

Params for `HrmpChannelAccepted`.

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

HrmpChannelClosingParams

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.

DescendOriginParams

struct DescendOriginParams

Params for `DescendOrigin`.

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

ReportErrorParams

struct ReportErrorParams

Params for `ReportError`.

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

DepositAssetParams

struct DepositAssetParams

Params for `DepositAsset`.

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

DepositReserveAssetParams

struct DepositReserveAssetParams

Params for `DepositReserveAsset`.

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

ExchangeAssetParams

struct ExchangeAssetParams

Params for `ExchangeAsset`.

Field	Type	Description
give	AssetFilter	Maximum assets to remove from holding.
want	Assets	Minimum assets expected in exchange.
minimal	otherwise	-

InitiateReserveWithdrawParams

struct InitiateReserveWithdrawParams

Params for `InitiateReserveWithdraw`.

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

InitiateTeleportParams

struct InitiateTeleportParams

Params for `InitiateTeleport`.

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

ReportHoldingParams

struct ReportHoldingParams

Params for `ReportHolding`.

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

BuyExecutionParams

struct BuyExecutionParams

Params for `BuyExecution`.

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

SetErrorHandlerParams

struct SetErrorHandlerParams

Params for `SetErrorHandler`.

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

SetAppendixParams

struct SetAppendixParams

Params for `SetAppendix`.

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

ClaimAssetParams

struct ClaimAssetParams

Params for `ClaimAsset`.

Field	Type	Description
exactly	must	-
ticket	Location	Ticket identifier used to locate the claimable asset.

TrapParams

struct TrapParams

Params for `Trap`.

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

SubscribeVersionParams

struct SubscribeVersionParams

Params for `SubscribeVersion`.

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

BurnAssetParams

struct BurnAssetParams

Params for `BurnAsset`.

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

ExpectAssetParams

struct ExpectAssetParams

Params for `ExpectAsset`.

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

ExpectOriginParams

struct ExpectOriginParams

Params for `ExpectOrigin`.

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

ExpectErrorParams

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	XcmError	Expected XCM error when `hasError` is true.

ExpectTransactStatusParams

struct ExpectTransactStatusParams

Params for `ExpectTransactStatus`.

Field	Type	Description
transactStatus	MaybeErrorCode	Expected transact status register value.

QueryPalletParams

struct QueryPalletParams

Params for `QueryPallet`.

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

ExpectPalletParams

struct ExpectPalletParams

Params for `ExpectPallet`.

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

ReportTransactStatusParams

struct ReportTransactStatusParams

Params for `ReportTransactStatus`.

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

UniversalOriginParams

struct UniversalOriginParams

Params for `UniversalOrigin`.

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

ExportMessageParams

struct ExportMessageParams

Params for `ExportMessage`.

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

LockAssetParams

struct LockAssetParams

Params for `LockAsset`.

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

UnlockAssetParams

struct UnlockAssetParams

Params for `UnlockAsset`.

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

NoteUnlockableParams

struct NoteUnlockableParams

Params for `NoteUnlockable`.

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

RequestUnlockParams

struct RequestUnlockParams

Params for `RequestUnlock`.

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

SetFeesModeParams

struct SetFeesModeParams

Params for `SetFeesMode`.

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

SetTopicParams

struct SetTopicParams

Params for `SetTopic`.

Field	Type	Description
topic	bytes32	32-byte topic identifier.

AliasOriginParams

struct AliasOriginParams

Params for `AliasOrigin`.

Field	Type	Description
location	Location	New origin to alias to.

UnpaidExecutionParams

struct UnpaidExecutionParams

Params for `UnpaidExecution`.

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

PayFeesParams

struct PayFeesParams

Params for `PayFees`.

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

InitiateTransferParams

struct InitiateTransferParams

Params for `InitiateTransfer`.

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

ExecuteWithOriginParams

struct ExecuteWithOriginParams

Params for `ExecuteWithOrigin`.

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

SetHintsParams

struct SetHintsParams

Params for `SetHints`.

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

Instruction

struct Instruction

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

Field	Type	Description
variant	InstructionVariant	The type of the instruction. See `InstructionVariant` enum for possible values.
the	see	-

File-Level Enums

• InstructionVariant

InstructionVariant

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.

---

Instruction

Kind: source