Skip to content

Commit 5b878de

Browse files
authored
docs:(oft-solana): mention amount flag for creation (LayerZero-Labs#1092)
1 parent 1bb0524 commit 5b878de

1 file changed

Lines changed: 15 additions & 9 deletions

File tree

examples/oft-solana/README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -185,31 +185,35 @@ sh -c "$(curl -sSfL https://release.solana.com/v1.17.31/install)"
185185

186186
### Create the Solana OFT
187187

188-
For OFT:
188+
: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.
189+
190+
: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\*.
191+
192+
: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. You will also not be able to renounce the Freeze Authority. The Mint Authority and Freeze Authority will be fixed to the Mint Authority Multisig address.
193+
194+
#### For OFT:
189195

190196
```bash
191197
pnpm hardhat lz:oft:solana:create --eid 40168 --program-id <PROGRAM_ID>
192198
```
193199

194-
:warning: You may specify the `--additional-minters` flag to add a CSV of additional minter keys to the mint
195-
multisig. If you do not want to, you must specify `--only-oft-store true`. If you choose the latter approach, you can never
196-
substitute in a different mint authority.
200+
: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`.
197201

198-
For OFTAdapter:
202+
:information_source: You can also specify `--amount <AMOUNT>` to have the OFT minted to your deployer address upon token creation.
203+
204+
#### For OFTAdapter:
199205

200206
```bash
201207
pnpm hardhat lz:oft-adapter:solana:create --eid 40168 --program-id <PROGRAM_ID> --mint <TOKEN_MINT> --token-program <TOKEN_PROGRAM_ID>
202208
```
203209

204-
For OFT Mint-And-Burn Adapter (MABA):
210+
#### For OFT Mint-And-Burn Adapter (MABA):
205211

206212
```bash
207213
pnpm hardhat lz:oft:solana:create --eid 40168 --program-id <PROGRAM_ID> --mint <TOKEN_MINT> --token-program <TOKEN_PROGRAM_ID>
208214
```
209215

210-
:warning: You may specify the `--additional-minters` flag to add a CSV of additional minter keys to the mint
211-
multisig. If you do not want to, you must specify `--only-oft-store store`. If you choose the latter approach, you can never
212-
substitute in a different mint authority.
216+
: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`.
213217

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

@@ -250,6 +254,8 @@ With a squads multisig, you can simply append the `--multisigKey` flag to the en
250254

251255
### Mint OFT on Solana
252256

257+
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.
258+
253259
: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`, you will not be able to mint your OFT on Solana.
254260

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

0 commit comments

Comments
 (0)