@etherisc/gif-next 0.0.2-ffa91a6-022 → 3.0.0-06d5e8b-738

package/artifacts/contracts/staking/StakingLifecycle.sol/StakingLifecycle.json

@@ -1,205 +0,0 @@
-{
-  "_format": "hh-sol-artifact-1",
-  "contractName": "StakingLifecycle",
-  "sourceName": "contracts/staking/StakingLifecycle.sol",
-  "abi": [
-    {
-      "inputs": [],
-      "stateMutability": "nonpayable",
-      "type": "constructor"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "address",
-          "name": "contractAddress",
-          "type": "address"
-        },
-        {
-          "internalType": "ObjectType",
-          "name": "objectType",
-          "type": "uint8"
-        },
-        {
-          "internalType": "StateId",
-          "name": "actual",
-          "type": "uint8"
-        },
-        {
-          "internalType": "StateId",
-          "name": "required",
-          "type": "uint8"
-        }
-      ],
-      "name": "ErrorFromStateMissmatch",
-      "type": "error"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "address",
-          "name": "contractAddress",
-          "type": "address"
-        },
-        {
-          "internalType": "ObjectType",
-          "name": "objectType",
-          "type": "uint8"
-        },
-        {
-          "internalType": "StateId",
-          "name": "fromStateId",
-          "type": "uint8"
-        },
-        {
-          "internalType": "StateId",
-          "name": "toStateId",
-          "type": "uint8"
-        }
-      ],
-      "name": "ErrorInvalidStateTransition",
-      "type": "error"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "address",
-          "name": "contractAddress",
-          "type": "address"
-        },
-        {
-          "internalType": "ObjectType",
-          "name": "objectType",
-          "type": "uint8"
-        }
-      ],
-      "name": "ErrorNoLifecycle",
-      "type": "error"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "StateId",
-          "name": "stateId",
-          "type": "uint8"
-        },
-        {
-          "internalType": "ObjectType",
-          "name": "objectType",
-          "type": "uint8"
-        },
-        {
-          "internalType": "StateId",
-          "name": "expectedFromId",
-          "type": "uint8"
-        },
-        {
-          "internalType": "StateId",
-          "name": "toId",
-          "type": "uint8"
-        }
-      ],
-      "name": "checkTransition",
-      "outputs": [],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "ObjectType",
-          "name": "objectType",
-          "type": "uint8"
-        }
-      ],
-      "name": "getInitialState",
-      "outputs": [
-        {
-          "internalType": "StateId",
-          "name": "",
-          "type": "uint8"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "ObjectType",
-          "name": "objectType",
-          "type": "uint8"
-        }
-      ],
-      "name": "hasLifecycle",
-      "outputs": [
-        {
-          "internalType": "bool",
-          "name": "",
-          "type": "bool"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "ObjectType",
-          "name": "objectType",
-          "type": "uint8"
-        },
-        {
-          "internalType": "StateId",
-          "name": "fromId",
-          "type": "uint8"
-        },
-        {
-          "internalType": "StateId",
-          "name": "toId",
-          "type": "uint8"
-        }
-      ],
-      "name": "isValidTransition",
-      "outputs": [
-        {
-          "internalType": "bool",
-          "name": "",
-          "type": "bool"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    }
-  ],
-  "bytecode": "0x6080604052348015600e575f80fd5b5060156019565b6089565b6024601f5b60016036565b602c600b601e565b6034601e601e565b565b60ff8281165f90815260208190526040902054161560545760546075565b60ff9182165f908152602081905260409020805460ff191691909216179055565b634e487b7160e01b5f52600160045260245ffd5b610412806100965f395ff3fe608060405234801561000f575f80fd5b506004361061004a575f3560e01c80630d3581811461004e57806354f1fa811461008a578063bf1db3f91461009f578063e9e96c70146100c2575b5f80fd5b61007361005c3660046102fa565b60ff9081165f908152602081905260409020541690565b60405160ff90911681526020015b60405180910390f35b61009d61009836600461031c565b6100ff565b005b6100b26100ad3660046102fa565b61025d565b6040519015158152602001610081565b6100b26100d0366004610375565b60ff9283165f908152600160209081526040808320948616835293815283822092851682529190915220541690565b60ff8381165f908152602081905260409081902054905163037c8cb160e51b81529116600482015273__$2e1fcf62e7a1b3c2a33bdf2228c171b2be$__90636f91962090602401602060405180830381865af4158015610161573d5f803e3d5ffd5b505050506040513d601f19601f8201168201806040525081019061018591906103bd565b156101b35760405163ea01ac1f60e01b815230600482015260ff841660248201526044015b60405180910390fd5b60ff808516908316146101f45760405163bae587e160e01b815230600482015260ff80851660248301528086166044830152831660648201526084016101aa565b60ff8084165f908152600160209081526040808320888516845282528083208585168452909152902054166102575760405163f33b49a360e01b815230600482015260ff80851660248301528086166044830152821660648201526084016101aa565b50505050565b60ff8181165f9081526020819052604080822054905163b2466acf60e01b8152921660048301529073__$2e1fcf62e7a1b3c2a33bdf2228c171b2be$__9063b2466acf90602401602060405180830381865af41580156102bf573d5f803e3d5ffd5b505050506040513d601f19601f820116820180604052508101906102e391906103bd565b92915050565b60ff811681146102f7575f80fd5b50565b5f6020828403121561030a575f80fd5b8135610315816102e9565b9392505050565b5f805f806080858703121561032f575f80fd5b843561033a816102e9565b9350602085013561034a816102e9565b9250604085013561035a816102e9565b9150606085013561036a816102e9565b939692955090935050565b5f805f60608486031215610387575f80fd5b8335610392816102e9565b925060208401356103a2816102e9565b915060408401356103b2816102e9565b809150509250925092565b5f602082840312156103cd575f80fd5b81518015158114610315575f80fdfea264697066735822122045c514fa9412f02e80b94e2ffb0bd53a21a1b2eba9e22f16d7106895c9600c5664736f6c634300081a0033",
-  "deployedBytecode": "0x608060405234801561000f575f80fd5b506004361061004a575f3560e01c80630d3581811461004e57806354f1fa811461008a578063bf1db3f91461009f578063e9e96c70146100c2575b5f80fd5b61007361005c3660046102fa565b60ff9081165f908152602081905260409020541690565b60405160ff90911681526020015b60405180910390f35b61009d61009836600461031c565b6100ff565b005b6100b26100ad3660046102fa565b61025d565b6040519015158152602001610081565b6100b26100d0366004610375565b60ff9283165f908152600160209081526040808320948616835293815283822092851682529190915220541690565b60ff8381165f908152602081905260409081902054905163037c8cb160e51b81529116600482015273__$2e1fcf62e7a1b3c2a33bdf2228c171b2be$__90636f91962090602401602060405180830381865af4158015610161573d5f803e3d5ffd5b505050506040513d601f19601f8201168201806040525081019061018591906103bd565b156101b35760405163ea01ac1f60e01b815230600482015260ff841660248201526044015b60405180910390fd5b60ff808516908316146101f45760405163bae587e160e01b815230600482015260ff80851660248301528086166044830152831660648201526084016101aa565b60ff8084165f908152600160209081526040808320888516845282528083208585168452909152902054166102575760405163f33b49a360e01b815230600482015260ff80851660248301528086166044830152821660648201526084016101aa565b50505050565b60ff8181165f9081526020819052604080822054905163b2466acf60e01b8152921660048301529073__$2e1fcf62e7a1b3c2a33bdf2228c171b2be$__9063b2466acf90602401602060405180830381865af41580156102bf573d5f803e3d5ffd5b505050506040513d601f19601f820116820180604052508101906102e391906103bd565b92915050565b60ff811681146102f7575f80fd5b50565b5f6020828403121561030a575f80fd5b8135610315816102e9565b9392505050565b5f805f806080858703121561032f575f80fd5b843561033a816102e9565b9350602085013561034a816102e9565b9250604085013561035a816102e9565b9150606085013561036a816102e9565b939692955090935050565b5f805f60608486031215610387575f80fd5b8335610392816102e9565b925060208401356103a2816102e9565b915060408401356103b2816102e9565b809150509250925092565b5f602082840312156103cd575f80fd5b81518015158114610315575f80fdfea264697066735822122045c514fa9412f02e80b94e2ffb0bd53a21a1b2eba9e22f16d7106895c9600c5664736f6c634300081a0033",
-  "linkReferences": {
-    "contracts/type/StateId.sol": {
-      "StateIdLib": [
-        {
-          "length": 20,
-          "start": 447
-        },
-        {
-          "length": 20,
-          "start": 797
-        }
-      ]
-    }
-  },
-  "deployedLinkReferences": {
-    "contracts/type/StateId.sol": {
-      "StateIdLib": [
-        {
-          "length": 20,
-          "start": 297
-        },
-        {
-          "length": 20,
-          "start": 647
-        }
-      ]
-    }
-  }
-}

