diff --git a/src/SUMMARY.md b/src/SUMMARY.md index d40bc10..26d43f6 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -47,8 +47,9 @@ - [EVM]() - [Core Layer](./technical/evm/coreLayer.md) - - [xAsset Layer](./technical/evm/xassetLayer.md) - - [NFT Layer](./technical/evm/nftLayer.md) + - [xAsset Module](./technical/evm/xassetLayer.md) + - [NFT Module](./technical/evm/nftLayer.md) + - [Relayer Module](./technical/evm/relayer.md) - [Solana]() - [Cosmos]() - [Algorand]() @@ -57,7 +58,7 @@ - [Relayers]() - - [Plugin Relayer]() + - [Plugin Relayer](./technical/relayer/pluginRelayers.md) - [Guardian Network](./technical/relayer/guardianNetwork.md) - [Wormhole Typescript SDK](./development/portal/overview.md) diff --git a/src/technical/evm/relayer.md b/src/technical/evm/relayer.md new file mode 100644 index 0000000..9d30da0 --- /dev/null +++ b/src/technical/evm/relayer.md @@ -0,0 +1 @@ +# Relayer Module diff --git a/src/technical/relayer/guardianNetwork.md b/src/technical/relayer/guardianNetwork.md index 6f91a05..f3fbe46 100644 --- a/src/technical/relayer/guardianNetwork.md +++ b/src/technical/relayer/guardianNetwork.md @@ -1 +1,9 @@ # Guardian Network + +If you're totally homerolling a relayer solution, you'll need to interact with the guardian network directly. + +link to spydk. Use this to tie directly into the guardian network and receive events. If you're particularly ambitious, you can even join the guardian network as a 'spy' which is the term for a non-validating guardian. + +VAAs can also be pulled directly from any public node on the guardian network using REST endpoints. This is a really simple way to grab known VAAs. + +- provide the REST endpoints for this diff --git a/src/technical/relayer/pluginRelayers.md b/src/technical/relayer/pluginRelayers.md new file mode 100644 index 0000000..d4eaf05 --- /dev/null +++ b/src/technical/relayer/pluginRelayers.md @@ -0,0 +1,15 @@ +- Link to Plugin relayer codebase + +- Recommend plugin relayers as the starting point for anyone developing specialized relayers +- plugin relayers provide a kernel for relayer development. Handles management of all the necessary hotwallets, provides the necessary typescript interfaces for dealing with each ecosystems, and provides an easy integration point to connect to the guardian network + +- Follow the instructions provided in the codebase in order to get it running +- to develop a plugin, simply implement the interface provided at [here] +- diagram explaining the flow +- Listener component listens to either incoming REST calls or the guardian network for relevant VAAs, +- When a relevant VAA is detected, your listener code is responsible for producing an action. +- This action is stored in a redis instance +- The executor portion of the interface is responsible for consuming interactions which are provided by the listener. +- The executor is handed an action and is responsible for consuming that action and (optionally) queuing up more actions + +- additional configuration info can be found in the README of the codebase.