diff --git a/src/Bundler.sol b/src/Bundler.sol index 0fd6e081..7794503a 100644 --- a/src/Bundler.sol +++ b/src/Bundler.sol @@ -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 security@farcaster.xyz + */ contract Bundler is IBundler, TrustedCaller { using TransferHelper for address; diff --git a/src/FnameResolver.sol b/src/FnameResolver.sol index ec9801c4..1866d414 100644 --- a/src/FnameResolver.sol +++ b/src/FnameResolver.sol @@ -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 security@farcaster.xyz */ contract FnameResolver is IExtendedResolver, EIP712, ERC165, Ownable2Step { /*////////////////////////////////////////////////////////////// diff --git a/src/IdRegistry.sol b/src/IdRegistry.sol index 47dbd671..ecb92884 100644 --- a/src/IdRegistry.sol +++ b/src/IdRegistry.sol @@ -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 security@farcaster.xyz */ contract IdRegistry is IIdRegistry, TrustedCaller, Signatures, Pausable, EIP712, Nonces { /*////////////////////////////////////////////////////////////// diff --git a/src/KeyRegistry.sol b/src/KeyRegistry.sol index fe1d240f..141f38e2 100644 --- a/src/KeyRegistry.sol +++ b/src/KeyRegistry.sol @@ -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 security@farcaster.xyz */ - contract KeyRegistry is IKeyRegistry, TrustedCaller, Signatures, Pausable, EIP712, Nonces { /*////////////////////////////////////////////////////////////// ERRORS diff --git a/src/RecoveryProxy.sol b/src/RecoveryProxy.sol index b89e0192..5cffdd66 100644 --- a/src/RecoveryProxy.sol +++ b/src/RecoveryProxy.sol @@ -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 security@farcaster.xyz */ contract RecoveryProxy is Ownable2Step { /*////////////////////////////////////////////////////////////// diff --git a/src/StorageRegistry.sol b/src/StorageRegistry.sol index c2db6f96..ac91df86 100644 --- a/src/StorageRegistry.sol +++ b/src/StorageRegistry.sol @@ -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 security@farcaster.xyz */ contract StorageRegistry is IStorageRegistry, AccessControlEnumerable, Pausable { using FixedPointMathLib for uint256; diff --git a/src/validators/SignedKeyRequestValidator.sol b/src/validators/SignedKeyRequestValidator.sol index fa2a4a49..e07e99c6 100644 --- a/src/validators/SignedKeyRequestValidator.sol +++ b/src/validators/SignedKeyRequestValidator.sol @@ -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 security@farcaster.xyz + */ contract SignedKeyRequestValidator is IMetadataValidator, Ownable2Step, EIP712 { /*////////////////////////////////////////////////////////////// STRUCTS