Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/sky-ecosystem/sky-oapp-oft

Sky cross-chain token and governance bridge
https://github.com/sky-ecosystem/sky-oapp-oft

Last synced: 5 months ago
JSON representation

Sky cross-chain token and governance bridge

Awesome Lists containing this project

README 

          


  

    LayerZero

  






  Homepage | Docs | Developers




Omnichain Fungible Token (OFT) Solana Example



## Requirements



- Rust `v1.75.0`

- Anchor `v0.29`

- Solana CLI `v1.17.31`

- Docker

- Node.js



## Setup



We recommend using `pnpm` as a package manager (but you can of course use a package manager of your choice).



[Docker](https://docs.docker.com/get-started/get-docker/) is required to build using anchor. We highly recommend that you use the most up-to-date Docker version to avoid any issues with anchor

builds.



:warning: You need anchor version `0.29` and solana version `1.17.31` specifically to compile the build artifacts. Using higher Anchor and Solana versions can introduce unexpected issues during compilation. See the following issues in Anchor's repo: [1](https://github.com/coral-xyz/anchor/issues/3089), [2](https://github.com/coral-xyz/anchor/issues/2835). After compiling the correct build artifacts, you can change the Solana version to higher versions.



### Install Rust



```bash

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y

```



### Install Solana



```bash

sh -c "$(curl -sSfL https://release.solana.com/v1.17.31/install)"

```



### Install Anchor



Install and use the correct version



```bash

cargo install --git https://github.com/coral-xyz/anchor --tag v0.29.0 anchor-cli --locked

```



### Get the code



```bash

LZ_ENABLE_SOLANA_OFT_EXAMPLE=1 npx create-lz-oapp@latest

```



### Installing Dependencies



```bash

pnpm install

```



### Running tests



```bash

pnpm test

```



### Get Devnet SOL



```bash

solana airdrop 5 -u devnet

```



We 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](https://faucet.solana.com/).



### Prepare `.env`



```bash

cp .env.example .env

```



In the `.env` just created, set `SOLANA_PRIVATE_KEY` to your private key value in base58 format. Since the locally stored keypair is in an integer array format, we'd need to encode it into base58 first.



You can run the `npx hardhat lz:solana:base-58` to output your private key in base58 format. Optionally, pass in a value for the `--keypair-file` flag if you want to use the keypair other than the default at `~/.config/solana/id.json`



Also set the `RPC_URL_SOLANA_TESTNET` value. Note that while the naming used here is `TESTNET`, it refers to the [Solana Devnet](https://docs.layerzero.network/v2/developers/evm/technical-reference/deployed-contracts#solana-testnet). We use `TESTNET` to keep it consistent with the existing EVM testnets.



## Deploy



### Prepare the OFT Program ID



Create `programId` keypair files by running:



```bash

solana-keygen new -o target/deploy/endpoint-keypair.json --force

solana-keygen new -o target/deploy/oft-keypair.json --force



anchor keys sync

```



:warning: `--force` flag overwrites the existing keys with the ones you generate.



Run



```

anchor keys list

```



to view the generated programIds (public keys). The output should look something like this:



```

endpoint: 

oft: 

```



Copy the OFT's program ID, which you will use in the build step.



### Building and Deploying the Solana OFT Program



Ensure you have Docker running before running the build command.



#### Build the Solana OFT program



```bash

anchor build -v -e OFT_ID=

```



Where `` is replaced with your OFT Program ID copied from the previous step.



### Generate OFT IDL



This is required to make set rate limit scripts work.



```

pnpm generate:oft

```



#### Preview Rent Costs for the Solana OFT



:information_source: The majority of the SOL required to deploy your program will be for [**rent**](https://solana.com/docs/core/fees#rent) (specifically, for the minimum balance of SOL required for [rent-exemption](https://solana.com/docs/core/fees#rent-exempt)), which is calculated based on the amount of bytes the program or account uses. Programs typically require more rent than PDAs as more bytes are required to store the program's executable code.



In our case, the OFT Program's rent accounts for roughly 99% of the SOL needed during deployment, while the other accounts' rent, OFT Store, Mint, Mint Authority Multisig and Escrow make up for only a fraction of the SOL needed.



You can preview how much SOL would be needed for the program account. Note that the total SOL required would to be slightly higher than just this, to account for the other accounts that need to be created.



```bash

solana rent $(wc -c < target/verifiable/oft.so)

```



You should see an output such as



```bash

Rent-exempt minimum: 3.87415872 SOL

```



:information_source: LayerZero's default deployment path for Solana OFTs require you to deploy your own OFT program as this means you own the Upgrade Authority and don't rely on LayerZero to manage that authority for you. Read [this](https://neodyme.io/en/blog/solana_upgrade_authority/) to understand more no why this is important.



#### Deploy the Solana OFT



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`).



##### Temporarily switch to Solana `v1.18.26`



First, we switch to Solana `v1.18.26` (remember to switch back to `v1.17.31` later)



```bash

sh -c "$(curl -sSfL https://release.solana.com/v1.18.26/install)"

```



##### (Recommended) Deploying with a priority fee



This section applies if you are unable to land your deployment transaction due to network congestion.



:information_source: [Priority Fees](https://solana.com/developers/guides/advanced/how-to-use-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 `--with-compute-unit-price` flag to our `solana program deploy` 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](https://www.quicknode.com/gas-tracker/solana) to know what value you'd need to pass into the `--with-compute-unit-price` flag.



##### Run the deploy command



```bash

solana program deploy --program-id target/deploy/oft-keypair.json target/verifiable/oft.so -u devnet --with-compute-unit-price 

```



:information_source: the `-u` flag specifies the RPC URL that should be used. The options are `mainnet-beta, devnet, testnet, localhost`, which also have their respective shorthands: `-um, -ud, -ut, -ul`



:warning: If the deployment is slow, it could be that the network is congested and you might need to increase the priority fee.



##### Switch back to Solana `1.17.31`



:warning: After deploying, make sure to switch back to v1.17.31 after deploying. If you need to rebuild artifacts, you must use Solana CLI version `1.17.31` and Anchor version `0.29.0`



```bash

sh -c "$(curl -sSfL https://release.solana.com/v1.17.31/install)"

```



### Create the Solana OFT



:information_source: 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.



:information_source: 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\*.



:warning: If you choose to go with `--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.



#### For OFT:



```bash

pnpm hardhat lz:oft:solana:create --eid 40168 --program-id 

```



:warning: Use `--additional-minters` flag to add a CSV of additional minter addresses to the Mint Authority Multisig. If you do not want to, you must specify `--only-oft-store true`.



:information_source: You can also specify `--amount ` to have the OFT minted to your deployer address upon token creation.



#### For OFTAdapter:



```bash

pnpm hardhat lz:oft-adapter:solana:create --eid 40168 --program-id  --mint  --token-program 

```



:information_source: You can use OFT Adapter if you want to use an existing token on Solana. For OFT Adapter, tokens will be locked when sending to other chains and unlocked when receiving from other chains.



#### For OFT Mint-And-Burn Adapter (MABA):



```bash

pnpm hardhat lz:oft:solana:create --eid 40168 --program-id  --mint  --token-program 

```



:information_source: You can use OFT Mint-And-Burn Adapter if you want to use an existing token on Solana. For OFT Mint-And-Burn Adapter, tokens will be burned when sending to other chains and minted when receiving from other chains.



:warning: You cannot use this option if your token's Mint Authority has been renounced.



:warning: Note that for MABA mode, before attempting any cross-chain transfers, **you must transfer the Mint Authority** for `lz_receive` to work, as that is not handled in the script (since you are using an existing token). If you opted for `--additional-minters`, then you must transfer the Mint Authority to the newly created multisig (this is the `mintAuthority` value in the `/deployments/solana-/OFT.json`). If not, then it should be set to the OFT Store address, which is `oftStore` in the same file.



### Update [layerzero.config.ts](./layerzero.config.ts)



Make sure to update [layerzero.config.ts](./layerzero.config.ts) and set `solanaContract.address` with the `oftStore` address.



```typescript

const solanaContract: OmniPointHardhat = {

  eid: EndpointId.SOLANA_V2_TESTNET,

  address: "", // <---TODO update this with the OFTStore address.

};

```



:warning: Ensure that you only specify `address` for the solana contract object. Do not specify addresses for the EVM chain contract objects. Under the hood, we use `hardhat-deploy` to retrieve the contract addresses of the deployed EVM chain contracts. You will run into an error if you specify `address` for an EVM chain contract object.



### Deploy a sepolia OFT peer



```bash

pnpm hardhat lz:deploy # follow the prompts

```



Note: If you are on testnet, consider using `MyOFTMock` to allow test token minting. If you do use `MyOFTMock`, make sure to update the `sepoliaContract.contractName` in [layerzero.config.ts](./layerzero.config.ts) to `MyOFTMock`.



#### Initialize the OFT Program's SendConfig and ReceiveConfig Accounts



:warning: Do this only when initializing the OFT for the first time. The only exception is if a new pathway is added later. If so, run this again to properly initialize the pathway.



Run the following command to init the pathway config. This step is unique to pathways that involve Solana.



```bash

npx hardhat lz:oft:solana:init-config --oapp-config layerzero.config.ts --solana-eid 

```



### Wire



Run the following to wire the pathways specified in your `layerzero.config.ts`



```bash

npx hardhat lz:oapp:wire --oapp-config layerzero.config.ts --solana-eid 

```



With a squads multisig, you can simply append the `--multisig-key` flag to the end of the above command.



### Mint OFT on Solana



This is only relevant for **OFT**. If you opted to include the `--amount` flag in the create step, that means you already have minted some Solana OFT and you can skip this section.



:information_source: This is only possible if you specified your deployer address as part of the `--additional-minters` flag when creating the Solana OFT. If you had chosen `--only-oft-store true`, you will not be able to mint your OFT on Solana.



First, you need to create the Associated Token Account for your address.



```bash

spl-token create-account 

```



Then, you can mint. Remember this is in local decimals, so with local decimals of 9, you would need to pass in `--amount 1000000000` to mint 1 OFT.



```bash

spl-token mint   --multisig-signer ~/.config/solana/id.json --owner 

```



:information_source: `~/.config/solana/id.json` assumes that you will use the keypair in the default location. To verify if this path applies to you, run `solana config get` and not the keypair path value.



:information_source: You can get the `` address from [deployments/solana-testnet/OFT.json](deployments/solana-testnet/OFT.json).



### Set Message Execution Options



Refer to [Generating Execution Options](https://docs.layerzero.network/v2/developers/solana/gas-settings/options#generating-options) to learn how to build the options param for send transactions.



Note that you will need to either enable `enforcedOptions` in [./layerzero.config.ts](./layerzero.config.ts) or pass in a value for `_options` when calling `send()`. Having neither will cause a revert when calling send().



For this example, we have already included `enforcedOptions` by default in the `layerzero.config.ts`, which will take effect in the wiring step.



#### (Optional) If specifying the `_options` value when calling `send()`



It's only necessary to specify `_options` if you do not have `enforcedOptions`.



For Sepolia -> Solana, you should pass in the options value into the script at [tasks/evm/send.ts](./tasks/evm/send.ts) as the value for `sendParam.extraOptions`.



For Solana -> Sepolia, you should pass in the options value into the script at [tasks/solana/sendOFT.ts](./tasks/solana/sendOFT.ts) as the value for `options` for both in `quote` and `send`.



### Send



#### Send SOL -> Sepolia



```bash

npx hardhat lz:oft:solana:send --amount  --from-eid 40168 --to  --to-eid 40161

```



#### Send Sepolia -> SOL



```bash

npx hardhat --network sepolia-testnet send --dst-eid 40168 --amount  --to 

```



:information_source: If you encounter an error such as `No Contract deployed with name`, ensure that the `tokenName` in the task defined in `tasks/evm/send.ts` matches the deployed contract name.



### Set a new Mint Authority Multisig



If you are not happy with the deployer being a mint authority, you can create and set a new mint authority by running:



```bash

pnpm hardhat lz:oft:solana:setauthority --eid  --mint  --program-id  --escrow  --additional-minters 

```



The `OFTStore` is automatically added as a mint authority to the newly created mint authority, and does not need to be

included in the `--additional-minters` list.



## Set inbound rate limit



```

pnpm hardhat lz:oft:solana:inbound-rate-limit --mint BAbxz9StRee3vcPXwKoqmZuuRWJw7nMDDzRCr8P8bhco --program-id E4fE7PL7CghQipjJ1q6tXW2Yx3MuUAVZwHMrG7X8APcD --src-eid 40106 --eid 40168 --oft-store ECrqD25BHkLtowssWef4LqjcmL7ZH8sMR1MYB4P8A79e --capacity 1 --refill-per-second 1 --type net

```



## Set outbound rate limit



```

pnpm hardhat lz:oft:solana:outbound-rate-limit --mint BAbxz9StRee3vcPXwKoqmZuuRWJw7nMDDzRCr8P8bhco --program-id E4fE7PL7CghQipjJ1q6tXW2Yx3MuUAVZwHMrG7X8APcD --dst-eid 40106 --eid 40168 --oft-store ECrqD25BHkLtowssWef4LqjcmL7ZH8sMR1MYB4P8A79e --capacity 1 --refill-per-second 1 --type net

```



## Appendix



### Solana Program Verification



Refer to [Verify the OFT Program](https://docs.layerzero.network/v2/developers/solana/oft/program#optional-verify-the-oft-program).



### Transferring ownership



Ownership of OFTs can be transferred via running the wire command after the appropriate changes are made to the LZ Config file (`layerzero.config.ts`). You need to first set the `delegate` value, and then only the `owner` value.



**First, set the `delegate`.**



How to set delegate: https://docs.layerzero.network/v2/developers/evm/create-lz-oapp/configuring-pathways#adding-delegate



Now run



```

npx hardhat lz:oapp:wire --oapp-config layerzero.config.ts --solana-eid 

```



and execute the transactions.



**Then, set the `owner`.**



How to set owner: https://docs.layerzero.network/v2/developers/evm/create-lz-oapp/configuring-pathways#adding-owner



Now, run



```

npx hardhat lz:ownable:transfer-ownership --oapp-config layerzero.config.ts --solana-eid 

```



### Troubleshooting



Refer to the [Solana Troubleshooting page on the LayerZero Docs](https://docs.layerzero.network/v2/developers/solana/troubleshooting/common-errors) to see how to solve common error when deploying Solana OFTs.