Skip to content

Commit

Permalink
Merge pull request #5515 from oasisprotocol/matevz/docs/fix-anchors
Browse files Browse the repository at this point in the history
docs: Fix broken anchors
  • Loading branch information
matevz authored Jan 11, 2024
2 parents 5b7def1 + 10b4c48 commit d95a268
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
1 change: 1 addition & 0 deletions .changelog/5515.doc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs: Fix broken link anchors
13 changes: 6 additions & 7 deletions docs/consensus/services/registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,8 @@ registry.RegisterEntity
```

The body of a register entity transaction must be a [`SignedEntity`] structure,
which is a [signed envelope] containing an [`Entity`] descriptor. The signer of
the entity MUST be the same as the signer of the transaction.
which is a [signed envelope][envelopes] containing an [`Entity`] descriptor. The
signer of the entity MUST be the same as the signer of the transaction.

Registering an entity may require sufficient stake in the entity's
[escrow account].
Expand All @@ -103,7 +103,7 @@ Registering an entity may require sufficient stake in the entity's
[`NewRegisterEntityTx`]: https://pkg.go.dev/github.com/oasisprotocol/oasis-core/go/registry/api?tab=doc#NewRegisterEntityTx
[`SignedEntity`]: https://pkg.go.dev/github.com/oasisprotocol/oasis-core/go/common/entity?tab=doc#SignedEntity
[`Entity`]: https://pkg.go.dev/github.com/oasisprotocol/oasis-core/go/common/entity?tab=doc#Entity
[signed envelope]: ../../crypto.md#signed-envelope
[envelopes]: ../../crypto.md#envelopes
[escrow account]: staking.md#escrow
<!-- markdownlint-enable line-length -->

Expand Down Expand Up @@ -140,13 +140,13 @@ registry.RegisterNode
```

The body of a register entity transaction must be a [`MultiSignedNode`]
structure, which is a [multi-signed envelope] containing a [`Node`] descriptor.
The signer of the transaction MUST be the node identity key.
structure, which is a [multi-signed envelope][envelopes] containing a [`Node`]
descriptor. The signer of the transaction MUST be the node identity key.

The owning entity MUST have the given node identity public key whitelisted in
the `Nodes` field in its [`Entity`] descriptor.

The node descriptor structure MUST be signed by all of the following keys:
The node descriptor structure MUST be signed by all the following keys:

* Node identity key.
* Consensus key.
Expand All @@ -171,7 +171,6 @@ sum of thresholds of all the runtimes it is registering for.
[`NewRegisterNodeTx`]: https://pkg.go.dev/github.com/oasisprotocol/oasis-core/go/registry/api?tab=doc#NewRegisterNodeTx
[`MultiSignedNode`]: https://pkg.go.dev/github.com/oasisprotocol/oasis-core/go/common/node?tab=doc#MultiSignedNode
[`Node`]: https://pkg.go.dev/github.com/oasisprotocol/oasis-core/go/common/node?tab=doc#Node
[multi-signed envelope]: ../../crypto.md#multi-signed-envelope
[`Thresholds` in staking consensus parameters]: https://pkg.go.dev/github.com/oasisprotocol/oasis-core/go/staking/api?tab=doc#ConsensusParameters.Thresholds
[`Staking` field]: https://pkg.go.dev/github.com/oasisprotocol/oasis-core/go/registry/api?tab=doc#Runtime.Staking
<!-- markdownlint-enable line-length -->
Expand Down
2 changes: 1 addition & 1 deletion docs/consensus/transactions.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ oasis-core/consensus: tx
```

[encoded]: ../encoding.md
[signed envelope]: ../crypto.md#signed-envelope
[signed envelope]: ../crypto.md#envelopes
[Domain separation]: ../crypto.md#domain-separation
[chain domain separation]: ../crypto.md#chain-domain-separation

Expand Down

0 comments on commit d95a268

Please sign in to comment.