Skip to content
solidity
import "solidity-scale-codec/src/Xcm/v5/Response/Response.sol";

File-Level Functions

null_()

solidity
function null_() internal pure returns (struct Response)

Creates a `Null` response.

assets(struct AssetsParams params)

solidity
function assets(struct AssetsParams params) internal pure returns (struct Response)

Creates an `Assets` response.

executionResult(struct ExecutionResultParams params)

solidity
function executionResult(struct ExecutionResultParams params) internal pure returns (struct Response)

Creates an `ExecutionResult` response.

version(struct VersionParams params)

solidity
function version(struct VersionParams params) internal pure returns (struct Response)

Creates a `Version` response.

palletsInfo(struct PalletsInfoParams params)

solidity
function palletsInfo(struct PalletsInfoParams params) internal pure returns (struct Response)

Creates a `PalletsInfo` response.

dispatchResult(struct DispatchResultParams params)

solidity
function dispatchResult(struct DispatchResultParams params) internal pure returns (struct Response)

Creates a `DispatchResult` response.

File-Level Structs

Response

solidity
struct Response

Response data to a query.

FieldTypeDescription
variantResponseVariantThe type of the response. See `ResponseVariant` enum for possible values.
payloadbytesThe SCALE-encoded payload of the response. Structure depends on `variant`.

AssetsParams

solidity
struct AssetsParams

Parameters for the `Assets` response variant.

FieldTypeDescription
assetsAssetsAssets payload.

ExecutionResultParams

solidity
struct ExecutionResultParams

Parameters for the `ExecutionResult` response variant.

FieldTypeDescription
hasErrorboolIndicates if there was an error.
indexuint32The index of the instruction that caused the error.
errXcmErrorThe XCM error that occurred.

VersionParams

solidity
struct VersionParams

Parameters for the `Version` response variant.

FieldTypeDescription
versionuint32XCM version value.

PalletsInfoParams

solidity
struct PalletsInfoParams

Parameters for the `PalletsInfo` response variant.

FieldTypeDescription
palletsPalletInfo[]Array of `PalletInfo` structs, containing the info of the pallets. Max length is MAX_PALLETS_INFO (64).

DispatchResultParams

solidity
struct DispatchResultParams

Parameters for the `DispatchResult` response variant.

FieldTypeDescription
resultMaybeErrorCodeDispatch result status.

File-Level Enums

ResponseVariant

solidity
enum ResponseVariant

Discriminant for the `Response` enum.

VariantDescription
NullNo response. Serves as a neutral default.
AssetsSome assets.
ExecutionResultThe outcome of an XCM instruction.
VersionAn XCM version.
PalletsInfoThe index, instance name, pallet name and version of some pallets.
DispatchResultThe status of a dispatch attempt using `Transact`.

Response

Kind: source