tilt additions
This commit is contained in:
parent
9384de0363
commit
e11957b64d
|
@ -1,22 +1,36 @@
|
|||
# Tilt
|
||||
|
||||
- tilt is a unique environment specifically set up to deal with the challenges of cross-chain development
|
||||
- used by the Wormhole core repository
|
||||
- Uses tilt to configure and manage a kubernetes environment.
|
||||
- has docker containers for every ecosystem supported by wormhole, along with containers for things like the guardian, spy, generic relayers, etc
|
||||
- Big bad development ecosystem with all the tools, used by core contributors
|
||||
### What is Tilt?
|
||||
|
||||
[Tilt](https://tilt.dev/) is part of the Docker ecosystem. It allows developers to easily configure a Kubernetes environment for development.
|
||||
|
||||
In the context of Wormhole, the 'Tilt' environment is the development environment used by the [Wormhole Core Repository](https://github.com/wormhole-foundation/wormhole). It utilizes Tilt to set up a development environment with all the tools necessary to build across multiple blockchains. It has docker images for all the common items encountered during cross-chain developing, including:
|
||||
|
||||
- All the supported blockchains / ecosystems of Wormhole
|
||||
- A Guardian Node
|
||||
- Relayers
|
||||
- Databases, Redis
|
||||
- Utility frontends
|
||||
|
||||
The Tilt environment is meant to be an entire cross-chain ecosystem right out of the box.
|
||||
|
||||
## Is Tilt Right for You?
|
||||
|
||||
Tilt is a generally a good starting point for most developers. Here's a succinct list of the pros and cons of the environment, so you can decide if it's the right fit for you.
|
||||
|
||||
Pros
|
||||
|
||||
- Out of the box support for the many components needed to develop across the heterogenous blockchain space
|
||||
- Consistent development environment, where contracts deploy deterministically & everything is already linked up
|
||||
- Ability to easily turn containers on and off as needed
|
||||
- Out-of-the-box support for the many components needed to develop across the heterogenous blockchain space.
|
||||
- Consistent development environment, where contracts deploy deterministically & everything is already linked up.
|
||||
- Ability to easily enable/disable contracts as needed.
|
||||
|
||||
Cons
|
||||
|
||||
- Relatively high system requirements. Specifically is RAM intensive
|
||||
- Iteration requires docker container rebuilds, which can be slow
|
||||
- Most blockchains are 'fresh', and thus may require you to deploy your own contract dependencies.
|
||||
- Relatively high system requirements. This can be mitigated by disabling components.
|
||||
- Most blockchains are 'fresh' and have no contracts by default. Thus, you may have to deploy your own dependencies, or alter the default tilt configuration.
|
||||
- Spin-up and rebuild times can be slow. This can result in a slow workflow if you rely on docker rebuilds.
|
||||
|
||||
## Setting up Tilt
|
||||
|
||||
show basic setup for each ecosystem, list installed dependencies
|
||||
explain the tiltfile, show how to enable/disable components, give command for starting with just two evm chains
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
#Tooling
|
||||
|
||||
Regardless of the developer environment that you use, there are a few wormhole-specific tools you should know about.
|
||||
Regardless of the developer environment that you use, there are a few wormhole-specific tools you should know about.
|
||||
|
||||
Below is a list of those tools with specific links but some developers also find it useful to clone the Wormhole core repository.
|
||||
|
||||
|
@ -14,7 +14,7 @@ Below is a list of those tools with specific links but some developers also find
|
|||
|
||||
### [Wormhole SDK](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/sdk)
|
||||
|
||||
- Libraries in various languages to help with interacting with Wormhole contracts.
|
||||
- Libraries in various languages to help with interacting with Wormhole contracts.
|
||||
|
||||
### Wormhole Spy Service
|
||||
|
||||
|
@ -27,3 +27,15 @@ Below is a list of those tools with specific links but some developers also find
|
|||
### [Explorer](https://wormhole.com/explorer/)
|
||||
|
||||
- Resource for looking at individual transfers statuses on mainnet and testnet.
|
||||
|
||||
regardless of what env you use, there are some wormhole-specific tools you should know about. Most developers find it useful to clone the Wormhole core repository, as it has quite a few useful tools.
|
||||
|
||||
worm CLI tool (link to code) - great cli tool for getting odds and ends done surround wormhole contracts, VAAs and more
|
||||
orchestrator - WIP tool which is connected to the WLV environment. Can be useful for managing deployment of your xDapp contracts
|
||||
reference bridge UI - a GUI which can be used to perform token transfers around the ecosystem
|
||||
Wormhole Typescript SDK - typescript SDK designed to aid in interacting directly with the Wormhole contracts.
|
||||
Explorer - mainnet link, and link to local code. Can be a good resource for looking at individual transfers
|
||||
Wormhole Rust SDKs - useful when working in the various Rust environments, WIP, link to source
|
||||
Spydk - useful for listening to the guardian network (link to source code and official release)
|
||||
|
||||
Link to as many example projects as possible here as well, ICCO, xDapp book examples
|
||||
|
|
Loading…
Reference in New Issue