communities-contracts/contracts/factories/CommunityOwnerTokenFactory.sol

64 lines
2.0 KiB
Solidity
Raw Permalink Normal View History

feat: implement `CommunityTokenDeployer` contract (#2) This commit introduces the `CommunityTokenDeployer` contract discussed in https://github.com/status-im/status-desktop/issues/11954. The idea is that, instead of having accounts deploy `OwnerToken` and `MasterToken` directly, they'd use a deployer contract instead, which maintains a registry of known `OwnerToken` addresses, mapped to Status community addresses. The following changes have been made: It was, and still is, a requirement that both, `OwnerToken` and `MasterToken` are deployed within a single transaction, so that when something goes wrong, we don't end up in an inconsistent state. That's why `OwnerToken` used to instantiated `MasterToken` and required all of its constructor arguments as well. Unfortunately, this resulted in compilation issues in the context of the newly introduce deployer contract, where there are too many function arguments. Because we now delegate deployment to a dedicated contract, we can instantiate both `OwnerToken` and `MasterToken` in a single transaction, without having `OwnerToken` being responsible to instantiate `MasterToken`. This fixes the compilation issues and simplifies the constructor of `OwnerToken`. The new `CommunityTokenDeployer` contract is now responsble for deploying the aforementioned tokens and ensures that they are deployed within a single transaction. To deploy an `OwnerToken` and `MasterToken` accounts can now call `CommunityDeloyerToken.deploy(TokenConfig, TokenConfig, DeploymentSignature)`. The `DeploymentSignature` uses `EIP712` structured type hash data to let the contract verify that the deployer is allowed to deploy the contracts on behalf of a community account.
2023-09-19 09:39:55 +00:00
// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.17;
import { BaseTokenFactory } from "./BaseTokenFactory.sol";
import { OwnerToken } from "../tokens/OwnerToken.sol";
/**
* @title CommunityOwnerTokenFactory contract
* @author 0x-r4bbit
*
* @notice This contract creates instances of `OwnerToken`.
* @dev This contract inherits `BaseTokenFactory` to get access to
* shared modifiers and other functions.
*/
contract CommunityOwnerTokenFactory is BaseTokenFactory {
error CommunityOwnerTokenFactory_InvalidReceiverAddress();
error CommunityOwnerTokenFactory_InvalidSignerPublicKey();
event CreateToken(address indexed);
/**
* @notice Creates an instance of `OwnerToken`.
* @dev Only the token deployer contract can call this function.
* @dev Emits a {CreateToken} event.
* @param _name The name of the `OwnerToken`.
* @param _symbol The symbol of the `OwnerToken`.
* @param _baseURI The base token URI of the `OwnerToken`.
* @param _receiver The address of the token owner.
* @param _signerPublicKey The public key of the trusted signer of the community
* that the `OwnerToken` instance belongs to.
* @return address The address of the created `OwnerToken` instance.
*/
function create(
string calldata _name,
string calldata _symbol,
string calldata _baseURI,
address _receiver,
bytes memory _signerPublicKey
)
external
onlyTokenDeployer
onlyValidTokenMetadata(_name, _symbol, _baseURI)
returns (address)
{
if (_receiver == address(0)) {
revert CommunityOwnerTokenFactory_InvalidReceiverAddress();
}
if (_signerPublicKey.length == 0) {
revert CommunityOwnerTokenFactory_InvalidSignerPublicKey();
}
OwnerToken ownerToken = new OwnerToken(
_name,
_symbol,
_baseURI,
_receiver,
_signerPublicKey
);
emit CreateToken(address(ownerToken));
return address(ownerToken);
}
}