XcmpQueue¶

Calls¶

resume_xcm_execution¶

Resumes all XCM executions for the XCMP queue.

Note that this function doesn't change the status of the in/out bound channels.

origin: Must pass ControllerOrigin.

Attributes¶

No attributes

Python¶

call = substrate.compose_call(
    'XcmpQueue', 'resume_xcm_execution', {}
)

service_overweight¶

Services a single overweight XCM.

origin: Must pass ExecuteOverweightOrigin.
index: The index of the overweight XCM to service
weight_limit: The amount of weight that XCM execution may take.

Errors: - BadOverweightIndex: XCM under index is not found in the Overweight storage map. - BadXcm: XCM under index cannot be properly decoded into a valid XCM format. - WeightOverLimit: XCM execution may use greater weight_limit.

Events: - OverweightServiced: On success.

Attributes¶

Name	Type
index	`OverweightIndex`
weight_limit	`Weight`

Python¶

call = substrate.compose_call(
    'XcmpQueue', 'service_overweight', {
    'index': 'u64',
    'weight_limit': {
        'proof_size': 'u64',
        'ref_time': 'u64',
    },
}
)

suspend_xcm_execution¶

Suspends all XCM executions for the XCMP queue, regardless of the sender's origin.

origin: Must pass ControllerOrigin.

Attributes¶

No attributes

Python¶

call = substrate.compose_call(
    'XcmpQueue', 'suspend_xcm_execution', {}
)

update_drop_threshold¶

Overwrites the number of pages of messages which must be in the queue after which we drop any further messages from the channel.

origin: Must pass Root.
new: Desired value for QueueConfigData.drop_threshold

Attributes¶

Name	Type
new	`u32`

Python¶

call = substrate.compose_call(
    'XcmpQueue', 'update_drop_threshold', {'new': 'u32'}
)

update_resume_threshold¶

Overwrites the number of pages of messages which the queue must be reduced to before it signals that message sending may recommence after it has been suspended.

origin: Must pass Root.
new: Desired value for QueueConfigData.resume_threshold

Attributes¶

Name	Type
new	`u32`

Python¶

call = substrate.compose_call(
    'XcmpQueue', 'update_resume_threshold', {'new': 'u32'}
)

update_suspend_threshold¶

Overwrites the number of pages of messages which must be in the queue for the other side to be told to suspend their sending.

origin: Must pass Root.
new: Desired value for QueueConfigData.suspend_value

Attributes¶

Name	Type
new	`u32`

Python¶

call = substrate.compose_call(
    'XcmpQueue', 'update_suspend_threshold', {'new': 'u32'}
)

update_threshold_weight¶

Overwrites the amount of remaining weight under which we stop processing messages.

origin: Must pass Root.
new: Desired value for QueueConfigData.threshold_weight

Attributes¶

Name	Type
new	`Weight`

Python¶

call = substrate.compose_call(
    'XcmpQueue', 'update_threshold_weight', {
    'new': {
        'proof_size': 'u64',
        'ref_time': 'u64',
    },
}
)

update_weight_restrict_decay¶

Overwrites the speed to which the available weight approaches the maximum weight. A lower number results in a faster progression. A value of 1 makes the entire weight available initially.

origin: Must pass Root.
new: Desired value for QueueConfigData.weight_restrict_decay.

Attributes¶

Name	Type
new	`Weight`

Python¶

call = substrate.compose_call(
    'XcmpQueue', 'update_weight_restrict_decay', {
    'new': {
        'proof_size': 'u64',
        'ref_time': 'u64',
    },
}
)

update_xcmp_max_individual_weight¶

Overwrite the maximum amount of weight any individual message may consume. Messages above this weight go into the overweight queue and may only be serviced explicitly.

origin: Must pass Root.
new: Desired value for QueueConfigData.xcmp_max_individual_weight.

Attributes¶

Name	Type
new	`Weight`

Python¶

call = substrate.compose_call(
    'XcmpQueue', 'update_xcmp_max_individual_weight', {
    'new': {
        'proof_size': 'u64',
        'ref_time': 'u64',
    },
}
)

Events¶

BadFormat¶

Bad XCM format used.

Attributes¶

Name	Type	Composition
message_hash	`Option<XcmHash>`	`(None, '[u8; 32]')`

BadVersion¶

Bad XCM version used.

Attributes¶

Name	Type	Composition
message_hash	`Option<XcmHash>`	`(None, '[u8; 32]')`

Fail¶

Some XCM failed.

Attributes¶

Name	Type	Composition
message_hash	`Option<XcmHash>`	`(None, '[u8; 32]')`
error	`XcmError`	{'Overflow': None, 'Unimplemented': None, 'UntrustedReserveLocation': None, 'UntrustedTeleportLocation': None, 'LocationFull': None, 'LocationNotInvertible': None, 'BadOrigin': None, 'InvalidLocation': None, 'AssetNotFound': None, 'FailedToTransactAsset': None, 'NotWithdrawable': None, 'LocationCannotHold': None, 'ExceedsMaxMessageSize': None, 'DestinationUnsupported': None, 'Transport': None, 'Unroutable': None, 'UnknownClaim': None, 'FailedToDecode': None, 'MaxWeightInvalid': None, 'NotHoldingFees': None, 'TooExpensive': None, 'Trap': 'u64', 'ExpectationFalse': None, 'PalletNotFound': None, 'NameMismatch': None, 'VersionIncompatible': None, 'HoldingWouldOverflow': None, 'ExportError': None, 'ReanchorFailed': None, 'NoDeal': None, 'FeesNotMet': None, 'LockError': None, 'NoPermission': None, 'Unanchored': None, 'NotDepositable': None, 'UnhandledXcmVersion': None, 'WeightLimitReached': {'ref_time': 'u64', 'proof_size': 'u64'}, 'Barrier': None, 'WeightNotComputable': None, 'ExceedsStackLimit': None}
weight	`Weight`	`{'ref_time': 'u64', 'proof_size': 'u64'}`

