Skip to content

factories.md

Latest commit

 

History

History
66 lines (48 loc) · 2.71 KB

factories.md

File metadata and controls

66 lines (48 loc) · 2.71 KB

Factories

Factories deploy cyberCORPs and their contracts.

CyberCorpFactory

The top-level entry point.

function deployCyberCorp(bytes32 salt, string companyName, string companyType,
    string companyJurisdiction, string companyContactDetails,
    string defaultDisputeResolution, address _companyPayable,
    CompanyOfficer _officer)
    external returns (address cyberCorp, address auth, address issuanceManager,
                      address dealManager, address roundManager);

function deployCyberCorpAndCreateOffer(/* ... */) external returns (/* corp suite + deal */);
function deployCyberCorpAndCreateRound(/* ... */) external returns (/* corp suite + roundId */);
function deployAndInitializeRoundManager(bytes32 salt, address cyberCorp) public returns (address);

deployCyberCorp:

  1. Deploys a BorgAuth ACL via CREATE2 and grants the officer level 200.
  2. Deploys the IssuanceManager, CyberCorp, DealManager, and RoundManager through their respective sub-factories and initialises them.
  3. Grants the IssuanceManager, DealManager, and RoundManager BorgAuth level 99, and the CyberCorp level 200.
  4. Emits CyberCorpDeployed.

The deployCyberCorpAndCreate* variants additionally create cert printers and open a deal or a round in the same transaction.

Setters (onlyOwner): setStable, setIssuanceManagerFactory, setCyberCorpSingleFactory, setCyberAgreementFactory, setDealManagerFactory, setRoundManagerFactory, setLexchexAuth.

Sub-factories

CyberCorpFactory composes:

Factory Deploys
CyberCorpSingleFactory the CyberCorp proxy; holds the reference implementation that gates CyberCorp upgrades.
IssuanceManagerFactory the IssuanceManager (and its CyberCertPrinter / CyberScrip beacons).
DealManagerFactory the DealManager.
RoundManagerFactory the RoundManager.

The CyberAgreementRegistry is shared (passed in as registryAddress).

Specialised factories

These build on the same primitives for specific structures:

Factory Source Purpose
PumpCorpFactory src/PumpCorpFactory.sol Deploys cyberCORPs configured for ACE (token-to-equity) offerings.
MetaDAOFactory src/MetaDAOFactory.sol Deploys MetaDAO futarchy-governed SPC structures.
ParentCoFactory src/ParentCoFactory.sol Deploys parent/subsidiary cyberCORP structures.

The specialised factories are documented here at a high level. Consult their source for exact constructors and deployment parameters.