@etherisc/gif-next 0.0.2-cc4a5cb-898 → 0.0.2-cc74a8b-656

package/artifacts/contracts/types/ReferralId.sol/ReferralIdLib.json

@@ -1,99 +0,0 @@
-{
-  "_format": "hh-sol-artifact-1",
-  "contractName": "ReferralIdLib",
-  "sourceName": "contracts/types/ReferralId.sol",
-  "abi": [
-    {
-      "inputs": [
-        {
-          "internalType": "ReferralId",
-          "name": "id",
-          "type": "bytes8"
-        }
-      ],
-      "name": "toKey32",
-      "outputs": [
-        {
-          "internalType": "Key32",
-          "name": "key",
-          "type": "bytes32"
-        }
-      ],
-      "stateMutability": "pure",
-      "type": "function"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "ReferralId",
-          "name": "id",
-          "type": "bytes8"
-        }
-      ],
-      "name": "toKeyId",
-      "outputs": [
-        {
-          "internalType": "KeyId",
-          "name": "keyId",
-          "type": "bytes31"
-        }
-      ],
-      "stateMutability": "pure",
-      "type": "function"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "string",
-          "name": "referral",
-          "type": "string"
-        }
-      ],
-      "name": "toReferralId",
-      "outputs": [
-        {
-          "internalType": "ReferralId",
-          "name": "",
-          "type": "bytes8"
-        }
-      ],
-      "stateMutability": "pure",
-      "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "zeroReferralId",
-      "outputs": [
-        {
-          "internalType": "ReferralId",
-          "name": "",
-          "type": "bytes8"
-        }
-      ],
-      "stateMutability": "pure",
-      "type": "function"
-    }
-  ],
-  "bytecode": "0x61034161003a600b82828239805160001a60731461002d57634e487b7160e01b600052600060045260246000fd5b30600052607381538281f3fe73000000000000000000000000000000000000000030146080604052600436106100565760003560e01c806317130acc1461005b5780632cf96bf91461008c57806355ee6275146100ba578063f77d70c8146100db575b600080fd5b61006e6100693660046101c2565b6100e2565b6040516001600160c01b031990911681526020015b60405180910390f35b6100a761009a366004610273565b6001600160c01b03191690565b60405160ff199091168152602001610083565b6100cd6100c8366004610273565b610112565b604051908152602001610083565b600061006e565b6000816040516020016100f591906102a4565b604051602081830303815290604052805190602001209050919050565b600073__$c8f743efd2b4f0c9300f2558c784479d3e$__63f48016ce60d46001600160c01b031985166040516001600160e01b031960e085901b16815260ff909216600483015260ff19166024820152604401602060405180830381865af4158015610182573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906101a691906102f2565b92915050565b634e487b7160e01b600052604160045260246000fd5b6000602082840312156101d457600080fd5b813567ffffffffffffffff808211156101ec57600080fd5b818401915084601f83011261020057600080fd5b813581811115610212576102126101ac565b604051601f8201601f19908116603f0116810190838211818310171561023a5761023a6101ac565b8160405282815287602084870101111561025357600080fd5b826020860160208301376000928101602001929092525095945050505050565b60006020828403121561028557600080fd5b81356001600160c01b03198116811461029d57600080fd5b9392505050565b600060208083528351808285015260005b818110156102d1578581018301518582016040015282016102b5565b506000604082860101526040601f19601f8301168501019250505092915050565b60006020828403121561030457600080fd5b505191905056fea26469706673582212206f489a59a5ff949525bfa166f5c495acd31da1b2cef5254b93c44b7b7f271b0664736f6c63430008140033",
-  "deployedBytecode": "0x73000000000000000000000000000000000000000030146080604052600436106100565760003560e01c806317130acc1461005b5780632cf96bf91461008c57806355ee6275146100ba578063f77d70c8146100db575b600080fd5b61006e6100693660046101c2565b6100e2565b6040516001600160c01b031990911681526020015b60405180910390f35b6100a761009a366004610273565b6001600160c01b03191690565b60405160ff199091168152602001610083565b6100cd6100c8366004610273565b610112565b604051908152602001610083565b600061006e565b6000816040516020016100f591906102a4565b604051602081830303815290604052805190602001209050919050565b600073__$c8f743efd2b4f0c9300f2558c784479d3e$__63f48016ce60d46001600160c01b031985166040516001600160e01b031960e085901b16815260ff909216600483015260ff19166024820152604401602060405180830381865af4158015610182573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906101a691906102f2565b92915050565b634e487b7160e01b600052604160045260246000fd5b6000602082840312156101d457600080fd5b813567ffffffffffffffff808211156101ec57600080fd5b818401915084601f83011261020057600080fd5b813581811115610212576102126101ac565b604051601f8201601f19908116603f0116810190838211818310171561023a5761023a6101ac565b8160405282815287602084870101111561025357600080fd5b826020860160208301376000928101602001929092525095945050505050565b60006020828403121561028557600080fd5b81356001600160c01b03198116811461029d57600080fd5b9392505050565b600060208083528351808285015260005b818110156102d1578581018301518582016040015282016102b5565b506000604082860101526040601f19601f8301168501019250505092915050565b60006020828403121561030457600080fd5b505191905056fea26469706673582212206f489a59a5ff949525bfa166f5c495acd31da1b2cef5254b93c44b7b7f271b0664736f6c63430008140033",
-  "linkReferences": {
-    "contracts/types/Key32.sol": {
-      "Key32Lib": [
-        {
-          "length": 20,
-          "start": 336
-        }
-      ]
-    }
-  },
-  "deployedLinkReferences": {
-    "contracts/types/Key32.sol": {
-      "Key32Lib": [
-        {
-          "length": 20,
-          "start": 278
-        }
-      ]
-    }
-  }
-}

