package
0.1.0
Repository: https://github.com/bpfs/dep2p.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

ExtractPublicKey extracts a [crypto.PubKey] matching the given [Name] from the IPNS Record, if possible.
MarshalRecord encodes the given IPNS Record into its [Protobuf serialization format].
NameFromCid creates a [Name] from the given [cid.Cid].
NameFromPeer creates a [Name] from the given [peer.ID].
NameFromRoutingKey creates a [Name] from the given IPNS Name in its routing key representation.
NameFromString creates a [Name] from the given IPNS Name in its [string representation].
NewRecord creates a new IPNS [Record] and signs it with the given private key.
UnmarshalRecord parses the [Protobuf-serialized] IPNS Record into a usable [Record] struct.
Validates validates the given IPNS Record against the given [crypto.PubKey], following the [Record Verification] specification.
ValidateWithName validates the given IPNS [Record] against the given [Name].
No description provided by the author
No description provided by the author

# Constants

DefaultRecordLifetime defines for how long IPNS record should be valid when ValidityType is 0.
DefaultRecordTTL specifies how long the record can be returned from cache before checking for update again.
MaxRecordSize is the IPNS Record [size limit].
NamespacePrefix is the prefix of the IPNS namespace.
ValidityEOL means "this record is valid until {Validity}".

# Variables

ErrDataMissing is returned when an IPNS [Record] is missing the data field.
ErrExpiredRecord is returned when an IPNS [Record] is invalid due to being expired.
ErrInvalidName is returned when an IPNS [Name] is invalid.
ErrInvalidPath is returned when an IPNS [Record] has an invalid path.
ErrInvalidPublicKey is returned when an IPNS [Record] has an invalid public key,.
ErrInvalidRecord is returned when an IPNS [Record] is malformed.
ErrInvalidValidity is returned when an IPNS [Record] has a known validity type, but the validity value is invalid.
ErrPublicKeyMismatch is return when the public key embedded in an IPNS [Record] does not match the expected public key.
ErrPublicKeyNotFound is returned when the public key is not found.
ErrRecordSize is returned when an IPNS [Record] exceeds the maximum size.
ErrSignature is returned when an IPNS [Record] fails signature verification.
ErrUnrecognizedValidity is returned when an IPNS [Record] has an unknown validity type.

# Structs

Name represents a [Multihash] of a serialized public key according to the [IPNS Name] specifications.
Record represents an [IPNS Record].
Validator is an IPNS Record validator that satisfies the [record.Validator] interface from DeP2P.

# Type aliases

No description provided by the author
No description provided by the author