Skip to content

Commit

Permalink
Merge pull request #471 from alephium/update-cli-doc
Browse files Browse the repository at this point in the history
Update cli doc
  • Loading branch information
polarker authored Dec 13, 2024
2 parents 8c7c64f + baf3b14 commit 5ad8d6a
Showing 1 changed file with 11 additions and 14 deletions.
25 changes: 11 additions & 14 deletions docs/sdk/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,26 +110,23 @@ In most cases, we only need to specify the `networks` config. The other optional
<td><i>errorOnWarnings</i><br/>Compiler warnings will be treated as errors if this config is enabled</td>
</tr>
<tr>
<td>skipRecompile</td>
<td>Specify whether contract code should be recompiled when deploying contracts, it is `false` by default</td>
<td>skipRecompileOnDeployment</td>
<td>Specify whether contract code should be recompiled when deploying contracts. It is `false` by default</td>
</tr>
<tr>
<td>forceRecompile</td>
<td>The `forceRecompile` flag is used to recompile all contracts. It is `false` by default.</td>
</tr>
<tr>
<td>skipRecompileIfDeployedOnMainnet</td>
<td>
The purpose of this config is to maintain backward compatibility, it is disabled by default. More concretely:
<ul>
<li>
If this config is disabled and the contract code has already been deployed to the testnet/mainnet without any updates, then no new bytecode will be generated for the contract
</li>
<li>
If this config is disabled and the contract code has already been deployed to the testnet/mainnet but the contract code has been updated, then new bytecode will be generated for the contract
</li>
<li>
If this config is enabled or the contract code has not been deployed to the testnet/mainnet, then new bytecode will be generated for the contract
</li>
</ul>
When this flag is enabled, it checks whether the contract has been deployed to the mainnet using the contract code hash. If it has been deployed, the contract will not be recompiled. It is `false` by default.
</td>
</tr>
<tr>
<td>skipRecompileContracts</td>
<td>This list specifies the contracts you do not want to recompile. It is an empty list by default.</td>
</tr>
<tr>
<td>enableDebugMode</td>
<td>Alephium CLI will print out network requests and error stack traces if enabled</td>
Expand Down

0 comments on commit 5ad8d6a

Please sign in to comment.