Technical Reference

ZHOU

Source updated:: 2024-08-23 00:39:44 UTC
Last updated:: 2026-09-19 17:17:43 UTC

Source Revision 0xb80e4856…d20d7f

Property	Value
Source Revision	`0xb80e4856136756c84425a43afdddcfdda898b9b2e2ec32217c1e85bfa6d20d7f`
Source URL	https://raw.githubusercontent.com/busytoby/atropa_pulsechain/cae528a2b9f1f083a114180dae2e20e073976356/solidity/dysnomia/06_zhou.sol
Source commit	`cae528a2b9f1f083a114180dae2e20e073976356`
Source Status	Source snapshot; source hashes do not establish deployed bytecode equivalence.
Compiler	solc 0.8.21; optimizer enabled with 200 runs
Compiler Configuration	`{"evmVersion":"compiler-default","optimizer":{"enabled":true,"runs":200},"version":"0.8.21+commit.d9974bed.Linux.g++"}`
Compilation Closure Hash	`0xd4be9445c681c56cb0fee6a3d8540bd2845b1dea0031184150564a5d2dec7213`
Compilation Closure Files	12
Hash Generated	2026-04-20T02:38:20Z

Overview

ZHOU is the market rate orchestrator that initializes a complete token hierarchy during deployment. It creates a primary SHIO pair and installs it as a Rod in ZHENG, establishing the foundational market infrastructure.

Kind: Contract
License: Sharia
Solidity: ^0.8.21
Source: 06_zhou.sol

Contract address:

0x5cC318d0c01FeD5942B5ED2F53dB07727d36E261

Inheritance Chain (C3 Linearized)

Immediate Parents

DYSNOMIA

What This Means For Players

Plain English Summary: ZHOU is the exchange rate board - it sets how much things are worth. When you want to trade one token for another, ZHOU’s infrastructure determines the exchange rate. It’s also the main chat channel where global messages are broadcast.

Real-World Analogy: Think of ZHOU as a currency exchange kiosk at an airport. It posts the rates for converting between different currencies and processes your exchanges. In Dysnomia, every token can be traded for any other token, and ZHOU manages those rates.

How It Affects Your Gameplay:

Token trading - The exchange rates you see when buying/selling tokens come from here
Chat channel - ZHOU hosts one of the main message channels in the game
Market foundation - ZHOU establishes the primary trading infrastructure that everything else builds on

State Variables

Variable	Type	Visibility	Mutability	Initial Value
`Type`	`string`	public	constant	`ZHOU`
`Upsilon`	`ZHENG`	public	mutable	``
`Xi`	`uint64`	public	mutable	``
`Monopole`	`uint64`	public	mutable	``

Constructor

constructor

constructorconstructor

constructor(address ZhengContract) DYSNOMIA(unicode"CHATLOG Zhou", unicode"ZHOU", address(DYSNOMIA(ZhengContract).Xiao()))

Modifiers: DYSNOMIA(unicode"CHATLOG Zhou", unicode"ZHOU", address(DYSNOMIA(ZhengContract).Xiao()))
Parameters: address ZhengContract

Functions

External & Public

Alpha

Alphafunction

function Alpha(string memory Name, string memory Symbol) public onlyOwners returns (SHA Epsilon)

Open this function to load its call form.

Visibility: public
Modifiers: onlyOwners
Parameters: string memory Name, string memory Symbol
Returns: SHA Epsilon

React

Reactfunction

function React(uint64 Iota) public returns (Bao memory)

Open this function to load its call form.

Visibility: public
Parameters: uint64 Iota
Returns: Bao memory

Internal

Augment

Augmentfunction

function Augment(Bao memory Theta) internal

Visibility: internal
Parameters: Bao memory Theta

Inherited Members

Public and external functions below are callable through this contract’s address. Parent links identify where each member is defined.

From DYSNOMIA

External & Public Functions

Rename

Renamefunction

function Rename(string memory newName, string memory newSymbol) public onlyOwners

Open this function to load its call form.

Visibility: public
Modifiers: onlyOwners
Parameters: string memory newName, string memory newSymbol

mintToCap

mintToCapfunction

function mintToCap() public onlyOwners

Open this function to load its call form.

Visibility: public
Modifiers: onlyOwners

GetMarketRate