package/artifacts/contracts/types/UFixed.sol/UFixedMathLib.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/1a42edd98eb9f337c509f79259ca2d18.json"
-}

package/contracts/components/BaseComponent.sol

@@ -1,94 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
-
-import {IRegisterable} from "../shared/IRegisterable.sol";
-import {Registerable} from "../shared/Registerable.sol";
-
-import {IRegistry} from "../registry/IRegistry.sol";
-import {IInstance} from "../instance/IInstance.sol";
-
-import {IInstance} from "../instance/IInstance.sol";
-import {IComponent, IComponentModule} from "../instance/module/component/IComponent.sol";
-import {IComponentOwnerService} from "../instance/service/IComponentOwnerService.sol";
-import {IBaseComponent} from "./IBaseComponent.sol";
-import {Fee, FeeLib} from "../types/Fee.sol";
-import {NftId} from "../types/NftId.sol";
-
-abstract contract BaseComponent is
-    Registerable,
-    IBaseComponent
-{
-    IComponentOwnerService internal _componentOwnerService;
-
-    address internal _deployer;
-    address internal _wallet;
-    IERC20Metadata internal _token;
-    IInstance internal _instance;
-    bool internal _isRegistered;
-    Fee internal _zeroFee;
-
-    constructor(
-        address registry,
-        NftId instanceNftId,
-        address token
-    )
-        Registerable(registry, instanceNftId)
-    {
-        IRegistry.ObjectInfo memory instanceInfo = _registry.getObjectInfo(instanceNftId);
-        _instance = IInstance(instanceInfo.objectAddress);
-        require(
-            _instance.supportsInterface(type(IInstance).interfaceId),
-            ""
-        );
-
-        _componentOwnerService = _instance.getComponentOwnerService();
-        _wallet = address(this);
-        _token = IERC20Metadata(token);
-        _isRegistered = false;
-        _zeroFee = FeeLib.zeroFee();
-    }
-
-    // from registerable
-    function register() public override(IRegisterable, Registerable) returns (NftId componentId) {
-        require(msg.sender == getOwner(), "");
-        require(
-            address(_registry) != address(0),
-            "ERROR:COB-001:REGISTRY_ZERO"
-        );
-        require(
-            _registry.isRegistered(address(_instance)),
-            "ERROR:COB:INSTANCE_NOT_REGISTERED"
-        );
-
-        _isRegistered = true;
-        return _componentOwnerService.register(this);
-    }
-
-    // from component contract
-    function lock() external onlyOwner override {
-        _componentOwnerService.lock(this);
-    }
-
-    function unlock() external onlyOwner override {
-        _componentOwnerService.unlock(this);
-    }
-
-    function getWallet()
-        external
-        view
-        override
-        returns (address walletAddress)
-    {
-        return _wallet;
-    }
-
-    function getToken() external view override returns (IERC20Metadata token) {
-        return _token;
-    }
-
-    function getInstance() external view override returns (IInstance instance) {
-        return _instance;
-    }
-}

