-
Notifications
You must be signed in to change notification settings - Fork 122
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: update contract heading natspec (#383)
- Loading branch information
1 parent
05ebd7e
commit 76bd8af
Showing
7 changed files
with
33 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,6 +8,13 @@ import {IBundler} from "./interfaces/IBundler.sol"; | |
import {TrustedCaller} from "./lib/TrustedCaller.sol"; | ||
import {TransferHelper} from "./lib/TransferHelper.sol"; | ||
|
||
/** | ||
* @title Farcaster Bundler | ||
* | ||
* @notice See https://github.com/farcasterxyz/contracts/blob/v3.0.0/docs/docs.md for an overview. | ||
* | ||
* @custom:security-contact [email protected] | ||
*/ | ||
contract Bundler is IBundler, TrustedCaller { | ||
using TransferHelper for address; | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -23,9 +23,11 @@ interface IResolverService { | |
} | ||
|
||
/** | ||
* @title FnameResolver | ||
* @title Farcaster FnameResolver | ||
* | ||
* @notice See ../docs/docs.md for an overview. | ||
* @notice See https://github.com/farcasterxyz/contracts/blob/v3.0.0/docs/docs.md for an overview. | ||
* | ||
* @custom:security-contact [email protected] | ||
*/ | ||
contract FnameResolver is IExtendedResolver, EIP712, ERC165, Ownable2Step { | ||
/*////////////////////////////////////////////////////////////// | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,9 +11,11 @@ import {Signatures} from "./lib/Signatures.sol"; | |
import {TrustedCaller} from "./lib/TrustedCaller.sol"; | ||
|
||
/** | ||
* @title IdRegistry | ||
* @title Farcaster IdRegistry | ||
* | ||
* @notice See ../docs/docs.md for an overview. | ||
* @notice See https://github.com/farcasterxyz/contracts/blob/v3.0.0/docs/docs.md for an overview. | ||
* | ||
* @custom:security-contact [email protected] | ||
*/ | ||
contract IdRegistry is IIdRegistry, TrustedCaller, Signatures, Pausable, EIP712, Nonces { | ||
/*////////////////////////////////////////////////////////////// | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,11 +13,12 @@ import {Signatures} from "./lib/Signatures.sol"; | |
import {TrustedCaller} from "./lib/TrustedCaller.sol"; | ||
|
||
/** | ||
* @title KeyRegistry | ||
* @title Farcaster KeyRegistry | ||
* | ||
* @notice See ../docs/docs.md for an overview. | ||
* @notice See https://github.com/farcasterxyz/contracts/blob/v3.0.0/docs/docs.md for an overview. | ||
* | ||
* @custom:security-contact [email protected] | ||
*/ | ||
|
||
contract KeyRegistry is IKeyRegistry, TrustedCaller, Signatures, Pausable, EIP712, Nonces { | ||
/*////////////////////////////////////////////////////////////// | ||
ERRORS | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,7 +5,7 @@ import {IdRegistry} from "./IdRegistry.sol"; | |
import {Ownable2Step} from "openzeppelin/contracts/access/Ownable2Step.sol"; | ||
|
||
/** | ||
* @title RecoveryProxy | ||
* @title Farcaster RecoveryProxy | ||
* | ||
* @notice RecoveryProxy allows the recovery execution logic to be changed | ||
* without changing the recovery address. | ||
|
@@ -16,6 +16,8 @@ import {Ownable2Step} from "openzeppelin/contracts/access/Ownable2Step.sol"; | |
* multisig. This allows a recovery service operator to change the | ||
* recovery mechanisms in the future without requiring each user to | ||
* come online and execute a transaction. | ||
* | ||
* @custom:security-contact [email protected] | ||
*/ | ||
contract RecoveryProxy is Ownable2Step { | ||
/*////////////////////////////////////////////////////////////// | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,9 +10,11 @@ import {IStorageRegistry} from "./interfaces/IStorageRegistry.sol"; | |
import {TransferHelper} from "./lib/TransferHelper.sol"; | ||
|
||
/** | ||
* @title StorageRegistry | ||
* @title Farcaster StorageRegistry | ||
* | ||
* @notice See ../docs/docs.md for an overview. | ||
* @notice See https://github.com/farcasterxyz/contracts/blob/v3.0.0/docs/docs.md for an overview. | ||
* | ||
* @custom:security-contact [email protected] | ||
*/ | ||
contract StorageRegistry is IStorageRegistry, AccessControlEnumerable, Pausable { | ||
using FixedPointMathLib for uint256; | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,6 +8,13 @@ import {IMetadataValidator} from "../interfaces/IMetadataValidator.sol"; | |
import {IdRegistryLike} from "../interfaces/IdRegistryLike.sol"; | ||
import {IdRegistry} from "../IdRegistry.sol"; | ||
|
||
/** | ||
* @title Farcaster SignedKeyRequestValidator | ||
* | ||
* @notice See https://github.com/farcasterxyz/contracts/blob/v3.0.0/docs/docs.md for an overview. | ||
* | ||
* @custom:security-contact [email protected] | ||
*/ | ||
contract SignedKeyRequestValidator is IMetadataValidator, Ownable2Step, EIP712 { | ||
/*////////////////////////////////////////////////////////////// | ||
STRUCTS | ||
|