GetMarketRatefunction

function GetMarketRate(address _a) public view returns (uint256)

Open this function to load its call form.

Visibility: public
State Mutability: view
Parameters: address _a
Returns: uint256

Purchase

Purchasefunction

function Purchase(address _t, uint256 _a) public

Open this function to load its call form.

Visibility: public
Parameters: address _t, uint256 _a

Redeem

Redeemfunction

function Redeem(address _t, uint256 _a) public

Open this function to load its call form.

Visibility: public
Parameters: address _t, uint256 _a

name

namefunction

function name() public view virtual returns (string memory)

Open this function to load its call form.

Visibility: public
State Mutability: view
Virtual: yes
Returns: string memory

symbol

symbolfunction

function symbol() public view virtual returns (string memory)

Open this function to load its call form.

Visibility: public
State Mutability: view
Virtual: yes
Returns: string memory

decimals

decimalsfunction

function decimals() public view virtual returns (uint8)

Open this function to load its call form.

Visibility: public
State Mutability: view
Virtual: yes
Returns: uint8

totalSupply

totalSupplyfunction

function totalSupply() public view virtual returns (uint256)

Open this function to load its call form.

Visibility: public
State Mutability: view
Virtual: yes
Returns: uint256

balanceOf

balanceOffunction

function balanceOf(address account) public view virtual returns (uint256)

Open this function to load its call form.

Visibility: public
State Mutability: view
Virtual: yes
Parameters: address account
Returns: uint256

transfer

transferfunction

function transfer(address to, uint256 value) public virtual returns (bool)

Open this function to load its call form.

Visibility: public
Virtual: yes
Parameters: address to, uint256 value
Returns: bool

allowance

allowancefunction

function allowance(address owner, address spender) public view virtual returns (uint256)

Open this function to load its call form.

Visibility: public
State Mutability: view
Virtual: yes
Parameters: address owner, address spender
Returns: uint256

approve

approvefunction

function approve(address spender, uint256 value) public virtual returns (bool)

Open this function to load its call form.

Visibility: public
Virtual: yes
Parameters: address spender, uint256 value
Returns: bool

transferFrom

transferFromfunction

function transferFrom(address from, address to, uint256 value) public virtual returns (bool)

Open this function to load its call form.

Visibility: public
Virtual: yes
Parameters: address from, address to, uint256 value
Returns: bool

Internal Functions

Function	Signature
`_mintToCap`	`function _mintToCap() internal`
`AddMarketRate`	`function AddMarketRate(address _a, uint256 _r) internal`
`_transfer`	`function _transfer(address from, address to, uint256 value) internal`
`_update`	`function _update(address from, address to, uint256 value) internal virtual`
`_mint`	`function _mint(address account, uint256 value) internal`
`_approve`	`function _approve(address owner, address spender, uint256 value) internal`
`_approve`	`function _approve(address owner, address spender, uint256 value, bool emitEvent) internal virtual`
`_spendAllowance`	`function _spendAllowance(address owner, address spender, uint256 value) internal virtual`
`log10`	`function log10(uint256 value) internal pure returns (uint256)`
`String`	`function String(uint256 value) internal pure returns (string memory buffer)`
`Hex`	`function Hex(address account) internal pure returns (string memory)`
`Hex`	`function Hex(uint256 value) internal pure returns (string memory)`
`Hex`	`function Hex(bytes32 value) internal pure returns (string memory)`
`Hex`	`function Hex(bytes memory data) internal pure returns (string memory)`

Events

Event	Parameters
`Transfer`	address indexed from, address indexed to, uint256 value
`Approval`	address indexed owner, address indexed spender, uint256 value

Errors

Error	Parameters
`MarketRateNotFound`	address asset
`DysnomiaInsufficientBalance`	address origin, address sender, address from, address to, address what, uint256 balance, uint256 needed
`DysnomiaInsufficientAllowance`	address origin, address sender, address owner, address spender, address what, uint256 allowance, uint256 needed

State Variables (private parent storage is not reachable and is omitted)

Variable	Type	Visibility	Mutability
`__name`	`string`	internal	mutable
`__symbol`	`string`	internal	mutable
`MotzkinPrime`	`uint64`	public	constant
`Xiao`	`atropaMath`	public	mutable
`maxSupply`	`uint256`	public	mutable

