Merge pull request #565 from lukso-network/add-lsp1-abi-docs

Add LSP1 ABI auto-generated docs.
lukso-network · Jul 7, 2023 · 5ac1153 · 5ac1153
2 parents 42662c2 + 3de6914
commit 5ac1153
Show file tree

Hide file tree

Showing 19 changed files with 1,661 additions and 158 deletions.
diff --git a/docs/contracts/_links.md b/docs/contracts/_links.md
diff --git a/...rsalReceiver/LSP1UniversalReceiverDelegateUP/LSP1UniversalReceiverDelegateUP.md b/...rsalReceiver/LSP1UniversalReceiverDelegateUP/LSP1UniversalReceiverDelegateUP.md
diff --git a/...ceiver/LSP1UniversalReceiverDelegateVault/LSP1UniversalReceiverDelegateVault.md b/...ceiver/LSP1UniversalReceiverDelegateVault/LSP1UniversalReceiverDelegateVault.md
diff --git a/docs/contracts/contracts/LSP4DigitalAssetMetadata/LSP4DigitalAssetMetadata.md b/docs/contracts/contracts/LSP4DigitalAssetMetadata/LSP4DigitalAssetMetadata.md
diff --git a/docs/contracts/contracts/LSP7DigitalAsset/LSP7DigitalAsset.md b/docs/contracts/contracts/LSP7DigitalAsset/LSP7DigitalAsset.md
diff --git a/...ontracts/contracts/LSP8IdentifiableDigitalAsset/LSP8IdentifiableDigitalAsset.md b/...ontracts/contracts/LSP8IdentifiableDigitalAsset/LSP8IdentifiableDigitalAsset.md
diff --git a/docs/contracts/introduction.md b/docs/contracts/introduction.md
@@ -64,7 +64,7 @@ Some of the LSP standards do not have a contract implementation as they represen
 The **Universal Profile** contracts allow a better representation of the identity on the blockchain and better control over it.
 
 - **[LSP0ERC725Account](../standards/smart-contracts/lsp0-erc725-account.md)**: a contract that can be used as an account and represents an **identity on-chain**.
-- **[LSP1UniversalReceiverDelegateUP](../standards/smart-contracts/lsp1-universal-receiver-delegate-up.md)**: a contract that allows the account to react to the calls that it receives (Normal transaction, Token transfer, Vaults transfer, etc.).
+- **[LSP1UniversalReceiverDelegateUP](./contracts/LSP1UniversalReceiver/LSP1UniversalReceiverDelegateUP/LSP1UniversalReceiverDelegateUP.md)**: a contract that allows the account to react to the calls that it receives (Normal transaction, Token transfer, Vaults transfer, etc.).
 - **[LSP6KeyManager](../standards/smart-contracts/lsp6-key-manager.md)**: a contract that allows **multi-control** over the account using different permissions.
 - **LSP11BasicSocialRecovery**
 
@@ -81,7 +81,7 @@ The **Digital Asset (Token and NFT 2.0)** contracts are the newest advanced vers
 These contracts are not just related to one specific section and could be used with the **Universal Profile**, **Digital Asset**, and **NFT 2.0** contracts.
 
 - **[LSP9Vault](../standards/smart-contracts/lsp9-vault.md)**: a contract representing a **Vault** able to execute and hold assets could be owned by an LSP0ERC725Account contract.
-- **[LSP1UniversalReceiverDelegateVault](../standards/smart-contracts/lsp1-universal-receiver-delegate-vault.md)**: a contract that allows the vault to react to the calls it receives (Normal transaction, Token transfer, etc.).
+- **[LSP1UniversalReceiverDelegateVault](./contracts/LSP1UniversalReceiver/LSP1UniversalReceiverDelegateVault/LSP1UniversalReceiverDelegateVault.md)**: a contract that allows the vault to react to the calls it receives (Normal transaction, Token transfer, etc.).
 - **LSP14Ownable2Step**
 - **LSP17ContractExtension**
 - **LSP20CallVerification**

