👮GeneralKeeper
总管理人合约模版
Name
GeneralKeeper
Dependent Contract
IGeneralKeeper, AccessControl, RolesRepo, UsersRepo, IROCKeeper, IRODKeeper, IBMMKeeper, IROMKeeper, IGMMKeeper, IROAKeeper, IROOKeeper, IROPKeeper, ISHAKeeper, ILOOKeeper, IRegisterOfAgreements,
IRegisterOfConstitution, IRegisterOfDirectors, IRegisterOfMembers, IRegisterOfOptions, IRegisterOfPledges, IRegisterOfShares, IListOfOrders, IMeetingMinutes
API：
Source Code:
GeneralKeeper
// SPDX-License-Identifier: UNLICENSED
/* *
* Copyright (c) 2021-2023 LI LI @ JINGTIAN & GONGCHENG.
*
* This WORK is licensed under ComBoox SoftWare License 1.0, a copy of which
* can be obtained at:
* [https://github.com/paul-lee-attorney/comboox]
*
* THIS WORK IS PROVIDED ON AN "AS IS" BASIS, WITHOUT
* WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
* TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. IN NO
* EVENT SHALL ANY CONTRIBUTOR BE LIABLE TO YOU FOR ANY DAMAGES.
*
* YOU ARE PROHIBITED FROM DEPLOYING THE SMART CONTRACTS OF THIS WORK, IN WHOLE
* OR IN PART, FOR WHATEVER PURPOSE, ON ANY BLOCKCHAIN NETWORK THAT HAS ONE OR
* MORE NODES THAT ARE OUT OF YOUR CONTROL.
* */
pragma solidity ^0.8.8;
import "./common/access/AccessControl.sol";
import "./IGeneralKeeper.sol";
contract GeneralKeeper is IGeneralKeeper, AccessControl {
CompInfo private _info;
mapping(uint256 => address) private _books;
mapping(uint256 => address) private _keepers;
mapping(uint256 => uint256) private _coffers;
// ######################
// ## AccessControl ##
// ######################
function setCompInfo (
uint8 _currency,
bytes20 _symbol,
string memory _name
) external onlyDK {
_info.currency = _currency;
_info.symbol = _symbol;
_info.name = _name;
}
function createCorpSeal() external onlyDK {
_rc.regUser();
_info.regNum = _rc.getMyUserNo();
_info.regDate = uint48(block.timestamp);
}
function getCompInfo() external view returns(CompInfo memory) {
return _info;
}
function getCompUser() external view onlyOwner returns (UsersRepo.User memory) {
return _rc.getUser();
}
// ---- Keepers ----
function regKeeper(
uint256 title,
address keeper
) external onlyDK {
_keepers[title] = keeper;
}
function isKeeper(address caller) external view returns (bool) {
uint256 len = 10;
while (len > 0) {
if (caller == _keepers[len]) return true;
len--;
}
return false;
}
function getKeeper(uint256 title) external view returns (address) {
return _keepers[title];
}
// ---- Books ----
function regBook(uint256 title, address book) external onlyDK {
_books[title] = book;
}
function getBook(uint256 title) external view returns (address) {
return _books[title];
}
// ##################
// ## Verify ID ##
// ##################
function _msgSender(uint price) private returns (uint40 usr) {
usr = _rc.getUserNo(
msg.sender,
price * (10 ** 10),
_rc.getAuthorByBody(address(this))
);
}
// ##################
// ## ROCKeeper ##
// ##################
function createSHA(uint version) external {
IROCKeeper(_keepers[1]).createSHA(version, msg.sender, _msgSender(18000));
}
function circulateSHA(address body, bytes32 docUrl, bytes32 docHash) external {
IROCKeeper(_keepers[1]).circulateSHA(body, docUrl, docHash, _msgSender(18000));
}
function signSHA(address sha, bytes32 sigHash) external {
IROCKeeper(_keepers[1]).signSHA(sha, sigHash, _msgSender(18000));
}
function activateSHA(address body) external {
IROCKeeper(_keepers[1]).activateSHA(body, _msgSender(58000));
}
function acceptSHA(bytes32 sigHash) external {
IROCKeeper(_keepers[1]).acceptSHA(sigHash, _msgSender(36000));
}
// ###################
// ## RODKeeper ##
// ###################
function takeSeat(uint256 seqOfMotion, uint256 seqOfPos) external {
IRODKeeper(_keepers[2]).takeSeat(seqOfMotion, seqOfPos, _msgSender(36000));
}
function removeDirector (uint256 seqOfMotion, uint256 seqOfPos) external {
IRODKeeper(_keepers[2]).removeDirector(seqOfMotion, seqOfPos, _msgSender(58000));
}
function takePosition(uint256 seqOfMotion, uint256 seqOfPos) external {
IRODKeeper(_keepers[2]).takePosition(seqOfMotion, seqOfPos, _msgSender(36000));
}
function removeOfficer (uint256 seqOfMotion, uint256 seqOfPos) external {
IRODKeeper(_keepers[2]).removeOfficer(seqOfMotion, seqOfPos, _msgSender(58000));
}
function quitPosition(uint256 seqOfPos) external {
IRODKeeper(_keepers[2]).quitPosition(seqOfPos, _msgSender(18000));
}
// ###################
// ## BMMKeeper ##
// ###################
function nominateOfficer(uint256 seqOfPos, uint candidate) external {
IBMMKeeper(_keepers[3]).nominateOfficer(seqOfPos, candidate, _msgSender(36000));
}
function createMotionToRemoveOfficer(uint256 seqOfPos) external {
IBMMKeeper(_keepers[3]).createMotionToRemoveOfficer(seqOfPos, _msgSender(58000));
}
function createMotionToApproveDoc(uint doc, uint seqOfVR, uint executor) external {
IBMMKeeper(_keepers[3]).createMotionToApproveDoc(doc, seqOfVR, executor, _msgSender(58000));
}
function createAction(
uint seqOfVR,
address[] memory targets,
uint256[] memory values,
bytes[] memory params,
bytes32 desHash,
uint executor
) external {
IBMMKeeper(_keepers[3]).createAction(seqOfVR, targets, values, params, desHash, executor, _msgSender(66000));
}
function entrustDelegaterForBoardMeeting(uint256 seqOfMotion, uint delegate) external {
IBMMKeeper(_keepers[3]).entrustDelegaterForBoardMeeting(seqOfMotion, delegate, _msgSender(18000));
}
function proposeMotionToBoard (uint seqOfMotion) external {
IBMMKeeper(_keepers[3]).proposeMotionToBoard(seqOfMotion, _msgSender(36000));
}
function castVote(uint256 seqOfMotion, uint attitude, bytes32 sigHash) external {
IBMMKeeper(_keepers[3]).castVote(seqOfMotion, attitude, sigHash, _msgSender(36000));
}
function voteCounting(uint256 seqOfMotion) external {
IBMMKeeper(_keepers[3]).voteCounting(seqOfMotion);
}
function execAction(
uint typeOfAction,
address[] memory targets,
uint256[] memory values,
bytes[] memory params,
bytes32 desHash,
uint256 seqOfMotion
) external {
uint contents = IBMMKeeper(_keepers[3]).execAction(typeOfAction, targets, values, params, desHash, seqOfMotion, _msgSender(18000));
if (_execute(targets, values, params)) {
emit ExecAction(contents, true);
} else emit ExecAction(contents, false);
}
function _execute(
address[] memory targets,
uint256[] memory values,
bytes[] memory params
) private returns (bool success) {
for (uint256 i = 0; i < targets.length; i++) {
(success, ) = targets[i].call{value: values[i]}(params[i]);
if (!success) return success;
}
}
// ###################
// ## ROMKeeper ##
// ###################
function setMaxQtyOfMembers(uint max) external onlyDK {
IROMKeeper(_keepers[4]).setMaxQtyOfMembers(max);
}
function setPayInAmt(uint seqOfShare, uint amt, uint expireDate, bytes32 hashLock) external onlyDK {
IROMKeeper(_keepers[4]).setPayInAmt(seqOfShare, amt, expireDate, hashLock);
}
function requestPaidInCapital(bytes32 hashLock, string memory hashKey) external {
IROMKeeper(_keepers[4]).requestPaidInCapital(hashLock, hashKey);
}
function withdrawPayInAmt(bytes32 hashLock, uint seqOfShare) external onlyDK {
IROMKeeper(_keepers[4]).withdrawPayInAmt(hashLock, seqOfShare);
}
function payInCapital(uint seqOfShare, uint amt) external payable {
IROMKeeper(_keepers[4]).payInCapital(seqOfShare, amt, msg.value, _msgSender(36000));
}
// ###################
// ## GMMKeeper ##
// ###################
function nominateDirector(uint256 seqOfPos, uint candidate) external {
IGMMKeeper(_keepers[5]).nominateDirector(seqOfPos, candidate, _msgSender(72000));
}
function createMotionToRemoveDirector(uint256 seqOfPos) external {
IGMMKeeper(_keepers[5]).createMotionToRemoveDirector(seqOfPos, _msgSender(116000));
}
function proposeDocOfGM(uint doc, uint seqOfVR, uint executor) external {
IGMMKeeper(_keepers[5]).proposeDocOfGM(doc, seqOfVR, executor, _msgSender(116000));
}
function createActionOfGM(
uint seqOfVR,
address[] memory targets,
uint256[] memory values,
bytes[] memory params,
bytes32 desHash,
uint executor
) external {
IGMMKeeper(_keepers[5]).createActionOfGM(
seqOfVR,
targets,
values,
params,
desHash,
executor,
_msgSender(99000)
);
}
function entrustDelegaterForGeneralMeeting(uint256 seqOfMotion, uint delegate) external {
IGMMKeeper(_keepers[5]).entrustDelegaterForGeneralMeeting(seqOfMotion, delegate, _msgSender(36000));
}
function proposeMotionToGeneralMeeting(uint256 seqOfMotion) external {
IGMMKeeper(_keepers[5]).proposeMotionToGeneralMeeting(seqOfMotion, _msgSender(72000));
}
function castVoteOfGM(
uint256 seqOfMotion,
uint attitude,
bytes32 sigHash
) external {
IGMMKeeper(_keepers[5]).castVoteOfGM(seqOfMotion, attitude, sigHash, _msgSender(72000));
}
function voteCountingOfGM(uint256 seqOfMotion) external {
IGMMKeeper(_keepers[5]).voteCountingOfGM(seqOfMotion);
}
function execActionOfGM(
uint seqOfVR,
address[] memory targets,
uint256[] memory values,
bytes[] memory params,
bytes32 desHash,
uint256 seqOfMotion
) external {
uint contents = IGMMKeeper(_keepers[5]).execActionOfGM(
seqOfVR,
targets,
values,
params,
desHash,
seqOfMotion,
_msgSender(36000)
);
if (_execute(targets, values, params)) {
emit ExecAction(contents, true);
} else emit ExecAction(contents, false);
}
// ###################
// ## ROAKeeper ##
// ###################
function createIA(uint256 snOfIA) external {
IROAKeeper(_keepers[6]).createIA(snOfIA, msg.sender, _msgSender(58000));
}
function circulateIA(address body, bytes32 docUrl, bytes32 docHash) external {
IROAKeeper(_keepers[6]).circulateIA(body, docUrl, docHash, _msgSender(36000));
}
function signIA(address ia, bytes32 sigHash) external {
IROAKeeper(_keepers[6]).signIA(ia, _msgSender(36000), sigHash);
}
// ======== Deal Closing ========
function pushToCoffer(address ia, uint256 seqOfDeal, bytes32 hashLock, uint closingDeadline)
external {
IROAKeeper(_keepers[6]).pushToCoffer(ia, seqOfDeal, hashLock, closingDeadline, _msgSender(58000));
}
function closeDeal(address ia, uint256 seqOfDeal, string memory hashKey)
external {
IROAKeeper(_keepers[6]).closeDeal(ia, seqOfDeal, hashKey);
}
function issueNewShare(address ia, uint256 seqOfDeal) external {
IROAKeeper(_keepers[6]).issueNewShare(ia, seqOfDeal, _msgSender(58000));
}
function transferTargetShare(address ia, uint256 seqOfDeal) external {
IROAKeeper(_keepers[6]).transferTargetShare(ia, seqOfDeal, _msgSender(58000));
}
function terminateDeal(address ia, uint256 seqOfDeal) external {
IROAKeeper(_keepers[6]).terminateDeal(ia, seqOfDeal, _msgSender(18000));
}
function payOffApprovedDeal(
address ia,
uint seqOfDeal
) external payable {
IROAKeeper(_keepers[6]).payOffApprovedDeal(ia, seqOfDeal, msg.value, _msgSender(58000));
}
// #################
// ## ROOKeeper ##
// #################
function updateOracle(
uint256 seqOfOpt,
uint d1,
uint d2,
uint d3
) external onlyDK {
IROOKeeper(_keepers[7]).updateOracle(seqOfOpt, d1, d2, d3);
}
function execOption(uint256 seqOfOpt) external {
IROOKeeper(_keepers[7]).execOption(seqOfOpt, _msgSender(18000));
}
function createSwap(
uint256 seqOfOpt,
uint seqOfTarget,
uint paidOfTarget,
uint seqOfPledge
) external {
IROOKeeper(_keepers[7]).createSwap(seqOfOpt, seqOfTarget, paidOfTarget, seqOfPledge, _msgSender(36000));
}
function payOffSwap(
uint256 seqOfOpt,
uint256 seqOfSwap
) external payable {
IROOKeeper(_keepers[7]).payOffSwap(seqOfOpt, seqOfSwap, msg.value, _msgSender(58000));
}
function terminateSwap(
uint256 seqOfOpt,
uint256 seqOfSwap
) external {
IROOKeeper(_keepers[7]).terminateSwap(seqOfOpt, seqOfSwap, _msgSender(58000));
}
function requestToBuy(address ia, uint seqOfDeal, uint paidOfTarget, uint seqOfPledge) external {
IROOKeeper(_keepers[7]).requestToBuy(ia, seqOfDeal, paidOfTarget, seqOfPledge, _msgSender(58000));
}
function payOffRejectedDeal(
address ia,
uint seqOfDeal,
uint seqOfSwap
) external payable {
IROOKeeper(_keepers[7]).payOffRejectedDeal(ia, seqOfDeal, seqOfSwap, msg.value, _msgSender(58000));
}
function pickupPledgedShare(
address ia,
uint seqOfDeal,
uint seqOfSwap
) external {
IROOKeeper(_keepers[7]).pickupPledgedShare(ia, seqOfDeal, seqOfSwap, _msgSender(58000));
}
// ###################
// ## ROPKeeper ##
// ###################
function createPledge(bytes32 snOfPld, uint paid, uint par, uint guaranteedAmt, uint execDays) external {
IROPKeeper(_keepers[8]).createPledge(snOfPld, paid, par, guaranteedAmt, execDays, _msgSender(66000));
}
function transferPledge(uint256 seqOfShare, uint256 seqOfPld, uint buyer, uint amt)
external {
IROPKeeper(_keepers[8]).transferPledge(seqOfShare, seqOfPld, buyer, amt, _msgSender(36000));
}
function refundDebt(uint256 seqOfShare, uint256 seqOfPld, uint amt) external {
IROPKeeper(_keepers[8]).refundDebt(seqOfShare, seqOfPld, amt, _msgSender(36000));
}
function extendPledge(uint256 seqOfShare, uint256 seqOfPld, uint extDays) external {
IROPKeeper(_keepers[8]).extendPledge(seqOfShare, seqOfPld, extDays, _msgSender(18000));
}
function lockPledge(uint256 seqOfShare, uint256 seqOfPld, bytes32 hashLock) external {
IROPKeeper(_keepers[8]).lockPledge(seqOfShare, seqOfPld, hashLock, _msgSender(58000));
}
function releasePledge(uint256 seqOfShare, uint256 seqOfPld, string memory hashKey) external {
IROPKeeper(_keepers[8]).releasePledge(seqOfShare, seqOfPld, hashKey);
}
function execPledge(bytes32 snOfDeal, uint256 seqOfPld, uint version, uint buyer, uint groupOfBuyer) external {
IROPKeeper(_keepers[8]).execPledge(snOfDeal, seqOfPld, version, msg.sender, buyer, groupOfBuyer, _msgSender(88000));
}
function revokePledge(uint256 seqOfShare, uint256 seqOfPld) external {
IROPKeeper(_keepers[8]).revokePledge(seqOfShare, seqOfPld, _msgSender(58000));
}
// ###################
// ## SHAKeeper ##
// ###################
// ======= TagAlong ========
function execTagAlong(
address ia,
uint256 seqOfDeal,
uint256 seqOfShare,
uint paid,
uint par,
bytes32 sigHash
) external {
ISHAKeeper(_keepers[9]).execAlongRight(
ia,
seqOfDeal,
false,
seqOfShare,
paid,
par,
_msgSender(88000),
sigHash
);
}
// ======= DragAlong ========
function execDragAlong(
address ia,
uint256 seqOfDeal,
uint256 seqOfShare,
uint paid,
uint par,
bytes32 sigHash
) external {
ISHAKeeper(_keepers[9]).execAlongRight(
ia,
seqOfDeal,
true,
seqOfShare,
paid,
par,
_msgSender(88000),
sigHash
);
}
function acceptAlongDeal(
address ia,
uint256 seqOfDeal,
bytes32 sigHash
) external {
ISHAKeeper(_keepers[9]).acceptAlongDeal(ia, seqOfDeal, _msgSender(36000), sigHash);
}
// ======== AntiDilution ========
function execAntiDilution(
address ia,
uint256 seqOfDeal,
uint256 seqOfShare,
bytes32 sigHash
) external {
ISHAKeeper(_keepers[9]).execAntiDilution(ia, seqOfDeal, seqOfShare, _msgSender(88000), sigHash);
}
function takeGiftShares(address ia, uint256 seqOfDeal) external {
ISHAKeeper(_keepers[9]).takeGiftShares(ia, seqOfDeal, _msgSender(58000));
}
// ======== First Refusal ========
function execFirstRefusal(
uint256 seqOfRule,
uint256 seqOfRightholder,
address ia,
uint256 seqOfDeal,
bytes32 sigHash
) external {
ISHAKeeper(_keepers[9]).execFirstRefusal(seqOfRule, seqOfRightholder, ia, seqOfDeal, _msgSender(88000), sigHash);
}
function computeFirstRefusal(
address ia,
uint256 seqOfDeal
) external {
ISHAKeeper(_keepers[9]).computeFirstRefusal(
ia,
seqOfDeal,
_msgSender(18000)
);
}
// ############
// ## Fund ##
// ############
function getCentPrice() external view returns(uint) {
return _rc.getCentPriceInWei(_info.currency);
}
function saveToCoffer(uint acct, uint value) external {
require (
msg.sender == _keepers[4] ||
msg.sender == _keepers[5] ||
msg.sender == _keepers[6] ||
msg.sender == _keepers[7] ||
msg.sender == _keepers[10],
"GK.saveToCoffer: not correct Keeper");
require(address(this).balance >= _coffers[0] + value,
"GK.saveToCoffer: insufficient Eth");
_coffers[acct] += value;
_coffers[0] += value;
}
function pickupDeposit() external {
uint caller = _msgSender(18000);
uint value = _coffers[caller];
if (value > 0) {
_coffers[caller] = 0;
_coffers[0] -= value;
payable(msg.sender).transfer(value);
} else revert("GK.pickupDeposit: no balance");
}
function proposeToDistributeProfits(
uint amt,
uint expireDate,
uint seqOfVR,
uint executor
) external {
IGMMKeeper(_keepers[5]).proposeToDistributeProfits(
amt,
expireDate,
seqOfVR,
executor,
_msgSender(68000)
);
}
function distributeProfits(
uint amt,
uint expireDate,
uint seqOfMotion
) external {
IGMMKeeper(_keepers[5]).distributeProfits(
amt,
expireDate,
seqOfMotion,
_msgSender(18000)
);
}
function proposeToTransferFund(
bool toBMM,
address to,
bool isCBP,
uint amt,
uint expireDate,
uint seqOfVR,
uint executor
) external {
if (toBMM)
IBMMKeeper(_keepers[3]).proposeToTransferFund(
to,
isCBP,
amt,
expireDate,
seqOfVR,
executor,
_msgSender(66000)
);
else IGMMKeeper(_keepers[5]).proposeToTransferFund(
to,
isCBP,
amt,
expireDate,
seqOfVR,
executor,
_msgSender(99000)
);
}
function transferFund(
bool fromBMM,
address to,
bool isCBP,
uint amt,
uint expireDate,
uint seqOfMotion
) external {
if (fromBMM)
IBMMKeeper(_keepers[3]).transferFund(
to,
isCBP,
amt,
expireDate,
seqOfMotion,
_msgSender(38000)
);
else IGMMKeeper(_keepers[5]).transferFund(
to,
isCBP,
amt,
expireDate,
seqOfMotion,
_msgSender(76000)
);
if (isCBP)
_rc.transfer(to, amt);
else {
require (address(this).balance >= _coffers[0] + amt,
"GK.transferFund: insufficient balance");
payable(to).transfer(amt);
}
}
// #################
// ## LOOKeeper ##
// #################
function regInvestor(uint groupRep, bytes32 idHash) external {
ILOOKeeper(_keepers[10]).regInvestor(_msgSender(36000), groupRep, idHash);
}
function approveInvestor(uint userNo, uint seqOfLR) external {
ILOOKeeper(_keepers[10]).approveInvestor(userNo, _msgSender(18000),seqOfLR);
}
function revokeInvestor(uint userNo, uint seqOfLR) external {
ILOOKeeper(_keepers[10]).revokeInvestor(userNo, _msgSender(18000),seqOfLR);
}
function placeInitialOffer(
uint classOfShare,
uint execHours,
uint paid,
uint price,
uint seqOfLR
) external {
ILOOKeeper(_keepers[10]).placeInitialOffer(
_msgSender(18000),
classOfShare,
execHours,
paid,
price,
seqOfLR
);
}
function withdrawInitialOffer(
uint classOfShare,
uint seqOfOrder,
uint seqOfLR
) external {
ILOOKeeper(_keepers[10]).withdrawInitialOffer(
_msgSender(18000),
classOfShare,
seqOfOrder,
seqOfLR
);
}
function placeSellOrder(
uint seqOfClass,
uint execHours,
uint paid,
uint price,
uint seqOfLR,
bool sortFromHead
) external {
ILOOKeeper(_keepers[10]).placeSellOrder(
_msgSender(58000),
seqOfClass,
execHours,
paid,
price,
seqOfLR,
sortFromHead
);
}
function withdrawSellOrder(
uint classOfShare,
uint seqOfOrder
) external {
ILOOKeeper(_keepers[10]).withdrawSellOrder(
_msgSender(88000),
classOfShare,
seqOfOrder
);
}
function placeBuyOrder(uint classOfShare, uint paid, uint price) external payable {
ILOOKeeper(_keepers[10]).placeBuyOrder(
_msgSender(88000),
classOfShare,
paid,
price,
msg.value
);
}
// ###############
// ## Routing ##
// ###############
function getROC() external view returns (IRegisterOfConstitution ) {
return IRegisterOfConstitution(_books[1]);
}
function getSHA() external view returns (IShareholdersAgreement ) {
return IShareholdersAgreement(IRegisterOfConstitution(_books[1]).pointer());
}
function getROD() external view returns (IRegisterOfDirectors ) {
return IRegisterOfDirectors(_books[2]);
}
function getBMM() external view returns (IMeetingMinutes ) {
return IMeetingMinutes(_books[3]);
}
function getROM() external view returns (IRegisterOfMembers ) {
return IRegisterOfMembers(_books[4]);
}
function getGMM() external view returns (IMeetingMinutes ) {
return IMeetingMinutes(_books[5]);
}
function getROA() external view returns (IRegisterOfAgreements) {
return IRegisterOfAgreements(_books[6]);
}
function getROO() external view returns (IRegisterOfOptions ) {
return IRegisterOfOptions(_books[7]);
}
function getROP() external view returns (IRegisterOfPledges ) {
return IRegisterOfPledges(_books[8]);
}
function getROS() external view returns (IRegisterOfShares ) {
return IRegisterOfShares(_books[9]);
}
function getLOO() external view returns (IListOfOrders ) {
return IListOfOrders(_books[10]);
}
// ---- Eth ----
function depositOfMine(uint user) external view returns(uint) {
return _coffers[user];
}
function totalDeposits() external view returns(uint) {
return _coffers[0];
}
}IGeneralKeeper
// SPDX-License-Identifier: UNLICENSED
/* *
* Copyright (c) 2021-2023 LI LI @ JINGTIAN & GONGCHENG.
*
* This WORK is licensed under ComBoox SoftWare License 1.0, a copy of which
* can be obtained at:
* [https://github.com/paul-lee-attorney/comboox]
*
* THIS WORK IS PROVIDED ON AN "AS IS" BASIS, WITHOUT
* WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
* TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. IN NO
* EVENT SHALL ANY CONTRIBUTOR BE LIABLE TO YOU FOR ANY DAMAGES.
*
* YOU ARE PROHIBITED FROM DEPLOYING THE SMART CONTRACTS OF THIS WORK, IN WHOLE
* OR IN PART, FOR WHATEVER PURPOSE, ON ANY BLOCKCHAIN NETWORK THAT HAS ONE OR
* MORE NODES THAT ARE OUT OF YOUR CONTROL.
* */
pragma solidity ^0.8.8;
import "./common/components/IMeetingMinutes.sol";
import "../lib/RolesRepo.sol";
import "../lib/UsersRepo.sol";
import "./keepers/IROCKeeper.sol";
import "./keepers/IRODKeeper.sol";
import "./keepers/IBMMKeeper.sol";
import "./keepers/IROMKeeper.sol";
import "./keepers/IGMMKeeper.sol";
import "./keepers/IROAKeeper.sol";
import "./keepers/IROOKeeper.sol";
import "./keepers/IROPKeeper.sol";
import "./keepers/ISHAKeeper.sol";
import "./keepers/ILOOKeeper.sol";
import "./books/roa/IRegisterOfAgreements.sol";
import "./books/roc/IRegisterOfConstitution.sol";
import "./books/rod/IRegisterOfDirectors.sol";
import "./books/rom/IRegisterOfMembers.sol";
import "./books/roo/IRegisterOfOptions.sol";
import "./books/rop/IRegisterOfPledges.sol";
import "./books/ros/IRegisterOfShares.sol";
import "./books/loo/IListOfOrders.sol";
interface IGeneralKeeper {
struct CompInfo {
uint40 regNum;
uint48 regDate;
uint8 currency;
bytes20 symbol;
string name;
}
// ###############
// ## Event ##
// ###############
event ExecAction(uint256 indexed contents, bool indexed result);
// ######################
// ## AccessControl ##
// ######################
function setCompInfo (
uint8 _currency,
bytes20 _symbol,
string memory _name
) external;
function createCorpSeal() external;
function getCompInfo() external view returns(CompInfo memory);
function getCompUser() external view returns (UsersRepo.User memory);
function regKeeper(uint256 title, address keeper) external;
function isKeeper(address caller) external view returns (bool flag);
function getKeeper(uint256) external view returns(address keeper);
function regBook(uint256 title, address keeper) external;
function getBook(uint256 title) external view returns (address);
// ##################
// ## ROCKeeper ##
// ##################
function createSHA(uint version) external;
function circulateSHA(address body, bytes32 docUrl, bytes32 docHash) external;
function signSHA(address sha, bytes32 sigHash) external;
function activateSHA(address body) external;
function acceptSHA(bytes32 sigHash) external;
// ###################
// ## RODKeeper ##
// ###################
function takeSeat(uint256 seqOfMotion, uint256 seqOfPos) external;
function removeDirector (uint256 seqOfMotion, uint256 seqOfPos) external;
function takePosition(uint256 seqOfMotion, uint256 seqOfPos) external;
function removeOfficer (uint256 seqOfMotion, uint256 seqOfPos) external;
function quitPosition(uint256 seqOfPos) external;
// ###################
// ## BMMKeeper ##
// ###################
function nominateOfficer(uint256 seqOfPos, uint candidate) external;
function createMotionToRemoveOfficer(uint256 seqOfPos) external;
function createMotionToApproveDoc(uint doc, uint seqOfVR, uint executor) external;
function createAction(
uint seqOfVR,
address[] memory targets,
uint256[] memory values,
bytes[] memory params,
bytes32 desHash,
uint executor
) external;
function entrustDelegaterForBoardMeeting(uint256 seqOfMotion, uint delegate) external;
function proposeMotionToBoard (uint seqOfMotion) external;
function castVote(uint256 seqOfMotion, uint attitude, bytes32 sigHash) external;
function voteCounting(uint256 seqOfMotion) external;
function execAction(
uint typeOfAction,
address[] memory targets,
uint256[] memory values,
bytes[] memory params,
bytes32 desHash,
uint256 seqOfMotion
) external;
// ###################
// ## ROMKeeper ##
// ###################
function setMaxQtyOfMembers(uint max) external;
function setPayInAmt(uint seqOfShare, uint amt, uint expireDate, bytes32 hashLock) external;
function requestPaidInCapital(bytes32 hashLock, string memory hashKey) external;
function withdrawPayInAmt(bytes32 hashLock, uint seqOfShare) external;
function payInCapital(uint seqOfShare, uint amt) external payable;
// ###################
// ## GMMKeeper ##
// ###################
function nominateDirector(uint256 seqOfPos, uint candidate) external;
function createMotionToRemoveDirector(uint256 seqOfPos) external;
function proposeDocOfGM(uint doc, uint seqOfVR, uint executor) external;
function createActionOfGM(
uint seqOfVR,
address[] memory targets,
uint256[] memory values,
bytes[] memory params,
bytes32 desHash,
uint executor
) external;
function entrustDelegaterForGeneralMeeting(uint256 seqOfMotion, uint delegate) external;
function proposeMotionToGeneralMeeting(uint256 seqOfMotion) external;
function castVoteOfGM(
uint256 seqOfMotion,
uint attitude,
bytes32 sigHash
) external;
function voteCountingOfGM(uint256 seqOfMotion) external;
function execActionOfGM(
uint seqOfVR,
address[] memory targets,
uint256[] memory values,
bytes[] memory params,
bytes32 desHash,
uint256 seqOfMotion
) external;
// ###################
// ## ROAKeeper ##
// ###################
function createIA(uint256 snOfIA) external;
function circulateIA(address body, bytes32 docUrl, bytes32 docHash) external;
function signIA(address ia, bytes32 sigHash) external;
// ======== Deal Closing ========
function pushToCoffer(address ia, uint256 seqOfDeal, bytes32 hashLock, uint closingDeadline) external;
function closeDeal(address ia, uint256 seqOfDeal, string memory hashKey) external;
function issueNewShare(address ia, uint256 seqOfDeal) external;
function transferTargetShare(address ia, uint256 seqOfDeal) external;
function terminateDeal(address ia, uint256 seqOfDeal) external;
function requestToBuy(address ia, uint seqOfDeal, uint paidOfTarget, uint seqOfPledge) external;
function payOffRejectedDeal(
address ia,
uint seqOfDeal,
uint seqOfSwap
) external payable;
function pickupPledgedShare(
address ia,
uint seqOfDeal,
uint seqOfSwap
) external;
function payOffApprovedDeal(
address ia,
uint seqOfDeal
) external payable;
// #################
// ## ROOKeeper ##
// #################
function updateOracle(
uint256 seqOfOpt,
uint d1,
uint d2,
uint d3
) external;
function execOption(uint256 seqOfOpt) external;
function payOffSwap(
uint256 seqOfOpt,
uint256 seqOfSwap
) external payable;
function terminateSwap(
uint256 seqOfOpt,
uint256 seqOfSwap
) external;
// ###################
// ## ROPKeeper ##
// ###################
function createPledge(bytes32 snOfPld, uint paid, uint par, uint guaranteedAmt, uint execDays) external;
function transferPledge(uint256 seqOfShare, uint256 seqOfPld, uint buyer, uint amt)
external;
function refundDebt(uint256 seqOfShare, uint256 seqOfPld, uint amt) external;
function extendPledge(uint256 seqOfShare, uint256 seqOfPld, uint extDays) external;
function lockPledge(uint256 seqOfShare, uint256 seqOfPld, bytes32 hashLock) external;
function releasePledge(uint256 seqOfShare, uint256 seqOfPld, string memory hashKey) external;
function execPledge(bytes32 snOfDeal, uint256 seqOfPld, uint version, uint buyer, uint groupOfBuyer) external;
function revokePledge(uint256 seqOfShare, uint256 seqOfPld) external;
// ###################
// ## SHAKeeper ##
// ###################
// ======= TagAlong ========
function execTagAlong(
address ia,
uint256 seqOfDeal,
uint256 seqOfShare,
uint paid,
uint par,
bytes32 sigHash
) external;
// ======= DragAlong ========
function execDragAlong(
address ia,
uint256 seqOfDeal,
uint256 seqOfShare,
uint paid,
uint par,
bytes32 sigHash
) external;
function acceptAlongDeal(
address ia,
uint256 seqOfDeal,
bytes32 sigHash
) external;
// ======== AntiDilution ========
function execAntiDilution(
address ia,
uint256 seqOfDeal,
uint256 seqOfShare,
bytes32 sigHash
) external;
function takeGiftShares(address ia, uint256 seqOfDeal) external;
// ======== First Refusal ========
function execFirstRefusal(
uint256 seqOfRule,
uint256 seqOfRightholder,
address ia,
uint256 seqOfDeal,
bytes32 sigHash
) external;
function computeFirstRefusal(
address ia,
uint256 seqOfDeal
) external;
// ############
// ## Fund ##
// ############
function getCentPrice() external view returns(uint);
function saveToCoffer(uint acct, uint value) external;
function pickupDeposit() external;
function proposeToDistributeProfits(
uint amt,
uint expireDate,
uint seqOfVR,
uint executor
) external;
function distributeProfits(
uint amt,
uint expireDate,
uint seqOfMotion
) external;
function proposeToTransferFund(
bool toBMM,
address to,
bool isCBP,
uint amt,
uint expireDate,
uint seqOfVR,
uint executor
) external;
function transferFund(
bool fromBMM,
address to,
bool isCBP,
uint amt,
uint expireDate,
uint seqOfMotion
) external;
// #################
// ## LOOKeeper ##
// #################
function regInvestor(uint groupRep, bytes32 idHash) external;
function approveInvestor(uint userNo, uint seqOfLR) external;
function revokeInvestor(uint userNo, uint seqOfLR) external;
function placeInitialOffer(
uint classOfShare,
uint execHours,
uint paid,
uint price,
uint seqOfLR
) external;
function withdrawInitialOffer(
uint classOfShare,
uint seqOfOrder,
uint seqOfLR
) external;
function placeSellOrder(
uint seqOfClass,
uint execHours,
uint paid,
uint price,
uint seqOfLR,
bool sortFromHead
) external;
function withdrawSellOrder(
uint classOfShare,
uint seqOfOrder
) external;
function placeBuyOrder(uint classOfShare, uint paid, uint price) external payable;
// ###############
// ## Routing ##
// ###############
function getROC() external view returns (IRegisterOfConstitution );
function getSHA() external view returns (IShareholdersAgreement);
function getROD() external view returns (IRegisterOfDirectors);
function getBMM() external view returns (IMeetingMinutes);
function getROM() external view returns (IRegisterOfMembers);
function getGMM() external view returns (IMeetingMinutes);
function getROA() external view returns (IRegisterOfAgreements);
function getROO() external view returns (IRegisterOfOptions);
function getROP() external view returns (IRegisterOfPledges);
function getROS() external view returns (IRegisterOfShares);
function getLOO() external view returns (IListOfOrders);
function depositOfMine(uint user) external view returns(uint);
function totalDeposits() external view returns(uint);
}