package/contracts/shared/ComponentVerifyingService.sol

@@ -1,128 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {IInstance} from "../instance/IInstance.sol";
-import {InstanceReader} from "../instance/InstanceReader.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
-import {NftId} from "../type/NftId.sol";
-import {ObjectType, COMPONENT, DISTRIBUTION, ORACLE, POOL, PRODUCT, STAKING} from "../type/ObjectType.sol";
-import {Service} from "../shared/Service.sol";
-
-
-abstract contract ComponentVerifyingService is 
-    Service
-{
-    error ErrorComponentVerifyingServiceComponentTypeInvalid(NftId componentNftId, ObjectType expectedType, ObjectType actualType);
-    error ErrorComponentVerifyingServiceComponentIsLocked(NftId componentNftId);
-
-    /// @dev based on the sender address returns the corresponding components nft id, info and instance.
-    /// the function reverts iff:
-    /// - there is no such component
-    /// - the component has the wrong object type
-    /// - the component is locked
-    function _getAndVerifyActiveComponent(
-        ObjectType expectedType // assume always of `component` type
-    )
-        internal
-        view
-        returns(
-            NftId componentNftId,
-            IRegistry.ObjectInfo memory objectInfo, 
-            IInstance instance
-        )
-    {
-        componentNftId = getRegistry().getNftIdForAddress(msg.sender);
-        (objectInfo, instance) = _getAndVerifyComponentInfo(
-            componentNftId, 
-            expectedType,
-            true); // only active
-    }
-
-
-    /// @dev returns the component info and instance contract reference given a component nft id
-    /// the function reverts iff:
-    /// - there is no such component
-    /// - the component has the wrong object type
-    function _getAndVerifyComponentInfo(
-        NftId componentNftId,
-        ObjectType expectedType, // assume always of `component` type
-        bool onlyActive
-    )
-        internal
-        virtual
-        view
-        returns(
-            IRegistry.ObjectInfo memory info, 
-            IInstance instance
-        )
-    {
-        IRegistry registry = getRegistry();
-        info = registry.getObjectInfo(componentNftId);
-
-        // if not COMPONENT require exact match
-        if(expectedType != COMPONENT()) {
-            // ensure component is of expected type
-            if(info.objectType != expectedType) {
-                revert ErrorComponentVerifyingServiceComponentTypeInvalid(
-                    componentNftId,
-                    expectedType,
-                    info.objectType);
-            }
-        } else {
-            if(!(info.objectType == PRODUCT()
-                || info.objectType == POOL()
-                || info.objectType == DISTRIBUTION()
-                || info.objectType == ORACLE()
-            ))
-            {
-                revert ErrorComponentVerifyingServiceComponentTypeInvalid(
-                    componentNftId,
-                    expectedType,
-                    info.objectType);
-            }
-        }
-
-        if (info.objectType == STAKING()) {
-            return (info, instance);
-        }
-        
-        if (info.objectType == PRODUCT()) {
-            instance = _getInstance(registry, info.parentNftId);
-        } else {
-            instance = _getInstanceForComponent(registry, info.parentNftId);
-        }
-
-        // ensure component is not locked
-        if (onlyActive) {
-            if (instance.getInstanceAdmin().isTargetLocked(info.objectAddress)) {
-                revert ErrorComponentVerifyingServiceComponentIsLocked(componentNftId);
-            }
-        }
-    }
-
-
-    function _getInstanceForComponent(IRegistry registry, NftId productNftId)
-        internal
-        view
-        returns (IInstance instance)
-    {
-        return _getInstance(
-                registry,
-                registry.getObjectInfo(
-                    productNftId).parentNftId);
-    }
-
-
-    /// @dev returns the product nft id from the registry.
-    /// assumes the component nft id is valid and represents a product linked component.
-    function _getProductNftId(NftId componentNftId) internal view returns (NftId productNftId) {
-        productNftId = getRegistry().getParentNftId(componentNftId);
-    }
-
-
-    /// @dev returns an IInstance contract reference for the specified instance nft id
-    function _getInstance(IRegistry registry, NftId instanceNftId) internal view returns (IInstance) {
-        return IInstance(
-            registry.getObjectAddress(instanceNftId));
-    }
-}

