Path
Encodes and inspects descriptor paths as big-endian uint16 sequences.
Paths represent navigation through ABI-encoded calldata:
- path[0] is the top-level argument index.
- path[1..n] are indices into nested composites (tuples, arrays).
Constants
ALL
Universal quantifier for array paths (∀). Rule must pass for every element.
Only valid immediately after an array node. Empty arrays give true (vacuous truth).
uint16 internal constant ALL = 0xFFFF;ANY
Existential quantifier for array paths (∃). Rule must pass for some element.
Only valid immediately after an array node. Empty arrays give false.
uint16 internal constant ANY = 0xFFFE;Functions
encode
Encodes a single-step path.
function encode(uint16 p0) internal pure returns (bytes memory out);Parameters
| Name | Type | Description |
|---|---|---|
p0 | uint16 | The first path step. |
Returns
| Name | Type | Description |
|---|---|---|
out | bytes | The encoded path bytes. |
encode
Encodes a two-step path.
function encode(uint16 p0, uint16 p1) internal pure returns (bytes memory out);Parameters
| Name | Type | Description |
|---|---|---|
p0 | uint16 | The first path step. |
p1 | uint16 | The second path step. |
Returns
| Name | Type | Description |
|---|---|---|
out | bytes | The encoded path bytes. |
encode
Encodes a three-step path.
function encode(uint16 p0, uint16 p1, uint16 p2) internal pure returns (bytes memory out);Parameters
| Name | Type | Description |
|---|---|---|
p0 | uint16 | The first path step. |
p1 | uint16 | The second path step. |
p2 | uint16 | The third path step. |
Returns
| Name | Type | Description |
|---|---|---|
out | bytes | The encoded path bytes. |
encode
Encodes a four-step path.
function encode(uint16 p0, uint16 p1, uint16 p2, uint16 p3) internal pure returns (bytes memory out);Parameters
| Name | Type | Description |
|---|---|---|
p0 | uint16 | The first path step. |
p1 | uint16 | The second path step. |
p2 | uint16 | The third path step. |
p3 | uint16 | The fourth path step. |
Returns
| Name | Type | Description |
|---|---|---|
out | bytes | The encoded path bytes. |
encode
Encodes a path from a uint16 array.
function encode(uint16[] memory path) internal pure returns (bytes memory out);Parameters
| Name | Type | Description |
|---|---|---|
path | uint16[] | The path indices as an array. |
Returns
| Name | Type | Description |
|---|---|---|
out | bytes | The encoded path bytes. |
depth
Returns the depth (number of steps) in a path.
function depth(bytes memory self) internal pure returns (uint256);Parameters
| Name | Type | Description |
|---|---|---|
self | bytes | The encoded path bytes. |
Returns
| Name | Type | Description |
|---|---|---|
<none> | uint256 | The number of steps in the path. |
validate
Validates strict be16 payload: non-empty and even length. Returns depth.
function validate(bytes memory self) internal pure returns (uint256);Parameters
| Name | Type | Description |
|---|---|---|
self | bytes | The encoded path bytes. |
Returns
| Name | Type | Description |
|---|---|---|
<none> | uint256 | The number of steps in the path. |
atUnchecked
Returns the step at a given step index without bounds checks. Caller must ensure stepIndex < depth.
function atUnchecked(bytes memory self, uint256 stepIndex) internal pure returns (uint16);Parameters
| Name | Type | Description |
|---|---|---|
self | bytes | The encoded path bytes. |
stepIndex | uint256 | The 0-based step index. |
Returns
| Name | Type | Description |
|---|---|---|
<none> | uint16 | The uint16 step value at the given index. |
Errors
EmptyPath
Thrown when the path is empty.
error EmptyPath();MalformedPath
Thrown when the be16-encoded path has an odd byte length.
error MalformedPath();