Technical Reference
VITUS
Contract addressNot currently resolved
Hash-verified
0xb29ac75c…2987d2Source details
| Property | Value |
|---|---|
| Keccak256 Hash | 0xb29ac75cf453b00abc913a65c938acfa9a5317fda1eaaa84c225295e212987d2 |
| Source URL | https://raw.githubusercontent.com/busytoby/atropa_pulsechain/58607494f7741b80525953e4a85bc99e66fd20fc/solidity/dysnomia/domain/assets/vitus.sol |
| Source Revision | 58607494f7741b80525953e4a85bc99e66fd20fc |
| Source Status | Canonical source snapshot; deployed bytecode equivalence is only established where a deployment record says so. |
| 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 | 0x06316f0691b7519c8b4a6b947632d863167022f27861c5486c8824e5ace053c8 |
| Compilation Closure Files | 42 |
| Hash Generated | 2026-09-14T19:33:51Z |
Overview
Section titled “Overview”VITUS is the creator reward token distributed by WORLD. It represents accumulated creation credits that can be withdrawn by players.
- Kind: Contract
- License: Sharia
- Solidity: ^0.8.21
- Source:
domain/assets/vitus.sol
Inheritance Chain (C3 Linearized)
Section titled “Inheritance Chain (C3 Linearized)”- self — VITUS
- DYSNOMIA
- MultiOwnable
Immediate Parents
Section titled “Immediate Parents”What This Means For Players
Section titled “What This Means For Players”Plain English Summary: VITUS is creator credits - rewards for building and contributing to the game world. When you claim territory using WORLD.Code(), you earn VITUS tokens. These credits accumulate in your YUE and can be withdrawn to your wallet.
Real-World Analogy: VITUS is like creator royalties. When you develop land (code at a location), you earn ongoing credits. It’s like being a content creator who earns revenue every time their work is accessed.
How It Affects Your Gameplay:
- Territory rewards - Earn VITUS by coding at locations near QINGs
- YUE accumulation - Credits build up in your bank until you withdraw
- Opt-in required - You must opt into VITUS via CHAN to withdraw
- Overflow protection - Same mechanism as H2O prevents excessive accumulation
State Variables
Section titled “State Variables”| Variable | Type | Visibility | Mutability | Initial Value | NatSpec |
|---|---|---|---|---|---|
Type |
string |
public | constant | VITUS |
|
World |
WORLDINTERFACE |
public | mutable | `` |
Constructor
Section titled “Constructor”constructor
Section titled “constructor”constructorconstructor
constructor(address WorldAddress) DYSNOMIA("Dysnomia Creators", "VITUS", address(DYSNOMIA(WorldAddress).Xiao()))- Modifiers:
DYSNOMIA("Dysnomia Creators", "VITUS", address(DYSNOMIA(WorldAddress).Xiao())) - Parameters: address WorldAddress
Functions
Section titled “Functions”External & Public
Section titled “External & Public”Withdraw
Section titled “Withdraw”Withdrawfunction
function Withdraw(uint256 Amount) publicA callable deployment has not been resolved for this reference.
- Visibility: public
- Parameters: uint256 Amount
Balance
Section titled “Balance”Balancefunction
function Balance() public view returns (uint256)A callable deployment has not been resolved for this reference.
- Visibility: public
- State Mutability: view
- Returns: uint256
Mintfunction
function Mint(address To, uint256 Amount) public onlyOwnersA callable deployment has not been resolved for this reference.
- Visibility: public
- Modifiers:
onlyOwners - Parameters: address To, uint256 Amount
Inherited Members
Section titled “Inherited Members”This contract inherits the members below from its parents. See each parent’s dedicated MD for full signatures, NatSpec, and semantics.
External & Public Functions
| Function | Signature | State Mutability |
|---|---|---|
Rename |
function Rename(string memory newName, string memory newSymbol) public virtual onlyOwners |
nonpayable |
mintToCap |
function mintToCap() public onlyOwners |
nonpayable |
GetMarketRate |
function GetMarketRate(address _a) public view returns (uint256) |
view |
Purchase |
function Purchase(address _t, uint256 _a) public |
nonpayable |
Redeem |
function Redeem(address _t, uint256 _a) public |
nonpayable |
name |
function name() public view virtual returns (string memory) |
view |
symbol |
function symbol() public view virtual returns (string memory) |
view |
decimals |
function decimals() public view virtual returns (uint8) |
view |
totalSupply |
function totalSupply() public view virtual returns (uint256) |
view |
balanceOf |
function balanceOf(address account) public view virtual returns (uint256) |
view |
transfer |
function transfer(address to, uint256 value) public virtual returns (bool) |
nonpayable |
allowance |
function allowance(address owner, address spender) public view virtual returns (uint256) |
view |
approve |
function approve(address spender, uint256 value) public virtual returns (bool) |
nonpayable |
transferFrom |
function transferFrom(address from, address to, uint256 value) public virtual returns (bool) |
nonpayable |
Internal Functions
| Function | Signature |
|---|---|
_addLibraryOwner |
function _addLibraryOwner(VOID Void, string memory what) internal |
_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 |
_spendAllowance |
function _spendAllowance(address owner, address spender, uint256 value) internal virtual |
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 |
External & Public Functions
| Function | Signature | State Mutability |
|---|---|---|
owner |
function owner() external view virtual returns (address) |
view |
renounceOwnership |
function renounceOwnership(address toRemove) public virtual onlyOwners |
nonpayable |
addOwner |
function addOwner(address newOwner) public virtual onlyOwners |
nonpayable |
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
Section titled “Contract Interactions”Depends On
Section titled “Depends On”- DYSNOMIA V2 - Base functionality
- WORLD - Owner and distributor
Created By
Section titled “Created By”- WORLD - Constructor deployment
Special Mechanisms
Section titled “Special Mechanisms”Withdrawal Flow
Section titled “Withdrawal Flow”function Withdraw(uint256 Amount) public { (YUEINTERFACE Yue, ) = World.Cheon().Sei().Chi(); World.Cheon().Sei().Chan().YueWithdraw(Yue, address(this), msg.sender, Amount);}Player must have opted into VITUS contract via CHAN.OptIn for withdrawal to work.
Overflow Protection
Section titled “Overflow Protection”Same pattern as H2O:
function Mint(address To, uint256 Amount) public onlyOwners { _mint(To, Amount);
uint256 _flip = VITUS(address(this)).balanceOf(To); uint256 _max = World.Map().Map().Meridians(13);
if(_flip > _max) { uint256 _flip2 = VITUS(address(this)).balanceOf(address(World)); uint256 _max2 = World.Map().Map().Meridians(20);
if(_flip2 < _max2) _transfer(To, address(World), _flip - _max); else _transfer(To, address(0x0), _flip - _max); // Burn excess }}Initial Supply
Section titled “Initial Supply”Constructor mints initial supply equal to WM token’s total supply:
DYSNOMIA wmtoken = DYSNOMIA(WMContract);_mint(address(this), wmtoken.totalSupply());Purpose
Section titled “Purpose”VITUS represents creator credits earned through:
- WORLD.Code() operations
- Territory development
- Game participation
Credits accumulate in YUE and can be withdrawn once opted in.
Inherited functions and getters (23)
VITUS.GetMarketRate(address _a)Read
A callable deployment has not been resolved for this reference.
VITUS.MotzkinPrime()Read
A callable deployment has not been resolved for this reference.
VITUS.Purchase(address _t, uint256 _a)Simulate / call
A callable deployment has not been resolved for this reference.
VITUS.Redeem(address _t, uint256 _a)Simulate / call
A callable deployment has not been resolved for this reference.
VITUS.Rename(string newName, string newSymbol)Simulate / call
A callable deployment has not been resolved for this reference.
VITUS.Type()Read
A callable deployment has not been resolved for this reference.
VITUS.World()Read
A callable deployment has not been resolved for this reference.
VITUS.Xiao()Read
A callable deployment has not been resolved for this reference.
VITUS.addOwner(address newOwner)Simulate / call
A callable deployment has not been resolved for this reference.
VITUS.allowance(address owner, address spender)Read
A callable deployment has not been resolved for this reference.
VITUS.approve(address spender, uint256 value)Simulate / call
A callable deployment has not been resolved for this reference.
VITUS.balanceOf(address account)Read
A callable deployment has not been resolved for this reference.
VITUS.decimals()Read
A callable deployment has not been resolved for this reference.
VITUS.maxSupply()Read
A callable deployment has not been resolved for this reference.
VITUS.mintToCap()Simulate / call
A callable deployment has not been resolved for this reference.
VITUS.name()Read
A callable deployment has not been resolved for this reference.
VITUS.owner(address cOwner)Read
A callable deployment has not been resolved for this reference.
VITUS.owner()Read
A callable deployment has not been resolved for this reference.
VITUS.renounceOwnership(address toRemove)Simulate / call
A callable deployment has not been resolved for this reference.
VITUS.symbol()Read
A callable deployment has not been resolved for this reference.
VITUS.totalSupply()Read
A callable deployment has not been resolved for this reference.
VITUS.transfer(address to, uint256 value)Simulate / call
A callable deployment has not been resolved for this reference.
VITUS.transferFrom(address from, address to, uint256 value)Simulate / call
A callable deployment has not been resolved for this reference.
Compiled ABI
Section titled “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": "WorldAddress", "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": [], "name": "Balance", "outputs": [ { "internalType": "uint256", "name": "", "type": "uint256" } ], "stateMutability": "view", "type": "function" }, { "inputs": [ { "internalType": "address", "name": "_a", "type": "address" } ], "name": "GetMarketRate", "outputs": [ { "internalType": "uint256", "name": "", "type": "uint256" } ], "stateMutability": "view", "type": "function" }, { "inputs": [ { "internalType": "address", "name": "To", "type": "address" }, { "internalType": "uint256", "name": "Amount", "type": "uint256" } ], "name": "Mint", "outputs": [], "stateMutability": "nonpayable", "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": "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": [ { "internalType": "uint256", "name": "Amount", "type": "uint256" } ], "name": "Withdraw", "outputs": [], "stateMutability": "nonpayable", "type": "function" }, { "inputs": [], "name": "World", "outputs": [ { "internalType": "contract WORLDINTERFACE", "name": "", "type": "address" } ], "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" }]