From 93baecb68a878a296108991f35f5feb31ff98858 Mon Sep 17 00:00:00 2001 From: b00ste Date: Tue, 17 Oct 2023 14:30:43 +0300 Subject: [PATCH] Add details in LSP1 page of Contracts section --- docs/contracts/overview/LSP1Delegate.md | 9 +++++++ .../lsp1-universal-receiver-delegate.md | 26 +++++++++++++++++++ 2 files changed, 35 insertions(+) diff --git a/docs/contracts/overview/LSP1Delegate.md b/docs/contracts/overview/LSP1Delegate.md index 9d9d4abb75..81a20300ce 100644 --- a/docs/contracts/overview/LSP1Delegate.md +++ b/docs/contracts/overview/LSP1Delegate.md @@ -10,3 +10,12 @@ There are two default implementations of the LSP1 Delegate contracts available, | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | | **[`LSP1UniversalReceiverDelegateUP.sol`](../contracts/LSP1UniversalReceiver/LSP1UniversalReceiverDelegateUP/LSP1UniversalReceiverDelegateUP.md)** | Add feature to a `LSP0ERC725Account` to registered and un-register tokens (LSP7 and LSP8) and vaults (LSP9) received. | | **[`LSP1UniversalReceiverDelegateVault.sol`](../contracts/LSP1UniversalReceiver/LSP1UniversalReceiverDelegateVault/LSP1UniversalReceiverDelegateVault.md)** | Add feature to a `LSP9Vault` to register and un-register tokens (LSP7 and LSP8). | + + +## Routing + +The Universal Profile implementation allows for attaching multiple instances of Universal Receiver Delegate to it. This is due to LSP1 Routing. You could have a single General Purpose Unviersal Receiver Delegate and multiple instances of Specific Unviersal Receiver Delegate. + +A General Purpose Universal Receiver Delegate has its address stored under the [LSP1UniversalReceiverDelegate Singleton](../../standards//generic-standards/lsp1-universal-receiver-delegate.md#lsp1universalreceiverdelegate-singleton) data key. This contract will be called on any LSP1 hook, meaning that it can potentially react on any [TypeID](../type-ids.md#universal-receiver-type-ids). + +A Specific Universal Receiver Delegate has its address stored under the [LSP1UniversalReceiverDelegate Mapping](../../standards//generic-standards/lsp1-universal-receiver-delegate.md#lsp1universalreceiverdelegate-mapping) data key. This contract will be called on specific LSP1 hook, depending on the [TypeID](../type-ids.md#universal-receiver-type-ids) that was passed as a parameter in the hook, meaning that it only reacts on a single specific [TypeID](../type-ids.md#universal-receiver-type-ids). diff --git a/docs/standards/generic-standards/lsp1-universal-receiver-delegate.md b/docs/standards/generic-standards/lsp1-universal-receiver-delegate.md index bfd30bc8a4..2180e70c57 100644 --- a/docs/standards/generic-standards/lsp1-universal-receiver-delegate.md +++ b/docs/standards/generic-standards/lsp1-universal-receiver-delegate.md @@ -92,6 +92,32 @@ One of the possible scenarios is a token transfer between Alice and Bob. Alice w > For the UniversalReceiverDelegate to be able to call setData function on the UniversalProfile, it should be allowed by the logic of the owner through LSP20. +## Data Keys + +### LSP1UniversalReceiverDelegate Singleton + +```json +{ + "name": "LSP1UniversalReceiverDelegate", + "key": "0x0cfc51aec37c55a4d0b1a65c6255c4bf2fbdf6277f3cc0730c45b828b6db8b47", + "keyType": "Singleton", + "valueType": "address", + "valueContent": "Address" +} +``` + +### LSP1UniversalReceiverDelegate Mapping + +```json +{ + "name": "LSP1UniversalReceiverDelegate:", + "key": "0x0cfc51aec37c55a4d0b10000", + "keyType": "Mapping", + "valueType": "address", + "valueContent": "Address" +} +``` + ## References - [LUKSO Standards Proposals: LSP1 - Universal Receiver (Standard Specification, GitHub)](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-1-UniversalReceiver.md)