package
1.32.0-rc2
Repository: https://github.com/filecoin-project/lotus.git
Documentation: pkg.go.dev

# README

Lotus API

This package contains all lotus API definitions. Interfaces defined here are exposed as JsonRPC 2.0 endpoints by lotus programs.

Versions

FileAlias FileInterfaceExposed byVersionHTTP EndpointStatusDocs
api_common.gov0api/latest.goCommonlotus; lotus-minerv0/rpc/v0Latest, StableMethods
api_full.gov1api/latest.goFullNodelotusv1/rpc/v1Latest, Work in progressMethods
api_storage.gov0api/latest.goStorageMinerlotus-minerv0/rpc/v0Latest, StableMethods
api_worker.gov0api/latest.goWorkerlotus-workerv0/rpc/v0Latest, StableMethods
v0api/full.goFullNodelotusv0/rpc/v0StableMethods

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
Package mocks is a generated GoMock package.
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

No description provided by the author
No description provided by the author
GetInternalStructs extracts all pointers to 'Internal' sub-structs from the provided pointer to a proxy struct.
No description provided by the author
NewErrExecutionReverted creates a new ErrExecutionReverted with the given reason.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Wrap adapts partial api impl to another version proxyT is the proxy type used as input in wrapperT Usage: Wrap(new(v1api.FullNodeStruct), new(v0api.WrapperV1Full), eventsApi).(EventAPI).

# Constants

go:generate go run golang.org/x/tools/cmd/stringer -type=CheckStatusCode -trimprefix=CheckStatus.
go:generate go run golang.org/x/tools/cmd/stringer -type=CheckStatusCode -trimprefix=CheckStatus.
go:generate go run golang.org/x/tools/cmd/stringer -type=CheckStatusCode -trimprefix=CheckStatus.
go:generate go run golang.org/x/tools/cmd/stringer -type=CheckStatusCode -trimprefix=CheckStatus.
go:generate go run golang.org/x/tools/cmd/stringer -type=CheckStatusCode -trimprefix=CheckStatus.
go:generate go run golang.org/x/tools/cmd/stringer -type=CheckStatusCode -trimprefix=CheckStatus.
go:generate go run golang.org/x/tools/cmd/stringer -type=CheckStatusCode -trimprefix=CheckStatus.
go:generate go run golang.org/x/tools/cmd/stringer -type=CheckStatusCode -trimprefix=CheckStatus.
go:generate go run golang.org/x/tools/cmd/stringer -type=CheckStatusCode -trimprefix=CheckStatus.
Message Checks.
go:generate go run golang.org/x/tools/cmd/stringer -type=CheckStatusCode -trimprefix=CheckStatus.
go:generate go run golang.org/x/tools/cmd/stringer -type=CheckStatusCode -trimprefix=CheckStatus.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Signing a blockheader.
Signing message CID.
Signing a deal proposal.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Manage permissions.
default.
Use wallet keys for signing.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SubsystemMining signifies the mining subsystem.
SubsystemSealing signifies the sealing subsystem.
SubsystemSectorStorage signifies the sector storage subsystem.
SubsystemUnknown is a placeholder for the zero value.
No description provided by the author

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
ErrF3Disabled signals that F3 consensus process is disabled.
ErrF3NotReady signals that the F3 instance isn't ready for participation yet.
ErrF3ParticipationIssuerMismatch signals that the ticket is not issued by the current node.
ErrF3ParticipationTicketExpired signals that the current GPBFT instance as surpassed the expiry of the ticket.
ErrF3ParticipationTicketInvalid signals that F3ParticipationTicket cannot be decoded.
ErrF3ParticipationTicketStartBeforeExisting signals that participation ticket is before the start instance of an existing lease held by the miner.
ErrF3ParticipationTooManyInstances signals that participation ticket cannot be issued because it asks for too many instances.
No description provided by the author
semver versions of the rpc api exposed.
semver versions of the rpc api exposed.
semver versions of the rpc api exposed.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
semver versions of the rpc api exposed.

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
APIVersion provides various build-time information.
No description provided by the author
No description provided by the author
ChainExportConfig holds configuration for chain ranged exports.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ErrActorNotFound signals that the actor is not found.
ErrExecutionReverted is used to return execution reverted with a reason for a revert in the `data` field.
No description provided by the author
ErrOutOfGas signals that a call failed due to insufficient gas.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
F3Participant captures information about the miners that are currently participating in F3, along with the number of instances for which their lease is valid.
F3ParticipationLease defines the lease granted to a storage provider for participating in F3 consensus, detailing the session identifier, issuer, subject, and the expiration instance.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
MessageSendSpec contains optional fields which modify message sending behavior.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PendingDealInfo has info about pending deals and when they are due to be published.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
VoucherCreateResult is the response to calling PaychVoucherCreate.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Interfaces

ChainIO abstracts operations for accessing raw IPLD objects.
No description provided by the author
EthSubscriber is the reverse interface to the client, called after EthSubscribe.
FullNode API is a low-level interface to the Filecoin network full node.
No description provided by the author
No description provided by the author
No description provided by the author
StorageMiner is a low-level interface to the Filecoin network storage miner node.
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
DealSchedule is deprecated DEPRECATED: Use piece.DealSchedule instead.
F3ParticipationTicket represents a ticket that authorizes a miner to participate in the F3 consensus.
MinerSubsystem represents a miner subsystem.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PieceDealInfo is deprecated DEPRECATED: Use piece.PieceDealInfo instead.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author