Skip to content

Commit

Permalink
docs: add missing generated docs paths
Browse files Browse the repository at this point in the history
  • Loading branch information
CJ42 committed Feb 19, 2024
1 parent 7da1a5d commit 34db753
Show file tree
Hide file tree
Showing 8 changed files with 4,686 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .github/workflows/build-lint-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -106,9 +106,11 @@ jobs:
path: |
artifacts
node_modules
dist
types
contracts.ts
packages/**/types
packages/**/dist
key: ${{ github.run_id }}

- name: Use Node.js v20
Expand Down
3 changes: 3 additions & 0 deletions contracts/Imports.sol
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,6 @@ import {
import {
UniversalProfilePostDeploymentModule
} from "@lukso/lsp23-contracts/contracts/modules/UniversalProfilePostDeploymentModule.sol";
import {
IPostDeploymentModule
} from "@lukso/lsp23-contracts/contracts/IPostDeploymentModule.sol";
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-LinkedContractsFactory`](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-23-LinkedContractsFactory.md)

:::
:::info Solidity implementation

[`IPostDeploymentModule.sol`](https://github.com/lukso-network/lsp-smart-contracts/blob/develop/@lukso/lsp23-contracts/contracts/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-LinkedContractsFactory**](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-23-LinkedContractsFactory.md#executepostdeployment)
- Solidity implementation: [`IPostDeploymentModule.sol`](https://github.com/lukso-network/lsp-smart-contracts/blob/develop/@lukso/lsp23-contracts/contracts/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` | The address of the deployed primary contract. |
| `secondaryContract` | `address` | The address of the deployed secondary contract. |
| `calldataToPostDeploymentModule` | `bytes` | Calldata to be passed for the post-deployment execution. |

<br/>

Large diffs are not rendered by default.

Loading

0 comments on commit 34db753

Please sign in to comment.