CityCoins
Search…
About CityCoins
CityCoins Resources
Developer Resources
Contract Functions
Supporting Stacks
Implementing and interacting with a Stacks node and related software.
Overview
In order to efficiently and reliably query the Stacks blockchain state, running a follower node allows for direct access to the same data as hosted APIs with the added benefit of decentralized control.
Stacks Node API
The Stacks Node API provides both a self-contained Docker image and manual installation instructions for running a Stacks 2.0 blockchain and API instance.
Doing so provides access to a robust API that allows for querying accounts, transactions, smart contracts, and more.
API Tech Stack
The Stacks Node API can be run on 4 GB memory / 80 GB disk, however it also requires a Bitcoin node to interact with, which have higher disk space requirements.
The main elements of the API tech stack include:
- Postgres
- Stacks Blockchain API
- Stacks Blockchain Node
- Bitcoin Node
Updates and Announcements
The stacks-announce mailing list is available to receive updates on new releases to the Stacks blockchain node.
Installation Methods
The Digital Ocean 1-Click App is the fastest way to get started, but the options above are available for custom implementations and environments.
The Syvita Guild also created the repository below, which contains a quick start script that sets up each component based on their cloned versions using Docker.
Optional: Stacks Explorer
The Stacks Explorer provides a web interface to interact with Stacks blockchain data, including accounts, transactions, contracts, and more.
Some examples include:
Stacking STX
Stacking is the act of locking up STX for a set number of reward cycles and receiving a portion of the BTC spent by Stacks miners.
We call it "stacking" instead of "staking" because the protocol provides rewards of the base currency instead of the same currency.
A few high-level notes about the protocol:
- A STX holder must qualify for a reward slot by controlling a Stacks wallet with >= 0.02% of the total unlocked Stacks tokens (currently ~110,000 STX, and visible on stacking.club)
- A STX holder must broadcast a signed message before the reward cycle begins that:
- Locks the associated Stacks tokens for a protocol-specified lockup period (reward cycles are 2,100 Stacks blocks in length, maximum of 12)
- Specifies the Bitcoin address to receive the funds
- Votes on a Stacks chain tip
- The required minimum for a reward slot is dynamic and can increase last minute. It only increases in steps of 10k STX
- It is possible that a reward slot receives 0 BTC because Stacks miners did not send any BTC when it was the slot's turn
- The more reward slots an address occupies, the closer the payouts will be to the average payout
- When the selected reward cycles are complete, the address must sit out for one cycle (a "cooldown period")
The PoX smart contract is the main tool and provides the functions to stack STX.
Last modified 1mo ago