solidity-scale-codec 1.0.0 → 2.0.0

package/CHANGELOG.md

@@ -7,6 +7,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 [Unreleased]
 
+## Version 2.0.0
+
+### Added
+
+- Add `Bytes.sol` to barrel import - [#2dbc1ab](https://github.com/LucasGrasso/solidity-scale-codec/commit/2dbc1ab)
+
+### Changed
+
+- Change all `uint8[]` to `bytes` for better ergonomics and consistency with typical byte handling in Solidity. - [#ab6c226](https://github.com/LucasGrasso/solidity-scale-codec/commit/ab6c226)
+
+## Version 1.0.1
+
+### Added
+
+- More docs and examples - [#5006d28](https://github.com/LucasGrasso/solidity-scale-codec/commit/5006d28)
+
 ## Version 1.0.0
 
 ### Added

package/README.md

@@ -26,10 +26,16 @@ See the [Definitions](https://lucasgrasso.github.io/solidity-scale-codec/Definit
 
 ## Usage
 
-## Encode Structs
+Check out the examples section of the documentation for how to use the library to encode and decode different types, and how to build XCM messages in Solidity.
+
+### Encode Structs
 
 See this [example](https://github.com/LucasGrasso/solidity-scale-codec/blob/main/contracts/examples/Foo.sol).
 
+### Encode XCM messages
+
+Check out the [Xcm Builder](https://lucasgrasso.github.io/solidity-scale-codec/Xcm/v5/Xcm/XcmBuilder.html) for an ergonomic API to build XCM messages in Solidity, and how you can use it in this [example](https://github.com/LucasGrasso/solidity-scale-codec/blob/main/test/VersionedXcm.t.sol#L120)
+
 ## About the libraries
 
 ### src/LittleEndian
@@ -95,34 +101,9 @@ Implementation notes:
 - Enum-like XCM types are represented as structs with a type discriminator plus `bytes payload`.
 - Each type has a codec library with `encode`, `encodedSizeAt`, `decode`, and `decodeAt`.
 - `VersionedXcm` currently supports v5 payloads.
+- The `XcmBuilder` library provides an ergonomic API to build XCM messages in Solidity, with functions for building various XCM instructions.
 
-Minimal usage example:
-
-```solidity
-import {Instruction} from "../src/Xcm/v5/Instruction/Instruction.sol";
-import {Xcm, fromInstructions} from "../src/Xcm/v5/Xcm/Xcm.sol";
-import {v5} from "../src/Xcm/VersionedXcm/VersionedXcm.sol";
-import {VersionedXcmCodec} from "../src/Xcm/VersionedXcm/VersionedXcmCodec.sol";
-import {Weight} from "../src/Xcm/v5/Weight/Weight.sol";
-import {WeightCodec} from "../src/Xcm/v5/Weight/WeightCodec.sol";
-
-address constant XCM_PRECOMPILE_ADDRESS = 0x00000000000000000000000000000000000a0000;
-
-contract XcmWeightEstimator {
-  function weighMessage(
-    Instruction[] memory instructions
-  ) external view returns (Weight memory) {
-    Xcm memory xcm = fromInstructions(instructions);
-    (bool success, bytes memory result) = XCM_PRECOMPILE_ADDRESS.staticcall(
-      VersionedXcmCodec.encode(v5(xcm))
-    );
-    require(success, "XCM precompile call failed");
-    (Weight memory weight, ) = WeightCodec.decode(result);
-    return weight;
-  }
-}
-
-```
+````
 
 ### Running Tests
 
@@ -144,3 +125,4 @@ npx hardhat test nodejs
 Copyright 2025 Lucas Grasso
 
 This project is licensed under the the [Apache License, Version 2.0](LICENSE).
+````

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "solidity-scale-codec",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Solidity implementation of scale-codec.",
   "keywords": [
     "solidity",
@@ -47,7 +47,7 @@
     "hardhat": "^3.0.15",
     "prettier": "^3.8.1",
     "prettier-plugin-solidity": "^2.2.1",
-    "solidity-doc-generator": "^1.2.1",
+    "solidity-doc-generator": "^1.2.4",
     "typescript": "~5.8.0",
     "viem": "^2.40.3",
     "vitepress": "^1.6.4",

package/src/Scale/Bytes.sol

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.28;
 
+import {Bytes} from "./Bytes/Bytes.sol";
 import {Bytes2} from "./Bytes/Bytes2.sol";
 import {Bytes4} from "./Bytes/Bytes4.sol";
 import {Bytes8} from "./Bytes/Bytes8.sol";

package/src/Xcm/v3/MaybeErrorCode/MaybeErrorCode.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.28;
 
-import {U8Arr} from "../../../Scale/Array.sol";
+import {Bytes} from "../../../Scale/Bytes.sol";
 import {MAX_DISPATCH_ERROR_LEN} from "../Constants.sol";
 
 /// @notice Discriminant for the `MaybeErrorCode` enum.
@@ -25,13 +25,13 @@ struct MaybeErrorCode {
 /// @notice Parameters for the `Error` variant.
 struct ErrorParams {
     /// @custom:property Dispatch error bytes.
-    uint8[] errorBytes;
+    bytes errorBytes;
 }
 
 /// @notice Parameters for the `TruncatedError` variant.
 struct TruncatedErrorParams {
     /// @custom:property Truncated dispatch error bytes.
-    uint8[] errorBytes;
+    bytes errorBytes;
 }
 
 // ============ Factory Functions ============
@@ -52,7 +52,7 @@ function error(ErrorParams memory params) pure returns (MaybeErrorCode memory) {
     return
         MaybeErrorCode({
             variant: MaybeErrorCodeVariant.Error,
-            payload: U8Arr.encode(params.errorBytes)
+            payload: Bytes.encode(params.errorBytes)
         });
 }
 
@@ -67,7 +67,7 @@ function truncatedError(
     return
         MaybeErrorCode({
             variant: MaybeErrorCodeVariant.TruncatedError,
-            payload: U8Arr.encode(params.errorBytes)
+            payload: Bytes.encode(params.errorBytes)
         });
 }
 

package/src/Xcm/v3/MaybeErrorCode/MaybeErrorCodeCodec.sol

@@ -1,8 +1,13 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.28;
 
-import {U8Arr} from "../../../Scale/Array.sol";
-import {MaybeErrorCode, MaybeErrorCodeVariant} from "./MaybeErrorCode.sol";
+import {Bytes} from "../../../Scale/Bytes.sol";
+import {
+    MaybeErrorCode,
+    MaybeErrorCodeVariant,
+    ErrorParams,
+    TruncatedErrorParams
+} from "./MaybeErrorCode.sol";
 import {BytesUtils} from "../../../Utils/BytesUtils.sol";
 
 /// @title SCALE Codec for XCM v3 `MaybeErrorCode`
@@ -38,7 +43,7 @@ library MaybeErrorCodeCodec {
             variant == uint8(MaybeErrorCodeVariant.Error) ||
             variant == uint8(MaybeErrorCodeVariant.TruncatedError)
         ) {
-            return 1 + U8Arr.encodedSizeAt(data, offset + 1);
+            return 1 + Bytes.encodedSizeAt(data, offset + 1);
         } else {
             revert InvalidMaybeErrorCodeVariant(variant);
         }
@@ -78,16 +83,32 @@ library MaybeErrorCodeCodec {
         bytesRead = size;
     }
 
-    /// @notice Decodes the dispatch error bytes from an `Error` or `TruncatedError` MaybeErrorCode.
-    /// @param me The `MaybeErrorCode` struct to decode. Must be of type `Error` or `TruncatedError`.
-    /// @return errorBytes The decoded dispatch error bytes.
-    function decodeError(
+    /// @notice Extracts the `Error` parameters from a `MaybeErrorCode` struct. Reverts if the variant is not `Error`.
+    /// @param me The `MaybeErrorCode` struct to extract from. Must be of type `Error`.
+    /// @return params An `ErrorParams` struct containing the decoded dispatch error
+    function asError(
         MaybeErrorCode memory me
-    ) internal pure returns (uint8[] memory errorBytes) {
-        if (
-            me.variant != MaybeErrorCodeVariant.Error &&
-            me.variant != MaybeErrorCodeVariant.TruncatedError
-        ) revert InvalidMaybeErrorCodeVariant(uint8(me.variant));
-        (errorBytes, ) = U8Arr.decode(me.payload);
+    ) internal pure returns (ErrorParams memory params) {
+        _assertVariant(me, MaybeErrorCodeVariant.Error);
+        (params.errorBytes, ) = Bytes.decode(me.payload);
+    }
+
+    /// @notice Extracts the `TruncatedError` parameters from a `MaybeErrorCode` struct. Reverts if the variant is not `TruncatedError`.
+    /// @param me The `MaybeErrorCode` struct to extract from. Must be of type `TruncatedError`.
+    /// @return params A `TruncatedErrorParams` struct containing the decoded truncated dispatch error
+    function asTruncatedError(
+        MaybeErrorCode memory me
+    ) internal pure returns (TruncatedErrorParams memory params) {
+        _assertVariant(me, MaybeErrorCodeVariant.TruncatedError);
+        (params.errorBytes, ) = Bytes.decode(me.payload);
+    }
+
+    function _assertVariant(
+        MaybeErrorCode memory me,
+        MaybeErrorCodeVariant expected
+    ) private pure {
+        if (me.variant != expected) {
+            revert InvalidMaybeErrorCodeVariant(uint8(me.variant));
+        }
     }
 }

package/src/Xcm/v5/PalletInfo/PalletInfo.sol

@@ -6,9 +6,9 @@ struct PalletInfo {
     /// @custom:property The index which identifies the pallet.
     uint32 index;
     /// @custom:property The name of the pallet. Max length is `MAX_PALLET_NAME_LEN`.
-    uint8[] name;
+    bytes name;
     /// @custom:property The module name of the pallet. Max length is `MAX_PALLET_NAME_LEN`.
-    uint8[] moduleName;
+    bytes moduleName;
     /// @custom:property The major version of the crate which implements the pallet.
     uint32 major;
     /// @custom:property The minor version of the crate which implements the pallet.

package/src/Xcm/v5/PalletInfo/PalletInfoCodec.sol

@@ -2,7 +2,7 @@
 pragma solidity ^0.8.28;
 
 import {Compact} from "../../../Scale/Compact.sol";
-import {U8Arr} from "../../../Scale/Array.sol";
+import {Bytes} from "../../../Scale/Bytes.sol";
 import {MAX_PALLET_NAME_LEN} from "../Constants.sol";
 import {PalletInfo} from "./PalletInfo.sol";
 
@@ -27,8 +27,8 @@ library PalletInfoCodec {
         return
             abi.encodePacked(
                 Compact.encode(info.index),
-                U8Arr.encode(info.name),
-                U8Arr.encode(info.moduleName),
+                Bytes.encode(info.name),
+                Bytes.encode(info.moduleName),
                 Compact.encode(info.major),
                 Compact.encode(info.minor),
                 Compact.encode(info.patch)
@@ -46,8 +46,8 @@ library PalletInfoCodec {
         if (data.length < offset + 1) revert InvalidPalletInfoLength();
         uint256 pos = offset;
         pos += Compact.encodedSizeAt(data, pos); // index
-        pos += U8Arr.encodedSizeAt(data, pos); // name
-        pos += U8Arr.encodedSizeAt(data, pos); // moduleName
+        pos += Bytes.encodedSizeAt(data, pos); // name
+        pos += Bytes.encodedSizeAt(data, pos); // moduleName
         pos += Compact.encodedSizeAt(data, pos); // major
         pos += Compact.encodedSizeAt(data, pos); // minor
         pos += Compact.encodedSizeAt(data, pos); // patch
@@ -80,12 +80,12 @@ library PalletInfoCodec {
         (index, read) = Compact.decodeAt(data, pos);
         pos += read;
 
-        uint8[] memory name;
-        (name, read) = U8Arr.decodeAt(data, pos);
+        bytes memory name;
+        (name, read) = Bytes.decodeAt(data, pos);
         pos += read;
 
-        uint8[] memory moduleName;
-        (moduleName, read) = U8Arr.decodeAt(data, pos);
+        bytes memory moduleName;
+        (moduleName, read) = Bytes.decodeAt(data, pos);
         pos += read;
 
         uint256 major;