Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/volumefi/evm-solana-wormhole-token-bridge
https://github.com/volumefi/evm-solana-wormhole-token-bridge
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/volumefi/evm-solana-wormhole-token-bridge
- Owner: VolumeFi
- Created: 2024-11-27T13:03:48.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-28T14:20:36.000Z (about 2 months ago)
- Last Synced: 2024-11-28T15:26:17.591Z (about 2 months ago)
- Language: TypeScript
- Size: 65.4 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Token Transfer EVM <=> Solana
## Prerequisites
Before you begin, ensure you have the following:
- [Node.js and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) installed on your machine
- A wallet with a private key, funded with native tokens (Testnet or Mainnet) for gas fees
Create a `.env` file at the root of the project with your private keys:
```bash
ETH_PRIVATE_KEY="INSERT_PRIVATE_KEY"
SOL_PRIVATE_KEY="INSERT_PRIVATE_KEY" // must be base58 not a byte array!
```
## Installation
1. Clone the repository and navigate to the project directory:
```bash
git clone git clone https://github.com/VolumeFi/evm-solana-wormhole-token-bridge.git
cd evm-solana-wormhole-token-bridge.git
```
2. Install the project dependencies:
```bash
npm install
```
## Token Registeration
### Create Attestation & Register Token
network_type: Mainnet | Testnet
chain_id: "Solana" | "Ethereum" | "Terra" | "Bsc" | "Polygon" | "Avalanche" | "Oasis" | "Algorand" | "Aurora" | "Fantom" | "Karura" | "Acala" | "Klaytn" | "Celo" | "Near" | "Moonbeam" | "Neon" | "Terra2" | "Injective" | "Osmosis" | "Sui" | "Aptos" | "Arbitrum" | "Optimism" | "Gnosis" | "Pythnet" | "Xpla" | "Btc" | "Base" | "Sei" | "Rootstock" | "Scroll" | "Mantle" | "Blast" | "Xlayer" | "Linea" | "Berachain" | "Seievm" | "Snaxchain" | "Wormchain" | "Cosmoshub" | "Evmos" | "Kujira" | "Neutron" | "Celestia" | "Stargaze" | "Seda" | "Dymension" | "Provenance" | "Sepolia" | "ArbitrumSepolia" | "BaseSepolia" | "OptimismSepolia" | "Holesky" | "PolygonSepolia"
token_address: "native" | token contract address
```bash
npm run register [network_type] [origin_chain_id] [token_address] [destination_chain_id]
```
e.g.
```bash
npm run register Mainnet Base 0xD6E2433eFeEA4b7711e6D98Ed108E40956E90e30 Ethereum
```
### Recover Attestation
```bash
npm run register [network_type] [origin_chain_id] [token_address] [destination_chain_id] [token_attestation_tx_id]
```
e.g.
```bash
npm run register Mainnet Base 0xD6E2433eFeEA4b7711e6D98Ed108E40956E90e30 Ethereum 0x03aa532d53b9106ee5f10e39789f242ab64e63743c09483ebef00cd5bd75e37d
```
## Running Transfers
### Token Transfer
network_type: Mainnet | Testnet
chain_id: "Solana" | "Ethereum" | "Terra" | "Bsc" | "Polygon" | "Avalanche" | "Oasis" | "Algorand" | "Aurora" | "Fantom" | "Karura" | "Acala" | "Klaytn" | "Celo" | "Near" | "Moonbeam" | "Neon" | "Terra2" | "Injective" | "Osmosis" | "Sui" | "Aptos" | "Arbitrum" | "Optimism" | "Gnosis" | "Pythnet" | "Xpla" | "Btc" | "Base" | "Sei" | "Rootstock" | "Scroll" | "Mantle" | "Blast" | "Xlayer" | "Linea" | "Berachain" | "Seievm" | "Snaxchain" | "Wormchain" | "Cosmoshub" | "Evmos" | "Kujira" | "Neutron" | "Celestia" | "Stargaze" | "Seda" | "Dymension" | "Provenance" | "Sepolia" | "ArbitrumSepolia" | "BaseSepolia" | "OptimismSepolia" | "Holesky" | "PolygonSepolia"
token_address: "native" | token contract address
amount: the token amount to bridge token
```bash
npm run transfer [network_type] [send_chain_id] [receive_chain_id] [token_address] [amount]
```
e.g.
```bash
npm run transfer Mainnet Base Solana 0x1eD7d3c06190048CF9DCCd578Ca6B84B93BCa543 1
```
### Token Recover
We need this command if you tried to send token but failed on VAA step.
```bash
npm run transfer [network_type] [send_chain_id] [receive_chain_id] [token_address] [amount] [token_transfer_tx_id]
```
e.g.
```bash
npm run transfer Mainnet Base Solana 0x1eD7d3c06190048CF9DCCd578Ca6B84B93BCa543 1 0xfdd73783a9906b130b208b1d8412ae98e05ca42e2f7fa7b7c3b75cb7144f2a62
```