diff --git a/docs/contracts/contracts/LSP0ERC725Account/LSP0ERC725Account.md b/docs/contracts/contracts/LSP0ERC725Account/LSP0ERC725Account.md index 2bfaa0d8a6..0611361b7a 100644 --- a/docs/contracts/contracts/LSP0ERC725Account/LSP0ERC725Account.md +++ b/docs/contracts/contracts/LSP0ERC725Account/LSP0ERC725Account.md @@ -1196,7 +1196,7 @@ This function does not forward to the extension contract the `msg.value` receive If you would like to forward the `msg.value` to the extension contract, you can override the code of this internal function as follow: ```solidity -(bool success, bytes memory result) = extension.call{value: msg.value}( +(bool success, bytes memory result) = extension.call\{value: msg.value\}( abi.encodePacked(callData, msg.sender, msg.value) ); ``` @@ -1464,11 +1464,11 @@ Emitted when the [`universalReceiver`](#universalreceiver) function was called w | Name | Type | Description | | ---------------------- | :-------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `from` **`indexed`** | `address` | The address of the EOA or smart contract that called the {universalReceiver(...)} function. | -| `value` **`indexed`** | `uint256` | The amount sent to the {universalReceiver(...)} function. | +| `from` **`indexed`** | `address` | The address of the EOA or smart contract that called the \{universalReceiver(...)\\} function. | +| `value` **`indexed`** | `uint256` | The amount sent to the \{universalReceiver(...)\\} function. | | `typeId` **`indexed`** | `bytes32` | A `bytes32` unique identifier (= _"hook"_)that describe the type of notification, information or transaction received by the contract. Can be related to a specific standard or a hook. | -| `receivedData` | `bytes` | Any arbitrary data that was sent to the {universalReceiver(...)} function. | -| `returnedValue` | `bytes` | The value returned by the {universalReceiver(...)} function. | +| `receivedData` | `bytes` | Any arbitrary data that was sent to the \{universalReceiver(...)\\} function. | +| `returnedValue` | `bytes` | The value returned by the \{universalReceiver(...)\\} function. |
diff --git a/docs/contracts/contracts/LSP17Extensions/Extension4337.md b/docs/contracts/contracts/LSP17Extensions/Extension4337.md index a0b0fe12db..ea47d2fd33 100644 --- a/docs/contracts/contracts/LSP17Extensions/Extension4337.md +++ b/docs/contracts/contracts/LSP17Extensions/Extension4337.md @@ -131,7 +131,7 @@ Must validate caller is the entryPoint. Must validate the signature and nonce | Name | Type | Description | | ---- | :-------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `0` | `uint256` | packaged ValidationData structure. use `_packValidationData` and `_unpackValidationData` to encode and decode <20-byte> sigAuthorizer - 0 for valid signature, 1 to mark signature failure, otherwise, an address of an "authorizer" contract. <6-byte> validUntil - last timestamp this operation is valid. 0 for "indefinite" <6-byte> validAfter - first timestamp this operation is valid If an account doesn't use time-range, it is enough to return SIG_VALIDATION_FAILED value (1) for signature failure. Note that the validation code cannot use block.timestamp (or block.number) directly. | +| `0` | `uint256` | packaged ValidationData structure. use `_packValidationData` and `_unpackValidationData` to encode and decode \<20-byte\> sigAuthorizer - 0 for valid signature, 1 to mark signature failure, otherwise, an address of an "authorizer" contract. \<6-byte\> validUntil - last timestamp this operation is valid. 0 for "indefinite" \<6-byte\> validAfter - first timestamp this operation is valid If an account doesn't use time-range, it is enough to return SIG_VALIDATION_FAILED value (1) for signature failure. Note that the validation code cannot use block.timestamp (or block.number) directly. |
diff --git a/docs/contracts/contracts/LSP25ExecuteRelayCall/LSP25MultiChannelNonce.md b/docs/contracts/contracts/LSP25ExecuteRelayCall/LSP25MultiChannelNonce.md index 75299527ec..f1b09d012c 100644 --- a/docs/contracts/contracts/LSP25ExecuteRelayCall/LSP25MultiChannelNonce.md +++ b/docs/contracts/contracts/LSP25ExecuteRelayCall/LSP25MultiChannelNonce.md @@ -90,7 +90,7 @@ The address of the signer will be recovered using the LSP25 signature format. | -------------------- | :-------: | ----------------------------------------------------------------------------------------------------------------------- | | `signature` | `bytes` | A 65 bytes long signature generated according to the signature format specified in the LSP25 standard. | | `nonce` | `uint256` | The nonce that the signer used to generate the `signature`. | -| `validityTimestamps` | `uint256` | The validity timestamp that the signer used to generate the signature (See {\_verifyValidityTimestamps} to learn more). | +| `validityTimestamps` | `uint256` | The validity timestamp that the signer used to generate the signature (See \{\_verifyValidityTimestamps\} to learn more). | | `msgValue` | `uint256` | The amount of native tokens intended to be sent for the relay transaction. | | `callData` | `bytes` | The calldata to execute as a relay transaction that the signer signed for. | diff --git a/docs/contracts/contracts/LSP6KeyManager/LSP6KeyManager.md b/docs/contracts/contracts/LSP6KeyManager/LSP6KeyManager.md index 953be91156..6a5d712883 100644 --- a/docs/contracts/contracts/LSP6KeyManager/LSP6KeyManager.md +++ b/docs/contracts/contracts/LSP6KeyManager/LSP6KeyManager.md @@ -79,13 +79,13 @@ Execute A `payload` on the linked [`target`](#target) contract after having veri | Name | Type | Description | | --------- | :-----: | ---------------------------------------------------------------- | -| `payload` | `bytes` | The abi-encoded function call to execute on the linked {target}. | +| `payload` | `bytes` | The abi-encoded function call to execute on the linked \{target}. | #### Returns | Name | Type | Description | | ---- | :-----: | ---------------------------------------------------------------------------- | -| `0` | `bytes` | The abi-decoded data returned by the function called on the linked {target}. | +| `0` | `bytes` | The abi-decoded data returned by the function called on the linked \{target}. |
@@ -128,13 +128,13 @@ Same as [`execute`](#execute) but execute a batch of payloads (abi-encoded funct | Name | Type | Description | | ---------- | :---------: | -------------------------------------------------------------------------------------- | | `values` | `uint256[]` | An array of amount of native tokens to be transferred for each `payload`. | -| `payloads` | `bytes[]` | An array of abi-encoded function calls to execute successively on the linked {target}. | +| `payloads` | `bytes[]` | An array of abi-encoded function calls to execute successively on the linked \{target}. | #### Returns | Name | Type | Description | | ---- | :-------: | ------------------------------------------------------------------------------------- | -| `0` | `bytes[]` | An array of abi-decoded data returned by the functions called on the linked {target}. | +| `0` | `bytes[]` | An array of abi-decoded data returned by the functions called on the linked \{target}. |
@@ -181,7 +181,7 @@ Allows any address (executor) to execute a payload (= abi-encoded function call) | Name | Type | Description | | -------------------- | :-------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `signature` | `bytes` | A 65 bytes long signature for a meta transaction according to LSP25. | -| `nonce` | `uint256` | The nonce of the address that signed the calldata (in a specific `_channel`), obtained via {getNonce}. Used to prevent replay attack. | +| `nonce` | `uint256` | The nonce of the address that signed the calldata (in a specific `_channel`), obtained via \{getNonce}. Used to prevent replay attack. | | `validityTimestamps` | `uint256` | Two `uint128` timestamps concatenated together that describes when the relay transaction is valid "from" (left `uint128`) and "until" as a deadline (right `uint128`). | | `payload` | `bytes` | The abi-encoded function call to execute. | @@ -232,7 +232,7 @@ Same as [`executeRelayCall`](#executerelaycall) but execute a batch of signed ca | Name | Type | Description | | -------------------- | :---------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | `signatures` | `bytes[]` | An array of 65 bytes long signatures for meta transactions according to LSP25. | -| `nonces` | `uint256[]` | An array of nonces of the addresses that signed the calldata payloads (in specific channels). Obtained via {getNonce}. Used to prevent replay attack. | +| `nonces` | `uint256[]` | An array of nonces of the addresses that signed the calldata payloads (in specific channels). Obtained via \{getNonce}. Used to prevent replay attack. | | `validityTimestamps` | `uint256[]` | An array of two `uint128` concatenated timestamps that describe when the relay transaction is valid "from" (left `uint128`) and "until" (right `uint128`). | | `values` | `uint256[]` | An array of amount of native tokens to be transferred for each calldata `payload`. | | `payloads` | `bytes[]` | An array of abi-encoded function calls to be executed successively. | @@ -339,7 +339,7 @@ Checks if a signature was signed by a controller that has the permission `SIGN`. :::tip Hint -This function can call by any other address than the {`target`}. This allows to verify permissions in a _"read-only"_ manner. Anyone can call this function to verify if the `caller` has the right permissions to perform the abi-encoded function call `data` on the {`target`} contract (while sending `msgValue` alongside the call). If the permissions have been verified successfully and `caller` is authorized, one of the following two LSP20 success value will be returned: +This function can call by any other address than the \{`target`}. This allows to verify permissions in a _"read-only"_ manner. Anyone can call this function to verify if the `caller` has the right permissions to perform the abi-encoded function call `data` on the \{`target`\} contract (while sending `msgValue` alongside the call). If the permissions have been verified successfully and `caller` is authorized, one of the following two LSP20 success value will be returned: - `0x1a238000`: LSP20 success value **without** post verification (last byte is `0x00`). - `0x1a238001`: LSP20 success value **with** post-verification (last byte is `0x01`). @@ -1060,7 +1060,7 @@ The address of the signer will be recovered using the LSP25 signature format. | -------------------- | :-------: | ----------------------------------------------------------------------------------------------------------------------- | | `signature` | `bytes` | A 65 bytes long signature generated according to the signature format specified in the LSP25 standard. | | `nonce` | `uint256` | The nonce that the signer used to generate the `signature`. | -| `validityTimestamps` | `uint256` | The validity timestamp that the signer used to generate the signature (See {\_verifyValidityTimestamps} to learn more). | +| `validityTimestamps` | `uint256` | The validity timestamp that the signer used to generate the signature (See \{\_verifyValidityTimestamps\} to learn more). | | `msgValue` | `uint256` | The amount of native tokens intended to be sent for the relay transaction. | | `callData` | `bytes` | The calldata to execute as a relay transaction that the signer signed for. | @@ -1133,7 +1133,7 @@ function _execute( Be aware that this function can also throw an error if the `callData` was signed incorrectly (not conforming to the signature format defined in the LSP25 standard). This is because the contract cannot distinguish if the data is signed correctly or not. Instead, it will recover an incorrect signer address from the signature -and throw an {InvalidRelayNonce} error with the incorrect signer address as the first parameter. +and throw an \{InvalidRelayNonce\} error with the incorrect signer address as the first parameter. ::: @@ -1180,13 +1180,13 @@ _Execute the `payload` passed to `execute(...)` or `executeRelayCall(...)`_ | ---------------- | :-------: | ------------------------------------------------------------------ | | `targetContract` | `address` | - | | `msgValue` | `uint256` | - | -| `payload` | `bytes` | The abi-encoded function call to execute on the {target} contract. | +| `payload` | `bytes` | The abi-encoded function call to execute on the \{target\} contract. | #### Returns | Name | Type | Description | | ---- | :-----: | ------------------------------------------------------------------------- | -| `0` | `bytes` | bytes The data returned by the call made to the linked {target} contract. | +| `0` | `bytes` | bytes The data returned by the call made to the linked \{target\} contract. |
@@ -1208,9 +1208,9 @@ Verify if the `from` address is allowed to execute the `payload` on the [`target | Name | Type | Description | | ---------------- | :-------: | ------------------------------------------------------------------- | | `targetContract` | `address` | The contract that is owned by the Key Manager | -| `from` | `address` | Either the caller of {execute} or the signer of {executeRelayCall}. | +| `from` | `address` | Either the caller of \{execute\} or the signer of \{executeRelayCall}. | | `isRelayedCall` | `bool` | - | -| `payload` | `bytes` | The abi-encoded function call to execute on the {target} contract. | +| `payload` | `bytes` | The abi-encoded function call to execute on the \{target\} contract. |
@@ -1266,9 +1266,9 @@ Emitted when the LSP6KeyManager contract verified the permissions of the `signer | Name | Type | Description | | ------------------------ | :-------: | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| `signer` **`indexed`** | `address` | The address of the controller that executed the calldata payload (either directly via {execute} or via meta transaction using {executeRelayCall}). | +| `signer` **`indexed`** | `address` | The address of the controller that executed the calldata payload (either directly via \{execute\} or via meta transaction using \{executeRelayCall}). | | `value` **`indexed`** | `uint256` | The amount of native token to be transferred in the calldata payload. | -| `selector` **`indexed`** | `bytes4` | The bytes4 function of the function that was executed on the linked {target} | +| `selector` **`indexed`** | `bytes4` | The bytes4 function of the function that was executed on the linked \{target\} |
@@ -1478,7 +1478,7 @@ Reverts when trying to call a function on the linked [`target`](#target), that i | Name | Type | Description | | ----------------- | :------: | ---------------------------------------------------------------------------------------------------------------- | -| `invalidFunction` | `bytes4` | The `bytes4` selector of the function that was attempted to be called on the linked {target} but not recognised. | +| `invalidFunction` | `bytes4` | The `bytes4` selector of the function that was attempted to be called on the linked \{target\} but not recognised. |
@@ -1827,7 +1827,7 @@ Reverts when `from` is not authorised to call the `execute(uint256,address,uint2 | Name | Type | Description | | ---------- | :-------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `from` | `address` | The controller that tried to call the `execute(uint256,address,uint256,bytes)` function. | -| `to` | `address` | The address of an EOA or contract that `from` tried to call using the linked {target} | +| `to` | `address` | The address of an EOA or contract that `from` tried to call using the linked \{target\} | | `selector` | `bytes4` | If `to` is a contract, the bytes4 selector of the function that `from` is trying to call. If no function is called (_e.g: a native token transfer_), selector = `0x00000000` |
@@ -1855,8 +1855,8 @@ Reverts when address `from` is not authorised to set the key `disallowedKey` on | Name | Type | Description | | --------------- | :-------: | ------------------------------------------------------------------------------------------------------ | -| `from` | `address` | address The controller that tried to `setData` on the linked {target}. | -| `disallowedKey` | `bytes32` | A bytes32 data key that `from` is not authorised to set on the ERC725Y storage of the linked {target}. | +| `from` | `address` | address The controller that tried to `setData` on the linked \{target}. | +| `disallowedKey` | `bytes32` | A bytes32 data key that `from` is not authorised to set on the ERC725Y storage of the linked \{target}. |
diff --git a/docs/contracts/contracts/LSP7DigitalAsset/LSP7DigitalAsset.md b/docs/contracts/contracts/LSP7DigitalAsset/LSP7DigitalAsset.md index abfd06ff58..9589281aab 100644 --- a/docs/contracts/contracts/LSP7DigitalAsset/LSP7DigitalAsset.md +++ b/docs/contracts/contracts/LSP7DigitalAsset/LSP7DigitalAsset.md @@ -90,7 +90,7 @@ Reverts whenever someone tries to send native tokens to a LSP7 contract. :::danger -To avoid front-running and Allowance Double-Spend Exploit when increasing or decreasing the authorized amount of an operator, it is advised to: 1. either call {revokeOperator} first, and then re-call {authorizeOperator} with the new amount. 2. or use the non-standard functions {increaseAllowance} or {decreaseAllowance}. For more information, see: https://docs.google.com/document/d/1YLPtQxZu1UAvO9cZ1O2RPXBbT0mooh4DYKjA_jp-RLM/ +To avoid front-running and Allowance Double-Spend Exploit when increasing or decreasing the authorized amount of an operator, it is advised to: 1. either call \{revokeOperator\} first, and then re-call \{authorizeOperator\} with the new amount. 2. or use the non-standard functions \{increaseAllowance\} or \{decreaseAllowance}. For more information, see: https://docs.google.com/document/d/1YLPtQxZu1UAvO9cZ1O2RPXBbT0mooh4DYKjA_jp-RLM/ ::: @@ -821,9 +821,9 @@ If the amount is zero then the operator is being revoked, otherwise the operator Any logic in the: -- {\_beforeTokenTransfer} function will run before updating the balances. +- \{\_beforeTokenTransfer\} function will run before updating the balances. -- {\_afterTokenTransfer} function will run after updating the balances, **but before notifying the recipient via LSP1**. +- \{\_afterTokenTransfer\} function will run after updating the balances, **but before notifying the recipient via LSP1**. ::: @@ -853,7 +853,7 @@ Mints `amount` of tokens and transfers it to `to`. | `to` | `address` | The address to mint tokens for. | | `amount` | `uint256` | The amount of tokens to mint. | | `force` | `bool` | A boolean that describe if transfer to a `to` address that does not support LSP1 is allowed or not. | -| `data` | `bytes` | Additional data the caller wants included in the emitted {Transfer} event, and sent in the LSP1 hook to the `to` address. | +| `data` | `bytes` | Additional data the caller wants included in the emitted \{Transfer\} event, and sent in the LSP1 hook to the `to` address. |
@@ -863,9 +863,9 @@ Mints `amount` of tokens and transfers it to `to`. Any logic in the: -- {\_beforeTokenTransfer} function will run before updating the balances. +- \{\_beforeTokenTransfer\} function will run before updating the balances. -- {\_afterTokenTransfer} function will run after updating the balances, **but before notifying the sender via LSP1**. +- \{\_afterTokenTransfer\} function will run after updating the balances, **but before notifying the sender via LSP1**. ::: @@ -930,9 +930,9 @@ Spend `amountToSpend` from the `operator`'s authorized on behalf of the `tokenOw Any logic in the: -- {\_beforeTokenTransfer} function will run before updating the balances. +- \{\_beforeTokenTransfer\} function will run before updating the balances. -- {\_afterTokenTransfer} function will run after updating the balances, **but before notifying the sender/recipient via LSP1**. +- \{\_afterTokenTransfer\} function will run after updating the balances, **but before notifying the sender/recipient via LSP1**. ::: @@ -1044,7 +1044,7 @@ If `to` is is an EOA or a contract that does not support the LSP1 interface, the | Name | Type | Description | | ---------- | :-------: | --------------------------------------------------------------------------------------------------- | -| `to` | `address` | The address to call the {universalReceiver} function on. | +| `to` | `address` | The address to call the \{universalReceiver\} function on. | | `force` | `bool` | A boolean that describe if transfer to a `to` address that does not support LSP1 is allowed or not. | | `lsp1Data` | `bytes` | The data to be sent to the `to` address in the `universalReceiver(...)` call. | diff --git a/docs/contracts/contracts/LSP7DigitalAsset/extensions/LSP7Burnable.md b/docs/contracts/contracts/LSP7DigitalAsset/extensions/LSP7Burnable.md index 28572334b1..9465e29d2e 100644 --- a/docs/contracts/contracts/LSP7DigitalAsset/extensions/LSP7Burnable.md +++ b/docs/contracts/contracts/LSP7DigitalAsset/extensions/LSP7Burnable.md @@ -88,7 +88,7 @@ Reverts whenever someone tries to send native tokens to a LSP7 contract. :::danger -To avoid front-running and Allowance Double-Spend Exploit when increasing or decreasing the authorized amount of an operator, it is advised to: 1. either call {revokeOperator} first, and then re-call {authorizeOperator} with the new amount. 2. or use the non-standard functions {increaseAllowance} or {decreaseAllowance}. For more information, see: https://docs.google.com/document/d/1YLPtQxZu1UAvO9cZ1O2RPXBbT0mooh4DYKjA_jp-RLM/ +To avoid front-running and Allowance Double-Spend Exploit when increasing or decreasing the authorized amount of an operator, it is advised to: 1. either call \{revokeOperator\} first, and then re-call \{authorizeOperator\} with the new amount. 2. or use the non-standard functions \{increaseAllowance\} or \{decreaseAllowance}. For more information, see: https://docs.google.com/document/d/1YLPtQxZu1UAvO9cZ1O2RPXBbT0mooh4DYKjA_jp-RLM/ ::: @@ -846,9 +846,9 @@ If the amount is zero then the operator is being revoked, otherwise the operator Any logic in the: -- {\_beforeTokenTransfer} function will run before updating the balances. +- \{\_beforeTokenTransfer\} function will run before updating the balances. -- {\_afterTokenTransfer} function will run after updating the balances, **but before notifying the recipient via LSP1**. +- \{\_afterTokenTransfer\} function will run after updating the balances, **but before notifying the recipient via LSP1**. ::: @@ -878,7 +878,7 @@ Mints `amount` of tokens and transfers it to `to`. | `to` | `address` | The address to mint tokens for. | | `amount` | `uint256` | The amount of tokens to mint. | | `force` | `bool` | A boolean that describe if transfer to a `to` address that does not support LSP1 is allowed or not. | -| `data` | `bytes` | Additional data the caller wants included in the emitted {Transfer} event, and sent in the LSP1 hook to the `to` address. | +| `data` | `bytes` | Additional data the caller wants included in the emitted \{Transfer\} event, and sent in the LSP1 hook to the `to` address. |
@@ -888,9 +888,9 @@ Mints `amount` of tokens and transfers it to `to`. Any logic in the: -- {\_beforeTokenTransfer} function will run before updating the balances. +- \{\_beforeTokenTransfer\} function will run before updating the balances. -- {\_afterTokenTransfer} function will run after updating the balances, **but before notifying the sender via LSP1**. +- \{\_afterTokenTransfer\} function will run after updating the balances, **but before notifying the sender via LSP1**. ::: @@ -955,9 +955,9 @@ Spend `amountToSpend` from the `operator`'s authorized on behalf of the `tokenOw Any logic in the: -- {\_beforeTokenTransfer} function will run before updating the balances. +- \{\_beforeTokenTransfer\} function will run before updating the balances. -- {\_afterTokenTransfer} function will run after updating the balances, **but before notifying the sender/recipient via LSP1**. +- \{\_afterTokenTransfer\} function will run after updating the balances, **but before notifying the sender/recipient via LSP1**. ::: @@ -1069,7 +1069,7 @@ If `to` is is an EOA or a contract that does not support the LSP1 interface, the | Name | Type | Description | | ---------- | :-------: | --------------------------------------------------------------------------------------------------- | -| `to` | `address` | The address to call the {universalReceiver} function on. | +| `to` | `address` | The address to call the \{universalReceiver\} function on. | | `force` | `bool` | A boolean that describe if transfer to a `to` address that does not support LSP1 is allowed or not. | | `lsp1Data` | `bytes` | The data to be sent to the `to` address in the `universalReceiver(...)` call. | diff --git a/docs/contracts/contracts/LSP7DigitalAsset/extensions/LSP7CappedSupply.md b/docs/contracts/contracts/LSP7DigitalAsset/extensions/LSP7CappedSupply.md index 38ca3799e9..431a6fc1a4 100644 --- a/docs/contracts/contracts/LSP7DigitalAsset/extensions/LSP7CappedSupply.md +++ b/docs/contracts/contracts/LSP7DigitalAsset/extensions/LSP7CappedSupply.md @@ -88,7 +88,7 @@ Reverts whenever someone tries to send native tokens to a LSP7 contract. :::danger -To avoid front-running and Allowance Double-Spend Exploit when increasing or decreasing the authorized amount of an operator, it is advised to: 1. either call {revokeOperator} first, and then re-call {authorizeOperator} with the new amount. 2. or use the non-standard functions {increaseAllowance} or {decreaseAllowance}. For more information, see: https://docs.google.com/document/d/1YLPtQxZu1UAvO9cZ1O2RPXBbT0mooh4DYKjA_jp-RLM/ +To avoid front-running and Allowance Double-Spend Exploit when increasing or decreasing the authorized amount of an operator, it is advised to: 1. either call \{revokeOperator\} first, and then re-call \{authorizeOperator\} with the new amount. 2. or use the non-standard functions \{increaseAllowance\} or \{decreaseAllowance}. For more information, see: https://docs.google.com/document/d/1YLPtQxZu1UAvO9cZ1O2RPXBbT0mooh4DYKjA_jp-RLM/ ::: @@ -862,9 +862,9 @@ after `amount` of tokens have been minted. Any logic in the: -- {\_beforeTokenTransfer} function will run before updating the balances. +- \{\_beforeTokenTransfer\} function will run before updating the balances. -- {\_afterTokenTransfer} function will run after updating the balances, **but before notifying the sender via LSP1**. +- \{\_afterTokenTransfer\} function will run after updating the balances, **but before notifying the sender via LSP1**. ::: @@ -929,9 +929,9 @@ Spend `amountToSpend` from the `operator`'s authorized on behalf of the `tokenOw Any logic in the: -- {\_beforeTokenTransfer} function will run before updating the balances. +- \{\_beforeTokenTransfer\} function will run before updating the balances. -- {\_afterTokenTransfer} function will run after updating the balances, **but before notifying the sender/recipient via LSP1**. +- \{\_afterTokenTransfer\} function will run after updating the balances, **but before notifying the sender/recipient via LSP1**. ::: @@ -1043,7 +1043,7 @@ If `to` is is an EOA or a contract that does not support the LSP1 interface, the | Name | Type | Description | | ---------- | :-------: | --------------------------------------------------------------------------------------------------- | -| `to` | `address` | The address to call the {universalReceiver} function on. | +| `to` | `address` | The address to call the \{universalReceiver\} function on. | | `force` | `bool` | A boolean that describe if transfer to a `to` address that does not support LSP1 is allowed or not. | | `lsp1Data` | `bytes` | The data to be sent to the `to` address in the `universalReceiver(...)` call. | diff --git a/docs/contracts/contracts/LSP7DigitalAsset/extensions/LSP7CompatibleERC20.md b/docs/contracts/contracts/LSP7DigitalAsset/extensions/LSP7CompatibleERC20.md index 49e6a5ceb2..01a18d8c61 100644 --- a/docs/contracts/contracts/LSP7DigitalAsset/extensions/LSP7CompatibleERC20.md +++ b/docs/contracts/contracts/LSP7DigitalAsset/extensions/LSP7CompatibleERC20.md @@ -158,7 +158,7 @@ Approval function from th ERC20 standard interface. :::danger -To avoid front-running and Allowance Double-Spend Exploit when increasing or decreasing the authorized amount of an operator, it is advised to: 1. either call {revokeOperator} first, and then re-call {authorizeOperator} with the new amount. 2. or use the non-standard functions {increaseAllowance} or {decreaseAllowance}. For more information, see: https://docs.google.com/document/d/1YLPtQxZu1UAvO9cZ1O2RPXBbT0mooh4DYKjA_jp-RLM/ +To avoid front-running and Allowance Double-Spend Exploit when increasing or decreasing the authorized amount of an operator, it is advised to: 1. either call \{revokeOperator\} first, and then re-call \{authorizeOperator\} with the new amount. 2. or use the non-standard functions \{increaseAllowance\} or \{decreaseAllowance}. For more information, see: https://docs.google.com/document/d/1YLPtQxZu1UAvO9cZ1O2RPXBbT0mooh4DYKjA_jp-RLM/ ::: @@ -1132,7 +1132,7 @@ If `to` is is an EOA or a contract that does not support the LSP1 interface, the | Name | Type | Description | | ---------- | :-------: | --------------------------------------------------------------------------------------------------- | -| `to` | `address` | The address to call the {universalReceiver} function on. | +| `to` | `address` | The address to call the \{universalReceiver\} function on. | | `force` | `bool` | A boolean that describe if transfer to a `to` address that does not support LSP1 is allowed or not. | | `lsp1Data` | `bytes` | The data to be sent to the `to` address in the `universalReceiver(...)` call. | diff --git a/docs/contracts/contracts/LSP7DigitalAsset/presets/LSP7CompatibleERC20Mintable.md b/docs/contracts/contracts/LSP7DigitalAsset/presets/LSP7CompatibleERC20Mintable.md index 0abc22ff66..c0956843c3 100644 --- a/docs/contracts/contracts/LSP7DigitalAsset/presets/LSP7CompatibleERC20Mintable.md +++ b/docs/contracts/contracts/LSP7DigitalAsset/presets/LSP7CompatibleERC20Mintable.md @@ -14,7 +14,7 @@ ::: -> LSP7CompatibleERC20 deployable preset contract with a public {mint} function callable only by the contract {owner}. +> LSP7CompatibleERC20 deployable preset contract with a public \{mint\} function callable only by the contract \{owner}. ## Public Methods @@ -159,7 +159,7 @@ Approval function from th ERC20 standard interface. :::danger -To avoid front-running and Allowance Double-Spend Exploit when increasing or decreasing the authorized amount of an operator, it is advised to: 1. either call {revokeOperator} first, and then re-call {authorizeOperator} with the new amount. 2. or use the non-standard functions {increaseAllowance} or {decreaseAllowance}. For more information, see: https://docs.google.com/document/d/1YLPtQxZu1UAvO9cZ1O2RPXBbT0mooh4DYKjA_jp-RLM/ +To avoid front-running and Allowance Double-Spend Exploit when increasing or decreasing the authorized amount of an operator, it is advised to: 1. either call \{revokeOperator\} first, and then re-call \{authorizeOperator\} with the new amount. 2. or use the non-standard functions \{increaseAllowance\} or \{decreaseAllowance}. For more information, see: https://docs.google.com/document/d/1YLPtQxZu1UAvO9cZ1O2RPXBbT0mooh4DYKjA_jp-RLM/ ::: @@ -1166,7 +1166,7 @@ If `to` is is an EOA or a contract that does not support the LSP1 interface, the | Name | Type | Description | | ---------- | :-------: | --------------------------------------------------------------------------------------------------- | -| `to` | `address` | The address to call the {universalReceiver} function on. | +| `to` | `address` | The address to call the \{universalReceiver\} function on. | | `force` | `bool` | A boolean that describe if transfer to a `to` address that does not support LSP1 is allowed or not. | | `lsp1Data` | `bytes` | The data to be sent to the `to` address in the `universalReceiver(...)` call. | diff --git a/docs/contracts/contracts/LSP7DigitalAsset/presets/LSP7Mintable.md b/docs/contracts/contracts/LSP7DigitalAsset/presets/LSP7Mintable.md index 5bafb806fa..1d35abdbf7 100644 --- a/docs/contracts/contracts/LSP7DigitalAsset/presets/LSP7Mintable.md +++ b/docs/contracts/contracts/LSP7DigitalAsset/presets/LSP7Mintable.md @@ -14,7 +14,7 @@ ::: -> LSP7DigitalAsset deployable preset contract with a public {mint} function callable only by the contract {owner}. +> LSP7DigitalAsset deployable preset contract with a public \{mint\} function callable only by the contract \{owner}. ## Public Methods @@ -119,7 +119,7 @@ Reverts whenever someone tries to send native tokens to a LSP7 contract. :::danger -To avoid front-running and Allowance Double-Spend Exploit when increasing or decreasing the authorized amount of an operator, it is advised to: 1. either call {revokeOperator} first, and then re-call {authorizeOperator} with the new amount. 2. or use the non-standard functions {increaseAllowance} or {decreaseAllowance}. For more information, see: https://docs.google.com/document/d/1YLPtQxZu1UAvO9cZ1O2RPXBbT0mooh4DYKjA_jp-RLM/ +To avoid front-running and Allowance Double-Spend Exploit when increasing or decreasing the authorized amount of an operator, it is advised to: 1. either call \{revokeOperator\} first, and then re-call \{authorizeOperator\} with the new amount. 2. or use the non-standard functions \{increaseAllowance\} or \{decreaseAllowance}. For more information, see: https://docs.google.com/document/d/1YLPtQxZu1UAvO9cZ1O2RPXBbT0mooh4DYKjA_jp-RLM/ ::: @@ -883,9 +883,9 @@ If the amount is zero then the operator is being revoked, otherwise the operator Any logic in the: -- {\_beforeTokenTransfer} function will run before updating the balances. +- \{\_beforeTokenTransfer\} function will run before updating the balances. -- {\_afterTokenTransfer} function will run after updating the balances, **but before notifying the recipient via LSP1**. +- \{\_afterTokenTransfer\} function will run after updating the balances, **but before notifying the recipient via LSP1**. ::: @@ -915,7 +915,7 @@ Mints `amount` of tokens and transfers it to `to`. | `to` | `address` | The address to mint tokens for. | | `amount` | `uint256` | The amount of tokens to mint. | | `force` | `bool` | A boolean that describe if transfer to a `to` address that does not support LSP1 is allowed or not. | -| `data` | `bytes` | Additional data the caller wants included in the emitted {Transfer} event, and sent in the LSP1 hook to the `to` address. | +| `data` | `bytes` | Additional data the caller wants included in the emitted \{Transfer\} event, and sent in the LSP1 hook to the `to` address. |
@@ -925,9 +925,9 @@ Mints `amount` of tokens and transfers it to `to`. Any logic in the: -- {\_beforeTokenTransfer} function will run before updating the balances. +- \{\_beforeTokenTransfer\} function will run before updating the balances. -- {\_afterTokenTransfer} function will run after updating the balances, **but before notifying the sender via LSP1**. +- \{\_afterTokenTransfer\} function will run after updating the balances, **but before notifying the sender via LSP1**. ::: @@ -992,9 +992,9 @@ Spend `amountToSpend` from the `operator`'s authorized on behalf of the `tokenOw Any logic in the: -- {\_beforeTokenTransfer} function will run before updating the balances. +- \{\_beforeTokenTransfer\} function will run before updating the balances. -- {\_afterTokenTransfer} function will run after updating the balances, **but before notifying the sender/recipient via LSP1**. +- \{\_afterTokenTransfer\} function will run after updating the balances, **but before notifying the sender/recipient via LSP1**. ::: @@ -1106,7 +1106,7 @@ If `to` is is an EOA or a contract that does not support the LSP1 interface, the | Name | Type | Description | | ---------- | :-------: | --------------------------------------------------------------------------------------------------- | -| `to` | `address` | The address to call the {universalReceiver} function on. | +| `to` | `address` | The address to call the \{universalReceiver\} function on. | | `force` | `bool` | A boolean that describe if transfer to a `to` address that does not support LSP1 is allowed or not. | | `lsp1Data` | `bytes` | The data to be sent to the `to` address in the `universalReceiver(...)` call. | diff --git a/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/LSP8IdentifiableDigitalAsset.md b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/LSP8IdentifiableDigitalAsset.md index e6e5e629de..ebbb046928 100644 --- a/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/LSP8IdentifiableDigitalAsset.md +++ b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/LSP8IdentifiableDigitalAsset.md @@ -837,9 +837,9 @@ When `tokenId` does not exist then revert with an error. Any logic in the: -- {\_beforeTokenTransfer} function will run before updating the balances and ownership of `tokenId`s. +- \{\_beforeTokenTransfer\} function will run before updating the balances and ownership of `tokenId`s. -- {\_afterTokenTransfer} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the recipient via LSP1**. +- \{\_afterTokenTransfer\} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the recipient via LSP1**. ::: @@ -879,9 +879,9 @@ Create `tokenId` by minting it and transfers it to `to`. Any logic in the: -- {\_beforeTokenTransfer} function will run before updating the balances and ownership of `tokenId`s. +- \{\_beforeTokenTransfer\} function will run before updating the balances and ownership of `tokenId`s. -- {\_afterTokenTransfer} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the sender via LSP1**. +- \{\_afterTokenTransfer\} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the sender via LSP1**. ::: @@ -924,9 +924,9 @@ all the parameters in the calldata packed encoded. Any logic in the: -- {\_beforeTokenTransfer} function will run before updating the balances and ownership of `tokenId`s. +- \{\_beforeTokenTransfer\} function will run before updating the balances and ownership of `tokenId`s. -- {\_afterTokenTransfer} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the sender/recipient via LSP1**. +- \{\_afterTokenTransfer\} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the sender/recipient via LSP1**. ::: @@ -1198,7 +1198,7 @@ Emitted when `tokenOwner` disables `operator` to transfer or burn `tokenId` on i | Name | Type | Description | | -------------------------- | :-------: | --------------------------------------------------------------- | -| `operator` **`indexed`** | `address` | The address revoked from the operator array ({getOperatorsOf}). | +| `operator` **`indexed`** | `address` | The address revoked from the operator array (getOperatorsOf). | | `tokenOwner` **`indexed`** | `address` | The owner of the `tokenId`. | | `tokenId` **`indexed`** | `bytes32` | The tokenId `operator` is revoked from operating on. | | `notified` | `bool` | Bool indicating whether the operator has been notified or not | diff --git a/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8Burnable.md b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8Burnable.md index 9b444005be..e074c74513 100644 --- a/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8Burnable.md +++ b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8Burnable.md @@ -863,9 +863,9 @@ When `tokenId` does not exist then revert with an error. Any logic in the: -- {\_beforeTokenTransfer} function will run before updating the balances and ownership of `tokenId`s. +- \{\_beforeTokenTransfer\} function will run before updating the balances and ownership of `tokenId`s. -- {\_afterTokenTransfer} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the recipient via LSP1**. +- \{\_afterTokenTransfer\} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the recipient via LSP1**. ::: @@ -905,9 +905,9 @@ Create `tokenId` by minting it and transfers it to `to`. Any logic in the: -- {\_beforeTokenTransfer} function will run before updating the balances and ownership of `tokenId`s. +- \{\_beforeTokenTransfer\} function will run before updating the balances and ownership of `tokenId`s. -- {\_afterTokenTransfer} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the sender via LSP1**. +- \{\_afterTokenTransfer\} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the sender via LSP1**. ::: @@ -950,9 +950,9 @@ all the parameters in the calldata packed encoded. Any logic in the: -- {\_beforeTokenTransfer} function will run before updating the balances and ownership of `tokenId`s. +- \{\_beforeTokenTransfer\} function will run before updating the balances and ownership of `tokenId`s. -- {\_afterTokenTransfer} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the sender/recipient via LSP1**. +- \{\_afterTokenTransfer\} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the sender/recipient via LSP1**. ::: @@ -1224,7 +1224,7 @@ Emitted when `tokenOwner` disables `operator` to transfer or burn `tokenId` on i | Name | Type | Description | | -------------------------- | :-------: | --------------------------------------------------------------- | -| `operator` **`indexed`** | `address` | The address revoked from the operator array ({getOperatorsOf}). | +| `operator` **`indexed`** | `address` | The address revoked from the operator array (getOperatorsOf). | | `tokenOwner` **`indexed`** | `address` | The owner of the `tokenId`. | | `tokenId` **`indexed`** | `bytes32` | The tokenId `operator` is revoked from operating on. | | `notified` | `bool` | Bool indicating whether the operator has been notified or not | diff --git a/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CappedSupply.md b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CappedSupply.md index a2688e0efa..d1c851f7ed 100644 --- a/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CappedSupply.md +++ b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CappedSupply.md @@ -879,9 +879,9 @@ after a new `tokenId` has of tokens have been minted. Any logic in the: -- {\_beforeTokenTransfer} function will run before updating the balances and ownership of `tokenId`s. +- \{\_beforeTokenTransfer\} function will run before updating the balances and ownership of `tokenId`s. -- {\_afterTokenTransfer} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the sender via LSP1**. +- \{\_afterTokenTransfer\} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the sender via LSP1**. ::: @@ -924,9 +924,9 @@ all the parameters in the calldata packed encoded. Any logic in the: -- {\_beforeTokenTransfer} function will run before updating the balances and ownership of `tokenId`s. +- \{\_beforeTokenTransfer\} function will run before updating the balances and ownership of `tokenId`s. -- {\_afterTokenTransfer} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the sender/recipient via LSP1**. +- \{\_afterTokenTransfer\} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the sender/recipient via LSP1**. ::: @@ -1198,7 +1198,7 @@ Emitted when `tokenOwner` disables `operator` to transfer or burn `tokenId` on i | Name | Type | Description | | -------------------------- | :-------: | --------------------------------------------------------------- | -| `operator` **`indexed`** | `address` | The address revoked from the operator array ({getOperatorsOf}). | +| `operator` **`indexed`** | `address` | The address revoked from the operator array (getOperatorsOf). | | `tokenOwner` **`indexed`** | `address` | The owner of the `tokenId`. | | `tokenId` **`indexed`** | `bytes32` | The tokenId `operator` is revoked from operating on. | | `notified` | `bool` | Bool indicating whether the operator has been notified or not | diff --git a/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CompatibleERC721.md b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CompatibleERC721.md index a23d9573db..fde89a41a6 100644 --- a/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CompatibleERC721.md +++ b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CompatibleERC721.md @@ -1562,7 +1562,7 @@ Emitted when `tokenOwner` disables `operator` to transfer or burn `tokenId` on i | Name | Type | Description | | -------------------------- | :-------: | --------------------------------------------------------------- | -| `operator` **`indexed`** | `address` | The address revoked from the operator array ({getOperatorsOf}). | +| `operator` **`indexed`** | `address` | The address revoked from the operator array (getOperatorsOf). | | `tokenOwner` **`indexed`** | `address` | The owner of the `tokenId`. | | `tokenId` **`indexed`** | `bytes32` | The tokenId `operator` is revoked from operating on. | | `notified` | `bool` | Bool indicating whether the operator has been notified or not | diff --git a/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8Enumerable.md b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8Enumerable.md index a9dec5aa0a..f701947f09 100644 --- a/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8Enumerable.md +++ b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8Enumerable.md @@ -868,9 +868,9 @@ When `tokenId` does not exist then revert with an error. Any logic in the: -- {\_beforeTokenTransfer} function will run before updating the balances and ownership of `tokenId`s. +- \{\_beforeTokenTransfer\} function will run before updating the balances and ownership of `tokenId`s. -- {\_afterTokenTransfer} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the recipient via LSP1**. +- \{\_afterTokenTransfer\} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the recipient via LSP1**. ::: @@ -910,9 +910,9 @@ Create `tokenId` by minting it and transfers it to `to`. Any logic in the: -- {\_beforeTokenTransfer} function will run before updating the balances and ownership of `tokenId`s. +- \{\_beforeTokenTransfer\} function will run before updating the balances and ownership of `tokenId`s. -- {\_afterTokenTransfer} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the sender via LSP1**. +- \{\_afterTokenTransfer\} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the sender via LSP1**. ::: @@ -955,9 +955,9 @@ all the parameters in the calldata packed encoded. Any logic in the: -- {\_beforeTokenTransfer} function will run before updating the balances and ownership of `tokenId`s. +- \{\_beforeTokenTransfer\} function will run before updating the balances and ownership of `tokenId`s. -- {\_afterTokenTransfer} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the sender/recipient via LSP1**. +- \{\_afterTokenTransfer\} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the sender/recipient via LSP1**. ::: @@ -1226,7 +1226,7 @@ Emitted when `tokenOwner` disables `operator` to transfer or burn `tokenId` on i | Name | Type | Description | | -------------------------- | :-------: | --------------------------------------------------------------- | -| `operator` **`indexed`** | `address` | The address revoked from the operator array ({getOperatorsOf}). | +| `operator` **`indexed`** | `address` | The address revoked from the operator array (getOperatorsOf). | | `tokenOwner` **`indexed`** | `address` | The owner of the `tokenId`. | | `tokenId` **`indexed`** | `bytes32` | The tokenId `operator` is revoked from operating on. | | `notified` | `bool` | Bool indicating whether the operator has been notified or not | diff --git a/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/presets/LSP8CompatibleERC721Mintable.md b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/presets/LSP8CompatibleERC721Mintable.md index 4c33c7597e..100adf9418 100644 --- a/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/presets/LSP8CompatibleERC721Mintable.md +++ b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/presets/LSP8CompatibleERC721Mintable.md @@ -14,7 +14,7 @@ ::: -> LSP8CompatibleERC721Mintable deployable preset contract with a public {mint} function callable only by the contract {owner}. +> LSP8CompatibleERC721Mintable deployable preset contract with a public \{mint\} function callable only by the contract \{owner}. ## Public Methods @@ -1604,7 +1604,7 @@ Emitted when `tokenOwner` disables `operator` to transfer or burn `tokenId` on i | Name | Type | Description | | -------------------------- | :-------: | --------------------------------------------------------------- | -| `operator` **`indexed`** | `address` | The address revoked from the operator array ({getOperatorsOf}). | +| `operator` **`indexed`** | `address` | The address revoked from the operator array (getOperatorsOf). | | `tokenOwner` **`indexed`** | `address` | The owner of the `tokenId`. | | `tokenId` **`indexed`** | `bytes32` | The tokenId `operator` is revoked from operating on. | | `notified` | `bool` | Bool indicating whether the operator has been notified or not | diff --git a/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/presets/LSP8Mintable.md b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/presets/LSP8Mintable.md index 8308d80366..9ab0f85453 100644 --- a/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/presets/LSP8Mintable.md +++ b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/presets/LSP8Mintable.md @@ -14,7 +14,7 @@ ::: -> LSP8IdentifiableDigitalAsset deployable preset contract with a public {mint} function callable only by the contract {owner}. +> LSP8IdentifiableDigitalAsset deployable preset contract with a public \{mint\} function callable only by the contract \{owner}. ## Public Methods @@ -901,9 +901,9 @@ When `tokenId` does not exist then revert with an error. Any logic in the: -- {\_beforeTokenTransfer} function will run before updating the balances and ownership of `tokenId`s. +- \{\_beforeTokenTransfer\} function will run before updating the balances and ownership of `tokenId`s. -- {\_afterTokenTransfer} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the recipient via LSP1**. +- \{\_afterTokenTransfer\} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the recipient via LSP1**. ::: @@ -943,9 +943,9 @@ Create `tokenId` by minting it and transfers it to `to`. Any logic in the: -- {\_beforeTokenTransfer} function will run before updating the balances and ownership of `tokenId`s. +- \{\_beforeTokenTransfer\} function will run before updating the balances and ownership of `tokenId`s. -- {\_afterTokenTransfer} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the sender via LSP1**. +- \{\_afterTokenTransfer\} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the sender via LSP1**. ::: @@ -988,9 +988,9 @@ all the parameters in the calldata packed encoded. Any logic in the: -- {\_beforeTokenTransfer} function will run before updating the balances and ownership of `tokenId`s. +- \{\_beforeTokenTransfer\} function will run before updating the balances and ownership of `tokenId`s. -- {\_afterTokenTransfer} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the sender/recipient via LSP1**. +- \{\_afterTokenTransfer\} function will run after updating the balances and ownership of `tokenId`s, **but before notifying the sender/recipient via LSP1**. ::: @@ -1262,7 +1262,7 @@ Emitted when `tokenOwner` disables `operator` to transfer or burn `tokenId` on i | Name | Type | Description | | -------------------------- | :-------: | --------------------------------------------------------------- | -| `operator` **`indexed`** | `address` | The address revoked from the operator array ({getOperatorsOf}). | +| `operator` **`indexed`** | `address` | The address revoked from the operator array (getOperatorsOf). | | `tokenOwner` **`indexed`** | `address` | The owner of the `tokenId`. | | `tokenId` **`indexed`** | `bytes32` | The tokenId `operator` is revoked from operating on. | | `notified` | `bool` | Bool indicating whether the operator has been notified or not | diff --git a/docs/contracts/contracts/LSP9Vault/LSP9Vault.md b/docs/contracts/contracts/LSP9Vault/LSP9Vault.md index fc9a6481fd..45f9af3d04 100644 --- a/docs/contracts/contracts/LSP9Vault/LSP9Vault.md +++ b/docs/contracts/contracts/LSP9Vault/LSP9Vault.md @@ -836,7 +836,7 @@ This pattern is useful in inheritance. :::caution Warning -Providing operation type DELEGATECALL (4) as argument will result in custom error {ERC725X_UnknownOperationType(4)} +Providing operation type DELEGATECALL (4) as argument will result in custom error \{ERC725X_UnknownOperationType(4)} ::: @@ -1393,11 +1393,11 @@ Emitted when the [`universalReceiver`](#universalreceiver) function was called w | Name | Type | Description | | ---------------------- | :-------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `from` **`indexed`** | `address` | The address of the EOA or smart contract that called the {universalReceiver(...)} function. | -| `value` **`indexed`** | `uint256` | The amount sent to the {universalReceiver(...)} function. | +| `from` **`indexed`** | `address` | The address of the EOA or smart contract that called the \{universalReceiver(...)\} function. | +| `value` **`indexed`** | `uint256` | The amount sent to the \{universalReceiver(...)\} function. | | `typeId` **`indexed`** | `bytes32` | A `bytes32` unique identifier (= _"hook"_)that describe the type of notification, information or transaction received by the contract. Can be related to a specific standard or a hook. | -| `receivedData` | `bytes` | Any arbitrary data that was sent to the {universalReceiver(...)} function. | -| `returnedValue` | `bytes` | The value returned by the {universalReceiver(...)} function. | +| `receivedData` | `bytes` | Any arbitrary data that was sent to the \{universalReceiver(...)\} function. | +| `returnedValue` | `bytes` | The value returned by the \{universalReceiver(...)\} function. |
diff --git a/docs/contracts/contracts/UniversalProfile.md b/docs/contracts/contracts/UniversalProfile.md index 4ec73c3b34..2413319629 100644 --- a/docs/contracts/contracts/UniversalProfile.md +++ b/docs/contracts/contracts/UniversalProfile.md @@ -1407,11 +1407,11 @@ Emitted when the [`universalReceiver`](#universalreceiver) function was called w | Name | Type | Description | | ---------------------- | :-------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `from` **`indexed`** | `address` | The address of the EOA or smart contract that called the {universalReceiver(...)} function. | -| `value` **`indexed`** | `uint256` | The amount sent to the {universalReceiver(...)} function. | +| `from` **`indexed`** | `address` | The address of the EOA or smart contract that called the \{universalReceiver(...)\} function. | +| `value` **`indexed`** | `uint256` | The amount sent to the \{universalReceiver(...)\} function. | | `typeId` **`indexed`** | `bytes32` | A `bytes32` unique identifier (= _"hook"_)that describe the type of notification, information or transaction received by the contract. Can be related to a specific standard or a hook. | -| `receivedData` | `bytes` | Any arbitrary data that was sent to the {universalReceiver(...)} function. | -| `returnedValue` | `bytes` | The value returned by the {universalReceiver(...)} function. | +| `receivedData` | `bytes` | Any arbitrary data that was sent to the \{universalReceiver(...)\} function. | +| `returnedValue` | `bytes` | The value returned by the \{universalReceiver(...)\} function. |