Reading path Source 9e38b931

DevelopersLink to this section

TL;DRLink to this section

The public API exposes wheel activity, settlement progress, NFT portfolios, and reward projections.
Use contract interfaces to read chain state and prepare owner transactions after verifying the deployment.
Mining4 API integration and Mining5 contract source are separate.

In this sectionLink to this section

Use the guide that matches your task. These are independent integration paths, not a mandatory setup sequence.

Choose your taskLink to this section

Use the public API Read measurement, settlement and portfolio projections. Obtain the intended endpoint first, then handle each resource's unavailable and stale states.
Read contracts Verify chain, contract addresses and code, then read ownership and positions at one Ethereum block.
Owner transaction integration Prepare claims and irreversible merges using current ownership and the deployment's ABI. Examples simulate without submitting.
Events and settlement Decode source-specific logs and keep indexed state correct through Ethereum reorgs.
Verify visuals and metadata Check onchain metadata independently of hosted API cards.

Choose an integration boundaryLink to this section

Need	Use	Do not assume
Live measurement and settlement progress	Public process and telemetry routes	Optimistic work is settled work
Confirmation-safe portfolios	Squeeks v2 public routes	API schema version 2 means `Mining` implementation version 2
Mining5 positions and claims	Pinned Mining5 ABI and verified contract addresses	Dev's Mining4 bindings decode Mining5
Canonical ownership	`NFT` `ownerOf` at a selected Ethereum block	Cached portfolio ownership authorizes a write
Reproducible visuals	Verified `NFT`, renderer, page and seed	A hosted raster independently proves the onchain rendering

The API provides read-only data; it does not relay wallet transactions or certify measurements. Store the chain ID, release, contract addresses and Ethereum block with each result.

SourceLink to this section

Based on system/API source 9e38b931; see source and release scope.

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.