-
Notifications
You must be signed in to change notification settings - Fork 62
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #608 from lukso-network/standards/lsp23
docs: create lsp23 docs
- Loading branch information
Showing
6 changed files
with
476 additions
and
0 deletions.
There are no files selected for viewing
53 changes: 53 additions & 0 deletions
53
docs/contracts/contracts/LSP23LinkedContractsDeployment/IPostDeploymentModule.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
<!-- This file is auto-generated. Do not edit! --> | ||
<!-- Check `@lukso-network/lsp-smart-contracts/CONTRIBUTING.md#solidity-code-comments` for more information. --> | ||
|
||
# IPostDeploymentModule | ||
|
||
:::info Standard Specifications | ||
|
||
[`LSP-23-LinkedContractsDeployment`](https://github.com/lukso-network/lips/tree/main/LSPs/LSP-23-LinkedContractsDeployment.md) | ||
|
||
::: | ||
:::info Solidity implementation | ||
|
||
[`IPostDeploymentModule.sol`](https://github.com/lukso-network/lsp-smart-contracts/blob/develop/contracts/LSP23LinkedContractsDeployment/IPostDeploymentModule.sol) | ||
|
||
::: | ||
|
||
## Public Methods | ||
|
||
Public methods are accessible externally from users, allowing interaction with this function from dApps or other smart contracts. | ||
When marked as 'public', a method can be called both externally and internally, on the other hand, when marked as 'external', a method can only be called externally. | ||
|
||
### executePostDeployment | ||
|
||
:::note References | ||
|
||
- Specification details: [**LSP-23-LinkedContractsDeployment**](https://github.com/lukso-network/lips/tree/main/LSPs/LSP-23-LinkedContractsDeployment.md#executepostdeployment) | ||
- Solidity implementation: [`IPostDeploymentModule.sol`](https://github.com/lukso-network/lsp-smart-contracts/blob/develop/contracts/LSP23LinkedContractsDeployment/IPostDeploymentModule.sol) | ||
- Function signature: `executePostDeployment(address,address,bytes)` | ||
- Function selector: `0x28c4d14e` | ||
|
||
::: | ||
|
||
```solidity | ||
function executePostDeployment( | ||
address primaryContract, | ||
address secondaryContract, | ||
bytes calldataToPostDeploymentModule | ||
) external nonpayable; | ||
``` | ||
|
||
_This function can be used to perform any additional setup or configuration after the primary and secondary contracts have been deployed._ | ||
|
||
Executes post-deployment logic for the primary and secondary contracts. | ||
|
||
#### Parameters | ||
|
||
| Name | Type | Description | | ||
| -------------------------------- | :-------: | -------------------------------------------------------- | | ||
| `primaryContract` | `address` | Address of the deployed primary contract. | | ||
| `secondaryContract` | `address` | Address of the deployed secondary contract. | | ||
| `calldataToPostDeploymentModule` | `bytes` | Calldata to be passed for the post-deployment execution. | | ||
|
||
<br/> |
Oops, something went wrong.