package/contracts/shared/IKeyValueStore.sol

@@ -1,54 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {Blocknumber, blockBlocknumber, zeroBlocknumber} from "../type/Blocknumber.sol";
-import {Key32, KeyId} from "../type/Key32.sol";
-import {NftId} from "../type/NftId.sol";
-import {ObjectType} from "../type/ObjectType.sol";
-import {StateId} from "../type/StateId.sol";
-
-import {ILifecycle} from "./ILifecycle.sol";
-
-interface IKeyValueStore is ILifecycle {
-
-    error ErrorKeyValueStoreTypeUndefined(ObjectType objectType);
-    error ErrorKeyValueStoreAlreadyCreated(Key32 key, ObjectType objectType);
-    error ErrorKeyValueStoreNoLifecycle(ObjectType objectType);
-    error ErrorKeyValueStoreStateZero(Key32 key);
-    error ErrorKeyValueStoreNotExisting(Key32 key);
-
-    event LogInfoCreated(ObjectType objectType, KeyId keyId, StateId state, address createdBy, address txOrigin);
-    event LogInfoUpdated(ObjectType objectType, KeyId keyId, StateId state, address updatedBy, address txOrigin, Blocknumber lastUpdatedIn);
-    event LogStateUpdated(ObjectType objectType, KeyId keyId, StateId stateOld, StateId stateNew, address updatedBy, address txOrigin, Blocknumber lastUpdatedIn);
-
-    struct Value {
-        Metadata metadata;
-        bytes data;
-    }
-
-    struct Metadata {
-        ObjectType objectType;
-        StateId state;
-        // TODO updatedBy needs concept that says what value should go here
-        // eg account outside gif objects that initiated the tx
-        // implies the caller needs to be propagated through all calls up to key values store itself
-        // to always have the instance address there doesn't seem to make sense
-        // address updatedBy;
-        Blocknumber updatedIn;
-        Blocknumber createdIn;
-    }
-
-    // generic state changing functions
-    // function create(Key32 key, bytes memory data) external;
-    // function update(Key32 key, bytes memory data, StateId state) external;
-    // function updateData(Key32 key, bytes memory data) external;
-    // function updateState(Key32 key, StateId state) external;
-
-    function exists(Key32 key) external view returns (bool);
-    function get(Key32 key) external view returns (Value memory value);
-    function getData(Key32 key) external view returns (bytes memory data);
-    function getMetadata(Key32 key) external view returns (Metadata memory metadata);
-    function getState(Key32 key) external view returns (StateId state);
-
-    function toKey32(ObjectType objectType, KeyId id) external pure returns(Key32);
-}

