Skip to content

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

Response

Kind: source

Structs

struct Response

Response data to a query.

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

struct AssetsParams

Parameters for the Assets response variant.

FieldTypeDescription
assetsstruct AssetsAssets payload.

struct ExecutionResultParams

Parameters for the ExecutionResult response variant.

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

struct VersionParams

Parameters for the Version response variant.

FieldTypeDescription
versionuint32XCM version value.

struct PalletsInfoParams

Parameters for the PalletsInfo response variant.

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

struct DispatchResultParams

Parameters for the DispatchResult response variant.

FieldTypeDescription
resultstruct MaybeErrorCodeDispatch result status.

Enums

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`.

Top-Level Functions

  • function null\_() internal pure returns (struct Response)
    • Creates a Null response.
  • function assets(struct AssetsParams params) internal pure returns (struct Response)
    • Creates an Assets response.
  • function executionResult(struct ExecutionResultParams params) internal pure returns (struct Response)
    • Creates an ExecutionResult response.
  • function version(struct VersionParams params) internal pure returns (struct Response)
    • Creates a Version response.
  • function palletsInfo(struct PalletsInfoParams params) internal pure returns (struct Response)
    • Creates a PalletsInfo response.
  • function dispatchResult(struct DispatchResultParams params) internal pure returns (struct Response)
    • Creates a DispatchResult response.

Created with solidity-doc-generator