diff --git a/src/SUMMARY.md b/src/SUMMARY.md index cf079af..8547305 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -45,9 +45,9 @@ - [Testnet](./technical/env/testnet.md) - [Tooling](./technical/env/tooling.md) -- [Contract Development]() +- [Contract Development](./technical/overview.md) - - [EVM](./technical/evm//overview.md) + - [EVM](./technical/evm/overview.md) - [Core Layer](./technical/evm/coreLayer.md) - [xAsset Module](./technical/evm/xassetLayer.md) - [NFT Module](./technical/evm/nftLayer.md) @@ -75,10 +75,9 @@ --- -# Other Resources - -- [Glossary](./reference/glossary.md) -- [Tools](./reference/tools.md) -- [Github & Useful Links](./reference/github.md) -- [Deployed Contracts](./reference/contracts.md) -- [RPC Nodes](./reference/rpcnodes.md) +- [Other Resources](./reference/overview.md) + - [Glossary](./reference/glossary.md) + - [Tools](./reference/tools.md) + - [Github](./reference/github.md) + - [Deployed Contracts](./reference/contracts.md) + - [RPC Nodes](./reference/rpcnodes.md) diff --git a/src/reference/overview.md b/src/reference/overview.md new file mode 100644 index 0000000..04d19aa --- /dev/null +++ b/src/reference/overview.md @@ -0,0 +1,9 @@ +# Other Resources + +Here is a collection of other resources and reference sources which you're likely to find helpful. + +- [Glossary & Terms](./glossary.md) +- [Tools & Helpful Links](./tools.md) +- [Github](./github.md) +- [Contract Addresses & Environment Information](./contracts.md) +- [RPC Info](./rpcnodes.md) diff --git a/src/reference/tools.md b/src/reference/tools.md index 27bac40..70e4499 100644 --- a/src/reference/tools.md +++ b/src/reference/tools.md @@ -1,17 +1,23 @@ # Tools + There are a variety of tools in the Wormhole ecosystem that can help you develop xDapps. Here are a few of the most notable: ### Testnet -Wormhole has deployed Core Bridge, Token Bridge and NFT Bridge contracts on various testnets of the chains connected by Wormhole. You can see the deployed addresses at [./contracts.md](./contracts.md). There's only a single Guardian that oversees the testnets, so you might get a higher rate of missed VAAs than you would on mainnet. + +Wormhole has deployed Core Bridge, Token Bridge and NFT Bridge contracts on various testnets of the chains connected by Wormhole. You can see the deployed addresses at [./contracts.md](./contracts.md). There's only a single Guardian that oversees the testnets, so you might get a higher rate of missed VAAs than you would on mainnet. ### Wormhole Explorer + Wormhole Explorer is a tool that will help you parse VAAs after they've been picked up the Guardian network. It's available at [https://wormholenetwork.com/en/explorer](https://wormholenetwork.com/en/explorer). ### Testnet Bridge UI -If you'd like to try out Portal Bridge on testnet, there's a UI you can use to attest and transfer tokens for testnet, hosted at [https://certusone.github.io/wormhole](https://certusone.github.io/wormhole). -### Tilt +If you'd like to try out bridging tokens on testnet, there's a UI you can use to attest and transfer tokens for testnet, hosted [here](https://wormhole-foundation.github.io/example-token-bridge-ui/#/transfer). + +### Tilt + Tilt is a Kubernetes-based tool that runs a copy of every chain along side a Guardian node to create a simulated testing environment. To set it up and test against it, start at [../development/tilt/overview.md](../development/tilt/overview.md). ### Wormhole SDK + The SDK is a set of Javascript tools to help you do Token Bridge transfers, plus fetch and submit VAAs from one chain to another. You can install it via NPM at [https://www.npmjs.com/package/@certusone/wormhole-sdk](https://www.npmjs.com/package/@certusone/wormhole-sdk). diff --git a/src/technical/algorand/overview.md b/src/technical/algorand/overview.md new file mode 100644 index 0000000..e69de29 diff --git a/src/technical/cosmos/overview.md b/src/technical/cosmos/overview.md new file mode 100644 index 0000000..e69de29 diff --git a/src/technical/evm/overview.md b/src/technical/evm/overview.md index e1b540b..e5f1ebc 100644 --- a/src/technical/evm/overview.md +++ b/src/technical/evm/overview.md @@ -1,9 +1,11 @@ # EVM -**Disclaimer**: This section is written as a guide for how to use Wormhole for experienced EVM developers. If you are new to using the EVM ecosystem, it's recommended for you to get started with a tutorial like [this](). +**Disclaimer**: This section is written as a guide for how to use Wormhole for experienced EVM developers. If you are new to using the EVM ecosystem, it's recommended for you to get started with a tutorial like [this](https://ethereum.org/en/developers/docs/intro-to-ethereum/). For our purposes, EVM refers to any blockchain in the Wormhole ecosystem that utilizes EVM contracts of Wormhole -- this includes blockchains beyond Ethereum such as Polygon or Avalanche, as well as EVM+ environments such as Acala. +At certain points, it may be easiest to integrate simply by referencing the implementation of the Wormhole contracts. The official implementation for the Wormhole contracts can be found [here](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/ethereum). + ### Recommended Tooling for EVM **Frontend Development** diff --git a/src/technical/near/overview.md b/src/technical/near/overview.md new file mode 100644 index 0000000..e69de29 diff --git a/src/technical/overview.md b/src/technical/overview.md new file mode 100644 index 0000000..df7aad3 --- /dev/null +++ b/src/technical/overview.md @@ -0,0 +1,7 @@ +# Contract Development + +This section should help you get off the ground with contract development in the Wormhole ecosystem. + +It is written in a fashion which assumes familiarity with smart contract development in each ecosystem. As such, it doesn't provide information on smart contract basics, and instead focuses on how to properly interact with the provided Wormhole functions. + +While the syntax for each programming environment differs, the general structure of the code and best practices tend to be quite similar. You should consider referencing the sections for environments other than the one you're working in, as many of the concepts outlined here are universal to cross-chain development. diff --git a/src/technical/relayer/specializedRelayers.md b/src/technical/relayer/specializedRelayers.md index c082a34..38d61b2 100644 --- a/src/technical/relayer/specializedRelayers.md +++ b/src/technical/relayer/specializedRelayers.md @@ -23,3 +23,5 @@ link to spydk. Use this to tie directly into the guardian network and receive ev 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 + +`${config.wormhole.restAddress}/v1/signed_vaa/${network.wormholeChainId}/${emitterAddr}/${seq} diff --git a/src/technical/solana/overview.md b/src/technical/solana/overview.md new file mode 100644 index 0000000..e69de29