From 7ea0e6cb8296d5b2abb96d0922e8a85a17fc54a7 Mon Sep 17 00:00:00 2001 From: fsgerse Date: Thu, 11 Jul 2024 09:55:14 +0800 Subject: [PATCH] chore: docs: fix typos (#12198) Co-authored-by: fsgerse <173036932+fsgerse@users.noreply.github.com> --- documentation/en/actor-events-api.md | 4 ++-- documentation/misc/Building_a_network_skeleton.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/en/actor-events-api.md b/documentation/en/actor-events-api.md index 801d101b59d..f8f4c6ad000 100644 --- a/documentation/en/actor-events-api.md +++ b/documentation/en/actor-events-api.md @@ -62,7 +62,7 @@ A `flags` field is used to convey metadata or hints about the entry, currently t * A `flag` of `0x02` indicates that the value is suitable for indexing. * A `flag` of `0x03` indicates that both the key and value are suitable for indexing. -Typically events contain entires that use either use `0x01` or `0x03` flags. +Typically events contain entries that use either use `0x01` or `0x03` flags. The structured logging style of composition should be seen in contrast to an alternative representation as a plain map or struct where the keys represent the fields of the event and the values represent the values of those fields. Some entries may duplicate keys, in which case that particular field of the event could be represented as an array. Builtin actor events are sufficiently well defined that translation to such a format is possible, but left up to the user. @@ -75,7 +75,7 @@ Two Lotus APIs are provided that can be used to obtain direct access to events s Both APIs take an `EventFilter` as an argument to determine which events to return. This event filter optionally comprises the following: -- `fromEpoch` determines when to start looking for matching events, either an epoch (in hex form), the string `earliest` or `latest` . A node is not guaranteed to have historical blocks for a particular epoch however `earliest` is intended to provide events from the begining of the available list. +- `fromEpoch` determines when to start looking for matching events, either an epoch (in hex form), the string `earliest` or `latest` . A node is not guaranteed to have historical blocks for a particular epoch however `earliest` is intended to provide events from the beginning of the available list. - `toEpoch` determines when to stop looking for matching events, either an epoch (in hex form), the string `earliest` or `latest`. - `addresses` will match a list of addresses that an event comes *from* (currently just a builtin actor address). - `fields` is a key to value mapping that matches specific event entries. Each field being matched is a property in the `fields` map and the value of that property is an array of maps, where each entry is a possible matching value for that entry. Each possible match contains a `codec` integer (currently just CBOR `0x51` for builtin actor events described in this document) and a `value` bytes blob (Base64 encoded) of the encoded field value (e.g. a Base64 encoded form of a CBOR encoded key string, such as an actor ID or an event ID). Matching first involves finding if an event’s entries contain one of the desired `key`s, then checking that one of the value matchers for that `key` field matches the value. Value matching is performed both on the `codec` and the `value` bytes. If an event’s entry is matched, the entire event is considered a match. This may be used to query for particular event types, such as `allocation`. diff --git a/documentation/misc/Building_a_network_skeleton.md b/documentation/misc/Building_a_network_skeleton.md index 68c1a50dd8d..f071e4a38c5 100644 --- a/documentation/misc/Building_a_network_skeleton.md +++ b/documentation/misc/Building_a_network_skeleton.md @@ -169,7 +169,7 @@ And you're done! These are all the steps necessary to create a network upgrade s - Have a local developer network that starts at the current network version. - Be able to see the Actor CIDs/Actor version for the mock Actor-bundle through `lotus state actor-cids --network-version XX+1` - Have a successful pre-migration. -- Complete the migration at upgrade epoch, with a succesful upgrade. +- Complete the migration at upgrade epoch, with a successful upgrade. - Sync the new network version with the mock actor bundle, and be able to see that you are on a new network version with `lotus state network-version` You can take a look at this [Lotus PR as a reference](https://github.com/filecoin-project/lotus/pull/11964), which added the skeleton for network version 23.