cyberia 3.0.3 → 3.2.5

package/hardhat/contracts/ObjectLayerToken.sol

@@ -0,0 +1,391 @@
+// SPDX-License-Identifier: MIT
+// Compatible with OpenZeppelin Contracts ^5.0.0
+pragma solidity ^0.8.20;
+
+import '@openzeppelin/contracts/token/ERC1155/ERC1155.sol';
+import '@openzeppelin/contracts/token/ERC1155/extensions/ERC1155Burnable.sol';
+import '@openzeppelin/contracts/token/ERC1155/extensions/ERC1155Pausable.sol';
+import '@openzeppelin/contracts/token/ERC1155/extensions/ERC1155Supply.sol';
+import '@openzeppelin/contracts/access/Ownable.sol';
+
+/**
+ * @title ObjectLayerToken
+ * @dev A unified ERC-1155 multi-token contract for the Cyberia Online Object Layer ecosystem.
+ *
+ * A single ERC-1155 contract that represents both fungible and non-fungible tokens
+ * within the Object Layer paradigm.
+ *
+ * Token ID semantics:
+ *   - Token ID 0 (CRYPTOKOYN): Fungible in-game currency.
+ *     Minted with 18-decimal supply; divisible and stackable.
+ *   - Token IDs >= 1: Object Layer item tokens. Each token ID is derived from
+ *     `uint256(keccak256(abi.encodePacked(namespace, itemId)))`.
+ *     - Supply of 1 → non-fungible (unique gear).
+ *     - Supply > 1 → semi-fungible (stackable resources, consumables).
+ *
+ * Object Layer mapping:
+ *   Each on-chain token ID corresponds to an off-chain ObjectLayer document whose
+ *   `data.ledger` field references this contract:
+ *     {
+ *       "type": "ERC-1155",
+ *       "address": "<this contract address>",
+ *       "tokenId": "<uint256 token id>"
+ *     }
+ *
+ *   The token URI resolves to `ipfs://{metadataCid}/{tokenId}.json` where
+ *   metadataCid is the IPFS CID stored in `data.render.metadataCid`.
+ *
+ * Features:
+ *   - Mint / batch-mint (owner only) — register new Object Layer items on-chain.
+ *   - Burn / batch-burn — holders can destroy tokens.
+ *   - Pause / unpause — owner can freeze all transfers (emergency governance).
+ *   - Supply tracking — on-chain total supply per token ID via ERC1155Supply.
+ *   - On-chain item registry — maps token IDs to IPFS metadata CIDs and item identifiers.
+ *
+ * Designed for deployment on Hyperledger Besu (IBFT2/QBFT) private networks via Hardhat.
+ */
+contract ObjectLayerToken is ERC1155, ERC1155Burnable, ERC1155Pausable, ERC1155Supply, Ownable {
+  // ──────────────────────────────────────────────────────────────────────
+  // Constants
+  // ──────────────────────────────────────────────────────────────────────
+
+  /**
+   * @dev Token ID 0 is the fungible in-game currency (CryptoKoyn / CKY equivalent).
+   */
+  uint256 public constant CRYPTOKOYN = 0;
+
+  /**
+   * @dev Initial fungible supply minted to the deployer (10 million with 18 decimals).
+   */
+  uint256 public constant INITIAL_CRYPTOKOYN_SUPPLY = 10_000_000 * 1e18;
+
+  // ──────────────────────────────────────────────────────────────────────
+  // State
+  // ──────────────────────────────────────────────────────────────────────
+
+  /**
+   * @dev Base URI prefix for token metadata (e.g. "ipfs://").
+   */
+  string private _baseTokenURI;
+
+  /**
+   * @dev Per-token-ID metadata CID override. When set, the full URI becomes
+   *      `{_baseTokenURI}{_tokenCIDs[id]}`.
+   */
+  mapping(uint256 => string) private _tokenCIDs;
+
+  /**
+   * @dev Human-readable item identifier for each registered token ID.
+   *      Maps tokenId → itemId string (e.g. "hatchet", "gold-ore").
+   */
+  mapping(uint256 => string) private _itemIds;
+
+  /**
+   * @dev Reverse lookup: keccak256(itemId) → tokenId. Used to prevent duplicate registrations.
+   */
+  mapping(bytes32 => uint256) private _itemIdToTokenId;
+
+  /**
+   * @dev Counter tracking the next sequential token ID for auto-registration.
+   *      Starts at 1 because token ID 0 is reserved for CRYPTOKOYN.
+   */
+  uint256 private _nextTokenId;
+
+  // ──────────────────────────────────────────────────────────────────────
+  // Events
+  // ──────────────────────────────────────────────────────────────────────
+
+  /**
+   * @dev Emitted when a new Object Layer item is registered on-chain.
+   * @param tokenId The ERC-1155 token ID assigned to this item.
+   * @param itemId The human-readable item identifier (e.g. "hatchet").
+   * @param metadataCid The IPFS CID pointing to the item's metadata JSON.
+   * @param initialSupply The number of tokens minted in the registration transaction.
+   */
+  event ObjectLayerRegistered(uint256 indexed tokenId, string itemId, string metadataCid, uint256 initialSupply);
+
+  /**
+   * @dev Emitted when a token's metadata CID is updated.
+   * @param tokenId The ERC-1155 token ID whose metadata was updated.
+   * @param metadataCid The new IPFS CID.
+   */
+  event MetadataUpdated(uint256 indexed tokenId, string metadataCid);
+
+  // ──────────────────────────────────────────────────────────────────────
+  // Constructor
+  // ──────────────────────────────────────────────────────────────────────
+
+  /**
+   * @dev Deploys the contract, mints the initial CryptoKoyn supply to the deployer,
+   *      and registers token ID 0 as the fungible currency.
+   * @param initialOwner The address that will own the contract and receive the initial supply.
+   * @param baseURI The base URI prefix for metadata resolution (e.g. "ipfs://").
+   */
+  constructor(address initialOwner, string memory baseURI) ERC1155(baseURI) Ownable(initialOwner) {
+    _baseTokenURI = baseURI;
+    _nextTokenId = 1;
+
+    // Register and mint the fungible currency token
+    _itemIds[CRYPTOKOYN] = 'cryptokoyn';
+    _itemIdToTokenId[keccak256(abi.encodePacked('cryptokoyn'))] = CRYPTOKOYN;
+    _mint(initialOwner, CRYPTOKOYN, INITIAL_CRYPTOKOYN_SUPPLY, '');
+
+    emit ObjectLayerRegistered(CRYPTOKOYN, 'cryptokoyn', '', INITIAL_CRYPTOKOYN_SUPPLY);
+  }
+
+  // ──────────────────────────────────────────────────────────────────────
+  // URI
+  // ──────────────────────────────────────────────────────────────────────
+
+  /**
+   * @dev Returns the metadata URI for a given token ID.
+   *      If a per-token CID is set, returns `{baseURI}{cid}`.
+   *      Otherwise falls back to the ERC-1155 default `{baseURI}{id}.json`.
+   * @param tokenId The token ID to query.
+   * @return The full metadata URI string.
+   */
+  function uri(uint256 tokenId) public view override returns (string memory) {
+    string memory tokenCid = _tokenCIDs[tokenId];
+    if (bytes(tokenCid).length > 0) {
+      return string(abi.encodePacked(_baseTokenURI, tokenCid));
+    }
+    return super.uri(tokenId);
+  }
+
+  /**
+   * @dev Updates the base URI prefix. Only callable by the owner.
+   * @param newBaseURI The new base URI string.
+   */
+  function setBaseURI(string calldata newBaseURI) external onlyOwner {
+    _baseTokenURI = newBaseURI;
+    _setURI(newBaseURI);
+  }
+
+  /**
+   * @dev Sets or updates the IPFS metadata CID for a specific token ID.
+   *      Only callable by the owner.
+   * @param tokenId The token ID to update.
+   * @param metadataCid The new IPFS CID string.
+   */
+  function setTokenMetadataCID(uint256 tokenId, string calldata metadataCid) external onlyOwner {
+    _tokenCIDs[tokenId] = metadataCid;
+    emit MetadataUpdated(tokenId, metadataCid);
+    emit URI(uri(tokenId), tokenId);
+  }
+
+  // ──────────────────────────────────────────────────────────────────────
+  // Object Layer Registration
+  // ──────────────────────────────────────────────────────────────────────
+
+  /**
+   * @dev Computes the deterministic token ID for a given item identifier.
+   * @param itemId The human-readable item identifier string.
+   * @return The uint256 token ID derived from keccak256.
+   */
+  function computeTokenId(string calldata itemId) public pure returns (uint256) {
+    return uint256(keccak256(abi.encodePacked('cyberia.object-layer:', itemId)));
+  }
+
+  /**
+   * @dev Registers a new Object Layer item on-chain and mints the initial supply.
+   *      The token ID is deterministically derived from the item identifier.
+   *      Reverts if the item identifier has already been registered.
+   *
+   *      For unique (non-fungible) items, set `initialSupply` to 1.
+   *      For stackable (semi-fungible) items, set `initialSupply` > 1.
+   *
+   * @param to The address to receive the minted tokens.
+   * @param itemId The human-readable item identifier (e.g. "hatchet", "gold-ore").
+   * @param metadataCid The IPFS CID for the item's metadata JSON.
+   * @param initialSupply The number of tokens to mint.
+   * @param data Additional data forwarded to the ERC-1155 receiver hook.
+   * @return tokenId The assigned ERC-1155 token ID.
+   */
+  function registerObjectLayer(
+    address to,
+    string calldata itemId,
+    string calldata metadataCid,
+    uint256 initialSupply,
+    bytes calldata data
+  ) external onlyOwner returns (uint256 tokenId) {
+    bytes32 itemHash = keccak256(abi.encodePacked(itemId));
+    require(
+      (_itemIdToTokenId[itemHash] == 0 && bytes(_itemIds[0]).length > 0) || _itemIdToTokenId[itemHash] == 0,
+      'ObjectLayerToken: item already registered'
+    );
+
+    tokenId = computeTokenId(itemId);
+
+    // Prevent collision with an existing different item at the same hash-derived ID
+    require(bytes(_itemIds[tokenId]).length == 0, 'ObjectLayerToken: token ID collision');
+
+    _itemIds[tokenId] = itemId;
+    _itemIdToTokenId[itemHash] = tokenId;
+
+    if (bytes(metadataCid).length > 0) {
+      _tokenCIDs[tokenId] = metadataCid;
+    }
+
+    if (initialSupply > 0) {
+      _mint(to, tokenId, initialSupply, data);
+    }
+
+    emit ObjectLayerRegistered(tokenId, itemId, metadataCid, initialSupply);
+  }
+
+  /**
+   * @dev Batch-registers multiple Object Layer items in a single transaction.
+   * @param to The address to receive all minted tokens.
+   * @param itemIds Array of human-readable item identifiers.
+   * @param metadataCids Array of IPFS CIDs for each item's metadata.
+   * @param supplies Array of initial supply amounts for each item.
+   * @param data Additional data forwarded to the ERC-1155 receiver hook.
+   * @return tokenIds Array of assigned ERC-1155 token IDs.
+   */
+  function batchRegisterObjectLayers(
+    address to,
+    string[] calldata itemIds,
+    string[] calldata metadataCids,
+    uint256[] calldata supplies,
+    bytes calldata data
+  ) external onlyOwner returns (uint256[] memory tokenIds) {
+    require(
+      itemIds.length == metadataCids.length && itemIds.length == supplies.length,
+      'ObjectLayerToken: array length mismatch'
+    );
+
+    tokenIds = new uint256[](itemIds.length);
+    uint256[] memory mintIds = new uint256[](itemIds.length);
+    uint256[] memory mintAmounts = new uint256[](itemIds.length);
+
+    for (uint256 i = 0; i < itemIds.length; i++) {
+      uint256 tokenId = computeTokenId(itemIds[i]);
+
+      require(bytes(_itemIds[tokenId]).length == 0, 'ObjectLayerToken: item already registered or token ID collision');
+
+      bytes32 itemHash = keccak256(abi.encodePacked(itemIds[i]));
+      _itemIds[tokenId] = itemIds[i];
+      _itemIdToTokenId[itemHash] = tokenId;
+
+      if (bytes(metadataCids[i]).length > 0) {
+        _tokenCIDs[tokenId] = metadataCids[i];
+      }
+
+      tokenIds[i] = tokenId;
+      mintIds[i] = tokenId;
+      mintAmounts[i] = supplies[i];
+
+      emit ObjectLayerRegistered(tokenId, itemIds[i], metadataCids[i], supplies[i]);
+    }
+
+    _mintBatch(to, mintIds, mintAmounts, data);
+  }
+
+  // ──────────────────────────────────────────────────────────────────────
+  // Minting (additional supply for existing tokens)
+  // ──────────────────────────────────────────────────────────────────────
+
+  /**
+   * @dev Mints additional supply for an existing token ID. Only callable by the owner.
+   * @param to The address to receive the minted tokens.
+   * @param tokenId The token ID to mint.
+   * @param amount The number of tokens to mint.
+   * @param data Additional data forwarded to the ERC-1155 receiver hook.
+   */
+  function mint(address to, uint256 tokenId, uint256 amount, bytes calldata data) external onlyOwner {
+    _mint(to, tokenId, amount, data);
+  }
+
+  /**
+   * @dev Batch-mints additional supply for multiple existing token IDs.
+   *      Only callable by the owner.
+   * @param to The address to receive all minted tokens.
+   * @param ids Array of token IDs.
+   * @param amounts Array of amounts to mint for each token ID.
+   * @param data Additional data forwarded to the ERC-1155 receiver hook.
+   */
+  function mintBatch(
+    address to,
+    uint256[] calldata ids,
+    uint256[] calldata amounts,
+    bytes calldata data
+  ) external onlyOwner {
+    _mintBatch(to, ids, amounts, data);
+  }
+
+  // ──────────────────────────────────────────────────────────────────────
+  // Pause / Unpause
+  // ──────────────────────────────────────────────────────────────────────
+
+  /**
+   * @dev Pauses all token transfers. Only callable by the owner.
+   *      Used for emergency governance or maintenance windows.
+   */
+  function pause() external onlyOwner {
+    _pause();
+  }
+
+  /**
+   * @dev Unpauses all token transfers. Only callable by the owner.
+   */
+  function unpause() external onlyOwner {
+    _unpause();
+  }
+
+  // ──────────────────────────────────────────────────────────────────────
+  // Query helpers
+  // ──────────────────────────────────────────────────────────────────────
+
+  /**
+   * @dev Returns the item identifier for a given token ID.
+   * @param tokenId The token ID to look up.
+   * @return The human-readable item identifier string.
+   */
+  function getItemId(uint256 tokenId) external view returns (string memory) {
+    return _itemIds[tokenId];
+  }
+
+  /**
+   * @dev Returns the token ID for a given item identifier.
+   * @param itemId The human-readable item identifier.
+   * @return The ERC-1155 token ID (0 if not registered, but 0 is also CRYPTOKOYN).
+   */
+  function getTokenIdByItemId(string calldata itemId) external view returns (uint256) {
+    return _itemIdToTokenId[keccak256(abi.encodePacked(itemId))];
+  }
+
+  /**
+   * @dev Returns the IPFS metadata CID for a given token ID.
+   * @param tokenId The token ID to look up.
+   * @return The IPFS CID string (empty if not set).
+   */
+  function getMetadataCID(uint256 tokenId) external view returns (string memory) {
+    return _tokenCIDs[tokenId];
+  }
+
+  /**
+   * @dev Returns the next auto-incremented token ID (informational only;
+   *      `registerObjectLayer` uses deterministic IDs from keccak256).
+   */
+  function nextTokenId() external view returns (uint256) {
+    return _nextTokenId;
+  }
+
+  // ──────────────────────────────────────────────────────────────────────
+  // Internal overrides required by Solidity
+  // ──────────────────────────────────────────────────────────────────────
+
+  /**
+   * @dev Hook that is called before any token transfer. Ensures both
+   *      ERC1155Pausable (transfer-blocking when paused) and ERC1155Supply
+   *      (total supply tracking) logic execute correctly.
+   */
+  function _update(
+    address from,
+    address to,
+    uint256[] memory ids,
+    uint256[] memory values
+  ) internal override(ERC1155, ERC1155Pausable, ERC1155Supply) {
+    super._update(from, to, ids, values);
+  }
+}

