Skip to content

Commit 68df393

Browse files
committed
docs: generate docs
1 parent 76202f9 commit 68df393

File tree

8 files changed

+156
-6
lines changed

8 files changed

+156
-6
lines changed

docs/contracts/LSP7DigitalAsset/LSP7DigitalAsset.md

+25
Original file line numberDiff line numberDiff line change
@@ -1688,6 +1688,31 @@ reverts when there is no extension for the function selector being called with
16881688

16891689
<br/>
16901690

1691+
### OperatorAllowanceCannotBeIncreasedFromZero
1692+
1693+
:::note References
1694+
1695+
- Specification details: [**LSP-7-DigitalAsset**](https://github.com/lukso-network/lips/tree/main/LSPs/LSP-7-DigitalAsset.md#operatorallowancecannotbeincreasedfromzero)
1696+
- Solidity implementation: [`LSP7DigitalAsset.sol`](https://github.com/lukso-network/lsp-smart-contracts/blob/develop/contracts/LSP7DigitalAsset/LSP7DigitalAsset.sol)
1697+
- Error signature: `OperatorAllowanceCannotBeIncreasedFromZero(address)`
1698+
- Error hash: `0xcba6e977`
1699+
1700+
:::
1701+
1702+
```solidity
1703+
error OperatorAllowanceCannotBeIncreasedFromZero(address operator);
1704+
```
1705+
1706+
Reverts when token owner call [`increaseAllowance`](#increaseallowance) for an operator that does not have any allowance
1707+
1708+
#### Parameters
1709+
1710+
| Name | Type | Description |
1711+
| ---------- | :-------: | ----------- |
1712+
| `operator` | `address` | - |
1713+
1714+
<br/>
1715+
16911716
### OwnableCallerNotTheOwner
16921717

16931718
:::note References

docs/contracts/LSP7DigitalAsset/extensions/LSP7Burnable.md

+25
Original file line numberDiff line numberDiff line change
@@ -1713,6 +1713,31 @@ reverts when there is no extension for the function selector being called with
17131713

17141714
<br/>
17151715

1716+
### OperatorAllowanceCannotBeIncreasedFromZero
1717+
1718+
:::note References
1719+
1720+
- Specification details: [**LSP-7-DigitalAsset**](https://github.com/lukso-network/lips/tree/main/LSPs/LSP-7-DigitalAsset.md#operatorallowancecannotbeincreasedfromzero)
1721+
- Solidity implementation: [`LSP7Burnable.sol`](https://github.com/lukso-network/lsp-smart-contracts/blob/develop/contracts/LSP7DigitalAsset/extensions/LSP7Burnable.sol)
1722+
- Error signature: `OperatorAllowanceCannotBeIncreasedFromZero(address)`
1723+
- Error hash: `0xcba6e977`
1724+
1725+
:::
1726+
1727+
```solidity
1728+
error OperatorAllowanceCannotBeIncreasedFromZero(address operator);
1729+
```
1730+
1731+
Reverts when token owner call [`increaseAllowance`](#increaseallowance) for an operator that does not have any allowance
1732+
1733+
#### Parameters
1734+
1735+
| Name | Type | Description |
1736+
| ---------- | :-------: | ----------- |
1737+
| `operator` | `address` | - |
1738+
1739+
<br/>
1740+
17161741
### OwnableCallerNotTheOwner
17171742

17181743
:::note References

docs/contracts/LSP7DigitalAsset/extensions/LSP7CappedSupply.md

+25
Original file line numberDiff line numberDiff line change
@@ -1729,6 +1729,31 @@ reverts when there is no extension for the function selector being called with
17291729

17301730
<br/>
17311731

1732+
### OperatorAllowanceCannotBeIncreasedFromZero
1733+
1734+
:::note References
1735+
1736+
- Specification details: [**LSP-7-DigitalAsset**](https://github.com/lukso-network/lips/tree/main/LSPs/LSP-7-DigitalAsset.md#operatorallowancecannotbeincreasedfromzero)
1737+
- Solidity implementation: [`LSP7CappedSupply.sol`](https://github.com/lukso-network/lsp-smart-contracts/blob/develop/contracts/LSP7DigitalAsset/extensions/LSP7CappedSupply.sol)
1738+
- Error signature: `OperatorAllowanceCannotBeIncreasedFromZero(address)`
1739+
- Error hash: `0xcba6e977`
1740+
1741+
:::
1742+
1743+
```solidity
1744+
error OperatorAllowanceCannotBeIncreasedFromZero(address operator);
1745+
```
1746+
1747+
Reverts when token owner call [`increaseAllowance`](#increaseallowance) for an operator that does not have any allowance
1748+
1749+
#### Parameters
1750+
1751+
| Name | Type | Description |
1752+
| ---------- | :-------: | ----------- |
1753+
| `operator` | `address` | - |
1754+
1755+
<br/>
1756+
17321757
### OwnableCallerNotTheOwner
17331758

17341759
:::note References

docs/contracts/LSP7DigitalAsset/extensions/LSP7CompatibleERC20.md

+25
Original file line numberDiff line numberDiff line change
@@ -1830,6 +1830,31 @@ reverts when there is no extension for the function selector being called with
18301830

18311831
<br/>
18321832

1833+
### OperatorAllowanceCannotBeIncreasedFromZero
1834+
1835+
:::note References
1836+
1837+
- Specification details: [**LSP-7-DigitalAsset**](https://github.com/lukso-network/lips/tree/main/LSPs/LSP-7-DigitalAsset.md#operatorallowancecannotbeincreasedfromzero)
1838+
- Solidity implementation: [`LSP7CompatibleERC20.sol`](https://github.com/lukso-network/lsp-smart-contracts/blob/develop/contracts/LSP7DigitalAsset/extensions/LSP7CompatibleERC20.sol)
1839+
- Error signature: `OperatorAllowanceCannotBeIncreasedFromZero(address)`
1840+
- Error hash: `0xcba6e977`
1841+
1842+
:::
1843+
1844+
```solidity
1845+
error OperatorAllowanceCannotBeIncreasedFromZero(address operator);
1846+
```
1847+
1848+
Reverts when token owner call [`increaseAllowance`](#increaseallowance) for an operator that does not have any allowance
1849+
1850+
#### Parameters
1851+
1852+
| Name | Type | Description |
1853+
| ---------- | :-------: | ----------- |
1854+
| `operator` | `address` | - |
1855+
1856+
<br/>
1857+
18331858
### OwnableCallerNotTheOwner
18341859

18351860
:::note References

docs/contracts/LSP7DigitalAsset/presets/LSP7CompatibleERC20Mintable.md

+25
Original file line numberDiff line numberDiff line change
@@ -1864,6 +1864,31 @@ reverts when there is no extension for the function selector being called with
18641864

18651865
<br/>
18661866

1867+
### OperatorAllowanceCannotBeIncreasedFromZero
1868+
1869+
:::note References
1870+
1871+
- Specification details: [**LSP-7-DigitalAsset**](https://github.com/lukso-network/lips/tree/main/LSPs/LSP-7-DigitalAsset.md#operatorallowancecannotbeincreasedfromzero)
1872+
- Solidity implementation: [`LSP7CompatibleERC20Mintable.sol`](https://github.com/lukso-network/lsp-smart-contracts/blob/develop/contracts/LSP7DigitalAsset/presets/LSP7CompatibleERC20Mintable.sol)
1873+
- Error signature: `OperatorAllowanceCannotBeIncreasedFromZero(address)`
1874+
- Error hash: `0xcba6e977`
1875+
1876+
:::
1877+
1878+
```solidity
1879+
error OperatorAllowanceCannotBeIncreasedFromZero(address operator);
1880+
```
1881+
1882+
Reverts when token owner call [`increaseAllowance`](#increaseallowance) for an operator that does not have any allowance
1883+
1884+
#### Parameters
1885+
1886+
| Name | Type | Description |
1887+
| ---------- | :-------: | ----------- |
1888+
| `operator` | `address` | - |
1889+
1890+
<br/>
1891+
18671892
### OwnableCallerNotTheOwner
18681893

18691894
:::note References

docs/contracts/LSP7DigitalAsset/presets/LSP7Mintable.md

+25
Original file line numberDiff line numberDiff line change
@@ -1750,6 +1750,31 @@ reverts when there is no extension for the function selector being called with
17501750

17511751
<br/>
17521752

1753+
### OperatorAllowanceCannotBeIncreasedFromZero
1754+
1755+
:::note References
1756+
1757+
- Specification details: [**LSP-7-DigitalAsset**](https://github.com/lukso-network/lips/tree/main/LSPs/LSP-7-DigitalAsset.md#operatorallowancecannotbeincreasedfromzero)
1758+
- Solidity implementation: [`LSP7Mintable.sol`](https://github.com/lukso-network/lsp-smart-contracts/blob/develop/contracts/LSP7DigitalAsset/presets/LSP7Mintable.sol)
1759+
- Error signature: `OperatorAllowanceCannotBeIncreasedFromZero(address)`
1760+
- Error hash: `0xcba6e977`
1761+
1762+
:::
1763+
1764+
```solidity
1765+
error OperatorAllowanceCannotBeIncreasedFromZero(address operator);
1766+
```
1767+
1768+
Reverts when token owner call [`increaseAllowance`](#increaseallowance) for an operator that does not have any allowance
1769+
1770+
#### Parameters
1771+
1772+
| Name | Type | Description |
1773+
| ---------- | :-------: | ----------- |
1774+
| `operator` | `address` | - |
1775+
1776+
<br/>
1777+
17531778
### OwnableCallerNotTheOwner
17541779

17551780
:::note References

docs/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CompatibleERC721.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1425,7 +1425,7 @@ Approve `operator` to operate on all tokens of `tokensOwner`.
14251425
event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId);
14261426
```
14271427

1428-
Emitted when the allowance of a `spender` for an `owner` is set by a call to [`approve`](#approve). `value` is the new allowance.
1428+
Emitted when `owner` enables `approved` to manage the `tokenId` token.
14291429

14301430
#### Parameters
14311431

@@ -1452,7 +1452,7 @@ Emitted when the allowance of a `spender` for an `owner` is set by a call to [`a
14521452
event ApprovalForAll(address indexed owner, address indexed operator, bool approved);
14531453
```
14541454

1455-
Emitted when `account` grants or revokes permission to `operator` to transfer their tokens, according to `approved`.
1455+
Emitted when `owner` enables or disables (`approved`) `operator` to manage all of its assets.
14561456

14571457
#### Parameters
14581458

@@ -1618,7 +1618,7 @@ Emitted when `tokenId` token is transferred from the `from` to the `to` address.
16181618
event Transfer(address indexed from, address indexed to, uint256 indexed tokenId);
16191619
```
16201620

1621-
Emitted when `value` tokens are moved from one account (`from`) to another (`to`). Note that `value` may be zero.
1621+
Emitted when `tokenId` token is transferred from `from` to `to`.
16221622

16231623
#### Parameters
16241624

docs/contracts/LSP8IdentifiableDigitalAsset/presets/LSP8CompatibleERC721Mintable.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1467,7 +1467,7 @@ Approve `operator` to operate on all tokens of `tokensOwner`.
14671467
event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId);
14681468
```
14691469

1470-
Emitted when the allowance of a `spender` for an `owner` is set by a call to [`approve`](#approve). `value` is the new allowance.
1470+
Emitted when `owner` enables `approved` to manage the `tokenId` token.
14711471

14721472
#### Parameters
14731473

@@ -1494,7 +1494,7 @@ Emitted when the allowance of a `spender` for an `owner` is set by a call to [`a
14941494
event ApprovalForAll(address indexed owner, address indexed operator, bool approved);
14951495
```
14961496

1497-
Emitted when `account` grants or revokes permission to `operator` to transfer their tokens, according to `approved`.
1497+
Emitted when `owner` enables or disables (`approved`) `operator` to manage all of its assets.
14981498

14991499
#### Parameters
15001500

@@ -1660,7 +1660,7 @@ Emitted when `tokenId` token is transferred from the `from` to the `to` address.
16601660
event Transfer(address indexed from, address indexed to, uint256 indexed tokenId);
16611661
```
16621662

1663-
Emitted when `value` tokens are moved from one account (`from`) to another (`to`). Note that `value` may be zero.
1663+
Emitted when `tokenId` token is transferred from `from` to `to`.
16641664

16651665
#### Parameters
16661666

0 commit comments

Comments
 (0)