diff --git a/docs/guides/universal-receiver-delegate/set-default-implementation.md b/docs/guides/universal-receiver-delegate/set-default-implementation.md
@@ -14,7 +14,7 @@ Users deploying their Universal Profiles using the guides that utilize **[lsp-fa
 
 :::
 
-This guide will teach you how to deploy and set the default implementation of the **[Universal Receiver Delegate](../../standards/smart-contracts/lsp1-universal-receiver-delegate-up.md)** (URD) used by the Universal Profile. This contract will register the addresses of the **[received assets](../../standards/universal-profile/lsp5-received-assets.md)** and **[vaults](../../standards/universal-profile/lsp10-received-vaults.md)** and will remove them on a balance equal to 0. This contract requires the [**`SUPER_SETDATA` Permission**](../../standards/universal-profile/lsp6-key-manager.md#super-permissions) to interact with the profile through the KeyManager.
+This guide will teach you how to deploy and set the default implementation of the **[Universal Receiver Delegate](../../contracts/contracts/LSP1UniversalReceiver/LSP1UniversalReceiverDelegateUP/LSP1UniversalReceiverDelegateUP.md)** (URD) used by the Universal Profile. This contract will register the addresses of the **[received assets](../../standards/universal-profile/lsp5-received-assets.md)** and **[vaults](../../standards/universal-profile/lsp10-received-vaults.md)** and will remove them on a balance equal to 0. This contract requires the [**`SUPER_SETDATA` Permission**](../../standards/universal-profile/lsp6-key-manager.md#super-permissions) to interact with the profile through the KeyManager.
 
 ![UniversalReceiverDelegate setting data keys on profile](/img/standards/lsp1delegate/token-transfer-4.jpg)
 

diff --git a/docs/guides/vault/edit-vault-data.md b/docs/guides/vault/edit-vault-data.md
@@ -8,7 +8,7 @@ import TabItem from '@theme/TabItem';
 
 # Edit Vault Data
 
-This guide will teach you how to set data to an **[LSP9Vault](../../standards/smart-contracts/lsp9-vault.md)** contract through a UniversalProfile owned by an LSP6KeyManager. Any data can be attached to the vault, and since it supports the **[LSP1-UniversalReceiver](../../standards/generic-standards/lsp1-universal-receiver.md)** standard, we will set the [**Universal Receiver Delegate**](../../standards/smart-contracts/lsp1-universal-receiver-delegate-vault.md) address inside the storage.
+This guide will teach you how to set data to an **[LSP9Vault](../../standards/smart-contracts/lsp9-vault.md)** contract through a UniversalProfile owned by an LSP6KeyManager. Any data can be attached to the vault, and since it supports the **[LSP1-UniversalReceiver](../../standards/generic-standards/lsp1-universal-receiver.md)** standard, we will set the [**Universal Receiver Delegate**](../../contracts/contracts/LSP1UniversalReceiver/LSP1UniversalReceiverDelegateVault/LSP1UniversalReceiverDelegateVault.md) address inside the storage.
 
 ## Setting Data (Universal Receiver Delegate)
 

diff --git a/docs/standards/generic-standards/lsp1-universal-receiver-delegate.md b/docs/standards/generic-standards/lsp1-universal-receiver-delegate.md
@@ -63,7 +63,7 @@ In summary, delegation provides a flexible way for smart contracts to handle and
 
 ## Implementations
 
-There are several implementations of the standard. The **[LSP1UniversalReceiverDelegateUP](../smart-contracts/lsp1-universal-receiver-delegate-up.md)** contract is one of them and is used as a delegate to the `universalReceiver(...)` function of **UniversalProfile** contract.
+There are several implementations of the standard. The **[LSP1UniversalReceiverDelegateUP](../../contracts/contracts/LSP1UniversalReceiver/LSP1UniversalReceiverDelegateUP/)** contract is one of them and is used as a delegate to the `universalReceiver(...)` function of **UniversalProfile** contract.
 
 At the moment, this contract allows to:
 

diff --git a/docs/standards/smart-contracts/lsp1-universal-receiver-delegate-up.md b/docs/standards/smart-contracts/lsp1-universal-receiver-delegate-up.md
diff --git a/docs/standards/smart-contracts/lsp1-universal-receiver-delegate-vault.md b/docs/standards/smart-contracts/lsp1-universal-receiver-delegate-vault.md
diff --git a/docs/standards/smart-contracts/lsp9-vault.md b/docs/standards/smart-contracts/lsp9-vault.md
@@ -323,7 +323,7 @@ function universalReceiver(
 ```
 
 Forwards the call to the **UniversalReceiverDelegate** contract if its address is stored at the [LSP1UniversalReceiverDelegate](../generic-standards/lsp1-universal-receiver.md#extension) data Key.
-The contract being called is expected to be an **[LSP1UniversalReceiverDelegateVault](./lsp1-universal-receiver-delegate-vault.md)**, supporting [LSP1UniversalReceiverDelegate InterfaceId](../../contracts/interface-ids.md) using ERC165.
+The contract being called is expected to be an **[LSP1UniversalReceiverDelegateVault](../../contracts/contracts/LSP1UniversalReceiver/LSP1UniversalReceiverDelegateVault/LSP1UniversalReceiverDelegateVault.md)**, supporting [LSP1UniversalReceiverDelegate InterfaceId](../../contracts/interface-ids.md) using ERC165.
 
 _Triggers the **[UniversalReceiver](#universalreceiver-1)** event when this function gets successfully executed._