package/hardhat/deployments/hardhat-ObjectLayerToken.json

@@ -0,0 +1,11 @@
+{
+  "network": "hardhat",
+  "chainId": "31337",
+  "contract": "ObjectLayerToken",
+  "address": "0x5FbDB2315678afecb367f032d93F642f64180aa3",
+  "deployer": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
+  "baseURI": "ipfs://",
+  "cryptokoynTokenId": "0",
+  "initialCryptokoynSupply": "10000000000000000000000000",
+  "timestamp": "2026-03-08T01:11:37.978Z"
+}

package/hardhat/hardhat.config.js

@@ -0,0 +1,136 @@
+// hardhat.config.js
+// Hardhat configuration for the Cyberia Online Object Layer ERC-1155 ecosystem.
+// Supports deployment to Hyperledger Besu (IBFT2/QBFT) private networks
+// running on kubeadm-managed Kubernetes clusters (manifests/besu/).
+//
+// Compatible with: Hardhat 3.x + Ethers v6 + hardhat-toolbox-mocha-ethers
+
+import { defineConfig } from 'hardhat/config';
+import hardhatToolboxMochaEthers from '@nomicfoundation/hardhat-toolbox-mocha-ethers';
+import dotenv from 'dotenv';
+import fs from 'fs-extra';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+dotenv.config();
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+// ──────────────────────────────────────────────────────────────────────────────
+// Helper: safely read a private key file, falling back to a dummy key for
+// compilation-only workflows (tests on hardhat network, etc.).
+// ──────────────────────────────────────────────────────────────────────────────
+const DUMMY_PRIVATE_KEY = '0x' + 'ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80';
+
+function readPrivateKey(relPath) {
+  try {
+    const abs = path.resolve(__dirname, relPath);
+    if (fs.existsSync(abs)) {
+      const raw = fs.readFileSync(abs, 'utf8').trim();
+      return raw.startsWith('0x') ? raw : `0x${raw}`;
+    }
+  } catch (_) {
+    // fall through
+  }
+  return DUMMY_PRIVATE_KEY;
+}
+
+// Read the coinbase private key used for Besu network deployments
+const coinbaseKey = readPrivateKey('../engine-private/eth-networks/besu/coinbase');
+
+// ──────────────────────────────────────────────────────────────────────────────
+// Configuration
+// ──────────────────────────────────────────────────────────────────────────────
+
+/** @type import('hardhat/config').HardhatUserConfig */
+const config = defineConfig({
+  plugins: [hardhatToolboxMochaEthers],
+
+  // ── Solidity ────────────────────────────────────────────────────────────────
+  solidity: {
+    version: '0.8.27',
+    settings: {
+      optimizer: {
+        enabled: true,
+        runs: 200,
+      },
+      evmVersion: 'cancun',
+    },
+  },
+
+  // ── Networks ────────────────────────────────────────────────────────────
+  //
+  // Hyperledger Besu private networks use IBFT2 or QBFT consensus.
+  // The RPC endpoints below correspond to the Kubernetes services defined in
+  // manifests/besu/ (deployed via `underpost cluster --besu` or `cyberia chain deploy`).
+  //
+  // Default to 'hardhat' for local testing; use 'besu-k8s' for kubeadm cluster deployments.
+  defaultNetwork: 'hardhat',
+
+  networks: {
+    // Local Hardhat in-process network (for testing)
+    hardhat: {
+      type: 'edr-simulated',
+    },
+
+    // ── Besu IBFT2 – direct RPC (e.g. port-forward or in-cluster access) ───
+    // Connects to the first validator JSON-RPC endpoint directly.
+    'besu-ibft2': {
+      type: 'http',
+      url: process.env.BESU_IBFT2_RPC_URL || 'http://127.0.0.1:8545',
+      accounts: [coinbaseKey],
+      chainId: parseInt(process.env.BESU_IBFT2_CHAIN_ID || '777771', 10),
+      // Besu-specific: gas price is typically 0 on private permissioned networks
+      gasPrice: 0,
+      // Timeout for JSON-RPC requests (Besu can be slow on first blocks)
+      timeout: 120000,
+    },
+
+    // ── Besu QBFT – direct RPC (e.g. port-forward or in-cluster access) ────
+    'besu-qbft': {
+      type: 'http',
+      url: process.env.BESU_QBFT_RPC_URL || 'http://127.0.0.1:8545',
+      accounts: [coinbaseKey],
+      chainId: parseInt(process.env.BESU_QBFT_CHAIN_ID || '777771', 10),
+      gasPrice: 0,
+      timeout: 120000,
+    },
+
+    // ── Besu – kubeadm cluster (NodePort) ───────────────────────────────────
+    // Use when deploying from outside the kubeadm cluster via the NodePort
+    // service (besu-rpc-nodeport → 30545) defined in manifests/besu/.
+    // This is the recommended network for the Cyberia Object Layer ecosystem.
+    'besu-k8s': {
+      type: 'http',
+      url: process.env.BESU_K8S_RPC_URL || 'http://127.0.0.1:30545',
+      accounts: [coinbaseKey],
+      chainId: parseInt(process.env.BESU_K8S_CHAIN_ID || '777771', 10),
+      gasPrice: 0,
+      timeout: 180000,
+    },
+  },
+
+  // ── Paths ───────────────────────────────────────────────────────────────────
+  paths: {
+    sources: './contracts',
+    tests: './test',
+    cache: './cache',
+    artifacts: './artifacts',
+  },
+
+  // ── Gas Reporter ────────────────────────────────────────────────────────────
+  gasReporter: {
+    enabled: process.env.REPORT_GAS === 'true',
+    currency: 'USD',
+    outputFile: process.env.GAS_REPORT_FILE || undefined,
+    noColors: !!process.env.GAS_REPORT_FILE,
+  },
+
+  // ── Mocha (test runner) ─────────────────────────────────────────────────────
+  mocha: {
+    timeout: 60000,
+  },
+});
+
+export default config;

package/hardhat/ignition/modules/ObjectLayerToken.js

@@ -0,0 +1,21 @@
+// Hardhat Ignition module for deploying the ObjectLayerToken (ERC-1155) contract.
+// Learn more about Hardhat Ignition at https://hardhat.org/ignition
+//
+// Usage:
+//   npx hardhat ignition deploy ignition/modules/ObjectLayerToken.js --network besu-ibft2
+
+import { buildModule } from '@nomicfoundation/ignition-core';
+
+const DEFAULT_BASE_URI = 'ipfs://';
+
+export default buildModule('ObjectLayerTokenModule', (m) => {
+  // The deployer account is used as the initial owner and receives the CryptoKoyn supply.
+  const initialOwner = m.getParameter('initialOwner', m.getAccount(0));
+  const baseURI = m.getParameter('baseURI', DEFAULT_BASE_URI);
+
+  // Deploy the unified ERC-1155 multi-token contract.
+  // Constructor: constructor(address initialOwner, string memory baseURI)
+  const objectLayerToken = m.contract('ObjectLayerToken', [initialOwner, baseURI]);
+
+  return { objectLayerToken };
+});