Git Source
Methods
WHERE_REGISTRY
function WHERE_REGISTRY() external view returns (address)
Get the address of the registry where to opt-in.
Returns
| Name | Type | Description |
|---|
| address | address of the "where" registry |
WHO_REGISTRY
function WHO_REGISTRY() external view returns (address)
Get the "who" registry’s address.
Returns
| Name | Type | Description |
|---|
| address | address of the "who" registry |
eip712Domain
function eip712Domain() external view returns (bytes1 fields, string name, string version, uint256 chainId, address verifyingContract, bytes32 salt, uint256[] extensions)
See IERC-5267.
Returns
| Name | Type | Description |
|---|
| fields | bytes1 | |
| name | string | |
| version | string | |
| chainId | uint256 | |
| verifyingContract | address | |
| salt | bytes32 | |
| extensions | uint256[] | |
increaseNonce
function increaseNonce(address where) external nonpayable
Increase the nonce of a given "who" to a particular "where" entity.
It can be used to invalidate a given signature.
Parameters
| Name | Type | Description |
|---|
| where | address | address of the "where" entity |
isOptedIn
function isOptedIn(address who, address where) external view returns (bool)
Check if a given "who" is opted-in to a particular "where" entity.
Parameters
| Name | Type | Description |
|---|
| who | address | address of the "who" |
| where | address | address of the "where" entity |
Returns
| Name | Type | Description |
|---|
| bool | if the "who" is opted-in |
isOptedInAt
function isOptedInAt(address who, address where, uint48 timestamp, bytes hint) external view returns (bool)
Get if a given "who" is opted-in to a particular "where" entity at a given timestamp using a hint.
Parameters
| Name | Type | Description |
|---|
| who | address | address of the "who" |
| where | address | address of the "where" entity |
| timestamp | uint48 | time point to get if the "who" is opted-in at |
| hint | bytes | hint for the checkpoint index |
Returns
| Name | Type | Description |
|---|
| bool | if the "who" is opted-in at the given timestamp |
nonces
function nonces(address who, address where) external view returns (uint256 nonce)
Get the nonce of a given "who" to a particular "where" entity.
Parameters
| Name | Type | Description |
|---|
| who | address | address of the "who" |
| where | address | address of the "where" entity |
Returns
| Name | Type | Description |
|---|
| nonce | uint256 | nonce |
optIn
function optIn(address where) external nonpayable
Opt-in a calling "who" to a particular "where" entity.
Parameters
| Name | Type | Description |
|---|
| where | address | address of the "where" entity |
optIn
function optIn(address who, address where, uint48 deadline, bytes signature) external nonpayable
Opt-in a "who" to a particular "where" entity with a signature.
Parameters
| Name | Type | Description |
|---|
| who | address | address of the "who" |
| where | address | address of the "where" entity |
| deadline | uint48 | time point until the signature is valid (inclusively) |
| signature | bytes | signature of the "who" |
optOut
function optOut(address who, address where, uint48 deadline, bytes signature) external nonpayable
Opt-out a "who" from a particular "where" entity with a signature.
Parameters
| Name | Type | Description |
|---|
| who | address | address of the "who" |
| where | address | address of the "where" entity |
| deadline | uint48 | time point until the signature is valid (inclusively) |
| signature | bytes | signature of the "who" |
optOut
function optOut(address where) external nonpayable
Opt-out a calling "who" from a particular "where" entity.
Parameters
| Name | Type | Description |
|---|
| where | address | address of the "where" entity |
staticDelegateCall
function staticDelegateCall(address target, bytes data) external nonpayable
Make a delegatecall from this contract to a given target contract with a particular data (always reverts with a return data).
It allows to use this contract’s storage on-chain.
Parameters
| Name | Type | Description |
|---|
| target | address | address of the contract to make a delegatecall to |
| data | bytes | data to make a delegatecall with |
Events
IncreaseNonce
event IncreaseNonce(address indexed who, address indexed where)
Emitted when the nonce of a "who" to a "where" entity is increased.
Parameters
| Name | Type | Description |
|---|
who indexed | address | address of the "who" |
where indexed | address | address of the "where" entity |
OptIn
event OptIn(address indexed who, address indexed where)
Emitted when a "who" opts into a "where" entity.
Parameters
| Name | Type | Description |
|---|
who indexed | address | address of the "who" |
where indexed | address | address of the "where" entity |
OptOut
event OptOut(address indexed who, address indexed where)
Emitted when a "who" opts out from a "where" entity.
Parameters
| Name | Type | Description |
|---|
who indexed | address | address of the "who" |
where indexed | address | address of the "where" entity |