@etherisc/gif-next 0.0.2-d408403-475 → 0.0.2-d48ae55-246

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/f93a8e80452dc32f10ebad6b13365e96.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/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/instance/IInstanceLinked.sol

@@ -1,8 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IInstance} from "./IInstance.sol";
-
-interface IInstanceLinked {
-    function getInstance() external view returns (IInstance instance);
-}

package/contracts/instance/base/ComponentServiceBase.sol

@@ -1,42 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IRegistry} from "../../registry/IRegistry.sol";
-import {IInstance} from "../../instance/IInstance.sol";
-import {ObjectType, INSTANCE, PRODUCT, POOL} from "../../types/ObjectType.sol";
-import {NftId, NftIdLib} from "../../types/NftId.sol";
-
-import {ServiceBase} from "./ServiceBase.sol";
-
-abstract contract ComponentServiceBase is ServiceBase {
-
-    constructor(
-        address registry,
-        NftId registryNftId
-    )
-        ServiceBase(registry, registryNftId)
-    // solhint-disable-next-line no-empty-blocks
-    {
-    }
-
-
-    function _getAndVerifyComponentInfoAndInstance(
-        ObjectType objectType
-    )
-        internal
-        view
-        returns(
-            IRegistry.ObjectInfo memory info, 
-            IInstance instance
-        )
-    {
-        NftId componentNftId = _registry.getNftId(msg.sender);
-        require(componentNftId.gtz(), "ERROR_COMPONENT_UNKNOWN");
-
-        info = _registry.getObjectInfo(componentNftId);
-        require(info.objectType == objectType, "OBJECT_TYPE_INVALID");
-
-        address instanceAddress = _registry.getObjectInfo(info.parentNftId).objectAddress;
-        instance = IInstance(instanceAddress);
-    }
-}

package/contracts/instance/base/IInstanceBase.sol

@@ -1,22 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {Key32} from "../../types/Key32.sol";
-import {StateId} from "../../types/StateId.sol";
-
-import {IKeyValueStore} from "./IKeyValueStore.sol";
-import {IComponentOwnerService} from "../service/IComponentOwnerService.sol";
-import {IDistributionService} from "../service/IDistributionService.sol";
-import {IProductService} from "../service/IProductService.sol";
-import {IPoolService} from "../service/IPoolService.sol";
-
-interface IInstanceBase {
-    function getKeyValueStore() external view returns (IKeyValueStore keyValueStore);
-    function updateState(Key32 key, StateId state) external;
-    function getState(Key32 key) external view returns (StateId state);
-
-    function getComponentOwnerService() external view returns(IComponentOwnerService service);
-    function getDistributionService() external view returns(IDistributionService);
-    function getProductService() external view returns(IProductService service);
-    function getPoolService() external view returns(IPoolService service);
-}

package/contracts/instance/base/IService.sol

@@ -1,15 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {VersionPart} from "../../types/Version.sol";
-
-import {IRegisterable} from "../../shared/IRegisterable.sol";
-import {IVersionable} from "../../shared/IVersionable.sol";
-
-interface IService is 
-    IRegisterable,
-    IVersionable
-{
-    function getName() external pure returns(string memory name);
-    function getMajorVersion() external view returns(VersionPart majorVersion);
-}

package/contracts/instance/base/InstanceBase.sol

@@ -1,91 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {Versionable} from "../../shared/Versionable.sol";
-import {Registerable} from "../../shared/Registerable.sol";
-
-import {ObjectType, INSTANCE} from "../../types/ObjectType.sol";
-import {Key32} from "../../types/Key32.sol";
-import {NftId} from "../../types/NftId.sol";
-import {StateId} from "../../types/StateId.sol";
-import {Version, VersionPart, VersionLib} from "../../types/Version.sol";
-
-import {IComponentOwnerService} from "../service/IComponentOwnerService.sol";
-import {IDistributionService} from "../service/IDistributionService.sol";
-import {IProductService} from "../service/IProductService.sol";
-import {IPoolService} from "../service/IPoolService.sol";
-
-import {IKeyValueStore} from "./IKeyValueStore.sol";
-import {IInstance} from "../IInstance.sol";
-import {IInstanceBase} from "./IInstanceBase.sol";
-
-import {KeyValueStore} from "./KeyValueStore.sol";
-
-abstract contract InstanceBase is
-    Versionable,
-    Registerable,
-    IInstanceBase
-{
-    IKeyValueStore internal _keyValueStore;
-
-    IComponentOwnerService internal _componentOwnerService;
-    IDistributionService internal _distributionService;
-    IProductService internal _productService;
-    IPoolService internal _poolService;
-
-    constructor(
-        address registry,
-        NftId registryNftId
-    )
-        Registerable(registry, registryNftId)
-        Versionable()
-    {
-        _keyValueStore = new KeyValueStore();
-
-        _registerInterface(type(IInstance).interfaceId);
-        _linkToServicesInRegistry();
-    }
-
-    function getKeyValueStore() public view virtual override returns (IKeyValueStore keyValueStore) { return _keyValueStore; }
-
-    function updateState(Key32 key, StateId state) external override {
-        _keyValueStore.updateState(key, state);
-    }
-
-    function getState(Key32 key) external view override returns (StateId state) {
-        return _keyValueStore.getState(key);
-    }
-
-    // from versionable
-    function getVersion()
-        public 
-        pure 
-        virtual override
-        returns(Version)
-    {
-        return VersionLib.toVersion(3,0,0);
-    }
-
-    // from registerable
-    function getType() external pure override returns (ObjectType objectType) {
-        return INSTANCE();
-    }
-
-
-    // internal / private functions
-    function _linkToServicesInRegistry() internal {
-        VersionPart majorVersion = getVersion().toMajorPart();
-        _componentOwnerService = IComponentOwnerService(_getAndCheck("ComponentOwnerService", majorVersion));
-        _distributionService = IDistributionService(_getAndCheck("DistributionService", majorVersion));
-        _productService = IProductService(_getAndCheck("ProductService", majorVersion));
-        _poolService = IPoolService(_getAndCheck("PoolService", majorVersion));
-    }
-
-    function _getAndCheck(string memory serviceName, VersionPart majorVersion) internal view returns (address serviceAddress) {
-        serviceAddress = _registry.getServiceAddress(serviceName, majorVersion);
-        require(
-            serviceAddress != address(0),
-            "ERROR:INS-001:NOT_REGISTERED"
-        );
-    }
-}

