Skip to content

Commit 0f59409

Browse files
authored
fix(content): updates label of Appendix filecoin address section
1 parent 9fb87eb commit 0f59409

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

content/appendix/address.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Address"
33
weight: 2
44
dashboardWeight: 0.2
5-
dashboardState: wip
5+
dashboardState: reliable
66
dashboardAudit: n/a
77
---
88

@@ -18,7 +18,7 @@ Accounts have a public key-based address (e.g. to receive funds), and non-single
1818

1919
An account actor's crypto-address (for signature verification) is found by looking up its actor state, keyed by the canonical ID-address. There is no map from ID-address to pubkey address.
2020

21-
The reference implementation is https://github.com/filecoin-project/go-address
21+
The reference implementation of the Filecoin Address can be found in the [`go-address` Github repository](https://github.com/filecoin-project/go-address).
2222

2323
## Design criteria
2424

@@ -64,13 +64,13 @@ When encoded to a string a filecoin address contains the following:
6464

6565
### Network Prefix
6666

67-
The **network prefix** is prepended to an address when encoding to a string. The network prefix indicates which network an address belongs in. The network prefix may either be `f` for filecoin mainnet or `t` for filecoin testnet. It is worth noting that a network prefix will never appear on chain and is only used when encoding an address to a human readable format.
67+
The **network prefix** is prepended to an address when encoding to a string. The network prefix indicates which network an address belongs to. The network prefix may either be `f` for filecoin mainnet or `t` for filecoin testnet. It is worth noting that a network prefix will never appear on chain and is only used when encoding an address to a human readable format.
6868

6969
### Protocol Indicator
7070

7171
The **protocol indicator** byte describes how a method should interpret the information in the payload field of an address. Any deviation for the algorithms and data types specified by the protocol must be assigned a new protocol number. In this way, protocols also act as versions.
7272

73-
- `0 ` : ID
73+
- `0` : ID
7474
- `1` : SECP256K1 Public Key
7575
- `2` : Actor
7676
- `3` : BLS Public Key
@@ -91,7 +91,7 @@ const (
9191

9292
#### Protocol 0: IDs
9393

94-
**Protocol 0** addresses are simple IDs. All actors have a numeric ID even if they don't have public keys. The payload of an ID address is base10 encoded. IDs are not hashed and do not have a checksum.
94+
**Protocol 0** addresses are simple IDs. All actors have a numeric ID even if they don't have public keys. The payload of an ID address is base10 encoded. IDs are not hashed and do not have a checksum.
9595

9696
**Bytes**
9797

@@ -206,7 +206,7 @@ type Address interface {
206206
```
207207
#### New()
208208

209-
New returns an Address for the specified protocol encapsulating corresponding payload. New fails for unknown protocols.
209+
`New()` returns an Address for the specified protocol encapsulating corresponding payload. New fails for unknown protocols.
210210

211211
```go
212212
func New(protocol byte, payload []byte) Address {
@@ -298,7 +298,7 @@ func Decode(a string) Address {
298298

299299
#### Checksum()
300300

301-
Checksum produces a byte array by taking the blake2b-4 hash of an address protocol and payload.
301+
`Checksum` produces a byte array by taking the blake2b-4 hash of an address protocol and payload.
302302

303303
```go
304304

@@ -309,7 +309,7 @@ func Checksum(a Address) [4]byte {
309309

310310
#### ValidateChecksum()
311311

312-
ValidateChecksum returns true if the Checksum of data matches the expected checksum.
312+
`ValidateChecksum` returns true if the `Checksum` of data matches the expected checksum.
313313

314314
```go
315315
func ValidateChecksum(data, expected []byte) bool {

0 commit comments

Comments
 (0)