This repository is a modified version of the LayerZero Endpoint V1 + Solana OFT example. It has been modified to support Olympus' bridge setup using Endpoint V1 and the LzApp approach (see the CrossChainBridge policy).
It provides:
- Deployment of an OFT on Solana
- Setting the mainnet/sepolia CrossChainBridge policy as a trusted remote
Following the instructions below will result in the following being deployed:
On the specified Solana chain:
- OFT program (see env.json
<network>.oft.programId)- Owned by the account specified as the DAO MS (see env.json
<network>.olympus.daoMS).
- Owned by the account specified as the DAO MS (see env.json
- OHM token (see env.json
<network>.token)- Owned by the OFT program, via a 1/1 multisig owned by the OFT store, which is owned by the OFT program.
- The only minter is the OFT store (bridge). It cannot be minted outside of a bridge transaction.
- OFT program linked to the bridge contract on the specified EVM chain.
On the specified EVM chain:
- Bridge contract linked to the specified Solana chain
The current setup only supports 1-to-1 bridging, for example:
- Ethereum Sepolia <-> Solana Devnet
- Ethereum Mainnet <-> Solana Mainnet
Additional work would be required to configure bridging from Ethereum L2s to Solana (and vice-versa).
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -ysh -c "$(curl -sSfL https://release.solana.com/v1.17.31/install)"Install and use the correct version
cargo install --git https://github.com/coral-xyz/anchor --tag v0.29.0 anchor-cli --lockedcargo install solana-verify
cargo install bs58-cli
If using the Olympus Deployer wallet, place the keypair in the ~/.config/solana/olympus-deployer.json file.
Then configure the Solana CLI to use that keypair by default: solana config set --keypair ~/.config/solana/olympus-deployer.json
Otherwise, the default wallet at ~/.config/solana/id.json will be used. You may need to create this.
Place the keypair files in target/deploy/endpoint-keypair.json and target/deploy/oft-keypair.json. These will need to be manually shared. These keypairs are tied to the deployer keypair, and must be re-generated if the keypair is changed.
./shell/oft_keypair.shEnsure the following files have the updated OFT ID:
- Anchor.toml: programs.localnet.oft
- env.json: .oft.programId (for all affected networks)
solana airdrop 5 -u devnetWe recommend that you request 5 devnet SOL, which should be sufficient for this walkthrough. For the example here, we will be using Solana Devnet. If you hit rate limits, you can also use the official Solana faucet.
cp .env.example .envIn the .env just created, set SOLANA_PRIVATE_KEY to the output of:
./shell/get_private_key.shAlso set the RPC_URL_SOLANA_TESTNET value. Note that while the naming used here is TESTNET, it refers to the Solana Devnet. We use TESTNET to keep it consistent with the existing EVM testnets.
pnpm install
The local scripts use the env.json file to store configuration variables.
LayerZero requires an additional configuration file. The local scripts will use [layerzero-testnet.config.ts] or [layerzero-mainnet.config.ts] automatically, depending on the network specified.
- TODO: Run the script to generate a new LayerZero config. https://docs.layerzero.network/v2/developers/evm/create-lz-oapp/configuring-pathways
- In the
deployments/directory, create a directory for the network that you wish to add:.chainId: EVM chain idCrossChainBridge.json: JSON containingaddressandabikeys.- See
deployments/solana-testnet/for an example.
The steps below can be used for either the Solana testnet/devnet or mainnet by changing the appropriate flag.
Docker must be running for many of these commands to work.
Configure the Solana CLI to use the correct RPC URL:
solana config set --url <devnet|mainnet>./shell/oft_build.sh --network <devnet|mainnet>While for building, we must use Solana v1.17.31, for deploying, we will be using v1.18.26 as it provides an improved program deployment experience (i.e. ability to attach priority fees and also exact-sized on-chain program length which prevents needing to provide 2x the rent as in v1.17.31). The deploy script will automatically switch versions and restore.
./shell/oft_deploy.sh --network <devnet|mainnet> --broadcast <true|false>This section applies if you are unable to land your deployment transaction due to network congestion.
ℹ️ Priority Fees are Solana's mechanism to allow transactions to be prioritized during periods of network congestion. When the network is busy, transactions without priority fees might never be processed. It is then necessary to include priority fees, or wait until the network is less congested. Priority fees are calculated as follows: priorityFee = compute budget * compute unit price. We can make use of priority fees by attaching the --priority-fee flag to our oft_deploy.sh command. Note that the flag takes in a value in micro lamports, where 1 micro lamport = 0.000001 lamport.
You can run refer QuickNode's Solana Priority Fee Tracker to know what value you'd need to pass into the --priority-fee flag.
./shell/oft_create.sh --network <devnet|mainnet> --broadcast <true|false>The OFT account is created without any additional minters (the bridge is the only one).
The OFT store and token addresses will be printed.
Save the OFT Store in:
- env.json:
<network>.oft.oftStore - layerzero-.config.ts:
solanaContract.address
Save the Token address in:
- env.json:
<network>.token
ℹ️ For OFT and OFT Mint-and-Burn Adapter, the SPL token's Mint Authority is set to the Mint Authority Multisig, which always has the OFT Store as a signer. The multisig is fixed to needing 1 of N signatures.
ℹ️ For OFT and OFT Mint-And-Burn Adapter, you have the option to specify additional signers through the --additional-minters flag. If you choose not to, you must pass in --only-oft-store true, which means only the OFT Store will be a signer for the _Mint Authority Multisig*.
--only-oft-store, you will not be able to add in other signers/minters or update the Mint Authority, and the Freeze Authority will be immediately renounced. The token Mint Authority will be fixed Mint Authority Multisig address while the Freeze Authority will be set to None.
./shell/oft_verify.sh --network <devnet|mainnet> --broadcast <true|false>The following command will link the Solana endpoint to the EVM (mainnet or sepolia, depending on the --network flag).
./shell/endpoint_solana.sh --network <devnet|mainnet> --broadcast <true|false>This script has a few steps:
- Initialising the OFT config: no input necessary
- Wiring the OFT
- The script will prepare some transactions related to "LzApp" (EVM) and ask if you want to preview them (no) and then submit them (no).
- It will then prepare some transactions related to "OApp" (Solana, in this case). Preview and submit them.
Prior to linking the EVM endpoint to Solana, transfer ownership of the OFT program to the MS.
./shell/oft_transfer_ownership.sh --network <devnet|mainnet> --broadcast <true|false>Currently, the update authority of the token will rename with the deployer. There does not appear to be a way to change that.
./shell/endpoint_evm.sh --network <devnet|mainnet> --account <cast account> --broadcast <true|false>This script will work on testnets, assuming that the cast account provided has the "bridge_admin" role. Mainnet/production deployments will need an OCG proposal or MS batch to perform this.
TODO needed?
The script will set it to the default value of 1, which is all that's needed in order to bypass gas assertion.
npx hardhat --network sepolia-testnet lz:lzapp:set-min-dst-gas --dst-eid 40168For Ethereum Sepolia -> Solana devnet:
./shell/bridge_from_evm.sh --network <devnet|mainnet> --to <recipient-address> --amount <amount> --account <account> --broadcast <true|false>./shell/bridge_to_evm.sh --network <devnet|mainnet> --amount <amount> --to <recipient> --broadcast <true|false>After deployment, the metadata on SolScan needs to be updated. More information.