From MultiOwnable

External & Public Functions

owner

ownerfunction

function owner() external view virtual returns (address)

Open this function to load its call form.

Visibility: external
State Mutability: view
Virtual: yes
Returns: address

owner

ownerfunction

function owner(address cOwner) public view virtual returns (bool)

Open this function to load its call form.

Visibility: public
State Mutability: view
Virtual: yes
Parameters: address cOwner
Returns: bool

renounceOwnership

renounceOwnershipfunction

function renounceOwnership(address toRemove) public virtual onlyOwners

Open this function to load its call form.

Visibility: public
Virtual: yes
Modifiers: onlyOwners
Parameters: address toRemove

addOwner

addOwnerfunction

function addOwner(address newOwner) public virtual onlyOwners

Open this function to load its call form.

Visibility: public
Virtual: yes
Modifiers: onlyOwners
Parameters: address newOwner

Internal Functions

Function	Signature
`_checkOwner`	`function _checkOwner() internal view virtual`
`_changeOwnership`	`function _changeOwnership(address cOwner, bool cState) internal virtual`

Events

Event	Parameters
`OwnershipUpdate`	address indexed newOwner, bool indexed state

Errors

Error	Parameters
`OwnableUnauthorizedAccount`	address origin, address account, address what
`OwnableInvalidOwner`	address origin, address owner, address what

Modifiers

Modifier	Parameters
`onlyOwners`	(none)

Contract Interactions

Depends On

DYSNOMIA - Base token functionality
ZHENG - Installation management
YI - Token creation (via ZHENG)

Depended On By

YAU - Uses ZHOU for protocol coordination

Constructor Logic

constructor(ZhengContract) {
    Upsilon = ZHENG(ZhengContract);

    // Add ownership up the chain
    Upsilon.addOwner(address(this));
    Upsilon.Eta().addOwner(address(this));

    // Create Bao for installation
    Bao memory Theta;
    Theta.Phi = address(this);
    Theta.Mu = Alpha("Zheng Rod", "ZROD");

    // Create Cone via YI
    SHA Cone = Upsilon.Eta().Beta("Yi Shio Cone", "ZCONE");
    Cone.addOwner(address(Upsilon));

    // Create SHIO pair
    Theta.Shio = Upsilon.Eta().Kappa(Theta.Mu, Cone);

    // Configure ownership
    Theta.Shio.addOwner(address(Upsilon));
    Theta.Shio.addOwner(address(Upsilon.Eta()));

    // Generate and ionize
    Theta.Xi = Xiao.Random();
    Theta.Shio.Generate(Theta.Xi, Xiao.Random(), Xiao.Random());
    Upsilon.Iodize(Theta.Shio);

    // Magnetize and react
    Theta.Ring = Theta.Shio.Magnetize();
    Theta = Upsilon.Eta().React(Theta, Theta.Xi);

    // Store values and install
    Monopole = Theta.Omicron;
    Theta = Upsilon.InstallRod(Theta.Xi, Theta, Monopole);
    Xi = Theta.Xi;
}

Special Mechanisms

Hierarchical Ownership Setup

The Alpha function sets up a three-level ownership chain:

msg.sender owns the token
ZHENG (Upsilon) owns the token
YI (Upsilon.Eta()) owns the token

This enables operations from any level in the hierarchy.

Primary Rod Installation

During construction, ZHOU creates and installs the first Rod in the system, establishing:

The Xi index for future lookups
The initial Monopole for reactions
Market rates for all created tokens

React Passthrough

The React function provides a convenient way to react against the primary Rod without needing to know its exact location - it automatically retrieves the Rod by Xi and reacts via YI.

Usage Pattern

// Create new SHA token
SHA token = zhou.Alpha("New Token", "NTK");

// React against the primary installation
Bao memory result = zhou.React(inputValue);

Inherited functions and getters (7)

ZHOU.Monopole()Read

Open this function to load its call form.

ZHOU.MotzkinPrime()Read

Open this function to load its call form.

ZHOU.Type()Read

Open this function to load its call form.

ZHOU.Upsilon()Read

Open this function to load its call form.

ZHOU.Xi()Read

Open this function to load its call form.

ZHOU.Xiao()Read

