Skip to content

Latest commit

 

History

History
258 lines (178 loc) · 9.01 KB

README.md

File metadata and controls

258 lines (178 loc) · 9.01 KB
Raw

UNS (Unstoppable Naming Service)

UNS Registry smart contracts. Author: Unstoppable Domains, Inc., 2021. All rights reserved.

Official deployments

UNS Contracts are officially deployed to several different Ethereum and Polygon networks The contract addresses are distributed via a UNS Config File and always kept up to date.

Specifications

  1. Implements ERC721

    ERC-721 Non-Fungible Token Standard

  2. Implements ERC165

    ERC-165 Standard Interface Detection

  3. Implements IERC721Metadata

    IERC721Metadata is an extension of ERC-721. IERC721Metadata allows smart contract to be interrogated for its name and for details about the assets which your NFTs represent.

    Ref: https://eips.ethereum.org/EIPS/eip-721

  4. Implements IUNSRegistry

  5. Record Storage (aka Resolver)

    Record Storage implements IRecordStorage

  6. Support meta-transactions

    EIP-2771: Secure Protocol for Native Meta Transactions

    Recipient:

    In order to support EIP-2771 recipient should implement Context.

    interface Context {
    function _msgSender() internal view returns (address);
    function _msgData() internal view returns (bytes calldata);
}

    The implementation should allow replacement of _msgSender and _msgData in case of forwarding.

    Implementation ERC2771RegistryContext.sol

    Forwarder:

    struct ForwardRequest {
    address from;
    uint256 tokenId;
    uint256 nonce;
    bytes data;
}

interface Forwarder {
    /**
     * @dev Return current token nonce
     */
    function nonceOf(uint256 tokenId) public view returns (uint256);

    /**
     * @dev Verify signature against provided request
     */
    function verify(ForwardRequest calldata req, bytes calldata signature) public view returns (bool);

    /**
     * @dev Execute bytecode if signature is correct
     */
    function execute(ForwardRequest calldata req, bytes calldata signature) public returns (bool, bytes memory);
}

    Implementation UNSRegistryForwarder.sol

  7. Upgradability

    By design, smart contracts are immutable. On the other hand, software quality heavily depends on the ability to upgrade and patch source code in order to produce iterative releases. Even though blockchain based software profits significantly from the technology’s immutability, still a certain degree of mutability is needed for bug fixing and potential product improvements.

    Upgradability comes from two patterns:

    1. Initializable

      Since a proxied contract can't have a constructor, it's common to move constructor logic to an external initializer function, usually called initialize. It then becomes necessary to protect this initializer function so it can only be called once.

    2. Context

      Provides information about the current execution context, including the sender of the transaction and its data.

    UNS uses Transparent Proxy for upgradability.

    Refs:

  8. TLD management

    UNS TLD management is delegated to MintingManager contract.

    contract IMintingManager {
    /**
     * @dev Mapping TLD `hashname` to TLD label
     *
     * `hashname` = uint256(keccak256(abi.encodePacked(uint256(0x0), keccak256(abi.encodePacked(label)))))
     */
    mapping(uint256 => string) internal _tlds;
}

  9. Domain minting

    Unstoppable Domains, Inc. reserves all rights of domains minting and defines rules of domain minting through MintingManager contract.

  10. Roles model

    TBD

Development

In order to compile, use yarn compile, this also autogenerates typechain types. Also, please note that in tests, it's required to use factories and types, generated by typechain. For example:

import { UNSRegistry } from '../types/contracts';
import { UNSRegistry__factory } from '../types/factories/contracts';


describe('UNSRegistry', () => {
  let unsRegistry: UNSRegistry;

  let coinbase: SignerWithAddress;

  before(async () => {
    [coinbase] = await ethers.getSigners();

    unsRegistry = await new UNSRegistry__factory(coinbase).deploy();
  });

  it('test', () => {
    // ...
  });
});

