Build with AI

Connect a coding agent to Squeekchain: install the squeekchain skill or point your agent at llms-full.txt, and see the rules it follows.

TL;DR

• Install the squeekchain agent skill with npx skills add https://docs.squeekchain.live, or paste /llms-full.txt into your agent.
• The skill contains the deployment record, the deployed contracts' ABIs, the API reference, runnable examples and the rules below; your agent loads it when a request matches its description or names squeekchain.
• Agents read and simulate; Squeek owners sign. The skill never asks for a key and never sends a transaction for an owner.

Quick start

Install the skill into the project you are working in:

npx skills add https://docs.squeekchain.live

This installs the skill in the current project for every supported coding agent (add -g for all projects). Then ask your agent about Squeekchain, for example "Read the current Squeek block height on Sepolia".

No Node.js? Paste this URL into your agent instead; it's the whole Developers section and the glossary in one file:

/llms-full.txt

Install the skill

The skill follows the Agent Skills format; the skills CLI discovers it from the site address at /.well-known/agent-skills/index.json.

The skill contains:

Set up your agent

npx skills add writes to these folders. Each agent loads the skill when your request matches its description, or when you name it.

For an agent without skill support, add /llms.txt to its documentation sources, or paste llms-full.txt into the conversation.

Coding agents and owner agents

Most agents use these docs and examples to build dashboards, indexers or contracts that read Squeekchain or the API without touching a user's funds.

Owner agents check a deposit, stake, unstake, claim or merge and prepare it for the owner to sign; the skill always loads their safety rules. An operator-configured Keeper may use its own key, but only to submit checkpoints.

Key concepts

• Round: a 600-second window of wheel activity. Rounds after SqueekCore settledThroughRound are unknown, not zero.
• Work unit: one accepted wheel-magnet passage. cumulativeWork counts them.
• Squeek block: a unit of earned progress, not an Ethereum block. Height is cumulativeBlockUnits / 1_000_000_000.
• Difficulty:workPerThousandBlocks, the work 1,000 Squeek blocks cost at the moment; it adapts to the hamster's active rounds.
• Squeek: one of 9,999 SqueekNFT tokens; the hamster mines Squeek blocks, Squeeks don't.
• Issuance: after SqueekMining.start(), each completed Squeek block issues $SQK on a schedule (a launch bonus, then three halving periods), until the 2.1 billion lifetime cap less the premint. Read the schedule from issuanceSchedule(); do not assume values.
• Checkpoint: the permissionless SqueekMining.checkpoint() call that issues $SQK for up to 32 earning rounds and funds SqueekStaking with all of it through fund.
• Staker: the address that deposits Squeeks or stakes $SQK in SqueekStaking; its deposited Squeeks and staked $SQK add its power, and rewards accrue to it, not to a Squeek.
• Power:accountPower, the account's Squeek power plus its boosted $SQK power; a deposit, withdrawal, stake, unstake or merge updates it in the same transaction, and rewards stream over 1,200 seconds of nonzero total power.
• Claim:SqueekStaking.claim(account), callable only by the address claimRecipient(account) returns (the account itself unless a claim recipient is set); claimAndStake() compounds instead.
• Unstake:unstake(amount, maxFee, deadline) exits mature principal and burns a dynamic exit fee; fresh $SQK matures at the next 600-second round.
• Merge: owner-signed SqueekNFT.merge for wallet-held Squeeks or SqueekStaking.mergeDeposited for deposited ones, gated by the admin's mergesOpen and Squeek block cooldowns. A merge permanently burns the donor NFT.
• Supply: SqueekToken totalMinted() == totalPreminted() + SqueekMining state().minted; burns are tracked in totalBurned() and never reopen the cap.
• $SQK base unit:10^-18 $SQK. Keep amounts as integers.
• API: read-only JSON at https://api.squeekchain.live/v1, 12 confirmations behind the chain. "status": "unavailable" means unknown, not zero or empty.
• Testnet only: the contracts run on Sepolia, and testnet $SQK and Squeeks have no monetary value.

Machine-readable resources