solidity-scale-codec 2.0.0 → 2.1.1

package/src/Xcm/v5/Junction/Junction.sol

@@ -99,6 +99,12 @@ struct GeneralIndexParams {
     uint128 index;
 }
 
+/// @notice Parameters for a `GlobalConsensus` junction.
+struct GlobalConsensusParams {
+    /// @custom:property The `NetworkId` associated with the global consensus, See `NetworkId` struct for details.
+    NetworkId network;
+}
+
 /// @notice A single item in a path to describe the relative location of a consensus system. Each item assumes a pre-existing location as its context and is defined in terms of it.
 struct Junction {
     /// @custom:property variant The type of the junction, determining how to interpret the payload. See `JunctionVariant` enum for possible values.
@@ -203,11 +209,9 @@ function generalIndex(
 function generalKey(
     GeneralKeyParams memory params
 ) pure returns (Junction memory) {
-    if (
-        params.length == 0 ||
-        params.length > 32 ||
-        params.key.length != params.length
-    ) revert InvalidJunctionPayload();
+    if (params.length == 0 || params.length > 32) {
+        revert InvalidJunctionPayload();
+    }
     return
         Junction({
             variant: JunctionVariant.GeneralKey,
@@ -221,6 +225,19 @@ function onlyChild() pure returns (Junction memory) {
     return Junction({variant: JunctionVariant.OnlyChild, payload: ""});
 }
 
+/// @notice Creates a `GlobalConsensus` junction, which represents a global network capable of externalizing its own consensus.
+/// @param params Parameters for the global consensus variant.
+/// @return A `Junction` struct representing the `GlobalConsensus` junction, with the encoded network payload.
+function globalConsensus(
+    GlobalConsensusParams memory params
+) pure returns (Junction memory) {
+    return
+        Junction({
+            variant: JunctionVariant.GlobalConsensus,
+            payload: params.network.encode()
+        });
+}
+
 /// @notice Creates a `Plurality` junction with the specified body ID and body part.
 /// @param params Parameters for the plurality variant.
 /// @return A `Junction` struct representing the `Plurality` junction with the provided parameters.

package/src/Xcm/v5/Junction/JunctionCodec.sol

@@ -10,18 +10,7 @@ import {NetworkIdCodec} from "../NetworkId/NetworkIdCodec.sol";
 import {Bytes32} from "../../../Scale/Bytes.sol";
 import {Address} from "../../../Scale/Address.sol";
 import {Compact} from "../../../Scale/Compact.sol";
-import {
-    Junction,
-    JunctionVariant,
-    ParachainParams,
-    AccountId32Params,
-    PluralityParams,
-    AccountIndex64Params,
-    AccountKey20Params,
-    GeneralKeyParams,
-    PalletInstanceParams,
-    GeneralIndexParams
-} from "./Junction.sol";
+import {Junction, JunctionVariant, ParachainParams, AccountId32Params, PluralityParams, AccountIndex64Params, AccountKey20Params, GeneralKeyParams, PalletInstanceParams, GeneralIndexParams, GlobalConsensusParams} from "./Junction.sol";
 import {BytesUtils} from "../../../Utils/BytesUtils.sol";
 import {UnsignedUtils} from "../../../Utils/UnsignedUtils.sol";
 
@@ -74,12 +63,12 @@ library JunctionCodec {
         } else if (variant == uint8(JunctionVariant.GeneralKey)) {
             if (offset >= data.length) revert InvalidJunctionLength();
             uint8 length = uint8(data[offset]);
-            payloadLength = 1 + length; // 1 byte for the length + the key bytes
-        } else if (
-            variant == uint8(JunctionVariant.OnlyChild) ||
-            variant == uint8(JunctionVariant.GlobalConsensus)
-        ) {
+            if (length == 0 || length > 32) revert InvalidJunctionPayload();
+            payloadLength = 1 + 32; // 1 byte for the length + the fixed key bytes
+        } else if (variant == uint8(JunctionVariant.OnlyChild)) {
             payloadLength = 0;
+        } else if (variant == uint8(JunctionVariant.GlobalConsensus)) {
+            payloadLength = NetworkIdCodec.encodedSizeAt(data, offset);
         } else if (variant == uint8(JunctionVariant.Plurality)) {
             uint256 innerLength = BodyIdCodec.encodedSizeAt(data, offset);
             payloadLength =
@@ -242,6 +231,16 @@ library JunctionCodec {
         );
     }
 
+    /// @notice Decodes a `GlobalConsensus` junction from a given `Junction` struct, extracting the network information.
+    /// @param junction The `Junction` struct to decode, which should represent a `GlobalConsensus` junction.
+    /// @return params A `GlobalConsensusParams` struct containing the decoded
+    function asGlobalConsensus(
+        Junction memory junction
+    ) internal pure returns (GlobalConsensusParams memory params) {
+        _assertVariant(junction, JunctionVariant.GlobalConsensus);
+        (params.network, ) = NetworkIdCodec.decode(junction.payload);
+    }
+
     function _innerNetworkIdSize(
         bytes memory data,
         uint256 offset

package/src/Xcm/v5/NetworkId/NetworkIdCodec.sol

@@ -2,13 +2,7 @@
 pragma solidity ^0.8.28;
 
 import {Compact} from "../../../Scale/Compact.sol";
-import {
-    NetworkId,
-    NetworkIdVariant,
-    ByForkParams,
-    ByGenesisParams,
-    EthereumParams
-} from "./NetworkId.sol";
+import {NetworkId, NetworkIdVariant, ByForkParams, ByGenesisParams, EthereumParams} from "./NetworkId.sol";
 import {LittleEndianU64} from "../../../LittleEndian/LittleEndianU64.sol";
 import {Bytes32} from "../../../Scale/Bytes.sol";
 import {BytesUtils} from "../../../Utils/BytesUtils.sol";
@@ -49,7 +43,13 @@ library NetworkIdCodec {
             payloadLen = 40; // 8 (u64) + 32 (bytes32)
         } else if (variant == uint8(NetworkIdVariant.Ethereum)) {
             payloadLen = Compact.encodedSizeAt(data, offset + 1);
-        } else if (variant < 4) {
+        } else if (
+            variant == uint8(NetworkIdVariant.Polkadot) ||
+            variant == uint8(NetworkIdVariant.Kusama) ||
+            variant == uint8(NetworkIdVariant.BitcoinCore) ||
+            variant == uint8(NetworkIdVariant.BitcoinCash) ||
+            variant == uint8(NetworkIdVariant.PolkadotBulletin)
+        ) {
             payloadLen = 0; // Static variants
         } else {
             // Reserved or unknown types are invalid

package/src/Xcm/v5/Response/ResponseCodec.sol

@@ -11,15 +11,7 @@ import {MaybeErrorCode} from "../../v3/MaybeErrorCode/MaybeErrorCode.sol";
 import {MaybeErrorCodeCodec} from "../../v3/MaybeErrorCode/MaybeErrorCodeCodec.sol";
 import {Compact} from "../../../Scale/Compact.sol";
 import {LittleEndianU32} from "../../../LittleEndian/LittleEndianU32.sol";
-import {
-    Response,
-    ResponseVariant,
-    AssetsParams,
-    VersionParams,
-    DispatchResultParams,
-    ExecutionResultParams,
-    PalletsInfoParams
-} from "./Response.sol";
+import {Response, ResponseVariant, AssetsParams, VersionParams, DispatchResultParams, ExecutionResultParams, PalletsInfoParams} from "./Response.sol";
 
 import {BytesUtils} from "../../../Utils/BytesUtils.sol";
 

package/src/Xcm/v5/WeightLimit/WeightLimitCodec.sol

@@ -3,11 +3,7 @@ pragma solidity ^0.8.28;
 
 import {Weight} from "../Weight/Weight.sol";
 import {WeightCodec} from "../Weight/WeightCodec.sol";
-import {
-    WeightLimit,
-    WeightLimitVariant,
-    LimitedParams
-} from "./WeightLimit.sol";
+import {WeightLimit, WeightLimitVariant, LimitedParams} from "./WeightLimit.sol";
 import {BytesUtils} from "../../../Utils/BytesUtils.sol";
 
 /// @title SCALE Codec for XCM v5 `WeightLimit`

package/src/Xcm/v5/WildAsset/WildAssetCodec.sol

@@ -6,13 +6,7 @@ import {AssetIdCodec} from "../AssetId/AssetIdCodec.sol";
 import {WildFungibilityCodec} from "../WildFungibility/WildFungibilityCodec.sol";
 import {AssetId} from "../AssetId/AssetId.sol";
 import {WildFungibility} from "../WildFungibility/WildFungibility.sol";
-import {
-    WildAsset,
-    WildAssetVariant,
-    AllOfParams,
-    AllCountedParams,
-    AllOfCountedParams
-} from "./WildAsset.sol";
+import {WildAsset, WildAssetVariant, AllOfParams, AllCountedParams, AllOfCountedParams} from "./WildAsset.sol";
 import {BytesUtils} from "../../../Utils/BytesUtils.sol";
 import {UnsignedUtils} from "../../../Utils/UnsignedUtils.sol";
 

package/src/Xcm/v5/Xcm/XcmBuilder.sol

@@ -1,107 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.28;
 
-import {
-    aliasOrigin as _aliasOrigin,
-    burnAsset as _burnAsset,
-    buyExecution as _buyExecution,
-    claimAsset as _claimAsset,
-    clearError as _clearError,
-    clearOrigin as _clearOrigin,
-    clearTopic as _clearTopic,
-    clearTransactStatus as _clearTransactStatus,
-    depositAsset as _depositAsset,
-    depositReserveAsset as _depositReserveAsset,
-    descendOrigin as _descendOrigin,
-    executeWithOrigin as _executeWithOrigin,
-    expectAsset as _expectAsset,
-    expectError as _expectError,
-    expectOrigin as _expectOrigin,
-    expectPallet as _expectPallet,
-    expectTransactStatus as _expectTransactStatus,
-    exchangeAsset as _exchangeAsset,
-    exportMessage as _exportMessage,
-    hrmpChannelAccepted as _hrmpChannelAccepted,
-    hrmpChannelClosing as _hrmpChannelClosing,
-    hrmpNewChannelOpenRequest as _hrmpNewChannelOpenRequest,
-    initiateReserveWithdraw as _initiateReserveWithdraw,
-    initiateTeleport as _initiateTeleport,
-    initiateTransfer as _initiateTransfer,
-    lockAsset as _lockAsset,
-    noteUnlockable as _noteUnlockable,
-    payFees as _payFees,
-    queryPallet as _queryPallet,
-    queryResponse as _queryResponse,
-    receiveTeleportedAsset as _receiveTeleportedAsset,
-    refundSurplus as _refundSurplus,
-    reportError as _reportError,
-    reportHolding as _reportHolding,
-    reportTransactStatus as _reportTransactStatus,
-    requestUnlock as _requestUnlock,
-    reserveAssetDeposited as _reserveAssetDeposited,
-    setAppendix as _setAppendix,
-    setErrorHandler as _setErrorHandler,
-    setFeesMode as _setFeesMode,
-    setHints as _setHints,
-    setTopic as _setTopic,
-    subscribeVersion as _subscribeVersion,
-    transact as _transact,
-    transferAsset as _transferAsset,
-    transferReserveAsset as _transferReserveAsset,
-    trap as _trap,
-    universalOrigin as _universalOrigin,
-    unpaidExecution as _unpaidExecution,
-    unlockAsset as _unlockAsset,
-    unsubscribeVersion as _unsubscribeVersion,
-    withdrawAsset as _withdrawAsset,
-    AliasOriginParams,
-    BurnAssetParams,
-    BuyExecutionParams,
-    ClaimAssetParams,
-    DepositAssetParams,
-    DepositReserveAssetParams,
-    DescendOriginParams,
-    ExecuteWithOriginParams,
-    ExpectAssetParams,
-    ExpectErrorParams,
-    ExpectOriginParams,
-    ExpectPalletParams,
-    ExpectTransactStatusParams,
-    ExchangeAssetParams,
-    ExportMessageParams,
-    HrmpChannelAcceptedParams,
-    HrmpChannelClosingParams,
-    HrmpNewChannelOpenRequestParams,
-    InitiateReserveWithdrawParams,
-    InitiateTeleportParams,
-    InitiateTransferParams,
-    Instruction,
-    LockAssetParams,
-    NoteUnlockableParams,
-    PayFeesParams,
-    QueryPalletParams,
-    QueryResponseParams,
-    ReceiveTeleportedAssetParams,
-    ReportErrorParams,
-    ReportHoldingParams,
-    ReportTransactStatusParams,
-    RequestUnlockParams,
-    ReserveAssetDepositedParams,
-    SetAppendixParams,
-    SetErrorHandlerParams,
-    SetFeesModeParams,
-    SetHintsParams,
-    SetTopicParams,
-    SubscribeVersionParams,
-    TransactParams,
-    TransferAssetParams,
-    TransferReserveAssetParams,
-    TrapParams,
-    UniversalOriginParams,
-    UnpaidExecutionParams,
-    UnlockAssetParams,
-    WithdrawAssetParams
-} from "../Instruction/Instruction.sol";
+import {aliasOrigin as _aliasOrigin, burnAsset as _burnAsset, buyExecution as _buyExecution, claimAsset as _claimAsset, clearError as _clearError, clearOrigin as _clearOrigin, clearTopic as _clearTopic, clearTransactStatus as _clearTransactStatus, depositAsset as _depositAsset, depositReserveAsset as _depositReserveAsset, descendOrigin as _descendOrigin, executeWithOrigin as _executeWithOrigin, expectAsset as _expectAsset, expectError as _expectError, expectOrigin as _expectOrigin, expectPallet as _expectPallet, expectTransactStatus as _expectTransactStatus, exchangeAsset as _exchangeAsset, exportMessage as _exportMessage, hrmpChannelAccepted as _hrmpChannelAccepted, hrmpChannelClosing as _hrmpChannelClosing, hrmpNewChannelOpenRequest as _hrmpNewChannelOpenRequest, initiateReserveWithdraw as _initiateReserveWithdraw, initiateTeleport as _initiateTeleport, initiateTransfer as _initiateTransfer, lockAsset as _lockAsset, noteUnlockable as _noteUnlockable, payFees as _payFees, queryPallet as _queryPallet, queryResponse as _queryResponse, receiveTeleportedAsset as _receiveTeleportedAsset, refundSurplus as _refundSurplus, reportError as _reportError, reportHolding as _reportHolding, reportTransactStatus as _reportTransactStatus, requestUnlock as _requestUnlock, reserveAssetDeposited as _reserveAssetDeposited, setAppendix as _setAppendix, setErrorHandler as _setErrorHandler, setFeesMode as _setFeesMode, setHints as _setHints, setTopic as _setTopic, subscribeVersion as _subscribeVersion, transact as _transact, transferAsset as _transferAsset, transferReserveAsset as _transferReserveAsset, trap as _trap, universalOrigin as _universalOrigin, unpaidExecution as _unpaidExecution, unlockAsset as _unlockAsset, unsubscribeVersion as _unsubscribeVersion, withdrawAsset as _withdrawAsset, AliasOriginParams, BurnAssetParams, BuyExecutionParams, ClaimAssetParams, DepositAssetParams, DepositReserveAssetParams, DescendOriginParams, ExecuteWithOriginParams, ExpectAssetParams, ExpectErrorParams, ExpectOriginParams, ExpectPalletParams, ExpectTransactStatusParams, ExchangeAssetParams, ExportMessageParams, HrmpChannelAcceptedParams, HrmpChannelClosingParams, HrmpNewChannelOpenRequestParams, InitiateReserveWithdrawParams, InitiateTeleportParams, InitiateTransferParams, Instruction, LockAssetParams, NoteUnlockableParams, PayFeesParams, QueryPalletParams, QueryResponseParams, ReceiveTeleportedAssetParams, ReportErrorParams, ReportHoldingParams, ReportTransactStatusParams, RequestUnlockParams, ReserveAssetDepositedParams, SetAppendixParams, SetErrorHandlerParams, SetFeesModeParams, SetHintsParams, SetTopicParams, SubscribeVersionParams, TransactParams, TransferAssetParams, TransferReserveAssetParams, TrapParams, UniversalOriginParams, UnpaidExecutionParams, UnlockAssetParams, WithdrawAssetParams} from "../Instruction/Instruction.sol";
 import {Xcm, fromInstructions, newXcm} from "./Xcm.sol";
 
 library XcmBuilder {