Merge branch 'main' into DEV-8626

lukso-network · Oct 18, 2023 · 6c9c1ef · 6c9c1ef
2 parents 576d221 + 568537e
commit 6c9c1ef
Show file tree

Hide file tree

Showing 3 changed files with 164 additions and 0 deletions.
diff --git a/docs/contracts/overview/KeyManager.md b/docs/contracts/overview/KeyManager.md
@@ -21,6 +21,36 @@ To illustrate, in the case of Universal Profile and the browser extension, you c
 
 Afterwards, you can grant partial access to dApp and protocol (more specifically the smart contract addresses behind them), so that they can use your Universal Profile to interact on your behalf. This catalyze interactions on the blockchain, where your Universal Profile can do more and operate automatically in controlled manner, without requiring the main profile owner to have to do everything.
 
+### Allowed ERC725Y Data Keys
+
+:::note
+
+If controller has `SETDATA` permission but has no `AllowedERC725YDataKeys`, controller will not be able to use the `SETDATA` permission at all. 
+
+:::
+
+Key Manager allows for restricting controller addresses to change only specific or dynamic data keys. In order to achieve such functionallity one could encode a set of data keys to [`bytes[CompactBytesArray]`](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-2-ERC725YJSONSchema.md#bytescompactbytesarray), and store them under the [Allowed ERC725Y Data Keys](../../standards/universal-profile/lsp6-key-manager.md#allowed-erc725y-data-keys) data key.
+
+#### Specific Data Keys
+
+A _Specific Data Key_ must have the length of 32 bytes. Setting a _Specific Data Key_ in the [Allowed ERC725Y Data Keys](../../standards/universal-profile/lsp6-key-manager.md#allowed-erc725y-data-keys) will allow the controller to only modify the data value of that _Specific Data Key_.
+
+#### Dynamic Data Keys
+
+A _Dynamic Data Key_ can have any length between 0 and 32 (except 0 and 32). Setting a _Dynamic Data Key_ in the [Allowed ERC725Y Data Keys](../../standards/universal-profile/lsp6-key-manager.md#allowed-erc725y-data-keys) will allow the controller to modify the data value of any data key that starts exactly with that  _Dynamic Data Key_.
+
+Example:
+
+Dynamic Data Key - `0xcafe0000cafe0000beef0000beef`
+
+|                              Data key                               | Can modify data value? |
+| :------------------------------------------------------------------ | :--------------------- |
+| `0xcafe0000cafe0000beef0000beef000000000000000000000000000000000000`|           ✅           |
+| `0xcafe0000cafe0000beef0000beef000000000000000000000000000000000123`|           ✅           |
+| `0xcafe0000cafe0000beef0000beefcafecafecafecafecafecafecafecafecafe`|           ✅           |
+| `0x0000000000000000000000000000cafecafecafecafecafecafecafecafecafe`|           ❌           |
+| `0x000000000000000000000000000000000000cafe0000cafe0000beef0000beef`|           ❌           |
+
 ## Further Reading
 
 - [The Bytecode episode #4 (Youtube) - overview of the Solidity code of the `LSP6KeyManagerCore.sol` by Jean Cavallera](https://www.youtube.com/watch?v=2Sm9LsCPjdE)
diff --git a/docs/contracts/type-ids.md b/docs/contracts/type-ids.md
@@ -0,0 +1,133 @@
+---
+title: Universal Receiver Type IDs
+---
+
+# Universal Receiver Type IDs
+
+## LSP0 - ERC725 Account
+
+### `LSP0OwnershipTransferStarted`
+
+|   |   |
+|---|---|
+| **Name**  | `"LSP0OwnershipTransferStarted"`  |
+| **Hash**  | `0xe17117c9d2665d1dbeb479ed8058bbebde3c50ac50e2e65619f60006caac6926`  |
+| **Used in:**  | [`transferOwnership(address)`](./contracts/LSP0ERC725Account/LSP0ERC725Account.md#transferownership)  |
+| **Solidity constant:**  | `LSP0OwnershipTransferStarted`  |
+
+
+### `LSP0OwnershipTransferred_SenderNotification`
+
+|   |   |
+|---|---|
+| **Name**  | `"LSP0OwnershipTransferred_SenderNotification"`  |
+| **Hash**  | `0xa4e59c931d14f7c8a7a35027f92ee40b5f2886b9fdcdb78f30bc5ecce5a2f814`  |
+| **Used in:**  | [`acceptOwnership()`](./contracts/LSP0ERC725Account/LSP0ERC725Account.md#acceptownership) <br/> [`renounceOwnership()`](./contracts/LSP0ERC725Account/LSP0ERC725Account.md#renounceownership) |
+| **Solidity constant:**  | `LSP0OwnershipTransferred_SenderNotification`  |
+
+### `LSP0OwnershipTransferred_RecipientNotification`
+
+|   |   |
+|---|---|
+| **Name**  | `"LSP0OwnershipTransferred_RecipientNotification"`  |
+| **Hash**  | `0xceca317f109c43507871523e82dc2a3cc64dfa18f12da0b6db14f6e23f995538`  |
+| **Used in:**  | [`acceptOwnership()`](./contracts/LSP0ERC725Account/LSP0ERC725Account.md#acceptownership) |
+| **Solidity constant:**  | `LSP0OwnershipTransferred_RecipientNotification`  |
+
+## LSP7 - Digital Asset
+
+### `LSP7Tokens_SenderNotification`
+
+|   |   |
+|---|---|
+| **Name**  | `"LSP7Tokens_SenderNotification"`  |
+| **Hash**  | `0x429ac7a06903dbc9c13dfcb3c9d11df8194581fa047c96d7a4171fc7402958ea`  |
+| **Used in:**  | [`_burn(address,uint256,bytes)`](./contracts/LSP7DigitalAsset/LSP7DigitalAsset.md#_burn), <br/> [`_transfer(address,address,uint256,bool,bytes)`](./contracts/LSP7DigitalAsset/LSP7DigitalAsset.md#_transfer) |
+| **Solidity constant:**  | `LSP7Tokens_SenderNotification`  |
+
+### `LSP7Tokens_RecipientNotification`
+
+|   |   |
+|---|---|
+| **Name**  | `"LSP7Tokens_RecipientNotification"`  |
+| **Hash**  | `0x20804611b3e2ea21c480dc465142210acf4a2485947541770ec1fb87dee4a55c`  |
+| **Used in:**  | [`_mint(address,uint256,bool,bytes)`](./contracts/LSP7DigitalAsset/LSP7DigitalAsset.md#_mint), <br/> [`_transfer(address,address,uint256,bool,bytes)`](./contracts/LSP7DigitalAsset/LSP7DigitalAsset.md#_transfer) |
+| **Solidity constant:**  | `LSP7Tokens_RecipientNotification`  |
+
+## LSP8 - Identifiable Digital Asset
+
+### `LSP8Tokens_SenderNotification`
+
+|   |   |
+|---|---|
+| **Name**  | `"LSP8Tokens_SenderNotification"`  |
+| **Hash**  | `0xb23eae7e6d1564b295b4c3e3be402d9a2f0776c57bdf365903496f6fa481ab00`  |
+| **Used in:**  | [`_burn(bytes32,bytes)`](./contracts/LSP8IdentifiableDigitalAsset/LSP8IdentifiableDigitalAsset.md#_burn), <br/> [`_transfer(address,address,bytes32,bool,bytes)`](./contracts/LSP8IdentifiableDigitalAsset/LSP8IdentifiableDigitalAsset.md#_transfer) |
+| **Solidity constant:**  | `LSP8Tokens_SenderNotification`  |
+
+### `LSP8Tokens_RecipientNotification`
+
+|   |   |
+|---|---|
+| **Name**  | `"LSP8Tokens_RecipientNotification"`  |
+| **Hash**  | `0x0b084a55ebf70fd3c06fd755269dac2212c4d3f0f4d09079780bfa50c1b2984d`  |
+| **Used in:**  | [`_mint(address,bytes32,bool,bytes)`](./contracts/LSP8IdentifiableDigitalAsset/LSP8IdentifiableDigitalAsset.md#_mint), <br/> [`_transfer(address,address,bytes32,bool,bytes)`](./contracts/LSP8IdentifiableDigitalAsset/LSP8IdentifiableDigitalAsset.md#_transfer) |
+| **Solidity constant:**  | `LSP8Tokens_RecipientNotification`  |
+
+## LSP9 - Vault
+
+### `LSP9OwnershipTransferStarted`
+
+|   |   |
+|---|---|
+| **Name**  | `"LSP9OwnershipTransferStarted"`  |
+| **Hash**  | `0xaefd43f45fed1bcd8992f23c803b6f4ec45cf6b62b0d404d565f290a471e763f`  |
+| **Used in:**  | [`transferOwnership(address)`](./contracts/LSP9Vault/LSP9Vault.md#transferownership)  |
+| **Solidity constant:**  | `LSP9OwnershipTransferStarted`  |
+
+### `LSP9OwnershipTransferred_SenderNotification`
+
+|   |   |
+|---|---|
+| **Name**  | `"LSP9OwnershipTransferred_SenderNotification"`  |
+| **Hash**  | `0x0c622e58e6b7089ae35f1af1c86d997be92fcdd8c9509652022d41aa65169471`  |
+| **Used in:**  | [`acceptOwnership()`](./contracts/LSP9Vault/LSP9Vault.md#acceptownership) <br/> [`renounceOwnership()`](./contracts/LSP9Vault/LSP9Vault.md#renounceownership) |
+| **Solidity constant:**  | `LSP9OwnershipTransferred_SenderNotification`  |
+
+### `LSP9OwnershipTransferred_RecipientNotification`
+
+|   |   |
+|---|---|
+| **Name**  | `"LSP9OwnershipTransferred_RecipientNotification"`  |
+| **Hash**  | `0x79855c97dbc259ce395421d933d7bc0699b0f1561f988f09a9e8633fd542fe5c`  |
+| **Used in:**  | [`acceptOwnership()`](./contracts/LSP9Vault/LSP9Vault.md#acceptownership) |
+| **Solidity constant:**  | `LSP9OwnershipTransferred_RecipientNotification`  |
+
+## LSP14 - Ownable 2-Step
+
+### `LSP14OwnershipTransferStarted`
+
+|   |   |
+|---|---|
+| **Name**  | `"LSP14OwnershipTransferStarted"`  |
+| **Hash**  | `0xee9a7c0924f740a2ca33d59b7f0c2929821ea9837ce043ce91c1823e9c4e52c0`  |
+| **Used in:**  | [`transferOwnership(address)`](./contracts/LSP14Ownable2Step/LSP14Ownable2Step.md#transferownership)  |
+| **Solidity constant:**  | `LSP14OwnershipTransferStarted`  |
+
+#### `LSP14OwnershipTransferred_SenderNotification`
+
+|   |   |
+|---|---|
+| **Name**  | `"LSP14OwnershipTransferred_SenderNotification"`  |
+| **Hash**  | `0xa124442e1cc7b52d8e2ede2787d43527dc1f3ae0de87f50dd03e27a71834f74c`  |
+| **Used in:**  | [`acceptOwnership()`](./contracts/LSP14Ownable2Step/LSP14Ownable2Step.md#acceptownership) <br/> [`renounceOwnership()`](./contracts/LSP14Ownable2Step/LSP14Ownable2Step.md#renounceownership) |
+| **Solidity constant:**  | `LSP14OwnershipTransferred_SenderNotification`  |
+
+#### `LSP14OwnershipTransferred_RecipientNotification`
+
+|   |   |
+|---|---|
+| **Name**  | `"LSP14OwnershipTransferred_RecipientNotification"`  |
+| **Hash**  | `0xe32c7debcb817925ba4883fdbfc52797187f28f73f860641dab1a68d9b32902c`  |
+| **Used in:**  | [`acceptOwnership()`](./contracts/LSP14Ownable2Step/LSP14Ownable2Step.md#acceptownership) |
+| **Solidity constant:**  | `LSP14OwnershipTransferred_RecipientNotification`  |
diff --git a/sidebars.js b/sidebars.js
@@ -60,6 +60,7 @@ module.exports = {
     // divider for the Libraries Technical references
     { type: 'html', value: '<hr/>', defaultStyle: false },
     'contracts/interface-ids',
+    'contracts/type-ids',
     {
       type: 'link',
       label: 'Audits',