package/contracts/components/IBaseComponent.sol

@@ -1,19 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
-
-import {IRegisterable} from "../shared/IRegisterable.sol";
-import {IInstanceLinked} from "../instance/IInstanceLinked.sol";
-
-interface IBaseComponent is IRegisterable, IInstanceLinked {
-
-    function lock() external;
-
-    function unlock() external;
-
-    function getToken() external view returns (IERC20Metadata token);
-
-    function getWallet() external view returns (address walletAddress);
-
-}

package/contracts/experiment/errors/Require.sol

@@ -1,38 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-contract Require {
-    error AsmallerThanB_S();
-    error AsmallerThanB_M(uint a);
-    error AsmallerThanB_L(uint a, uint b);
-
-    uint256 private _b;
-
-    constructor() {
-        _b = 42;
-    }
-
-    function isAlargerThanBRequire_S(
-        uint a
-    ) external view returns (bool isLarger) {
-        require(a > _b, "ERROR:ABC-001");
-
-        return true;
-    }
-
-    function isAlargerThanBRequire_M(
-        uint a
-    ) external view returns (bool isLarger) {
-        require(a > _b, "ERROR:ABC-002:A_IS_SMALLER");
-
-        return true;
-    }
-
-    function isAlargerThanBRequire_L(
-        uint a
-    ) external view returns (bool isLarger) {
-        require(a > _b, "ERROR:ABC-003:A_IS_SMALLER_THAN_B");
-
-        return true;
-    }
-}

package/contracts/experiment/errors/Revert.sol

@@ -1,44 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-contract Revert {
-    error AsmallerThanB_S();
-    error AsmallerThanB_M(uint a);
-    error AsmallerThanB_L(uint a, uint b);
-
-    uint256 private _b;
-
-    constructor() {
-        _b = 42;
-    }
-
-    function isAlargerThanBRevert_S(
-        uint a
-    ) external view returns (bool isLarger) {
-        if (a <= _b) {
-            revert AsmallerThanB_S();
-        }
-
-        return true;
-    }
-
-    function isAlargerThanBRevert_M(
-        uint a
-    ) external view returns (bool isLarger) {
-        if (a <= _b) {
-            revert AsmallerThanB_M(a);
-        }
-
-        return true;
-    }
-
-    function isAlargerThanBRevert_L(
-        uint a
-    ) external view returns (bool isLarger) {
-        if (a <= _b) {
-            revert AsmallerThanB_L(a, _b);
-        }
-
-        return true;
-    }
-}

package/contracts/experiment/inheritance/A.sol

@@ -1,53 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IA, ISharedA} from "./IA.sol";
-import {B} from "./B.sol";
-import {C} from "./C.sol";
-
-/* 
-
-# dependency graph
-
-   B <...+
-   ^     |
-   |     |
-   A --> C
-
-   - A is the main contract
-   - A provides functionality implemented by modules B and C
-   - B and C rely on functionality shared by A
-   - C accesses functionality of module B
-
-# chisel session
-
-import {A} from "./contracts/experiment/A.sol";
-A a = new A();
-uint(a.getA())
-uint(a.getB()))
-uint(a.getC())
-uint(a.getAfromB())
-uint(a.getAfromC())
-uint(a.getBfromC())
-a.setA(100);
-a.setB(10);
-a.setC(20);
- */
-
-contract AShared is ISharedA {
-    uint256 private _x;
-
-    constructor() {
-        _x = 42;
-    }
-
-    function getA() external view override returns (uint256) {
-        return _x;
-    }
-
-    function setA(uint256 newA) external override {
-        _x = newA;
-    }
-}
-
-contract A is AShared, B, C, IA {}

