wormhole-foundation / docs.wormhole.com Goto Github PK

The contracts on the reference page and elsewhere should provide links to block explorers showing live deployed contracts

https://docs.wormhole.com/wormhole/blockchain-environments/contracts

The connect-sdk has explorer URLs we can use for this

The on-chain relayer SDK for Ethereum should have documentation.

Where does it belong?
Can we autogen docs?
What will people need to know to use it?
Link off to tutorial for hello-universe

https://github.com/wormhole-foundation/wormhole/blob/main/ethereum/contracts/interfaces/relayer/IWormholeRelayer.sol
https://github.com/wormhole-foundation/wormhole/blob/main/ethereum/contracts/interfaces/relayer/IWormholeReceiver.sol

Rewrite the outdated definitions of a few terms in the Glossary section of docs

xChain
Term that refers to the full range of cross-blockchain interoperability.
xAssets
Chain-and-path agnostic token that exists on a layer outside the blockchain ecosystem, which can be used to conduct transactions on any blockchain.
xDapp
Decentralized application that enables users to create and/or use xData.
xData
Data that exists in a layer outside of Layer 1 blockchains, which is accessible by all chains.

Maintain a list of repositories we depend on for content and as changes are made, run the relevant scripts to determine if any changes would be made to the docs. If changes would result, issue a PR to the docs repo.

Also setup a github action to submit a pr if the README is updated

It is hard to find what you need on a giant page, make it nicer to use

The term xThing is not well used besides xAsset.

Remove from everywhere except glossary, noting in the glossary that its not a term that is widely used but might show up in older demos/docs

An integrator should be provided a document describing best practices including; security checks, deployment, migration.

This document may be different for each chain

I am having an issue, i have verified the contract from BNB to SOL using wormhole and contract authority is BCD75RNBHrJJpW4dXVagL5mPjzRLnVZq4YirJdjEYMV7
gogu wormhole

Meanwhile this token with the same authority managed to update the logo/socials
maga wormhole

Can someone explain how is it possible to update the info/logo

There are a number of terms we interchange, like "Origin" and "Source" to mean the chain or contract from which some relevant message was issued.

We should be as consistent as possible in the docs and make sure the glossary mentions "Also called ..." to explain content from sources outside the docs

Support for tBTC has been added to wormhole-connect

The workflow for generating docs or pulling in content needs to be improved

Gas on source (eth) - yes
Gas on dest. (gateway) - no: Gateway doesn't have token-priced metering and require gas fees to be paid by the user
Relay fee to land on gateway - yes: Whatever Guardians charge right now, if at all
Relay fee to land on cosmos chain- no: Relayers aren't incentivized by user fees,
No added bridging fees - yes
any gas to be paid on (destination) cosmos chain - no: IBC covers the processing on the destination chain

0 gas to land transactions on Gateway. There are no fees, its a private chain
Fees to land transactions on Cosmos chains, covered

For the various gateway bridging flows:

External -> Cosmos: IBC relayer will need to relay the transaction from Gateway to the destination Cosmos chain. The relayer needs to pay gas fees on the destination cosmos chain.

Cosmos -> Cosmos: IBC relayer relays the transaction from source Cosmos chain to Gateway. They'll need to pay a small amount of fees on the source Cosmos chain for the packet acknowledgement transaction. Then an IBC relayer will relay the transaction from Gateway to the destination Cosmos chain, so they'll need to pay gas fees to land the transaction on the destination cosmos chain.

Cosmos -> External: IBC relayer relays the transaction from source Cosmos chain to Gateway. They'll need to pay a small amount of fees on the source Cosmos chain for the packet acknowledgement transaction

https://github.com/wormhole-foundation/docs.wormhole.com/blob/main/docs/reference/components/core-contracts.md?plain=1#L42 doesn't correctly resolve to https://docs.wormhole.com/wormhole/blockchain-environments/environments

Review Tilt instructions and ensure correctness.

Add hints for likely issues

possible issue example
In this file, it looks like chains are defaulted to false to begin with so it should be reversed to enable chains: https://github.com/wormhole-foundation/wormhole/blob/main/Tiltfile

tilt up -- --algorand=false --near=false --solana=false terra_classic=false terra2=false

The initial FAQ page needs to be populated with common questions.

What are the common questions devs/researchers might ask?

Some chains have multiple testnet environments, it isn't always clear what testnet we're referring to.

Add testnet network names to configuration and add them to the chain and constants pages along with more familiar chain ids

If an integrator wants to have the same contract address on all chains and provide a "non-wrapped" version of the token for bridging, a Burn and Mint style transfer should be used.

At the moment there is no documentation or examples for this style of transfer (that I could find)