solidity-scale-codec 2.0.0 → 2.1.0

package/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 [Unreleased]
 
+### Added
+
+- Missing `GlobalConsensus` junction variant and related helper function in `Junction.sol` and `JunctionCodec.sol`. - [#5592427](https://github.com/LucasGrasso/solidity-scale-codec/commit/5592427)
+
+### Fixed
+
+- Variant checking in `NetworkId`. - [#7e9309d](https://github.com/LucasGrasso/solidity-scale-codec/commit/7e9309d)
+- Decoding of `Index` variant in `BodyId`. - [#75ead59](https://github.com/LucasGrasso/solidity-scale-codec/commit/75ead59)
+- Incorrect encoding/decoding of `GeneralKey` junction variant. - [#4e0f795](https://github.com/LucasGrasso/solidity-scale-codec/commit/4e0f795)
+
 ## Version 2.0.0
 
 ### Added

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "solidity-scale-codec",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Solidity implementation of scale-codec.",
   "keywords": [
     "solidity",

package/src/Xcm/v5/BodyId/BodyIdCodec.sol

@@ -50,7 +50,7 @@ library BodyIdCodec {
         } else if (variant == BodyIdVariant.Moniker) {
             payloadLength = 4;
         } else if (variant == BodyIdVariant.Index) {
-            payloadLength = 4;
+            payloadLength = Compact.encodedSizeAt(data, offset + 1);
         } else {
             revert InvalidBodyIdVariant(variantValue);
         }

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

@@ -20,7 +20,8 @@ import {
     AccountKey20Params,
     GeneralKeyParams,
     PalletInstanceParams,
-    GeneralIndexParams
+    GeneralIndexParams,
+    GlobalConsensusParams
 } from "./Junction.sol";
 import {BytesUtils} from "../../../Utils/BytesUtils.sol";
 import {UnsignedUtils} from "../../../Utils/UnsignedUtils.sol";
@@ -74,12 +75,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 +243,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

@@ -49,7 +49,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