package/contracts/experiment/inheritance/B.sol

@@ -1,28 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {ISharedA} from "./IA.sol";
-import {IB} from "./IB.sol";
-
-abstract contract B is ISharedA, IB {
-    // names of private variables can be re-used in inheritance
-    uint256 private _x;
-
-    constructor() {
-        _x = 1;
-    }
-
-    // access own state
-    function getB() external view override returns (uint256) {
-        return _x;
-    }
-
-    function setB(uint256 newB) external override {
-        _x = newB;
-    }
-
-    // access state from parent contract A
-    function getAfromB() external view override returns (uint256) {
-        return this.getA();
-    }
-}

package/contracts/experiment/inheritance/C.sol

@@ -1,34 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {ISharedA} from "./IA.sol";
-import {IB} from "./IB.sol";
-import {IC} from "./IC.sol";
-
-abstract contract C is ISharedA, IC {
-    uint256 private _x;
-
-    constructor() {
-        _x = 2;
-    }
-
-    // access own state
-    function getC() external view override returns (uint256) {
-        return _x;
-    }
-
-    function setC(uint256 newC) external override {
-        _x = newC;
-    }
-
-    // access state from parent contract A
-    function getAfromC() external view override returns (uint256) {
-        return this.getA();
-    }
-
-    // access state from other module B
-    function getBfromC() external view override returns (uint256) {
-        IB b = IB(address(this));
-        return b.getB();
-    }
-}

package/contracts/experiment/inheritance/IA.sol

@@ -1,13 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IB} from "./IB.sol";
-import {IC} from "./IC.sol";
-
-interface ISharedA {
-    function getA() external view returns (uint256);
-
-    function setA(uint256 newA) external;
-}
-
-interface IA is ISharedA, IB, IC {}

package/contracts/experiment/inheritance/IB.sol

@@ -1,10 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-interface IB {
-    function getAfromB() external view returns (uint256);
-
-    function getB() external view returns (uint256);
-
-    function setB(uint256 newA) external;
-}

package/contracts/experiment/inheritance/IC.sol

@@ -1,12 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-interface IC {
-    function getAfromC() external view returns (uint256);
-
-    function getBfromC() external view returns (uint256);
-
-    function getC() external view returns (uint256);
-
-    function setC(uint256 newA) external;
-}

package/contracts/experiment/statemachine/Dummy.sol

@@ -1,27 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {ObjectType} from "../../types/ObjectType.sol";
-import {StateId, toStateId, zeroStateId} from "../../types/StateId.sol";
-
-contract LifeCycleModule {
-    mapping(ObjectType objectType => StateId initialState)
-        private _initialState;
-
-    mapping(ObjectType objectType => mapping(StateId stateFrom => mapping(StateId stateTo => bool isValid)))
-        private _isValidTransition;
-
-    function getInitialState(
-        ObjectType objectType
-    ) external view returns (StateId) {
-        return _initialState[objectType];
-    }
-
-    function isValidTransition(
-        ObjectType objectType,
-        StateId fromId,
-        StateId toId
-    ) external view returns (bool) {
-        return _isValidTransition[objectType][fromId][toId];
-    }
-}

package/contracts/experiment/statemachine/ISM.sol

@@ -1,25 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {StateId} from "../../types/StateId.sol";
-
-interface ISMEE {
-    error ErrorInitialStateUndefined();
-    error ErrorStartStateUndefined();
-    error ErrorNextStateUndefined();
-    error ErrorStateChangeInvalid(StateId currentStateId, StateId newStateId);
-
-    event LogInitialStateSet(StateId initialStateId);
-    event LogStateChanged(StateId oldStateId, StateId newStateId);
-}
-
-interface ISM is ISMEE {
-    function changeToState(StateId newStateId) external;
-
-    function isValidTransition(
-        StateId currentStateId,
-        StateId newStateId
-    ) external view returns (bool isValid);
-
-    function getState() external view returns (StateId currentStateId);
-}