OverweightEnqueued¶

An XCM exceeded the individual message weight budget.

Attributes¶

Name	Type	Composition
sender	`ParaId`	`u32`
sent_at	`RelayBlockNumber`	`u32`
index	`OverweightIndex`	`u64`
required	`Weight`	`{'ref_time': 'u64', 'proof_size': 'u64'}`

OverweightServiced¶

An XCM from the overweight queue was executed with the given actual weight used.

Attributes¶

Name	Type	Composition
index	`OverweightIndex`	`u64`
used	`Weight`	`{'ref_time': 'u64', 'proof_size': 'u64'}`

Success¶

Some XCM was executed ok.

Attributes¶

Name	Type	Composition
message_hash	`Option<XcmHash>`	`(None, '[u8; 32]')`
weight	`Weight`	`{'ref_time': 'u64', 'proof_size': 'u64'}`

XcmpMessageSent¶

An HRMP message was sent to a sibling parachain.

Attributes¶

Name	Type	Composition
message_hash	`Option<XcmHash>`	`(None, '[u8; 32]')`

Storage functions¶

CounterForOverweight¶

Counter for the related counted storage map

Python¶

result = substrate.query(
    'XcmpQueue', 'CounterForOverweight', []
)

Return value¶

'u32'

InboundXcmpMessages¶

Inbound aggregate XCMP messages. It can only be one per ParaId/block.

Python¶

result = substrate.query(
    'XcmpQueue', 'InboundXcmpMessages', ['u32', 'u32']
)

Return value¶

'Bytes'

InboundXcmpStatus¶

Status of the inbound XCMP channels.

Python¶

result = substrate.query(
    'XcmpQueue', 'InboundXcmpStatus', []
)

Return value¶

[
    {
        'message_metadata': [
            (
                'u32',
                (
                    'ConcatenatedVersionedXcm',
                    'ConcatenatedEncodedBlob',
                    'Signals',
                ),
            ),
        ],
        'sender': 'u32',
        'state': ('Ok', 'Suspended'),
    },
]

OutboundXcmpMessages¶

The messages outbound in a given XCMP channel.

Python¶

result = substrate.query(
    'XcmpQueue', 'OutboundXcmpMessages', ['u32', 'u16']
)

Return value¶

'Bytes'

OutboundXcmpStatus¶

The non-empty XCMP channels in order of becoming non-empty, and the index of the first and last outbound message. If the two indices are equal, then it indicates an empty queue and there must be a non-Ok OutboundStatus. We assume queues grow no greater than 65535 items. Queue indices for normal messages begin at one; zero is reserved in case of the need to send a high-priority signal message this block. The bool is true if there is a signal message waiting to be sent.

Python¶

result = substrate.query(
    'XcmpQueue', 'OutboundXcmpStatus', []
)

Return value¶

[
    {
        'first_index': 'u16',
        'last_index': 'u16',
        'recipient': 'u32',
        'signals_exist': 'bool',
        'state': ('Ok', 'Suspended'),
    },
]

Overweight¶

The messages that exceeded max individual message weight budget.

These message stay in this storage map until they are manually dispatched via service_overweight.

Python¶

result = substrate.query(
    'XcmpQueue', 'Overweight', ['u64']
)

Return value¶

('u32', 'u32', 'Bytes')

OverweightCount¶

The number of overweight messages ever recorded in Overweight. Also doubles as the next available free overweight index.

Python¶

result = substrate.query(
    'XcmpQueue', 'OverweightCount', []
)

Return value¶

'u64'

QueueConfig¶

The configuration which controls the dynamics of the outbound queue.

Python¶

result = substrate.query(
    'XcmpQueue', 'QueueConfig', []
)

Return value¶

{
    'drop_threshold': 'u32',
    'resume_threshold': 'u32',
    'suspend_threshold': 'u32',
    'threshold_weight': {'proof_size': 'u64', 'ref_time': 'u64'},
    'weight_restrict_decay': {'proof_size': 'u64', 'ref_time': 'u64'},
    'xcmp_max_individual_weight': {'proof_size': 'u64', 'ref_time': 'u64'},
}

QueueSuspended¶

Whether or not the XCMP queue is suspended from executing incoming XCMs or not.

Python¶

result = substrate.query(
    'XcmpQueue', 'QueueSuspended', []
)

Return value¶

'bool'

SignalMessages¶

Any signal messages waiting to be sent.

Python¶

result = substrate.query(
    'XcmpQueue', 'SignalMessages', ['u32']
)

Return value¶

'Bytes'

Errors¶

BadOverweightIndex¶

Bad overweight index.

BadXcm¶

Bad XCM data.

BadXcmOrigin¶

Bad XCM origin.

FailedToSend¶

Failed to send XCM message.

WeightOverLimit¶

Provided weight is possibly not enough to execute the message.