ReferenceLink to this section
TL;DRLink to this section
Corerecords accepted work,Miningfunds and tracks NFT rewards, andTokencaps SQK supply.- Contract tables describe Mining5 source; the public API reference describes Mining4 data.
- Source versions and constants do not establish live addresses, launch policy or deployment approval.
In this sectionLink to this section
- Read the Contract graph for contract connections, SQK custody and upgrade permissions.
- Check Source and release scope before using these interfaces with a deployment.
Look up a contractLink to this section
Look up an integration boundaryLink to this section
- Factories and proxies Deployment checks and contract upgrades.
- Events and errors Log fields, state changes and failure meanings.
- Public API Choose a resource, inspect complete response schemas and handle unavailable data.
- DotGrid format and identities Image generation, code and data verification, and content limits.
Reading conventionsLink to this section
| Term | Convention |
|---|---|
Core block or Squeek block |
Completed fixed-difficulty unit of accepted work |
| Ethereum block | Chain block containing transactions and logs |
| Round | One-indexed 600-second Core interval |
| SQK base unit | 10^-18 SQK; contract integers are base units |
| Scaled credit or index | Fixed-point accounting with scale 2^128 |
| Implementation version | Code metadata, not an API route version or independent proof of runtime identity |
| Source fact | Behavior of this pinned implementation, not a promise of deployed parameters |
These tables describe public views, actions, events and errors, but are not a complete ABI. First-party source is private; integration requires authorized access to the ABI for the intended source version and deployment.
SourceLink to this section
Mining5 source specification e0617449. First-party source is private; see source and release scope.
Related pagesLink to this section
Records verified work and tracks settled rounds and Squeek blocks on Ethereum.
Calculates rewards from settled work, holds funded SQK, and pays eligible NFT owners.
The Miner ERC-721 contract. Tracks NFT ownership and coordinates minting and merges with Mining.
Applies Core or Mining upgrades authorized by its governing Timelock.
Generates Miner NFT artwork from fixed onchain visual data.
Queues governance operations and enforces a delay before they can be executed.
The SQK ERC-20 contract. Enforces the lifetime supply cap; only Mining can mint SQK.
Checks that visual data conforms to the required DotGrid format.
When new mining power starts earning. Minting and merging schedule it for a later round, and a checkpoint must process the change.
A reward update that processes settled work and scheduled mining-power changes. It can make rewards available but doesn't pay them to an owner's wallet.
The Miner NFT permanently burned in a merge. Its unclaimed rewards move to the survivor, but its image is not combined or kept.
SQK issued under the mining reward rules. You can direct a share of your Miner's rewards to fund SqueekFi projects.
The physical mining device that records accepted wheel-magnet passages as work. It is separate from the virtual Miner NFTs.
Squeekchain's record of accepted wheel-magnet passages. It doesn't prove animal identity and isn't how Ethereum reaches consensus.
Combining two eligible same-level Miners you own into one higher-level Miner. One NFT is permanently burned; the survivor keeps both Miners' unclaimed rewards.
The completed Squeek blocks a Miner must wait through before merging. It measures completed work, not elapsed time or Ethereum blocks; transfers don't reset it.
The power used to calculate a Miner's share of rewards when eligible and active. A larger share of total power can mean a larger share of rewards.
A ten-minute period used to group measured work. The device saves a completed round's work total when measurement remained uninterrupted.
The transferable token used for mining rewards. It has a lifetime supply cap and is separate from the Miner NFT and the device's work count.
A completed amount of settled work. Enough recorded work completes one Squeek block; it is not an Ethereum block.
Squeek Miner NFTs earn SQK linked to recorded wheel activity. Owners can direct a share of those rewards to fund SqueekFi projects.
Squeekchain's ecosystem for hamster-powered onchain finance. Miner owners can choose to fund projects with a share of their SQK rewards.
The Miner NFT you keep in a merge. It gains a level, keeps its ID and image, and receives both Miners' unclaimed rewards.
A Miner's recorded reward balance that hasn't been paid to a wallet. It stays with the NFT when ownership changes.
One wheel-magnet passage that met the device's counting rules and was saved. It records work, not an amount of SQK.