Spy

Spy
A Spy, in the wormhole context, is a daemon that subscribes to the gossiped messages in the Guardian Network.
The messages available on over gossip are things like
​VAAs​
​Observations​
Guardian Heartbeats
The source for the Spy is available on Github​
The Spy has no persistence layer built in, so typically its paired with something like Redis or a SQL database to record relevant messages
Use
To start a Spy locally, run the following docker command.
Testnet
Mainnet
docker run --platform=linux/amd64 \
    -p 7073:7073 \
    --entrypoint /guardiand ghcr.io/wormhole-foundation/guardiand:latest \
    spy \
    --nodeKey /node.key \
    --spyRPC "[::]:7073" \
    --network /wormhole/testnet/2/1 \
    --bootstrap "/dns4/wormhole-testnet-v2-bootstrap.certus.one/udp/8999/quic/p2p/12D3KooWAkB9ynDur1Jtoa97LBUp8RXdhzS5uHgAfdTquJbrbN7i,/dns4/t-guardian-01.nodes.stable.io/udp/8999/quic/p2p/12D3KooWCW3LGUtkCVkHZmVSZHzL3C4WRKWfqAiJPz1NR7dT9Bxh,/dns4/t-guardian-02.nodes.stable.io/udp/8999/quic/p2p/12D3KooWJXA6goBCiWM8ucjzc4jVUBSqL9Rri6UpjHbkMPErz5zK" 
docker run --platform=linux/amd64 \
    -p 7073:7073 \
    --entrypoint /guardiand ghcr.io/wormhole-foundation/guardiand:latest \
    spy \
    --nodeKey /node.key \
    --spyRPC "[::]:7073" \
    --network /wormhole/mainnet/2 \
    --bootstrap /dns4/wormhole-mainnet-v2-bootstrap.certus.one/udp/8999/quic/p2p/12D3KooWQp644DK27fd3d4Km3jr7gHiuJJ5ZGmy8hH4py7fP4FP7,/dns4/wormhole-v2-mainnet-bootstrap.xlabs.xyz/udp/8999/quic/p2p/12D3KooWNQ9tVrcb64tw6bNs2CaNrUGPM7yRrKvBBheQ5yCyPHKC
Once running, a gRPC client (i.e. your program) can subscribe to a filtered stream of messages.
To generate a client for the gRPC service use this proto spec file.
If using JavaScript/TypeScript, the Spydk makes setting up a client easier.
See Also
The relayer engine implements a client and persistence layer for messages received from a Spy subscription.
Last modified 4d ago