Retrieving Settled Claims
This tutorial walks you through how to retrieve settled claims from the VSL network using the vsl-cli
tool.
Whether you're validating application behavior or auditing claim activity, this guide shows you how to list and inspect settled claims quickly.
Step 1: Enter REPL Mode
Start the CLI in interactive REPL mode:
vsl-cli repl --tmp-config
Step 2: Connect to a Network
You can either connect to your local node or the public Devnet.
Option A: Use a Local Node
vsl> server:launch --db tmp --genesis-file "genesis.json"
Ensure your local environment includes settled claims. This is typically useful if you are running verification and settlement flows manually.
Option B: Use Remote Devnet
vsl> network:add remote --url https://rpc.vsl.pi2.network
vsl> network:use remote
Confirm network connectivity:
vsl> health:check
Step 3: List All Settled Claims
To view all claims that have been settled on the current network:
vsl> claim:settled
This returns a list of settled claim IDs and basic metadata.
You can also format the output as JSON:
vsl> claim:settled --json
Step 4: Filter Recent Settled Claims
You can filter claims by time (e.g., last hour):
vsl> claim:settled --within 3600
This helps you narrow down the results to only those settled within the past n
seconds.
Step 5: Inspect a Specific Claim
Once you have a claim ID from the list, retrieve its full details:
vsl> claim:get <claim_id>
This gives you the claim body, its proof, verifier information, and the settlement certificate.
You can format the output for clarity:
vsl> claim:get <claim_id> --json
Optional: Use in Scripts
You can script claim retrieval using REPL batch files or shell commands:
vsl-cli claim:settled --json | jq '.[0]' # Fetch the latest settled claim
This is useful for automation, monitoring, or verification flows in production.
Cleanup (Optional)
If you're using a local test setup:
vsl> network:remove remote
vsl> server:stop
Next Steps
You now know how to retrieve and inspect settled claims on the VSL network. This is useful for:
Debugging claim workflows
Validating proof and certificate content
Tracking user verification or asset transfer events
Ready to take the next step? Learn how to submit & verify a claim or subscribe to a claim in the VSL network.
Last updated
Was this helpful?