update outdated github links from dev.v2 to main (#33)
* update outdated github links from dev.v2 to main * update outdated github links from dev.v2 to main
This commit is contained in:
parent
621ced009a
commit
c90495d2c6
|
@ -3,7 +3,7 @@
|
|||
|
||||
set -euo pipefail
|
||||
|
||||
# dev.v2 for now (until we make a release)
|
||||
# main for now (until we make a release)
|
||||
DOCKER_IMAGE="ghcr.io/wormhole-foundation/guardiand:latest"
|
||||
|
||||
DOCKER_FLAGS="-p 7070:7070 -p 7071:7071 -p 6060:6060 -p 8999:8999/udp --add-host=host.docker.internal:host-gateway --platform linux/amd64"
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
To send messages from EVM, first we have to download the Core Bridge interfaces.
|
||||
|
||||
We need two interfaces, [IWormhole.sol](https://github.com/wormhole-foundation/wormhole/raw/dev.v2/ethereum/contracts/interfaces/IWormhole.sol) and [Structs.sol](https://github.com/wormhole-foundation/wormhole/raw/dev.v2/ethereum/contracts/Structs.sol)
|
||||
We need two interfaces, [IWormhole.sol](https://github.com/wormhole-foundation/wormhole/raw/main/ethereum/contracts/interfaces/IWormhole.sol) and [Structs.sol](https://github.com/wormhole-foundation/wormhole/raw/main/ethereum/contracts/Structs.sol)
|
||||
|
||||
In your xdapp-starter, place those files in
|
||||
|
||||
|
|
|
@ -54,7 +54,7 @@ curl -fsSL https://raw.githubusercontent.com/tilt-dev/tilt/master/scripts/instal
|
|||
### 5. Clone the Wormhole Repo and start Tilt
|
||||
|
||||
```sh
|
||||
git clone --branch dev.v2 https://github.com/wormhole-foundation/wormhole.git
|
||||
git clone --branch main https://github.com/wormhole-foundation/wormhole.git
|
||||
```
|
||||
|
||||
If you're running Tilt on your machine:
|
||||
|
|
|
@ -31,7 +31,7 @@ brew install tilt
|
|||
## Clone Wormhole Repo and Start Tilt
|
||||
|
||||
```sh
|
||||
git clone --branch dev.v2 https://github.com/wormhole-foundation/wormhole.git
|
||||
git clone --branch main https://github.com/wormhole-foundation/wormhole.git
|
||||
```
|
||||
|
||||
```sh
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Below are a variety of tools and information in the Wormhole ecosystem that can help you develop xDapps.
|
||||
|
||||
### [Design Documents](https://github.com/certusone/wormhole/tree/dev.v2/whitepapers)
|
||||
### [Design Documents](https://github.com/certusone/wormhole/tree/main/whitepapers)
|
||||
|
||||
Wormhole's component design specifications outline the reasoning behind design decisions with added technical depth.
|
||||
|
||||
|
|
|
@ -1,9 +1,9 @@
|
|||
# Algorand
|
||||
|
||||
The implementation contracts for Wormhole's official Algorand integration can be found [here](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/algorand).
|
||||
The implementation contracts for Wormhole's official Algorand integration can be found [here](https://github.com/wormhole-foundation/wormhole/tree/main/algorand).
|
||||
|
||||
An overview of the contracts and how they work is outlined [here](https://github.com/wormhole-foundation/wormhole/blob/dev.v2/algorand/README.md).
|
||||
An overview of the contracts and how they work is outlined [here](https://github.com/wormhole-foundation/wormhole/blob/main/algorand/README.md).
|
||||
|
||||
The deployed contract addresses can be found on the [Contracts page](../../reference/contracts.md).
|
||||
|
||||
The Algorand integration is also fully supported by the [Wormhole Typescript SDK](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/sdk/js).
|
||||
The Algorand integration is also fully supported by the [Wormhole Typescript SDK](https://github.com/wormhole-foundation/wormhole/tree/main/sdk/js).
|
||||
|
|
|
@ -1,9 +1,9 @@
|
|||
# Cosmos
|
||||
|
||||
The implementation contracts for Wormhole's official Cosmos integration can be found [here](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/cosmwasm).
|
||||
The implementation contracts for Wormhole's official Cosmos integration can be found [here](https://github.com/wormhole-foundation/wormhole/tree/main/cosmwasm).
|
||||
|
||||
The deployed contract addresses can be found on the [Contracts page](../../reference/contracts.md).
|
||||
|
||||
Cosmos is a rust-based programming environment. You'll likely find the [Wormhole Rust SDK](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/sdk/rust) useful.
|
||||
Cosmos is a rust-based programming environment. You'll likely find the [Wormhole Rust SDK](https://github.com/wormhole-foundation/wormhole/tree/main/sdk/rust) useful.
|
||||
|
||||
The Cosmos integration is also fully supported by the [Wormhole Typescript SDK](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/sdk/js).
|
||||
The Cosmos integration is also fully supported by the [Wormhole Typescript SDK](https://github.com/wormhole-foundation/wormhole/tree/main/sdk/js).
|
||||
|
|
|
@ -42,14 +42,14 @@ In order to run the Tilt environment, make sure you have [Tilt](https://docs.til
|
|||
Once you've installed these two dependencies, just clone the Wormhole Core Repository and start Tilt.
|
||||
|
||||
```
|
||||
git clone --branch dev.v2 https://github.com/wormhole-foundation/wormhole.git
|
||||
git clone --branch main https://github.com/wormhole-foundation/wormhole.git
|
||||
|
||||
cd wormhole
|
||||
|
||||
tilt up
|
||||
```
|
||||
|
||||
Be sure to check out the [**Tiltfile**](https://github.com/wormhole-foundation/wormhole/blob/dev.v2/Tiltfile), which has much of the configuration and arguments for the development environment. It's relatively straightforward to enable and disable components.
|
||||
Be sure to check out the [**Tiltfile**](https://github.com/wormhole-foundation/wormhole/blob/main/Tiltfile), which has much of the configuration and arguments for the development environment. It's relatively straightforward to enable and disable components.
|
||||
|
||||
For example, you can disable blockchains by setting them to false at startup
|
||||
|
||||
|
@ -65,7 +65,7 @@ If you've followed the standard setup, all your resources will be bound to vario
|
|||
|
||||
All the deployed contract addresses can be found under the 'Devnet / Tilt' section of [contracts](../../reference/contracts.md).
|
||||
|
||||
Useful information pertaining to funded wallets & private keys can also be found in the [devnet.md](https://github.com/wormhole-foundation/wormhole/blob/dev.v2/docs/devnet.md) file of the docs.
|
||||
Useful information pertaining to funded wallets & private keys can also be found in the [devnet.md](https://github.com/wormhole-foundation/wormhole/blob/main/docs/devnet.md) file of the docs.
|
||||
|
||||
Additional helpful resources can be found in the [Tooling](./tooling.md) page.
|
||||
|
||||
|
|
|
@ -2,11 +2,11 @@
|
|||
|
||||
Regardless of the development environment that you use, there are a few wormhole-specific tools you should know about.
|
||||
|
||||
### [Wormhole Core Repository](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/)
|
||||
### [Wormhole Core Repository](https://github.com/wormhole-foundation/wormhole/tree/main/)
|
||||
|
||||
- Most developers find it useful to clone the Wormhole Core repository. This repository provides the Devnet Tilt environment, plenty of useful code examples and tests, along with some utilities which do not have an official release package.
|
||||
|
||||
### [Worm CLI tool](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/clients/js)
|
||||
### [Worm CLI tool](https://github.com/wormhole-foundation/wormhole/tree/main/clients/js)
|
||||
|
||||
- Swiss-Army Knife Utility CLI tool. Excellent for creating one-off VAAs, parsing VAAs, reading Wormhole contract configurations, and more.
|
||||
|
||||
|
@ -14,7 +14,7 @@ Regardless of the development environment that you use, there are a few wormhole
|
|||
|
||||
- Small WIP tool which comes as part of the [Wormhole Local Validator](./wlv.md) environment. Used to quickly deploy and redeploy multiple smart contracts. Will eventually become part of a larger deployment management tool.
|
||||
|
||||
### [Wormhole SDKs](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/sdk)
|
||||
### [Wormhole SDKs](https://github.com/wormhole-foundation/wormhole/tree/main/sdk)
|
||||
|
||||
- Libraries in various languages to help with interacting with Wormhole contracts.
|
||||
|
||||
|
@ -22,7 +22,7 @@ Regardless of the development environment that you use, there are a few wormhole
|
|||
|
||||
- Typescript SDK destributed on npm. Can greatly aid in writing frontend code for xDapps and utilizing the Wormhole Token Bridge directly.
|
||||
|
||||
### [Wormhole Spy SDK](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/spydk/js)
|
||||
### [Wormhole Spy SDK](https://github.com/wormhole-foundation/wormhole/tree/main/spydk/js)
|
||||
|
||||
- The Wormhole Spy SDK allows you to listen to all of the activity on the Guardian Network.
|
||||
|
||||
|
|
|
@ -39,7 +39,7 @@ brew install tilt
|
|||
### 4. Clone Wormhole Repo and Start Tilt
|
||||
|
||||
```sh
|
||||
git clone --branch dev.v2 https://github.com/wormhole-foundation/wormhole.git
|
||||
git clone --branch main https://github.com/wormhole-foundation/wormhole.git
|
||||
cd wormhole/
|
||||
tilt up
|
||||
```
|
||||
|
@ -51,7 +51,7 @@ You'll be able to access the Tilt UI at
|
|||
|
||||
## Script Setup
|
||||
|
||||
If you're using a Debian distro, you should run the [dev-setup.sh](https://github.com/wormhole-foundation/wormhole/blob/dev.v2/scripts/dev-setup.sh) script. Even if you're not using Debian, this script still contains the main steps for setup.
|
||||
If you're using a Debian distro, you should run the [dev-setup.sh](https://github.com/wormhole-foundation/wormhole/blob/main/scripts/dev-setup.sh) script. Even if you're not using Debian, this script still contains the main steps for setup.
|
||||
|
||||
## Regular Setup
|
||||
|
||||
|
@ -97,7 +97,7 @@ curl -fsSL https://raw.githubusercontent.com/tilt-dev/tilt/master/scripts/instal
|
|||
### 5. Clone the Wormhole Repo and start Tilt
|
||||
|
||||
```sh
|
||||
git clone --branch dev.v2 https://github.com/wormhole-foundation/wormhole.git
|
||||
git clone --branch main https://github.com/wormhole-foundation/wormhole.git
|
||||
```
|
||||
|
||||
If you're running Tilt on your machine:
|
||||
|
|
|
@ -6,7 +6,7 @@ Messages in Wormhole take the form of a Verified Action Approval (VAA) and both
|
|||
|
||||
## Configuring the Interface
|
||||
|
||||
[Here](https://github.com/wormhole-foundation/wormhole/blob/dev.v2/ethereum/contracts/interfaces) is the interface for applications to interact with Wormhole's Core Contract to publish VAAs or verify and parse a received VAAs.
|
||||
[Here](https://github.com/wormhole-foundation/wormhole/blob/main/ethereum/contracts/interfaces) is the interface for applications to interact with Wormhole's Core Contract to publish VAAs or verify and parse a received VAAs.
|
||||
|
||||
Instantiating the interface will depend on the contract address of your development ecosystem and blockchain.
|
||||
|
||||
|
|
|
@ -4,7 +4,7 @@ This section will explain how to properly interact with the NFT Bridge Module in
|
|||
|
||||
## Configuring the interface
|
||||
|
||||
[Here](https://github.com/wormhole-foundation/wormhole/blob/dev.v2/ethereum/contracts/nft/interfaces/INFTBridge.sol) is the interface for applications to interact with Wormhole's NFT Bridge.
|
||||
[Here](https://github.com/wormhole-foundation/wormhole/blob/main/ethereum/contracts/nft/interfaces/INFTBridge.sol) is the interface for applications to interact with Wormhole's NFT Bridge.
|
||||
|
||||
<!---
|
||||
TODO
|
||||
|
|
|
@ -4,7 +4,7 @@
|
|||
|
||||
Within the Wormhole ecosystem, EVM refers to any blockchain 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).
|
||||
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/main/ethereum).
|
||||
|
||||
### Recommended Tooling for EVM
|
||||
|
||||
|
|
|
@ -4,7 +4,7 @@ This section will explain how to properly interact with the Wormhole Token Bridg
|
|||
|
||||
## Configuring the interface
|
||||
|
||||
[Here](https://github.com/wormhole-foundation/wormhole/blob/dev.v2/ethereum/contracts/bridge/interfaces/ITokenBridge.sol) is the interface for applications to interact with Wormhole's Token Bridge.
|
||||
[Here](https://github.com/wormhole-foundation/wormhole/blob/main/ethereum/contracts/bridge/interfaces/ITokenBridge.sol) is the interface for applications to interact with Wormhole's Token Bridge.
|
||||
|
||||
Instantiating the interface will depend on your development ecosystem and blockchain. The Wormhole Token Bridge contract address is usually stored in your contract address.
|
||||
|
||||
|
|
|
@ -1,9 +1,9 @@
|
|||
# NEAR
|
||||
|
||||
The implementation contracts for Wormhole's official NEAR integration can be found [here](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/near).
|
||||
The implementation contracts for Wormhole's official NEAR integration can be found [here](https://github.com/wormhole-foundation/wormhole/tree/main/near).
|
||||
|
||||
The deployed contract addresses can be found on the [Contracts page](../../reference/contracts.md).
|
||||
|
||||
NEAR is a rust-based programming environment. You'll likely find the [Wormhole Rust SDK](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/sdk/rust) useful.
|
||||
NEAR is a rust-based programming environment. You'll likely find the [Wormhole Rust SDK](https://github.com/wormhole-foundation/wormhole/tree/main/sdk/rust) useful.
|
||||
|
||||
The NEAR integration is also fully supported by the [Wormhole Typescript SDK](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/sdk/js).
|
||||
The NEAR integration is also fully supported by the [Wormhole Typescript SDK](https://github.com/wormhole-foundation/wormhole/tree/main/sdk/js).
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# Specialized Relayers
|
||||
|
||||
Rather than home-rolling a relayer, it's recommended that integrators start from the existing [Spy Relayer](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/relayer/spy_relayer) provided in the Wormhole Core Repository.
|
||||
Rather than home-rolling a relayer, it's recommended that integrators start from the existing [Spy Relayer](https://github.com/wormhole-foundation/wormhole/tree/main/relayer/spy_relayer) provided in the Wormhole Core Repository.
|
||||
|
||||
Additionally there's an extensible relayer (called the [Plugin Relayer](https://github.com/wormhole-foundation/wormhole/tree/feat/plugin_relayer/relayer/plugin_relayer)) currently in development.
|
||||
|
||||
|
|
|
@ -1,9 +1,9 @@
|
|||
# Solana
|
||||
|
||||
The implementation contracts for Wormhole's official Solana integration can be found [here](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/solana).
|
||||
The implementation contracts for Wormhole's official Solana integration can be found [here](https://github.com/wormhole-foundation/wormhole/tree/main/solana).
|
||||
|
||||
The deployed contract addresses can be found on the [Contracts page](../../reference/contracts.md).
|
||||
|
||||
Solana is a rust-based programming environment. You'll likely find the [Wormhole Rust SDK](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/sdk/rust) useful.
|
||||
Solana is a rust-based programming environment. You'll likely find the [Wormhole Rust SDK](https://github.com/wormhole-foundation/wormhole/tree/main/sdk/rust) useful.
|
||||
|
||||
The Solana integration is also fully supported by the [Wormhole Typescript SDK](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/sdk/js).
|
||||
The Solana integration is also fully supported by the [Wormhole Typescript SDK](https://github.com/wormhole-foundation/wormhole/tree/main/sdk/js).
|
||||
|
|
|
@ -10,6 +10,6 @@ npm i @certusone/wormhole-sdk
|
|||
|
||||
The following sections will explain and provide examples of how to perform key functions with Wormhole using the Typescript SDK.
|
||||
|
||||
For more examples with a more exhaustive coverage of all the supported blockchains in Wormhole, be sure to check the [official codebase](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/sdk/js) for the Typescript SDK.
|
||||
For more examples with a more exhaustive coverage of all the supported blockchains in Wormhole, be sure to check the [official codebase](https://github.com/wormhole-foundation/wormhole/tree/main/sdk/js) for the Typescript SDK.
|
||||
|
||||
Virtually all functions of the SDK are demonstrated in the [reference bridge UI](https://github.com/wormhole-foundation/example-token-bridge-ui), which makes it an excellent source of example code as well.
|
||||
|
|
|
@ -59,7 +59,7 @@ However, they also have a couple notable downsides
|
|||
|
||||
Due to specialized relayers being such a common solution, an extensible relayer (called the plugin relayer) has been provided in the main Wormhole repository. The plugin relayer stands up most of the requisite infrastructure for relaying, so that you only need to implement the logic which is specific to your application.
|
||||
|
||||
If you plan to develop a specialized relayer, consider starting from the plugin relayer [found here](https://github.com/wormhole-foundation/wormhole/tree/dev.v2/relayer).
|
||||
If you plan to develop a specialized relayer, consider starting from the plugin relayer [found here](https://github.com/wormhole-foundation/wormhole/tree/main/relayer).
|
||||
|
||||
<!--
|
||||
TODO link to plugin relayer once it has been merged down
|
||||
|
|
|
@ -121,7 +121,7 @@ Wormchain is a Cosmos based blockchain which runs internally to the Guardian net
|
|||
|
||||
This enables two additional protections for the Wormhole Asset Layer in addition to the core assumptions:
|
||||
|
||||
- **Governor:** The Governor tracks inflows and outflows of all blockchains and delays suspicious transfers which may be indicative of a exploit. [More Info](https://github.com/wormhole-foundation/wormhole/blob/dev.v2/whitepapers/0007_governor.md)
|
||||
- **Governor:** The Governor tracks inflows and outflows of all blockchains and delays suspicious transfers which may be indicative of a exploit. [More Info](https://github.com/wormhole-foundation/wormhole/blob/main/whitepapers/0007_governor.md)
|
||||
- **Global Accountant:** The accountant tracks the total circulating supply of all Wormhole assets across all chains and prevents any blockchain from bridging assets which would violate the supply invariant.
|
||||
|
||||
</br>
|
||||
|
|
Loading…
Reference in New Issue