package/contracts/shared/KeyValueStore.sol

@@ -1,131 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {Blocknumber, blockBlocknumber, zeroBlocknumber} from "../type/Blocknumber.sol";
-import {Key32, KeyId, Key32Lib} from "../type/Key32.sol";
-import {NftId} from "../type/NftId.sol";
-import {ObjectType} from "../type/ObjectType.sol";
-import {StateId, ACTIVE, KEEP_STATE} from "../type/StateId.sol";
-import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
-
-import {Lifecycle} from "./Lifecycle.sol";
-import {IKeyValueStore} from "./IKeyValueStore.sol";
-
-abstract contract KeyValueStore is
-    Lifecycle, 
-    IKeyValueStore
-{
-
-    mapping(Key32 key32 => Value value) private _value;
-
-    function _create(
-        Key32 key32, 
-        bytes memory data
-    )
-        internal
-    {
-        ObjectType objectType = key32.toObjectType();
-        if (objectType.eqz()) {
-            revert ErrorKeyValueStoreTypeUndefined(objectType);
-        }
-
-        Metadata storage metadata = _value[key32].metadata;
-        if (metadata.state.gtz()) {
-            revert ErrorKeyValueStoreAlreadyCreated(key32, objectType);
-        }
-
-        if(!hasLifecycle(objectType)) {
-            revert ErrorKeyValueStoreNoLifecycle(objectType);
-        }
-
-        Blocknumber blocknumber = blockBlocknumber();
-        StateId initialState = getInitialState(objectType);
-
-        // set metadata
-        metadata.objectType = objectType;
-        metadata.state = initialState;
-        metadata.updatedIn = blocknumber;
-        metadata.createdIn = blocknumber;
-
-        // set data
-        _value[key32].data = data;
-
-        // solhint-disable-next-line avoid-tx-origin
-        emit LogInfoCreated(key32.toObjectType(), key32.toKeyId(), initialState, msg.sender, tx.origin);
-    }
-
-
-    function _update(
-        Key32 key32, 
-        bytes memory data,
-        StateId state
-    ) 
-        internal
-    {
-        // update state
-        Blocknumber lastUpdatedIn = _updateState(key32, state);
-
-        // update data
-        _value[key32].data = data;
-
-        // solhint-disable-next-line avoid-tx-origin
-        emit LogInfoUpdated(key32.toObjectType(), key32.toKeyId(), state, msg.sender, tx.origin, lastUpdatedIn);
-    }
-
-
-    function _updateState(
-        Key32 key32, 
-        StateId state
-    )
-        internal
-        returns (Blocknumber lastUpdatedIn)
-    {
-        if (state.eqz()) {
-            revert ErrorKeyValueStoreStateZero(key32);
-        }
-
-        Metadata storage metadata = _value[key32].metadata;
-        StateId stateOld = metadata.state;
-        lastUpdatedIn = metadata.updatedIn;
-
-        if (stateOld.eqz()) {
-            revert ErrorKeyValueStoreNotExisting(key32);
-        }
-
-        // update state 
-        if(state != KEEP_STATE()) {
-            checkTransition(stateOld, metadata.objectType, stateOld, state);
-            metadata.state = state;
-
-            // solhint-disable-next-line avoid-tx-origin
-            emit LogStateUpdated(key32.toObjectType(), key32.toKeyId(), stateOld, state, msg.sender, tx.origin, lastUpdatedIn);
-        }
-
-        // update metadata
-        metadata.updatedIn = blockBlocknumber();
-    }
-
-    function exists(Key32 key32) public view returns (bool) {
-        return _value[key32].metadata.state.gtz();
-    }
-
-    function get(Key32 key32) public view returns (Value memory value) {
-        return _value[key32];
-    }
-
-    function getMetadata(Key32 key32) public view returns (Metadata memory metadata) {
-        return _value[key32].metadata;
-    }
-
-    function getData(Key32 key32) public view returns (bytes memory data) {
-        return _value[key32].data;
-    }
-
-    function getState(Key32 key32) public view returns (StateId state) {
-        return _value[key32].metadata.state;
-    }
-
-    function toKey32(ObjectType objectType, KeyId id) external pure override returns(Key32) {
-        return Key32Lib.toKey32(objectType, id);
-    }
-}

package/contracts/staking/StakingLifecycle.sol

@@ -1,23 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {TARGET, COMPONENT, STAKE} from "../type/ObjectType.sol";
-import {INITIAL} from "../type/StateId.sol";
-import {Lifecycle} from "../shared/Lifecycle.sol";
-
-contract StakingLifecycle is
-    Lifecycle
-{
-    constructor() {
-        _setupLifecycle();
-    }
-
-    function _setupLifecycle()
-        internal
-        override
-    {
-        setInitialState(TARGET(), INITIAL());
-        setInitialState(COMPONENT(), INITIAL());
-        setInitialState(STAKE(), INITIAL());
-    }
-}