Dependencies

  • Slither - solidity source analyzer [optional]

    Installation command: pip3 install slither-analyzer

Environment variables

  • {NETWORK}_INFURA_KEY - Infura key for connecting to Ethereum Node
  • {NETWORK}_UNS_PRIVATE_KEY - Private key of account for contracts deployment
  • {EXPLORER}_API_KEY - Etherscan(or any whitelabled compatible explorer) API Key for smart contracts verification

NOTE: All private keys should be in HEX format with 0x prefix

Network Variables
Mainnet MAINNET_INFURA_KEY
MAINNET_UNS_PRIVATE_KEY
ETHERSCAN_API_KEY
Sepolia SEPOLIA_INFURA_KEY
SEPOLIA_UNS_PRIVATE_KEY
ETHERSCAN_API_KEY
Polygon POLYGON_INFURA_KEY
POLYGON_UNS_PRIVATE_KEY
POLYGONSCAN_API_KEY
Amoy AMOY_INFURA_KEY
AMOY_UNS_PRIVATE_KEY
POLYGONSCAN_API_KEY
Base BASE_INFURA_KEY
BASE_UNS_PRIVATE_KEY
BASESCAN_API_KEY
Base sepolia BASE_INFURA_KEY
BASE_UNS_PRIVATE_KEY
BASESCAN_API_KEY

Backward incompatibility

Note: List of changes which makes UNS and CNS backward incompatible

Events

  • event Approved ApprovedForAll Transfer NewURI
    • Unchanged
  • event Resolve(uint256 indexed tokenId, address indexed to)
    • Removed
    • UNS has a single resolver which is Registry, so one can assume that resolver is always set to registry address
  • event Sync(address indexed resolver, uint256 indexed updateId, uint256 indexed tokenId)
    • Removed
    • There is no need for this event because there is only one resolver and changes can be tracked by Set event instead
  • event Set(uint256 indexed tokenId, string indexed keyIndex, string indexed valueIndex, string key, string value)
    • Moved from Resolver to Registry
  • event NewKey(uint256 indexed tokenId, string indexed keyIndex, string key)
    • Moved from Resolver to Regisry
  • event ResetRecords(uint256 indexed tokenId)
    • Moved from Resolver to Registry
    • Registry now fires this event when records are reset on transfer.

Resolvers Removal

  • function resolveTo(address to, uint256 tokenId) external {}
    • Removed - UNS uses a single Resolver which is Registry itself.
  • function resolverOf(uint256 tokenId)
    • Now always returns Registry address itself

Sandbox

>> README

Deploying contracts

Scripts for deploying contracts are located inside ./scripts directory. In order to run them, you can use the following command:

yarn hardhat run --network <network> scripts/filename.ts

As scripts make JSON-RPC calls to Infura and sign transactions, you'll need to specify 2 environment variables. Those variables' names depend on the network you want deploy the contracts to. Assuming you want to deploy new contracts to Sepolia, you'll need the following variables:

export SEPOLIA_UNS_PRIVATE_KEY=<HEX_PRIVATE_KEY>
export SEPOLIA_INFURA_KEY=<INFURA_PROJECT_ID>

The scripts located in ./scripts directory are wrappers around Deployer tasks. You can see their definitions inside src/tasks.ts.

Deploying CNS

yarn hardhat run --network <network> scripts/deploy_CNS.ts

Deploying UNS

UNS depends on CNS, as CNS registry address is used as a MintingManager's initializer argument. Before deploying UNS, make sure that CNS is deployed and actual CNS contract addresses are specified in the uns-config.json file.

yarn hardhat run --network <network> scripts/deploy.ts

Warning: In case of contracts' redeployment, make sure there is no deployment output file .deployer/{chain_id}.json

Deploying UNS on L2(Polygon/Amoy)

yarn hardhat run --network amoy scripts/deploy_UNS_only.ts

L2 Polygon

There are configs networks Mainnet, Testnet