docs

Author: ARR552

doc/polycli_ulxly.md

@@ -48,6 +48,8 @@ The command also inherits flags from parent commands.
 
 - [polycli ulxly empty-proof](polycli_ulxly_empty-proof.md) - create an empty proof
 
+- [polycli ulxly get-claims](polycli_ulxly_get-claims.md) - Generate ndjson for each bridge claim over a particular range of blocks
+
 - [polycli ulxly get-deposits](polycli_ulxly_get-deposits.md) - Generate ndjson for each bridge deposit over a particular range of blocks
 
 - [polycli ulxly get-verify-batches](polycli_ulxly_get-verify-batches.md) - Generate ndjson for each verify batch over a particular range of blocks

doc/polycli_ulxly_get-claims.md

@@ -0,0 +1,93 @@
+# `polycli ulxly get-claims`
+
+> Auto-generated documentation.
+
+## Table of Contents
+
+- [Description](#description)
+- [Usage](#usage)
+- [Flags](#flags)
+- [See Also](#see-also)
+
+## Description
+
+Generate ndjson for each bridge claim over a particular range of blocks
+
+```bash
+polycli ulxly get-claims [flags]
+```
+
+## Usage
+
+This command will attempt to scan a range of blocks and look for uLxLy
+Claim Events. This is the specific signature that we're interested
+in:
+
+```solidity
+    /**
+     * @dev Emitted when a claim is done from another network
+     */
+    event ClaimEvent(
+        uint256 globalIndex,
+        uint32 originNetwork,
+        address originAddress,
+        address destinationAddress,
+        uint256 amount
+    );
+```
+
+If you're looking at the raw topics from on chain or in an explorer, this is the associated value:
+
+`0x1df3f2a973a00d6635911755c260704e95e8a5876997546798770f76396fda4d`
+
+Each event that we counter will be parsed and written as JSON to
+stdout. Example usage:
+
+```bash
+polycli ulxly get-claims \
+        --bridge-address 0x528e26b25a34a4A5d0dbDa1d57D318153d2ED582 \
+        --rpc-url https://eth-sepolia.g.alchemy.com/v2/demo \
+        --from-block 4880876 \
+        --to-block 6028159 \
+        --filter-size 9999 > cardona-4880876-to-6028159.ndjson
+```
+
+This command will look for claim events from block `4880876` to
+block `6028159` in increments of `9999` blocks at a time for the
+contract address `0x528e26b25a34a4A5d0dbDa1d57D318153d2ED582`. The
+output will be written as newline delimited JSON.
+
+This command is very specific for the ulxly bridge, and it's meant to
+serve as the input to the proof command.
+
+
+
+## Flags
+
+```bash
+  -a, --bridge-address string   The address of the ulxly bridge
+  -i, --filter-size uint        The batch size for individual filter queries (default 1000)
+  -f, --from-block uint         The start of the range of blocks to retrieve
+  -h, --help                    help for get-claims
+  -u, --rpc-url string          The RPC URL to read the events data
+  -t, --to-block uint           The end of the range of blocks to retrieve
+```
+
+The command also inherits flags from parent commands.
+
+```bash
+      --config string   config file (default is $HOME/.polygon-cli.yaml)
+      --pretty-logs     Should logs be in pretty format or JSON (default true)
+  -v, --verbosity int   0 - Silent
+                        100 Panic
+                        200 Fatal
+                        300 Error
+                        400 Warning
+                        500 Info
+                        600 Debug
+                        700 Trace (default 500)
+```
+
+## See also
+
+- [polycli ulxly](polycli_ulxly.md) - Utilities for interacting with the uLxLy bridge