Skip to content

Commit

Permalink
Revert "Add crescendo network"
Browse files Browse the repository at this point in the history
  • Loading branch information
bshahid331 authored Dec 19, 2023
1 parent 6b96a9c commit 0d62eff
Show file tree
Hide file tree
Showing 140 changed files with 3,225 additions and 916 deletions.
8 changes: 4 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ yarn-error.log*
/docs/unsorted
.idea/

docs/reference/core-contracts/flow-ft/*
!docs/reference/core-contracts/flow-ft/index.md
docs/reference/core-contracts/flow-nft/*
!docs/reference/core-contracts/flow-nft/index.md
docs/references/core-contracts/flow-ft/*
!docs/references/core-contracts/flow-ft/index.md
docs/references/core-contracts/flow-nft/*
!docs/references/core-contracts/flow-nft/index.md

docs/.obsidian
2 changes: 1 addition & 1 deletion docs/architecture/node-ops/nodes/node-operation/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ More on this [here](./node-migration.md)

### Where can I find how many nodes are currently running Flow?

If you are running a node, then you most definitely have this information on your node in the file `<your bootstrap dir>/public-root-information/node-infos.pub.json`. If you are not running a node, you can find this information by using a Cadence script to query the [Staking Smart Contract](../../../../reference/core-contracts/06-staking-contract-reference.md) (or check [Flowdiver](https://flowdiver.io/staking/overview))
If you are running a node, then you most definitely have this information on your node in the file `<your bootstrap dir>/public-root-information/node-infos.pub.json`. If you are not running a node, you can find this information by using a Cadence script to query the [Staking Smart Contract](../../../../references/core-contracts/06-staking-contract-reference.md) (or check [Flowdiver](https://flowdiver.io/staking/overview))

### Why do I need to update my node's ulimit?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ All your private keys should be in the `bootstrap` folder created earlier. Pleas

You need to now register the node on chain by staking the node via [Flow Port](https://port.onflow.org/).

[Here](../../../../reference/flow-port/staking-guide.md) is a guide on how to use Flow port if you are not familiar with it.
[Here](../../../../references/run-and-secure/nodes/flow-port/staking-guide.md) is a guide on how to use Flow port if you are not familiar with it.
If you are staking via a custody provider or would like to directly submit a staking transaction instead follow this [guide](../../../staking/index.md#how-do-i-stake).

Fund you Flow account with at least 100.01 FLOW tokens, which covers the required stake plus the storage deposit.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ $tree ./bootstrap/
## Create Machine Account

You will now need to copy the Machine account public key displayed in the terminal output and
head over to [Flow Port](../../../../reference/flow-port/staking-guide.md#existing-node-operators) to submit a transaction to create a Machine Account.
head over to [Flow Port](../../../../references/run-and-secure/nodes/flow-port/staking-guide.md#existing-node-operators) to submit a transaction to create a Machine Account.
For example, from the example above, we would copy `f847...` from this line:

```shell Example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ Ensure you have configured your node using the [Node Setup guide](./node-setup.m

### Confirming authorization

You can confirm your node's successful registration and authorization by executing a Cadence script to query the [Staking Contract](../../../../reference/core-contracts/06-staking-contract-reference.md#contract).
You can confirm your node's successful registration and authorization by executing a Cadence script to query the [Staking Contract](../../../../references/core-contracts/06-staking-contract-reference.md#contract).
At the end of the `Staking Auction Phase`, the members of the Proposed Identity Table are confirmed as authorized participants in the next epoch.
Therefore, if your node ID appears in the Proposed Identity Table during the `Staking Auction Phase`, your node will be a participant in the next epoch.

Expand Down
8 changes: 4 additions & 4 deletions docs/architecture/staking/05-epoch-scripts-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ pub struct EpochMetadata {
The `FlowEpoch` smart contract provides a public function, `FlowEpoch.getEpochMetadata()`
to query the metadata for a particular epoch.

You can use the **Get Epoch Metadata**([EP.01](../../reference/core-contracts/07-epoch-contract-reference.md#getting-epoch-info)) script
You can use the **Get Epoch Metadata**([EP.01](../../references/core-contracts/07-epoch-contract-reference.md#getting-epoch-info)) script
with the following arguments:

| Argument | Type | Description |
Expand Down Expand Up @@ -207,7 +207,7 @@ pub struct Config {
}
```

You can use the **Get Configurable Metadata**([EP.02](../../reference/core-contracts/07-epoch-contract-reference.md#getting-epoch-info)) script
You can use the **Get Configurable Metadata**([EP.02](../../references/core-contracts/07-epoch-contract-reference.md#getting-epoch-info)) script
to get the list of configurable metadata:

This script does not require any arguments.
Expand All @@ -216,7 +216,7 @@ This script does not require any arguments.

The `FlowEpoch` smart contract always tracks the counter of the current epoch.

You can use the **Get Epoch Counter**([EP.03](../../reference/core-contracts/07-epoch-contract-reference.md#getting-epoch-info)) script
You can use the **Get Epoch Counter**([EP.03](../../references/core-contracts/07-epoch-contract-reference.md#getting-epoch-info)) script
to get the current epoch counter.

This script does not require any arguments.
Expand All @@ -233,7 +233,7 @@ pub enum EpochPhase: UInt8 {
}
```

You can use the **Get Epoch Phase**([EP.04](../../reference/core-contracts/07-epoch-contract-reference.md#getting-epoch-info)) script
You can use the **Get Epoch Phase**([EP.04](../../references/core-contracts/07-epoch-contract-reference.md#getting-epoch-info)) script
to get the current epoch phase.

This script does not require any arguments.
26 changes: 13 additions & 13 deletions docs/architecture/staking/07-staking-scripts-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ or you can monitor events that are emitted by the staking contract to be notifie
`FlowIDTableStaking.getProposedNodeIDs()`: Returns an array of node IDs for proposed nodes.
Proposed nodes are nodes that have enough staked and committed for the next epoch to be above the minimum requirement.

You can use the **Get Proposed Table**([SC.05](../../reference/core-contracts/06-staking-contract-reference.md#getting-staking-info)) script for retrieving this info.
You can use the **Get Proposed Table**([SC.05](../../references/core-contracts/06-staking-contract-reference.md#getting-staking-info)) script for retrieving this info.

This script requires no arguments.

Expand All @@ -26,7 +26,7 @@ This script requires no arguments.
`FlowIDTableStaking.getStakedNodeIDs()`: Returns an array of nodeIDs that are currently staked.
Staked nodes are nodes that currently have staked tokens above the minimum.

You can use the **Get Current Table**([SC.04](../../reference/core-contracts/06-staking-contract-reference.md#getting-staking-info)) script for retrieving this info.
You can use the **Get Current Table**([SC.04](../../references/core-contracts/06-staking-contract-reference.md#getting-staking-info)) script for retrieving this info.

This script requires no arguments.

Expand All @@ -36,14 +36,14 @@ This script requires no arguments.
associated with the specified node ID. You can see the `NodeInfo` definition in the [FlowIDTableStaking
smart contract.](https://github.com/onflow/flow-core-contracts/blob/master/contracts/FlowIDTableStaking.cdc#L264)

You can use the **Get Node Info**([SC.08](../../reference/core-contracts/06-staking-contract-reference.md#getting-staking-info)) script
You can use the **Get Node Info**([SC.08](../../references/core-contracts/06-staking-contract-reference.md#getting-staking-info)) script
with the following arguments:

| Argument | Type | Description |
| ---------- | -------- | -------------------------------------- |
| **nodeID** | `String` | The node ID of the node to search for. |

You can also query the info from an address by using the **Get Node Info From Address**([SC.26](../../reference/core-contracts/06-staking-contract-reference.md#getting-staking-info)) script
You can also query the info from an address by using the **Get Node Info From Address**([SC.26](../../references/core-contracts/06-staking-contract-reference.md#getting-staking-info)) script
with the following arguments:

| Argument | Type | Description |
Expand All @@ -55,7 +55,7 @@ with the following arguments:
`FlowIDTableStaking.NodeInfo(_ nodeID: String).totalCommittedWithDelegators()`: Returns the total committed balance for a node,
which is their total tokens staked + committed, plus all of the staked + committed tokens of all their delegators.

You can use the **Get Node Total Commitment**([SC.09](../../reference/core-contracts/06-staking-contract-reference.md#getting-staking-info)) script
You can use the **Get Node Total Commitment**([SC.09](../../references/core-contracts/06-staking-contract-reference.md#getting-staking-info)) script
with the following argument:

| Argument | Type | Description |
Expand All @@ -67,7 +67,7 @@ with the following argument:
`FlowIDTableStaking.NodeInfo(_ nodeID: String).totalCommittedWithoutDelegators()`: Returns the total committed balance for a node,
which is their total tokens staked + committed, plus all of the staked + committed tokens of all their delegators.

You can use the **Get Only Node Total Commitment**([SC.09](../../reference/core-contracts/06-staking-contract-reference.md#getting-staking-info)) script
You can use the **Get Only Node Total Commitment**([SC.09](../../references/core-contracts/06-staking-contract-reference.md#getting-staking-info)) script
with the following argument:

| Argument | Type | Description |
Expand All @@ -80,15 +80,15 @@ with the following argument:
associated with the specified node ID and delegator ID. You can see the `DelegatorInfo` definition in the [FlowIDTableStaking
smart contract.](https://github.com/onflow/flow-core-contracts/blob/master/contracts/FlowIDTableStaking.cdc#L348)

You can use the **Get Delegator Info**([SC.10](../../reference/core-contracts/06-staking-contract-reference.md#getting-staking-info))
You can use the **Get Delegator Info**([SC.10](../../references/core-contracts/06-staking-contract-reference.md#getting-staking-info))
script with the following arguments:

| Argument | Type | Description |
| --------------- | -------- | -------------------------------------------- |
| **nodeID** | `String` | The node ID that the delegator delegates to. |
| **delegatorID** | `String` | The ID of the delegator to search for. |

You can also query the info from an address by using the **Get Delegator Info From Address**([SC.27](../../reference/core-contracts/06-staking-contract-reference.md#getting-staking-info)) script
You can also query the info from an address by using the **Get Delegator Info From Address**([SC.27](../../references/core-contracts/06-staking-contract-reference.md#getting-staking-info)) script
with the following arguments:

| Argument | Type | Description |
Expand All @@ -99,7 +99,7 @@ with the following arguments:

`FlowIDTableStaking.getRewardCutPercentage(): UFix64`: Returns a `UFix64` number for the cut of delegator rewards that each node operator takes.

You can use the **Get Cut Percentage**([SC.01](../../reference/core-contracts/06-staking-contract-reference.md#getting-staking-info)) script to retrieve this info.
You can use the **Get Cut Percentage**([SC.01](../../references/core-contracts/06-staking-contract-reference.md#getting-staking-info)) script to retrieve this info.

This script requires no arguments.

Expand All @@ -108,27 +108,27 @@ This script requires no arguments.
`FlowIDTableStaking.getMinimumStakeRequirements(): {UInt8: UFix64}`: Returns a mapping
for the stake requirements for each node type.

You can use the **Get stake requirements**([SC.02](../../reference/core-contracts/06-staking-contract-reference.md#getting-staking-info)) script to retrieve this info.
You can use the **Get stake requirements**([SC.02](../../references/core-contracts/06-staking-contract-reference.md#getting-staking-info)) script to retrieve this info.

This script requires no arguments.

## Get the total weekly reward payout:

`FlowIDTableStaking.getEpochTokenPayout(): UFix64`: Returns a `UFix64` value for the total number of FLOW paid out each epoch (week).

You can use the **Get weekly payout**([SC.03](../../reference/core-contracts/06-staking-contract-reference.md#getting-staking-info)) script to retrieve this info.
You can use the **Get weekly payout**([SC.03](../../references/core-contracts/06-staking-contract-reference.md#getting-staking-info)) script to retrieve this info.

This script requires no arguments.

## Get the total FLOW staked:

You can use the **Get total FLOW staked**([SC.06](../../reference/core-contracts/06-staking-contract-reference.md#getting-staking-info)) script to retrieve this info.
You can use the **Get total FLOW staked**([SC.06](../../references/core-contracts/06-staking-contract-reference.md#getting-staking-info)) script to retrieve this info.

This script requires no arguments.

## Get the total FLOW staked by all the nodes of a single node role:

You can use the **Get total FLOW staked by node type**([SC.07](../../reference/core-contracts/06-staking-contract-reference.md#getting-staking-info)) script
You can use the **Get total FLOW staked by node type**([SC.07](../../references/core-contracts/06-staking-contract-reference.md#getting-staking-info)) script
with the following arguments:

| Argument | Type | Description |
Expand Down
10 changes: 5 additions & 5 deletions docs/architecture/staking/09-qc-dkg.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,14 +72,14 @@ It also creates a machine account for the QC object.
If a user already has a registered node with the staking collection, but hasn't created their QC Voter object yet,
they can use the [`create_machine_account.cdc` transaction.](./14-staking-collection.md#create-a-machine-account-for-an-existing-node)

If a user is not using the staking collection, they can use the **Create QC Voter** ([QC.01](../../reference/core-contracts/07-epoch-contract-reference.md#quorum-certificate-transactions-and-scripts))
If a user is not using the staking collection, they can use the **Create QC Voter** ([QC.01](../../references/core-contracts/07-epoch-contract-reference.md#quorum-certificate-transactions-and-scripts))
transaction. This will only store the QC Voter object in the account that stores the `NodeStaker` object.
It does not create a machine account or store it elsewhere, so it is not recommended to use. We encourage to use the staking collection instead.

### Submit Vote

During the Epoch Setup Phase, the node software should submit the votes for the QC generation
automatically using the **Submit QC Vote** ([QC.02](../../reference/core-contracts/07-epoch-contract-reference.md#quorum-certificate-transactions-and-scripts))
automatically using the **Submit QC Vote** ([QC.02](../../references/core-contracts/07-epoch-contract-reference.md#quorum-certificate-transactions-and-scripts))
transaction with the following arguments.

| Argument | Type | Description |
Expand Down Expand Up @@ -113,15 +113,15 @@ It also creates a machine account for the DKG Object.
If a user already has a registered node with the staking collection, but hasn't created their DKG Participant object yet,
they can use the [`create_machine_account.cdc` transaction.](./14-staking-collection.md#create-a-machine-account-for-an-existing-node)

If a user is not using the staking collection, they can use the **Create DKG Participant** ([DKG.01](../../reference/core-contracts/07-epoch-contract-reference.md#dkg-transactions-and-scripts))
If a user is not using the staking collection, they can use the **Create DKG Participant** ([DKG.01](../../references/core-contracts/07-epoch-contract-reference.md#dkg-transactions-and-scripts))
transaction. This will only store the DKG Participant object in the account that stores the `NodeStaker` object.
It does not create a machine account or store it elsewhere, so it is not recommended to use.
The staking collection is the recommended method.

### Post Whiteboard Message

During the Epoch Setup Phase, the node software should post whiteboard messages to the DKG
automatically using the **Post Whiteboard Message** ([DKG.02](../../reference/core-contracts/07-epoch-contract-reference.md#dkg-transactions-and-scripts))
automatically using the **Post Whiteboard Message** ([DKG.02](../../references/core-contracts/07-epoch-contract-reference.md#dkg-transactions-and-scripts))
transaction with the following arguments.

| Argument | Type | Description |
Expand All @@ -131,7 +131,7 @@ transaction with the following arguments.
### Send Final Submission

During the Epoch Setup Phase, the node software should send its final submission for the DKG
automatically using the **Send Final Submission** ([DKG.03](../../reference/core-contracts/07-epoch-contract-reference.md#dkg-transactions-and-scripts))
automatically using the **Send Final Submission** ([DKG.03](../../references/core-contracts/07-epoch-contract-reference.md#dkg-transactions-and-scripts))
transaction with the following arguments.

| Argument | Type | Description |
Expand Down
Loading

0 comments on commit 0d62eff

Please sign in to comment.