package/contracts/instance/base/ModuleBase.sol

@@ -1,57 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IRegistry} from "../../registry/IRegistry.sol";
-
-import {Blocknumber, blockNumber} from "../../types/Blocknumber.sol";
-import {Key32, KeyId} from "../../types/Key32.sol";
-import {LibNftIdSet} from "../../types/NftIdSet.sol";
-import {NftId} from "../../types/NftId.sol";
-import {ObjectType, PRODUCT, ORACLE, POOL, BUNDLE, POLICY} from "../../types/ObjectType.sol";
-import {StateId, ACTIVE, PAUSED, ARCHIVED, CLOSED, APPLIED, REVOKED, DECLINED} from "../../types/StateId.sol";
-import {Timestamp, blockTimestamp, zeroTimestamp} from "../../types/Timestamp.sol";
-
-import {IKeyValueStore} from "./IKeyValueStore.sol";
-
-abstract contract ModuleBase {
-
-    IKeyValueStore private _store;
-
-    function _initialize(IKeyValueStore keyValueStore) internal {
-        _store = keyValueStore;
-    }
-
-    function _create(ObjectType objectType, Key32 key, bytes memory data) internal {
-        _store.create(
-            key, 
-            objectType,
-            data);
-    }
-
-    function _create(ObjectType objectType, NftId nftId, bytes memory data) internal {
-        _store.create(
-            nftId.toKey32(objectType), 
-            objectType,
-            data);
-    }
-
-    function _updateData(ObjectType objectType, NftId nftId, bytes memory data) internal {
-        _store.updateData(nftId.toKey32(objectType), data);
-    }
-
-    function _updateState(ObjectType objectType, NftId nftId, StateId state) internal {
-        _store.updateState(nftId.toKey32(objectType), state);
-    }
-
-    function _exists(ObjectType objectType, NftId nftId) internal view returns (bool hasData) {
-        return _store.exists(nftId.toKey32(objectType));
-    }
-
-    function _getData(ObjectType objectType, NftId nftId) internal view returns(bytes memory data) {
-        return _store.getData(nftId.toKey32(objectType));
-    }
-
-    function _getState(ObjectType objectType, NftId nftId) internal view returns(StateId) {
-        return _store.getState(nftId.toKey32(objectType));
-    }
-}

package/contracts/instance/base/ServiceBase.sol

@@ -1,37 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {NftId, zeroNftId} from "../../types/NftId.sol";
-import {ObjectType, SERVICE} from "../../types/ObjectType.sol";
-import {Version, VersionPart} from "../../types/Version.sol";
-
-import {Registerable} from "../../shared/Registerable.sol";
-import {IVersionable} from "../../shared/IVersionable.sol";
-import {Versionable} from "../../shared/Versionable.sol";
-
-import {IService} from "./IService.sol";
-
-abstract contract ServiceBase is 
-    Registerable,
-    Versionable,
-    IService
-{
-
-    constructor(
-        address registry,
-        NftId registryNftId
-    )
-        Registerable(registry, registryNftId)
-        Versionable()
-    {
-        _registerInterface(type(IService).interfaceId);
-    }
-
-    function getMajorVersion() external view override returns(VersionPart majorVersion) {
-        return this.getVersion().toMajorPart();
-    }
-
-    function getType() external pure override returns (ObjectType) {
-        return SERVICE();
-    }
-}