diff --git a/docs/08-operating-a-stake-pool/01-stake-pool-operations-101.mdx b/docs/08-operating-a-stake-pool/01-stake-pool-operations-101.mdx deleted file mode 100644 index e4186858..00000000 --- a/docs/08-operating-a-stake-pool/01-stake-pool-operations-101.mdx +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: Stake pool operations 101 -metaTitle: Stake pool operations 101 ---- - -Welcome to your one-stop shop for all things related to stake pool operations! - -This page helps you navigate through the technical information, resources, and -updates needed to manage your pool/s operations efficiently, whether you're an -experienced operator or just starting out. - -## Latest node details - -You can find the [latest release here.](https://github.com/IntersectMBO/cardano-node/releases) - -## Overview of Cardano environments - -### Preview - -Preview is the longer-term network environment for testing release candidates -and expanded test scenarios. Preview is meant for DApps, SPOs, and exchanges -wishing to test mature release candidates. - -[Preview configurations](https://book.world.dev.cardano.org/environments.html#preview-testnet) - -### Pre-production - -Pre-production is the most mature network for testing purposes, resembling a -production (mainnet) environment. It is meant for exchanges, SPOs, -pre-deployment DApps, and wallets wishing to test release functionality before -deploying on mainnet. - -[Pre-production configurations](https://book.world.dev.cardano.org/environments.html#pre-production-testnet) - -### Production (mainnet) - -Production is the live network, also referred to as mainnet. It features -official functionality releases. Exchanges, SPOs, DApps, wallets, and end users -can use the mainnet for development, transaction processing, and other needs. - -[Production configurations](https://book.world.dev.cardano.org/environments.html#production-mainnet) - -Learn more about Cardano environments -[here](https://docs.cardano.org/cardano-testnet/getting-started/#environments). - -## SPO tools and resources - -Access tools and resources through the links below. - -[Testnets faucet](https://docs.cardano.org/cardano-testnets/tools/faucet) -[Release notes](https://docs.cardano.org/release-notes/release-notes) -[Compatibility matrix](https://docs.cardano.org/release-notes/comp-matrix) -[Cardano ecosystem tools](https://developers.cardano.org/tools/) -[Community-built developer tools](https://www.essentialcardano.io/article/a-list-of-community-built-developer-tools-on-cardano) -[Cardano blockchain explorer](https://explorer.cardano.org/en.html) -[AdaEx](https://adaex.org/) -[Adapools](https://adapools.org/) -[AdaStat](https://adastat.net/transactions) -[Adatools](https://adatools.io/) -[Cardanoscan](https://cardanoscan.io/transactions) -[Cexplorer](https://cexplorer.io/) -[Cardano Assets](https://cardanoassets.com/) -[Pool.pm](https://pool.pm/tokens) -[ADAtainment](https://www.adatainment.com/index.php?page=home&lang=en) -[Cardano PoolTool](https://pooltool.io/) -[POOLSTATS](https://poolstats.org/#) - -## SPO alliances - -[Guild Operators](https://cardano-community.github.io/guild-operators/): a group -of well-known and experienced community members that provides information about -guild tools that simplify various stake ops (setting up, managing, and -monitoring pools) for Cardano SPOs. -[Cardano Single Pool Alliance (SPA)](https://singlepoolalliance.net/): a group -of separate SPOs who have vowed to run a single stake pool for the sole purpose -of providing the Cardano ecosystem with true decentralization. -[xSPO Alliance](https://www.xspo-alliance.org/): a group of small SPOs that -joined with a total live stake of less than one million ada each. - -## Communication channels - -[SPO Telegram announcements channel](https://t.me/SPOannouncements) -[SPO digest registration](https://www.iogservices.io/register-for-the-spo-digest) -[IOG Technical Community Discord](https://discord.gg/inputoutput) - -Have we missed anything? Contribute to the list by submitting a pull request, -and add any relevant SPO information to the above categories. diff --git a/docs/08-operating-a-stake-pool/02-about-stake-pools.mdx b/docs/08-operating-a-stake-pool/02-about-stake-pools.mdx index 93233aff..153b7933 100644 --- a/docs/08-operating-a-stake-pool/02-about-stake-pools.mdx +++ b/docs/08-operating-a-stake-pool/02-about-stake-pools.mdx @@ -3,51 +3,47 @@ title: About stake pools, operators, and owners metaTitle: About stake pools, operators, and owners --- -This section includes an overview of stake pool operations and explains the ways -of creating and managing your own stake pool. - -A [stake pool](/learn/stake-pools) is a reliable server node that holds and -maintains the combined stake of various stakeholders in a single entity. Stake +A [stake pool](/learn/stake-pools) is a reliable server node that represents the +combined stake of various stakeholders in a single entity. Stake pools use the [Cardano node](https://docs.cardano.org/learn/cardano-node/) to -validate how the pool interacts with the network and are responsible for -transaction processing and block production. - -Successfully operating a stake pool includes the roles of a stake pool operator -and one or more stake pool owner(s). It is important to note that there is a -conceptual difference between these two roles: - -- A _stake pool operator_ is a person who is assigned responsibility for setting - up and keeping the stake pool running, which means that they own or rent a - server, hold the key of the stake pool, and hold responsibility for running - and monitoring the node. With their key, a stake pool operator can sign - blocks, register, re-register, or retire a stake pool, and post updated - certificates. A stake pool operator is also empowered to exclude some stake - pool owners during re-registration. -- A _stake pool owner_ is a person who pledges their stake to the pool to - increase the pool’s reward earning capacity and desirability. The ability of - the owner to [pledge stake](/learn/pledging-rewards) provides protection - against Sybil attacks. - -Usually, the stake pool operator and the owner is the same person, however, a -stake pool can also have multiple owners, who pledge their stake to form one -larger pool to ensure it is competitive. Even in this case, there is still only -one stake pool operator who is responsible for stake pool processes. - -It is essential that all stake pool owners trust a stake pool operator. All -operators’ and owners’ rewards are paid out into a single shared reward account -associated with the reward address of the pool. The holder of the rewards -account pays out rewards independently to the owners. - -This makes it clear to all parties that an agreement is needed to define when +form the backbone of the Cardano network by processing transactions and validating and producing blocks. + +Stake pool roles include a stake pool operator +and one or more stake pool owner(s). It is important to note the +conceptual differences between the two: + +- A _stake pool operator_ is the owner of the cold and VRF signing keys used to create the stake pool. + The operator configures and maintains stake pool infrastructure and is responsible for monitoring it. + The operator can register, re-register, or retire a stake pool, update + certificates, and ensure that the block-producing node can sign and validate blocks and process transactions. +- A _stake pool owner_ is determined by the stake signing keys used in stake pool creation. The owner's + [pledge stake](/learn/pledging-rewards) is intended to + provide protection against Sybil attacks. + +Usually, the stake pool operator and the owner are the same person. However, a +stake pool can have multiple owners that choose to combine their pledge. It should +be noted that the stake pool's declared pledge must be met by the combined stake in the +owner's wallets and failure to do so will result in the pool being unable to produce blocks. + +All operator and owner rewards are paid out into a single rewards account +associated with the reward address of the pool. If a stake pool has multiple owners, it is +up to the owner of the rewards account to distribute rewards to the operator and +other owners. + +An agreement is likely needed to define when and how the accumulated rewards in a shared account should be split. For example, they can agree to have the operator control the shared account, or they -could choose to use a multisig account. +can choose to use a multisig account. To run a pool effectively, a bi-directional relationship and trust are crucial. If this trust is broken, other parties can lose in regards to accumulated or potential rewards, or reputation for the operator. -_Note, that to eliminate such a case, it is beneficial for owners and operators -to consider entering into contractual arrangements._ +:::info + +Developer resources: + +- [Stake pool operations overview](https://developers.cardano.org/docs/operate-a-stake-pool/) +- [Cardano course: creating a stake pool](https://cardano-course.gitbook.io/cardano-course/handbook/create-a-stake-pool) -Read the following sections to find out how to set up and operate a stake pool. +::: diff --git a/docs/08-operating-a-stake-pool/03-creating-a-stake-pool.mdx b/docs/08-operating-a-stake-pool/03-creating-a-stake-pool.mdx deleted file mode 100644 index 182c19f3..00000000 --- a/docs/08-operating-a-stake-pool/03-creating-a-stake-pool.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Creating and managing a stake pool -metaTitle: Creating and managing a stake pool ---- - -First, you should [install the node from source](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/getting-started/install.md). - -You can then proceed with the operational tasks for managing your stake pool. - -**Video lessons** on how to create and manage a stake pool on the preview testnet: - -1. [The setup](https://youtu.be/6AQaPdmxnfo) -2. [Generating stake pool keys](https://youtu.be/xydi4_pqOdo) -3. [Registering the stake pool on-chain](https://youtu.be/9UK_EFG-nkA) -4. [Stake pool's topology file, startup script and systemd](https://youtu.be/1CaMmsgFPnw) -5. [Requesting delegation from the faucet and stake snapshots](https://youtu.be/t5BOFmy6IYg) -6. [Stake pool operations part 1](https://youtu.be/NCdsk75-7NA) - -- Querying stake snapshot -- Querying leadership schedule -- Querying KES period information -- Renewing KES keys and an operational certificate - -7. [Stake pool operations part 2](https://youtu.be/2LHCWyvM4Lc) - -- Changing pool parameters -- Withdrawing rewards - -8. [Stake pool operations part 3](https://www.youtube.com/watch?v=WcT2gyflJKg) - -- [Updating cardano-node and cardano-cli](https://youtu.be/WcT2gyflJKg) -- [Retiring a stake pool](https://youtu.be/x4Igwc_WaoA) - -Supporting **handbook** material: - -- [The Setup](https://cardano-course.gitbook.io/cardano-course/handbook/create-a-stake-pool/the-setup) -- [Generating keys](https://cardano-course.gitbook.io/cardano-course/handbook/create-a-stake-pool/generate-keys) -- [Registering a stake pool](https://cardano-course.gitbook.io/cardano-course/handbook/create-a-stake-pool/register-stake-pool) -- [Exploring runtime system options](https://cardano-course.gitbook.io/cardano-course/handbook/create-a-stake-pool/runtime-system-options) -- [Running the nodes](https://cardano-course.gitbook.io/cardano-course/handbook/create-a-stake-pool/running-the-nodes) -- [About stake snapshots](https://cardano-course.gitbook.io/cardano-course/handbook/create-a-stake-pool/stake-snapshots) -- [Upgrading cardano-node and cardano-cli](https://cardano-course.gitbook.io/cardano-course/handbook/create-a-stake-pool/upgrading-cardano-node-and-cardano-cli) -- [Stake pool operations and maintenance](https://cardano-course.gitbook.io/cardano-course/handbook/create-a-stake-pool/pool-maintainance) -- [Retiring a stake pool](https://cardano-course.gitbook.io/cardano-course/handbook/create-a-stake-pool/retiring-a-stake-pool) - diff --git a/docs/08-operating-a-stake-pool/04-node-connectivity.mdx b/docs/08-operating-a-stake-pool/04-node-connectivity.mdx index bf4d28ae..f3c18257 100644 --- a/docs/08-operating-a-stake-pool/04-node-connectivity.mdx +++ b/docs/08-operating-a-stake-pool/04-node-connectivity.mdx @@ -9,14 +9,12 @@ block creation. ## Cardano networking -Cardano's networking evolved from its initial federated structure to hybrid and the current Dynamic peer-to-peer (P2P) model. Networking will keep evolving with future additions such as Ouroboros Genesis and peer-sharing. See [this explainer](https://docs.cardano.org/explore-cardano/cardano-network/p2p-networking) for more details about network evolution and Dynamic P2P. +Cardano's networking evolved from its initial federated structure to hybrid and the Dynamic peer-to-peer (P2P) model. Networking will keep evolving with future additions such as Ouroboros Genesis and peer-sharing. See [this explainer](/explore-cardano/cardano-network/p2p-networking) for more details about network evolution and P2P. In a previous hybrid setup, SPOs could configure a node to connect to, for example, 50 other SPO nodes. This is a pretty large number, since many nodes can be offline, change their addresses, etc. While 20 connections are enough for efficient communication, SPOs had to over-provision because of the static configuration. In a Dynamic P2P setup, SPOs can target to configure 20 connections, which can be picked from thousands of SPO relays, not just 50. And if any are offline, or go offline, the setup will automatically pick new ones, to meet the set target. This means that the configuration is no longer limited to a static pool of 50 peers. -P2P also allows for more sophisticated configurations for direct peering arrangements between SPOs. For example, if two SPOs want to maintain a connection between their relays, and each has two relays, they can configure a group of peers that lists the other SPOs’ two relays but with a target that there should be at least one connection. This means that there is no need for over-provisioning, and SPOs still get automatic failover if one relay goes down. With static configuration, one had to choose between listing only one and thus not getting resilience, or listing both and over-provisioning (using more resources). - ## Connecting core and relay nodes As a stake pool operator, you will have two types of nodes: core nodes and relay @@ -27,14 +25,16 @@ producing blocks, while relays are responsible for communicating with other relays in the network and broadcasting blocks. This difference determines how they are configured and how they are connected to the network. -A core node is configured with various key-pairs and an operational certificate -needed for block generation. It only connects to its relay nodes. +A core node is configured with various key pairs and an operational certificate +required for block generation. It only connects to its relay nodes. + +:::info + +Developer resources: -## Instructions to configure a node +- [Stake pool networking](https://developers.cardano.org/docs/operate-a-stake-pool/stake-pool-networking) +- [Cardano relay configuration](https://developers.cardano.org/docs/operate-a-stake-pool/cardano-relay-configuration) +- [Configurations and setup](https://cardano-course.gitbook.io/cardano-course/handbook/create-a-stake-pool/the-setup) -- [About node configuration files](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/getting-started/understanding-config-files.md) -- [Configuring topology files for block-producing and relay nodes](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/stake-pool-operations/0_core_relay.md) -- [Getting configuration files and connecting the node](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/stake-pool-operations/1_getConfigFiles_AND_Connect.md) -- [Starting the node](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/stake-pool-operations/2_start_your_nodes.md) +::: -Read the next section about **keys and operational certificates** to proceed. diff --git a/docs/08-operating-a-stake-pool/05-node-monitoring.mdx b/docs/08-operating-a-stake-pool/05-node-monitoring.mdx index 4a0449cb..eb85fc13 100644 --- a/docs/08-operating-a-stake-pool/05-node-monitoring.mdx +++ b/docs/08-operating-a-stake-pool/05-node-monitoring.mdx @@ -5,18 +5,14 @@ metaTitle: Logging and monitoring Regular monitoring of active nodes is crucial to determine if the node is running optimally, if the system is performant, or if fine-tuning is required. -Activate a trace on the node to access metrics, including network traffic, memory usage, and general blockchain data. For details, see: +:::info -- [Configuring logging](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/logging-monitoring/logging.md) - -You can then choose a toolset to monitor your node: +Developer resources: -- [Monitoring the node with EKG](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/logging-monitoring/ekg.md) -- [Using a Grafana Dashboard](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/logging-monitoring/grafana.md) -- [Monitoring the node in real time with RTView](https://docs.cardano.org/cardano-components/cardano-rtview) -- [Monitoring the node with Prometheus](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/logging-monitoring/prometheus.md) +- [Cardano course: monitoring the nodes](https://cardano-course.gitbook.io/cardano-course/handbook/monitoring-our-nodes) +- [Monitoring with gLiveView](https://developers.cardano.org/docs/operate-a-stake-pool/monitoring-gLiveView) +- [Grafana dashboard tutorial](https://developers.cardano.org/docs/operate-a-stake-pool/grafana-dashboard-tutorial) + +::: -You can also see video tutorials and Cardano Course handbook material: -- [Monitoring the node with Prometheus and Grafana](https://cardano-course.gitbook.io/cardano-course/handbook/monitoring-our-nodes) -- [Video explainer on monitoring the node with Prometheus](https://www.youtube.com/watch?v=iqAmwhk7djE&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=22) diff --git a/docs/08-operating-a-stake-pool/06-creating-keys-and-certificates.mdx b/docs/08-operating-a-stake-pool/06-creating-keys-and-certificates.mdx index 5f6975a9..7782ca8c 100644 --- a/docs/08-operating-a-stake-pool/06-creating-keys-and-certificates.mdx +++ b/docs/08-operating-a-stake-pool/06-creating-keys-and-certificates.mdx @@ -14,7 +14,7 @@ The keys that you need as a stake pool operator are: - stake pool cold key - stake pool hot key (KES key) -- stake pool VRF key +- stake pool VRF key. The KES key, or hot key as mentioned above, is a node operational key that authenticates who you are. You specify the validity of the KES key using the @@ -22,13 +22,15 @@ start time and key period parameters and this KES key needs to be updated every 90 days. The VRF key is a signing verification key and is stored within the operational certificate. -## Instructions to create and manage stake pool operation keys +:::info -- [Creating keys and addresses](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/stake-pool-operations/3_keys_and_addresses.md) -- [Creating a simple transaction](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/stake-pool-operations/4_simple_transaction.md) -- [Registering stake address](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/stake-pool-operations/5_register_key.md) -- [Generating stake pool keys](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/stake-pool-operations/6_node_keys.md) -- [Creating KES key pair](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/stake-pool-operations/7_KES_period.md) +Developer resources: + +- [Generating wallet keys](https://developers.cardano.org/docs/operate-a-stake-pool/generating-wallet-keys) +- [Generating block-producing keys](https://developers.cardano.org/docs/operate-a-stake-pool/block-producer-keys) +- [Cardano course: generating keys](https://cardano-course.gitbook.io/cardano-course/handbook/create-a-stake-pool/generate-keys). + +::: ## Creating an operational certificate and registering a stake pool @@ -43,21 +45,24 @@ operational key is valid, to prevent malicious interference. The certificate identifies the current operational key, and is signed by the offline key. Certificates are generated with an issue counter number and included in the -header of each block the node generates. Note that with the Vasil hard fork, an operator would need to create an operational certificate using cold.counter +1. This means that the `OpCert` must be exactly one more than the previously used one. +header of each block the node generates. -Certificates include a kes-period (start date), which indicates the time span +Certificates include a kes-period (start date), which indicates the period within which the certificate is valid before you need to create another one. Certificates are generated on the offline machine using the offline/cold keys, before being copied over to the node to validate the KES keys used to sign the blocks. -## Instructions to work with operational certificates +:::info -After creating a KES key pair, you can proceed with registering your stake pool with metadata, registering relay nodes on-chain, and generating a stake pool registration certificate. For a step-by-step tutorial, see: +Developer resources: -- [Registering a stake pool](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/stake-pool-operations/8_register_stakepool.md) +- [Registering a stake address](https://developers.cardano.org/docs/operate-a-stake-pool/register-stake-address) +- [Registering a pool](https://developers.cardano.org/docs/operate-a-stake-pool/register-stake-pool) +- [Cardano course: registering a stake pool](https://cardano-course.gitbook.io/cardano-course/handbook/create-a-stake-pool/register-stake-pool). +::: diff --git a/docs/08-operating-a-stake-pool/07-maintenance.mdx b/docs/08-operating-a-stake-pool/07-maintenance.mdx new file mode 100644 index 00000000..43a43546 --- /dev/null +++ b/docs/08-operating-a-stake-pool/07-maintenance.mdx @@ -0,0 +1,28 @@ +--- +title: Stake pool operations and maintenance +metaTitle: Stake pool operations and maintenance +--- + +After a successful stake pool registration and its further operation, SPOs might +be interested in obtaining certain information about their pools’ activity. +Information about those pools that are operating on mainnet can be fetched using +different explorer tools. See [introduction](/08-operating-a-stake-pool/index.mdx) for useful resources. + +In certain cases, exchanges and stake pool operators, in particular, are looking +for in-depth information about their mainnet _and_ testnet pools. To access data +that is stored on the Cardano blockchain, it is recommended to use +[cardano-node](https://github.com/input-output-hk/cardano-node), +[cardano-db-sync](https://github.com/input-output-hk/cardano-db-sync), or +[cardano-graphql](https://github.com/input-output-hk/cardano-graphql). + +Each of the above integration components can be installed and easily deployed +using Docker. + +:::info + +Developer resources: + +- [Cardano course: operations and maintenance](https://cardano-course.gitbook.io/cardano-course/handbook/create-a-stake-pool/pool-maintainance) +- [Developer portal: operator tools](https://developers.cardano.org/docs/operate-a-stake-pool/guild-ops-suite) + +::: diff --git a/docs/08-operating-a-stake-pool/07-public-stake-pools.mdx b/docs/08-operating-a-stake-pool/07-public-stake-pools.mdx deleted file mode 100644 index c85c37ff..00000000 --- a/docs/08-operating-a-stake-pool/07-public-stake-pools.mdx +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: Stake pool operations and maintenance -metaTitle: Stake pool operations and maintenance ---- - -## Stake pool maintenance tutorials - -- [Checking leadership schedule](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/stake-pool-operations/9_leadership_schedule.md) -- [Querying stake snapshots and pool parameters](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/stake-pool-operations/10_query_stakepool.md) -- [Withdrawing rewards](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/stake-pool-operations/11_withdraw-rewards.md) -- [Retiring a stake pool](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/stake-pool-operations/12_retire_stakepool.md) - -## How to obtain stake pool information - -After a successful stake pool registration and its further operation, SPOs might -be interested in obtaining certain information about their pools’ activity. -Information about those pools that are operating on mainnet can be fetched using -a [pooltool.io](https://pooltool.io/), which provides verified stake pool -details. - -In certain cases, exchanges and stake pool operators, in particular, are looking -for in-depth information about their mainnet _and_ testnet pools. To access data -that is stored on the Cardano blockchain, we recommend using -[cardano-node](https://github.com/input-output-hk/cardano-node), -[cardano-db-sync](https://github.com/input-output-hk/cardano-db-sync), and a -[cardano-graphql](https://github.com/input-output-hk/cardano-graphql). - -Each of the above integration components can be installed and easily deployed -using Docker. - -Another available option – which is often useful by exchanges and stake pool -operators who wish to test stake pool operations on testnet – is the public -[Cardano Explorer](https://explorer.cardano.org/en) which also functions based -on the cardano-graphql instance. - -Below are some queries that you may find useful in obtaining _testnet_ stake -pool information. The same query can be used on the mainnet by substituting the -relevant URL: - -**Show the pool ID assigned to the stake address:** - -``` -curl -X POST -H "Content-Type: application/json" -d '{"query": "query getStake_address($address: StakeAddress!){ activeStake(limit: 1 where: { address: { _eq: $address } }) { address stakePoolId }}","variables":{"address":”$My_stake_address_here"}}' https://explorer.cardano-testnet.iohkdev.io/graphql: | jq -``` - -**Show the amount of active stake in the staking address:** - -``` -curl -X POST -H "Content-Type: application/json" -d '{"query": "query get_active_stake($address: StakeAddress!){ activeStake(limit: 1 where: { address: { _eq: $address } }) { address amount }}","variables":{"address":"$My_stake_address_here"}}' https://explorer.cardano-testnet.iohkdev.io/graphql: -``` - -**Check that pool ID has been registered on the chain:** - -``` -curl -X POST -H "Content-Type: application/json" -d '{"query": "query getStake_pool($id: StakePoolID!){ stakePools(limit: 1 where: { id: { _eq: $id } }){ id } }","variables":{"id":”$My_Pool_id_here"}}' https://explorer.cardano.org/graphql: -``` - -**Fetch pool information:** - -``` -curl -X POST -H "Content-Type: application/json" -d '{"query": "query getStake_pool($id: StakePoolID!){ stakePools(limit: 1 where: { id: { _eq: $id } }){ id pledge fixedCost hash margin metadataHash} }","variables":{"id":"$My_Pool_id_here"}}' https://explorer.cardano-testnet.iohkdev.io/graphql: | jq -``` - -**Check rewards:** - -``` -curl -X POST -H "Content-Type: application/json" -d '{"query": "query getStake_address($address: StakeAddress!){ rewards(limit: 10 where: { address: { _eq: $address } }) { amount address } }", "variables":{"address":"$My_stake_address_here"}}' https://explorer.cardano.org/graphql: | jq -``` - -**Check rewards in more detail:** - -``` -curl -X POST -H "Content-Type: application/json" -d '{"query": "query getStake_pool($id: StakePoolID!){ stakePools(limit: 1 where: { id: { _eq: $id } }){ id rewards{address amount stakePool{id}} } }","variables":{"id":"$My_Pool_id_here"}}' https://explorer.cardano.org/graphql: | jq -``` - -**See rewards earned in a certain epoch:** - -``` -curl -X POST -H "Content-Type: application/json" -d '{"query": "query getStake_address($address: StakeAddress!){ rewards(limit: 1 where: { address: { _eq: $address } }) { amount address earnedIn{blocks{epochNo}} stakePool{id} } }","variables":{"address":"$My_stake_address_here"}}' https://explorer.cardano-testnet.iohkdev.io/graphql: | jq -``` diff --git a/docs/08-operating-a-stake-pool/08-SMASH.mdx b/docs/08-operating-a-stake-pool/08-metadata-management.mdx similarity index 100% rename from docs/08-operating-a-stake-pool/08-SMASH.mdx rename to docs/08-operating-a-stake-pool/08-metadata-management.mdx diff --git a/docs/08-operating-a-stake-pool/_category_.yml b/docs/08-operating-a-stake-pool/_category_.yml deleted file mode 100644 index 3f3835c7..00000000 --- a/docs/08-operating-a-stake-pool/_category_.yml +++ /dev/null @@ -1,4 +0,0 @@ -position: 8 -label: 'Operating a stake pool' -collapsible: true -collapsed: true diff --git a/docs/08-operating-a-stake-pool/index.mdx b/docs/08-operating-a-stake-pool/index.mdx new file mode 100644 index 00000000..034d90a0 --- /dev/null +++ b/docs/08-operating-a-stake-pool/index.mdx @@ -0,0 +1,30 @@ +--- +title: Operating a stake pool +metaTitle: Operating a stake pool +sidebar_position: 8 +--- + +Welcome to the stake pool operations section! + +Here, you will find explanations about stake pools, operators, and owners, along with core concepts such as node connectivity, keys, operational certificates, metadata management, performance, and ranking. + + :::info + +To get started with stake pool operations, refer to: + +- [Developer portal SPO tutorials](https://developers.cardano.org/docs/operate-a-stake-pool/) +- [Cardano course SPO tutorials](https://cardano-course.gitbook.io/cardano-course/handbook/create-a-stake-pool) +- [The Guild Operators' tutorials](https://cardano-community.github.io/guild-operators/). + +::: + +## Useful resources + +| | | +|--|--| +| Node details | [Release notes](/release-notes/release-notes), [compatibility matrix](/release-notes/comp-matrix), [Cardano node repository](https://github.com/input-output-hk/cardano-node#overview-of-the-cardano-node-repository), [Cardano node video course (includes SPO explainers).](/development-guidelines/cardano-node-course/) | +| Testnets | [Cardano testnet environments](/cardano-testnets/environments), [testnets faucet](/cardano-testnets/tools/faucet/). | +| Tools | [Cardano ecosystem tools](https://developers.cardano.org/tools/), [community-built developer tools](https://www.essentialcardano.io/article/a-list-of-community-built-developer-tools-on-cardano).| +| Explorers | [AdaStat](https://adastat.net/transactions), [Adatools](https://adatools.io/), [Cardanoscan](https://cardanoscan.io/transactions), [Cexplorer](https://cexplorer.io/), [Cardano Assets](https://cardanoassets.com/), [Pool.pm](https://pool.pm/tokens), [ADAtainment](https://www.adatainment.com/index.php?page=home&lang=en), [Cardano PoolTool](https://pooltool.io/). | +| SPO alliances | [Guild Operators](https://cardano-community.github.io/guild-operators/): a group of well-known and experienced community members that provides information about guild tools that simplify various stake operations, [Cardano Single Pool Alliance (SPA)](https://singlepoolalliance.net/): a group of separate SPOs who have vowed to run a single stake pool for the sole purpose of providing the Cardano ecosystem with true decentralization, [xSPO Alliance](https://www.xspo-alliance.org/): a group of small SPOs that joined with a total live stake of less than one million ada each.| +| Communication channels | [SPO Telegram announcements channel](https://t.me/SPOannouncements), [IOG Technical Community Discord](https://discord.com/invite/5kaErDKDRq), [support](https://iohk.zendesk.com/hc/en-us).| diff --git a/src/pages/index.tsx b/src/pages/index.tsx index f52d8d19..10e771d3 100644 --- a/src/pages/index.tsx +++ b/src/pages/index.tsx @@ -90,7 +90,7 @@ export default function Home(): JSX.Element { heading="Stake pool operators" text="Committed to the health and diversity of Cardano, stake pool operators (SPOs) act as the driving force of the ecosystem, being responsible for transaction processing and block production. Interested in running your own stake pool? Find out how to set up and operate a stake pool. " label="Learn more" - ctalink="/operating-a-stake-pool/creating-a-stake-pool" + ctalink="/operating-a-stake-pool/" />