chore(lib/contracts): fix byte semantics

omni-network · Oct 10, 2024 · 9aee7d4 · 9aee7d4
1 parent 2359a87
commit 9aee7d4
Show file tree

Hide file tree

Showing 14 changed files with 14 additions and 14 deletions.
diff --git a/contracts/allocs/devnet.json b/contracts/allocs/devnet.json
diff --git a/contracts/allocs/staging.json b/contracts/allocs/staging.json
diff --git a/contracts/bindings/admin.go b/contracts/bindings/admin.go
diff --git a/contracts/bindings/allocpredeploys.go b/contracts/bindings/allocpredeploys.go
diff --git a/contracts/bindings/omnibridgel1.go b/contracts/bindings/omnibridgel1.go
diff --git a/contracts/bindings/omnibridgenative.go b/contracts/bindings/omnibridgenative.go
diff --git a/contracts/bindings/omnigaspump.go b/contracts/bindings/omnigaspump.go
diff --git a/contracts/bindings/omnigasstation.go b/contracts/bindings/omnigasstation.go
diff --git a/contracts/bindings/omniportal.go b/contracts/bindings/omniportal.go
diff --git a/contracts/bindings/pingpong.go b/contracts/bindings/pingpong.go
diff --git a/contracts/core/.gas-snapshot b/contracts/core/.gas-snapshot
@@ -37,7 +37,7 @@ OmniBridgeNative_Test:test_pauseBridging() (gas: 44449)
 OmniBridgeNative_Test:test_pauseWithdraws() (gas: 61348)
 OmniBridgeNative_Test:test_stub() (gas: 143)
 OmniBridgeNative_Test:test_withdraw() (gas: 279800)
-OmniGasPump_Test:testFuzz_quote(uint32) (runs: 256, μ: 63919, ~: 63969)
+OmniGasPump_Test:testFuzz_quote(uint32) (runs: 256, μ: 63922, ~: 63969)
 OmniGasPump_Test:test_fillUp() (gas: 231427)
 OmniGasPump_Test:test_pause() (gas: 62757)
 OmniGasPump_Test:test_setMaxSwap() (gas: 34749)

diff --git a/contracts/core/src/interfaces/IOmniPortal.sol b/contracts/core/src/interfaces/IOmniPortal.sol
@@ -33,7 +33,7 @@ interface IOmniPortal {
     /**
      * @notice Emitted when an XMsg is executed on its destination chain
      * @param sourceChainId Source chain ID
-     * @param shardId       Shard ID of the XStream (first byte is the confirmation level)
+     * @param shardId       Shard ID of the XStream (last byte is the confirmation level)
      * @param offset        Offset the XMsg in the source -> dest XStream
      * @param gasUsed       Gas used in execution of the XMsg
      * @param relayer       Address of the relayer who submitted the XMsg

diff --git a/contracts/core/src/libraries/XTypes.sol b/contracts/core/src/libraries/XTypes.sol
@@ -12,7 +12,7 @@ library XTypes {
      *        throughout Omni's cross-chain messaging protocol. Msg is used to construct and verify
      *        XSubmission merkle trees / proofs.
      * @custom:field destChainId    Chain ID of the destination chain
-     * @custom:field shardId        Shard ID of the XStream (first byte is the confirmation level)
+     * @custom:field shardId        Shard ID of the XStream (last byte is the confirmation level)
      * @custom:field offset         Monotonically incremented offset of Msg in source -> dest Stream
      * @custom:field sender         msg.sender of xcall on source chain
      * @custom:field to             Target address to call on destination chain

diff --git a/contracts/core/src/xchain/OmniPortal.sol b/contracts/core/src/xchain/OmniPortal.sol
@@ -139,7 +139,7 @@ contract OmniPortal is
         require(gasLimit >= xmsgMinGasLimit, "OmniPortal: gasLimit too low");
         require(data.length <= xmsgMaxDataSize, "OmniPortal: data too large");
 
-        // conf level will always be first byte of shardId. for now, shardId is just conf level
+        // conf level will always be last byte of shardId. for now, shardId is just conf level
         uint64 shardId = uint64(conf);
         require(isSupportedShard[shardId], "OmniPortal: unsupported shard");