Skip to content

Commit

Permalink
chore: update contract heading natspec (#383)
Browse files Browse the repository at this point in the history
  • Loading branch information
horsefacts authored Aug 29, 2023
1 parent 05ebd7e commit 76bd8af
Show file tree
Hide file tree
Showing 7 changed files with 33 additions and 10 deletions.
7 changes: 7 additions & 0 deletions src/Bundler.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down
6 changes: 4 additions & 2 deletions src/FnameResolver.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
/*//////////////////////////////////////////////////////////////
Expand Down
6 changes: 4 additions & 2 deletions src/IdRegistry.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
/*//////////////////////////////////////////////////////////////
Expand Down
7 changes: 4 additions & 3 deletions src/KeyRegistry.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion src/RecoveryProxy.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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 {
/*//////////////////////////////////////////////////////////////
Expand Down
6 changes: 4 additions & 2 deletions src/StorageRegistry.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
7 changes: 7 additions & 0 deletions src/validators/SignedKeyRequestValidator.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 76bd8af

Please sign in to comment.