cic-contracts/doc/texinfo/accountsindex.sol.texi
lash da5d7d9d2d Fix remaining texinfo code examples
Signed-off-by: lash <dev@holbrook.no>
2023-08-02 10:22:32 +01:00

43 lines
1.4 KiB
Plaintext

@subsection Accounts Index
Append-only list of addresses. Typically used for access control lists.
Addresses may be @emph{added}, @emph{removed}, aswell as @emph{deactivated} and @emph{activated}. Deactivated accounts still count towards the @code{entryCount}.
The @code{entry} method is used to iterate the account list. The order of which accounts are returned is not guaranteed. Any returned value matching @code{address(0x00)} should be skipped, and not counted towards @code{entryCount}.
May optionally record time when account was added.
@subsubsection ERC165 Interface identifier
@include ../../build/AccountsIndex.interface
@subsubsection Solidity interface definition
@include ../../build/contract_AccountsIndex.texi
@subsubsection Reference implementation
@uref{git://holbrook.no/eth-accounts-index.git,} (v0.5.1)
@subsection Accounts Index Mutable
Extends the functionality of @code{Accounts Index} to allow changes to the address list.
Addresses may be @emph{added}, @emph{removed}, aswell as @emph{deactivated} and @emph{activated}. Deactivated accounts still count towards the @code{entryCount}.
@subsubsection ERC165 Interface identifier
@include ../../build/AccountsIndexMutable.interface
@subsubsection Solidity interface definition
@include ../../build/contract_AccountsIndexMutable.texi
@subsubsection Reference implementation
@uref{git://holbrook.no/eth-accounts-index.git,} (v0.5.1)