package/contracts/experiment/statemachine/README.md

@@ -1,112 +0,0 @@
-# State Machines
-
-Most GIF objects have a life cycle defined by a state machine.
-
-For each object type the set of possible states is defined together with its initial state and the set of valid state transitions.
-
-## Object Types without States
-
-* Protocol
-* Chains
-* Registries (both chain and main registry)
-
-## Object Types with States
-
-* Tokens
-* Instances
-* Products
-* Oracles
-* Pools
-* Bundles
-* Policies
-* Claim (non-NFT)
-* Payout (non-NFT)
-
-### Simple State Machine
-
-Valid states
-
-* Active (initial state)
-* Paused
-* Archived (final state)
-
-Valid state transitions:
-
-* Active -> Paused
-* Paused -> Active
-* Paused -> Archived
-
-
-Candidate object types for simple state machine
-
-* Token
-* Instance
-* Product
-* Oracle
-* Pool
-
-To discuss: 
-
-* Archived is final state
-* What mechanism should exist to revert an unintended transition to 'Archived' state. Should there be such a mechanism?
-* What mechanism should exist when the NFT of such an object is burned prematurely. Should there be such a mechanism
-
-### Bundle State Machine
-
-Valid states
-
-* Active (initial state)
-* Paused
-* Expired (implicit state)
-* Closed (final state)
-
-Expired is not an explicit state. 
-A bundle is expired for block.timestamp >= expiredAt
-
-### Policy State Machine
-
-Valid states
-
-* Applied (initial state)
-* Revoked (final state)
-* Declined (final state)
-* Active
-* Expired (implicit state)
-* Closed (final state)
-
-Expired is not an explicit state. 
-A policy is expired for block.timestamp >= expiredAt
-
-To discuss: 
-
-* Should 'Closed' be less explicit using a closedAt state variable? 
-* Or even more lighweight? ie. block.timestamp >= expiredAt and no open claims
-
-Valid state transitions:
-
-* Applied -> Revoked
-* Applied -> Declined
-* Applied -> Active
-* Active -> Closed (needs to be expired)
-
-### Claim State Machine
-
-Valid states
-* Applied (initial state)
-* Confirmed
-* Declined (final state)
-* Closed (final state)
-
-Valid state transitions:
-* Applied -> Confirmed
-* Applied -> Declined
-* Confirmed -> Closed
-
-### Payout State Machine
-
-Valid states
-* Expected
-* PaidOut
-
-Valid state transitions:
-* Expected -> PaidOut

package/contracts/experiment/statemachine/SM.sol

@@ -1,57 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {StateId, toStateId, zeroStateId} from "../../types/StateId.sol";
-import {ISM} from "./ISM.sol";
-
-contract SM is ISM {
-    mapping(StateId currentState => mapping(StateId newState => bool isValid))
-        private _isValidTransition;
-
-    StateId internal _state;
-
-    function setInitialState(StateId initialStateId) internal {
-        if (initialStateId == zeroStateId()) {
-            revert ErrorInitialStateUndefined();
-        }
-
-        _state = initialStateId;
-    }
-
-    function addTransition(
-        StateId currentStateId,
-        StateId nextStateId
-    ) internal {
-        if (currentStateId == zeroStateId()) {
-            revert ErrorStartStateUndefined();
-        }
-
-        if (nextStateId == zeroStateId()) {
-            revert ErrorNextStateUndefined();
-        }
-
-        _isValidTransition[currentStateId][nextStateId] = true;
-    }
-
-    function changeToState(StateId newStateId) external override {
-        if (!_isValidTransition[_state][newStateId]) {
-            revert ErrorStateChangeInvalid(_state, newStateId);
-        }
-
-        StateId stateOld = _state;
-        _state = newStateId;
-
-        emit LogStateChanged(stateOld, _state);
-    }
-
-    function isValidTransition(
-        StateId currentStateId,
-        StateId newStateId
-    ) external view override returns (bool isValid) {
-        return _isValidTransition[currentStateId][newStateId];
-    }
-
-    function getState() external view override returns (StateId state) {
-        return _state;
-    }
-}