Open this function to load its call form.

ZHOU.maxSupply()Read

Open this function to load its call form.

Compiled ABI

The compiled ABI below is produced by solc 0.8.21 from the exact source bytes recorded in Source details. Consumers can paste it directly into ethers/web3/viem.

Click to expand JSON ABI

[
  {
    "inputs": [
      {
        "internalType": "address",
        "name": "ZhengContract",
        "type": "address"
      }
    ],
    "stateMutability": "nonpayable",
    "type": "constructor"
  },
  {
    "inputs": [
      {
        "internalType": "address",
        "name": "origin",
        "type": "address"
      },
      {
        "internalType": "address",
        "name": "sender",
        "type": "address"
      },
      {
        "internalType": "address",
        "name": "owner",
        "type": "address"
      },
      {
        "internalType": "address",
        "name": "spender",
        "type": "address"
      },
      {
        "internalType": "address",
        "name": "what",
        "type": "address"
      },
      {
        "internalType": "uint256",
        "name": "allowance",
        "type": "uint256"
      },
      {
        "internalType": "uint256",
        "name": "needed",
        "type": "uint256"
      }
    ],
    "name": "DysnomiaInsufficientAllowance",
    "type": "error"
  },
  {
    "inputs": [
      {
        "internalType": "address",
        "name": "origin",
        "type": "address"
      },
      {
        "internalType": "address",
        "name": "sender",
        "type": "address"
      },
      {
        "internalType": "address",
        "name": "from",
        "type": "address"
      },
      {
        "internalType": "address",
        "name": "to",
        "type": "address"
      },
      {
        "internalType": "address",
        "name": "what",
        "type": "address"
      },
      {
        "internalType": "uint256",
        "name": "balance",
        "type": "uint256"
      },
      {
        "internalType": "uint256",
        "name": "needed",
        "type": "uint256"
      }
    ],
    "name": "DysnomiaInsufficientBalance",
    "type": "error"
  },
  {
    "inputs": [
      {
        "internalType": "address",
        "name": "asset",
        "type": "address"
      }
    ],
    "name": "MarketRateNotFound",
    "type": "error"
  },
  {
    "inputs": [
      {
        "internalType": "address",
        "name": "origin",
        "type": "address"
      },
      {
        "internalType": "address",
        "name": "owner",
        "type": "address"
      },
      {
        "internalType": "address",
        "name": "what",
        "type": "address"
      }
    ],
    "name": "OwnableInvalidOwner",
    "type": "error"
  },
  {
    "inputs": [
      {
        "internalType": "address",
        "name": "origin",
        "type": "address"
      },
      {
        "internalType": "address",
        "name": "account",
        "type": "address"
      },
      {
        "internalType": "address",
        "name": "what",
        "type": "address"
      }
    ],
    "name": "OwnableUnauthorizedAccount",
    "type": "error"
  },
  {
    "anonymous": false,
    "inputs": [
      {
        "indexed": true,
        "internalType": "address",
        "name": "owner",
        "type": "address"
      },
      {
        "indexed": true,
        "internalType": "address",
        "name": "spender",
        "type": "address"
      },
      {
        "indexed": false,
        "internalType": "uint256",
        "name": "value",
        "type": "uint256"
      }
    ],
    "name": "Approval",
    "type": "event"
  },
  {
    "anonymous": false,
    "inputs": [
      {
        "indexed": true,
        "internalType": "address",
        "name": "newOwner",
        "type": "address"
      },
      {
        "indexed": true,
        "internalType": "bool",
        "name": "state",
        "type": "bool"
      }
    ],
    "name": "OwnershipUpdate",
    "type": "event"
  },
  {
    "anonymous": false,
    "inputs": [
      {
        "indexed": true,
        "internalType": "address",
        "name": "from",
        "type": "address"
      },
      {
        "indexed": true,
        "internalType": "address",
        "name": "to",
        "type": "address"
      },
      {
        "indexed": false,
        "internalType": "uint256",
        "name": "value",
        "type": "uint256"
      }
    ],
    "name": "Transfer",
    "type": "event"
  },
  {
    "inputs": [
      {
        "internalType": "string",
        "name": "Name",
        "type": "string"
      },
      {
        "internalType": "string",
        "name": "Symbol",
        "type": "string"
      }
    ],
    "name": "Alpha",
    "outputs": [
      {
        "internalType": "contract SHA",
        "name": "Epsilon",
        "type": "address"
      }
    ],
    "stateMutability": "nonpayable",
    "type": "function"
  },
  {
    "inputs": [
      {
        "internalType": "address",
        "name": "_a",
        "type": "address"
      }
    ],
    "name": "GetMarketRate",
    "outputs": [
      {
        "internalType": "uint256",
        "name": "",
        "type": "uint256"
      }
    ],
    "stateMutability": "view",
    "type": "function"
  },
  {
    "inputs": [],
    "name": "Monopole",
    "outputs": [
      {
        "internalType": "uint64",
        "name": "",
        "type": "uint64"
      }
    ],
    "stateMutability": "view",
    "type": "function"
  },
  {
    "inputs": [],
    "name": "MotzkinPrime",
    "outputs": [
      {
        "internalType": "uint64",
        "name": "",
        "type": "uint64"
      }
    ],
    "stateMutability": "view",
    "type": "function"
  },
  {
    "inputs": [
      {
        "internalType": "address",
        "name": "_t",
        "type": "address"
      },
      {
        "internalType": "uint256",
        "name": "_a",
        "type": "uint256"
      }
    ],
    "name": "Purchase",
    "outputs": [],
    "stateMutability": "nonpayable",
    "type": "function"
  },
  {
    "inputs": [
      {
        "internalType": "uint64",
        "name": "Iota",
        "type": "uint64"
      }
    ],
    "name": "React",
    "outputs": [
      {
        "components": [
          {
            "internalType": "address",
            "name": "Phi",
            "type": "address"
          },
          {
            "internalType": "contract SHA",
            "name": "Mu",
            "type": "address"
          },
          {
            "internalType": "uint64",
            "name": "Xi",
            "type": "uint64"
          },
          {
            "internalType": "uint64",
            "name": "Pi",
            "type": "uint64"
          },
          {
            "internalType": "contract SHIO",
            "name": "Shio",
            "type": "address"
          },
          {
            "internalType": "uint64",
            "name": "Ring",
            "type": "uint64"
          },
          {
            "internalType": "uint64",
            "name": "Omicron",
            "type": "uint64"
          },
          {
            "internalType": "uint64",
            "name": "Omega",
            "type": "uint64"
          }
        ],
        "internalType": "struct Bao",
        "name": "",
        "type": "tuple"
      }
    ],
    "stateMutability": "nonpayable",
    "type": "function"
  },
  {
    "inputs": [
      {
        "internalType": "address",
        "name": "_t",
        "type": "address"
      },
      {
        "internalType": "uint256",
        "name": "_a",
        "type": "uint256"
      }
    ],
    "name": "Redeem",
    "outputs": [],
    "stateMutability": "nonpayable",
    "type": "function"
  },
  {
    "inputs": [
      {
        "internalType": "string",
        "name": "newName",
        "type": "string"
      },
      {
        "internalType": "string",
        "name": "newSymbol",
        "type": "string"
      }
    ],
    "name": "Rename",
    "outputs": [],
    "stateMutability": "nonpayable",
    "type": "function"
  },
  {
    "inputs": [],
    "name": "Type",
    "outputs": [
      {
        "internalType": "string",
        "name": "",
        "type": "string"
      }
    ],
    "stateMutability": "view",
    "type": "function"
  },
  {
    "inputs": [],
    "name": "Upsilon",
    "outputs": [
      {
        "internalType": "contract ZHENG",
        "name": "",
        "type": "address"
      }
    ],
    "stateMutability": "view",
    "type": "function"
  },
  {
    "inputs": [],
    "name": "Xi",
    "outputs": [
      {
        "internalType": "uint64",
        "name": "",
        "type": "uint64"
      }
    ],
    "stateMutability": "view",
    "type": "function"
  },
  {
    "inputs": [],
    "name": "Xiao",
    "outputs": [
      {
        "internalType": "contract atropaMath",
        "name": "",
        "type": "address"
      }
    ],
    "stateMutability": "view",
    "type": "function"
  },
  {
    "inputs": [
      {
        "internalType": "address",
        "name": "newOwner",
        "type": "address"
      }
    ],
    "name": "addOwner",
    "outputs": [],
    "stateMutability": "nonpayable",
    "type": "function"
  },
  {
    "inputs": [
      {
        "internalType": "address",
        "name": "owner",
        "type": "address"
      },
      {
        "internalType": "address",
        "name": "spender",
        "type": "address"
      }
    ],
    "name": "allowance",
    "outputs": [
      {
        "internalType": "uint256",
        "name": "",
        "type": "uint256"
      }
    ],
    "stateMutability": "view",
    "type": "function"
  },
  {
    "inputs": [
      {
        "internalType": "address",
        "name": "spender",
        "type": "address"
      },
      {
        "internalType": "uint256",
        "name": "value",
        "type": "uint256"
      }
    ],
    "name": "approve",
    "outputs": [
      {
        "internalType": "bool",
        "name": "",
        "type": "bool"
      }
    ],
    "stateMutability": "nonpayable",
    "type": "function"
  },
  {
    "inputs": [
      {
        "internalType": "address",
        "name": "account",
        "type": "address"
      }
    ],
    "name": "balanceOf",
    "outputs": [
      {
        "internalType": "uint256",
        "name": "",
        "type": "uint256"
      }
    ],
    "stateMutability": "view",
    "type": "function"
  },
  {
    "inputs": [],
    "name": "decimals",
    "outputs": [
      {
        "internalType": "uint8",
        "name": "",
        "type": "uint8"
      }
    ],
    "stateMutability": "view",
    "type": "function"
  },
  {
    "inputs": [],
    "name": "maxSupply",
    "outputs": [
      {
        "internalType": "uint256",
        "name": "",
        "type": "uint256"
      }
    ],
    "stateMutability": "view",
    "type": "function"
  },
  {
    "inputs": [],
    "name": "mintToCap",
    "outputs": [],
    "stateMutability": "nonpayable",
    "type": "function"
  },
  {
    "inputs": [],
    "name": "name",
    "outputs": [
      {
        "internalType": "string",
        "name": "",
        "type": "string"
      }
    ],
    "stateMutability": "view",
    "type": "function"
  },
  {
    "inputs": [
      {
        "internalType": "address",
        "name": "cOwner",
        "type": "address"
      }
    ],
    "name": "owner",
    "outputs": [
      {
        "internalType": "bool",
        "name": "",
        "type": "bool"
      }
    ],
    "stateMutability": "view",
    "type": "function"
  },
  {
    "inputs": [],
    "name": "owner",
    "outputs": [
      {
        "internalType": "address",
        "name": "",
        "type": "address"
      }
    ],
    "stateMutability": "view",
    "type": "function"
  },
  {
    "inputs": [
      {
        "internalType": "address",
        "name": "toRemove",
        "type": "address"
      }
    ],
    "name": "renounceOwnership",
    "outputs": [],
    "stateMutability": "nonpayable",
    "type": "function"
  },
  {
    "inputs": [],
    "name": "symbol",
    "outputs": [
      {
        "internalType": "string",
        "name": "",
        "type": "string"
      }
    ],
    "stateMutability": "view",
    "type": "function"
  },
  {
    "inputs": [],
    "name": "totalSupply",
    "outputs": [
      {
        "internalType": "uint256",
        "name": "",
        "type": "uint256"
      }
    ],
    "stateMutability": "view",
    "type": "function"
  },
  {
    "inputs": [
      {
        "internalType": "address",
        "name": "to",
        "type": "address"
      },
      {
        "internalType": "uint256",
        "name": "value",
        "type": "uint256"
      }
    ],
    "name": "transfer",
    "outputs": [
      {
        "internalType": "bool",
        "name": "",
        "type": "bool"
      }
    ],
    "stateMutability": "nonpayable",
    "type": "function"
  },
  {
    "inputs": [
      {
        "internalType": "address",
        "name": "from",
        "type": "address"
      },
      {
        "internalType": "address",
        "name": "to",
        "type": "address"
      },
      {
        "internalType": "uint256",
        "name": "value",
        "type": "uint256"
      }
    ],
    "name": "transferFrom",
    "outputs": [
      {
        "internalType": "bool",
        "name": "",
        "type": "bool"
      }
    ],
    "stateMutability": "nonpayable",
    "type": "function"
  }
]