Documentation ¶
Index ¶
- Constants
- type BeaconAPI
- type ChainAPI
- func (a *ChainAPI) ChainExport(ctx context.Context, nroots abi.ChainEpoch, tsk types.TipSetKey) (<-chan []byte, error)
- func (a *ChainAPI) ChainGetBlock(ctx context.Context, msg cid.Cid) (*types.BlockHeader, error)
- func (a *ChainAPI) ChainGetBlockMessages(ctx context.Context, msg cid.Cid) (*api.BlockMessages, error)
- func (a *ChainAPI) ChainGetGenesis(ctx context.Context) (*types.TipSet, error)
- func (a *ChainAPI) ChainGetMessage(ctx context.Context, mc cid.Cid) (*types.Message, error)
- func (a *ChainAPI) ChainGetNode(ctx context.Context, p string) (*api.IpldObject, error)
- func (a *ChainAPI) ChainGetParentMessages(ctx context.Context, bcid cid.Cid) ([]api.Message, error)
- func (a *ChainAPI) ChainGetParentReceipts(ctx context.Context, bcid cid.Cid) ([]*types.MessageReceipt, error)
- func (a *ChainAPI) ChainGetPath(ctx context.Context, from types.TipSetKey, to types.TipSetKey) ([]*api.HeadChange, error)
- func (a *ChainAPI) ChainGetRandomnessFromBeacon(ctx context.Context, tsk types.TipSetKey, ...) (abi.Randomness, error)
- func (a *ChainAPI) ChainGetRandomnessFromTickets(ctx context.Context, tsk types.TipSetKey, ...) (abi.Randomness, error)
- func (a *ChainAPI) ChainGetTipSet(ctx context.Context, key types.TipSetKey) (*types.TipSet, error)
- func (a *ChainAPI) ChainGetTipSetByHeight(ctx context.Context, h abi.ChainEpoch, tsk types.TipSetKey) (*types.TipSet, error)
- func (a *ChainAPI) ChainHasObj(ctx context.Context, obj cid.Cid) (bool, error)
- func (a *ChainAPI) ChainHead(context.Context) (*types.TipSet, error)
- func (a *ChainAPI) ChainNotify(ctx context.Context) (<-chan []*api.HeadChange, error)
- func (a *ChainAPI) ChainReadObj(ctx context.Context, obj cid.Cid) ([]byte, error)
- func (a *ChainAPI) ChainSetHead(ctx context.Context, tsk types.TipSetKey) error
- func (a *ChainAPI) ChainStatObj(ctx context.Context, obj cid.Cid, base cid.Cid) (api.ObjStat, error)
- func (a *ChainAPI) ChainTipSetWeight(ctx context.Context, tsk types.TipSetKey) (types.BigInt, error)
- type GasAPI
- func (a *GasAPI) GasEstimateFeeCap(ctx context.Context, msg *types.Message, maxqueueblks int64, ...) (types.BigInt, error)
- func (a *GasAPI) GasEstimateGasLimit(ctx context.Context, msgIn *types.Message, _ types.TipSetKey) (int64, error)
- func (a *GasAPI) GasEstimateGasPremium(ctx context.Context, nblocksincl uint64, sender address.Address, ...) (types.BigInt, error)
- func (a *GasAPI) GasEstimateMessageGas(ctx context.Context, msg *types.Message, spec *api.MessageSendSpec, ...) (*types.Message, error)
- type MpoolAPI
- func (a *MpoolAPI) MpoolClear(ctx context.Context, local bool) error
- func (a *MpoolAPI) MpoolGetConfig(context.Context) (*types.MpoolConfig, error)
- func (a *MpoolAPI) MpoolGetNonce(ctx context.Context, addr address.Address) (uint64, error)
- func (a *MpoolAPI) MpoolPending(ctx context.Context, tsk types.TipSetKey) ([]*types.SignedMessage, error)
- func (a *MpoolAPI) MpoolPush(ctx context.Context, smsg *types.SignedMessage) (cid.Cid, error)
- func (a *MpoolAPI) MpoolPushMessage(ctx context.Context, msg *types.Message, spec *api.MessageSendSpec) (*types.SignedMessage, error)
- func (a *MpoolAPI) MpoolSelect(ctx context.Context, tsk types.TipSetKey, ticketQuality float64) ([]*types.SignedMessage, error)
- func (a *MpoolAPI) MpoolSetConfig(ctx context.Context, cfg *types.MpoolConfig) error
- func (a *MpoolAPI) MpoolSub(ctx context.Context) (<-chan api.MpoolUpdate, error)
- type MsigAPI
- func (a *MsigAPI) MsigApprove(ctx context.Context, msig address.Address, txID uint64, ...) (cid.Cid, error)
- func (a *MsigAPI) MsigCancel(ctx context.Context, msig address.Address, txID uint64, to address.Address, ...) (cid.Cid, error)
- func (a *MsigAPI) MsigCreate(ctx context.Context, req uint64, addrs []address.Address, ...) (cid.Cid, error)
- func (a *MsigAPI) MsigPropose(ctx context.Context, msig address.Address, to address.Address, ...) (cid.Cid, error)
- func (a *MsigAPI) MsigSwapApprove(ctx context.Context, msig address.Address, src address.Address, txID uint64, ...) (cid.Cid, error)
- func (a *MsigAPI) MsigSwapCancel(ctx context.Context, msig address.Address, src address.Address, txID uint64, ...) (cid.Cid, error)
- func (a *MsigAPI) MsigSwapPropose(ctx context.Context, msig address.Address, src address.Address, ...) (cid.Cid, error)
- type StateAPI
- func (a *StateAPI) MinerCreateBlock(ctx context.Context, bt *api.BlockTemplate) (*types.BlockMsg, error)
- func (a *StateAPI) MinerGetBaseInfo(ctx context.Context, maddr address.Address, epoch abi.ChainEpoch, ...) (*api.MiningBaseInfo, error)
- func (a *StateAPI) MsigGetAvailableBalance(ctx context.Context, addr address.Address, tsk types.TipSetKey) (types.BigInt, error)
- func (a *StateAPI) StateAccountKey(ctx context.Context, addr address.Address, tsk types.TipSetKey) (address.Address, error)
- func (a *StateAPI) StateAllMinerFaults(ctx context.Context, lookback abi.ChainEpoch, endTsk types.TipSetKey) ([]*api.Fault, error)
- func (a *StateAPI) StateCall(ctx context.Context, msg *types.Message, tsk types.TipSetKey) (*api.InvocResult, error)
- func (a *StateAPI) StateChangedActors(ctx context.Context, old cid.Cid, new cid.Cid) (map[string]types.Actor, error)
- func (a *StateAPI) StateCirculatingSupply(ctx context.Context, tsk types.TipSetKey) (api.CirculatingSupply, error)
- func (a *StateAPI) StateCompute(ctx context.Context, height abi.ChainEpoch, msgs []*types.Message, ...) (*api.ComputeStateOutput, error)
- func (a *StateAPI) StateDealProviderCollateralBounds(ctx context.Context, size abi.PaddedPieceSize, verified bool, ...) (api.DealCollateralBounds, error)
- func (a *StateAPI) StateGetActor(ctx context.Context, actor address.Address, tsk types.TipSetKey) (*types.Actor, error)
- func (a *StateAPI) StateGetReceipt(ctx context.Context, msg cid.Cid, tsk types.TipSetKey) (*types.MessageReceipt, error)
- func (a *StateAPI) StateListActors(ctx context.Context, tsk types.TipSetKey) ([]address.Address, error)
- func (a *StateAPI) StateListMessages(ctx context.Context, match *types.Message, tsk types.TipSetKey, ...) ([]cid.Cid, error)
- func (a *StateAPI) StateListMiners(ctx context.Context, tsk types.TipSetKey) ([]address.Address, error)
- func (a *StateAPI) StateLookupID(ctx context.Context, addr address.Address, tsk types.TipSetKey) (address.Address, error)
- func (a *StateAPI) StateMarketBalance(ctx context.Context, addr address.Address, tsk types.TipSetKey) (api.MarketBalance, error)
- func (a *StateAPI) StateMarketDeals(ctx context.Context, tsk types.TipSetKey) (map[string]api.MarketDeal, error)
- func (a *StateAPI) StateMarketParticipants(ctx context.Context, tsk types.TipSetKey) (map[string]api.MarketBalance, error)
- func (a *StateAPI) StateMarketStorageDeal(ctx context.Context, dealId abi.DealID, tsk types.TipSetKey) (*api.MarketDeal, error)
- func (a *StateAPI) StateMinerActiveSectors(ctx context.Context, maddr address.Address, tsk types.TipSetKey) ([]*api.ChainSectorInfo, error)
- func (a *StateAPI) StateMinerAvailableBalance(ctx context.Context, maddr address.Address, tsk types.TipSetKey) (types.BigInt, error)
- func (a *StateAPI) StateMinerDeadlines(ctx context.Context, m address.Address, tsk types.TipSetKey) ([]*miner.Deadline, error)
- func (a *StateAPI) StateMinerFaults(ctx context.Context, addr address.Address, tsk types.TipSetKey) (bitfield.BitField, error)
- func (a *StateAPI) StateMinerInfo(ctx context.Context, actor address.Address, tsk types.TipSetKey) (api.MinerInfo, error)
- func (a *StateAPI) StateMinerInitialPledgeCollateral(ctx context.Context, maddr address.Address, pci miner.SectorPreCommitInfo, ...) (types.BigInt, error)
- func (a *StateAPI) StateMinerPartitions(ctx context.Context, m address.Address, dlIdx uint64, tsk types.TipSetKey) ([]*miner.Partition, error)
- func (a *StateAPI) StateMinerPower(ctx context.Context, addr address.Address, tsk types.TipSetKey) (*api.MinerPower, error)
- func (a *StateAPI) StateMinerPreCommitDepositForPower(ctx context.Context, maddr address.Address, pci miner.SectorPreCommitInfo, ...) (types.BigInt, error)
- func (a *StateAPI) StateMinerProvingDeadline(ctx context.Context, addr address.Address, tsk types.TipSetKey) (*miner.DeadlineInfo, error)
- func (a *StateAPI) StateMinerRecoveries(ctx context.Context, addr address.Address, tsk types.TipSetKey) (bitfield.BitField, error)
- func (a *StateAPI) StateMinerSectorCount(ctx context.Context, addr address.Address, tsk types.TipSetKey) (api.MinerSectors, error)
- func (a *StateAPI) StateMinerSectors(ctx context.Context, addr address.Address, filter *bitfield.BitField, ...) ([]*api.ChainSectorInfo, error)
- func (a *StateAPI) StateNetworkName(ctx context.Context) (dtypes.NetworkName, error)
- func (a *StateAPI) StateReadState(ctx context.Context, actor address.Address, tsk types.TipSetKey) (*api.ActorState, error)
- func (a *StateAPI) StateReplay(ctx context.Context, tsk types.TipSetKey, mc cid.Cid) (*api.InvocResult, error)
- func (a *StateAPI) StateSearchMsg(ctx context.Context, msg cid.Cid) (*api.MsgLookup, error)
- func (a *StateAPI) StateSectorExpiration(ctx context.Context, maddr address.Address, sectorNumber abi.SectorNumber, ...) (*api.SectorExpiration, error)
- func (a *StateAPI) StateSectorGetInfo(ctx context.Context, maddr address.Address, n abi.SectorNumber, ...) (*miner.SectorOnChainInfo, error)
- func (a *StateAPI) StateSectorPartition(ctx context.Context, maddr address.Address, sectorNumber abi.SectorNumber, ...) (*api.SectorLocation, error)
- func (a *StateAPI) StateSectorPreCommitInfo(ctx context.Context, maddr address.Address, n abi.SectorNumber, ...) (miner.SectorPreCommitOnChainInfo, error)
- func (a *StateAPI) StateVerifiedClientStatus(ctx context.Context, addr address.Address, tsk types.TipSetKey) (*verifreg.DataCap, error)
- func (a *StateAPI) StateWaitMsg(ctx context.Context, msg cid.Cid, confidence uint64) (*api.MsgLookup, error)
- type SyncAPI
- func (a *SyncAPI) SyncCheckBad(ctx context.Context, bcid cid.Cid) (string, error)
- func (a *SyncAPI) SyncCheckpoint(ctx context.Context, tsk types.TipSetKey) error
- func (a *SyncAPI) SyncIncomingBlocks(ctx context.Context) (<-chan *types.BlockHeader, error)
- func (a *SyncAPI) SyncMarkBad(ctx context.Context, bcid cid.Cid) error
- func (a *SyncAPI) SyncState(ctx context.Context) (*api.SyncState, error)
- func (a *SyncAPI) SyncSubmitBlock(ctx context.Context, blk *types.BlockMsg) error
- func (a *SyncAPI) SyncUnmarkBad(ctx context.Context, bcid cid.Cid) error
- type WalletAPI
- func (a *WalletAPI) WalletBalance(ctx context.Context, addr address.Address) (types.BigInt, error)
- func (a *WalletAPI) WalletDefaultAddress(ctx context.Context) (address.Address, error)
- func (a *WalletAPI) WalletDelete(ctx context.Context, addr address.Address) error
- func (a *WalletAPI) WalletExport(ctx context.Context, addr address.Address) (*types.KeyInfo, error)
- func (a *WalletAPI) WalletHas(ctx context.Context, addr address.Address) (bool, error)
- func (a *WalletAPI) WalletImport(ctx context.Context, ki *types.KeyInfo) (address.Address, error)
- func (a *WalletAPI) WalletList(ctx context.Context) ([]address.Address, error)
- func (a *WalletAPI) WalletNew(ctx context.Context, typ crypto.SigType) (address.Address, error)
- func (a *WalletAPI) WalletSetDefault(ctx context.Context, addr address.Address) error
- func (a *WalletAPI) WalletSign(ctx context.Context, k address.Address, msg []byte) (*crypto.Signature, error)
- func (a *WalletAPI) WalletSignMessage(ctx context.Context, k address.Address, msg *types.Message) (*types.SignedMessage, error)
- func (a *WalletAPI) WalletVerify(ctx context.Context, k address.Address, msg []byte, sig *crypto.Signature) bool
Constants ¶
View Source
const MaxSpendOnFeeDenom = 100
View Source
const MinGasPremium = 100e3
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BeaconAPI ¶ added in v0.5.0
type BeaconAPI struct { fx.In Beacon beacon.RandomBeacon }
func (*BeaconAPI) BeaconGetEntry ¶ added in v0.5.0
func (a *BeaconAPI) BeaconGetEntry(ctx context.Context, epoch abi.ChainEpoch) (*types.BeaconEntry, error)
type ChainAPI ¶
type ChainAPI struct { fx.In WalletAPI Chain *store.ChainStore }
func (*ChainAPI) ChainExport ¶ added in v0.2.6
func (*ChainAPI) ChainGetBlock ¶
func (*ChainAPI) ChainGetBlockMessages ¶
func (*ChainAPI) ChainGetGenesis ¶
func (*ChainAPI) ChainGetMessage ¶ added in v0.1.6
func (*ChainAPI) ChainGetNode ¶ added in v0.1.5
func (*ChainAPI) ChainGetParentMessages ¶
func (*ChainAPI) ChainGetParentReceipts ¶
func (*ChainAPI) ChainGetPath ¶ added in v0.2.5
func (*ChainAPI) ChainGetRandomnessFromBeacon ¶ added in v0.5.0
func (a *ChainAPI) ChainGetRandomnessFromBeacon(ctx context.Context, tsk types.TipSetKey, personalization crypto.DomainSeparationTag, randEpoch abi.ChainEpoch, entropy []byte) (abi.Randomness, error)
func (*ChainAPI) ChainGetRandomnessFromTickets ¶ added in v0.5.0
func (a *ChainAPI) ChainGetRandomnessFromTickets(ctx context.Context, tsk types.TipSetKey, personalization crypto.DomainSeparationTag, randEpoch abi.ChainEpoch, entropy []byte) (abi.Randomness, error)
func (*ChainAPI) ChainGetTipSet ¶
func (*ChainAPI) ChainGetTipSetByHeight ¶
func (*ChainAPI) ChainHasObj ¶ added in v0.2.8
func (*ChainAPI) ChainNotify ¶
func (*ChainAPI) ChainReadObj ¶
func (*ChainAPI) ChainSetHead ¶
func (*ChainAPI) ChainStatObj ¶ added in v0.3.0
type GasAPI ¶ added in v0.5.0
type GasAPI struct { fx.In Stmgr *stmgr.StateManager Chain *store.ChainStore Mpool *messagepool.MessagePool }
func (*GasAPI) GasEstimateFeeCap ¶ added in v0.5.0
func (*GasAPI) GasEstimateGasLimit ¶ added in v0.5.0
func (*GasAPI) GasEstimateGasPremium ¶ added in v0.5.0
type MpoolAPI ¶
type MpoolAPI struct { fx.In WalletAPI GasAPI Chain *store.ChainStore Mpool *messagepool.MessagePool PushLocks *dtypes.MpoolLocker }
func (*MpoolAPI) MpoolClear ¶ added in v0.5.0
func (*MpoolAPI) MpoolGetConfig ¶ added in v0.5.0
func (*MpoolAPI) MpoolGetNonce ¶
func (*MpoolAPI) MpoolPending ¶
func (*MpoolAPI) MpoolPushMessage ¶
func (a *MpoolAPI) MpoolPushMessage(ctx context.Context, msg *types.Message, spec *api.MessageSendSpec) (*types.SignedMessage, error)
func (*MpoolAPI) MpoolSelect ¶ added in v0.5.0
func (*MpoolAPI) MpoolSetConfig ¶ added in v0.5.0
type MsigAPI ¶ added in v0.3.0
func (*MsigAPI) MsigApprove ¶ added in v0.3.0
func (*MsigAPI) MsigCancel ¶ added in v0.3.0
func (*MsigAPI) MsigCreate ¶ added in v0.3.0
func (a *MsigAPI) MsigCreate(ctx context.Context, req uint64, addrs []address.Address, duration abi.ChainEpoch, val types.BigInt, src address.Address, gp types.BigInt) (cid.Cid, error)
TODO: remove gp (gasPrice) from arguments
func (*MsigAPI) MsigPropose ¶ added in v0.3.0
func (*MsigAPI) MsigSwapApprove ¶ added in v0.5.0
func (*MsigAPI) MsigSwapCancel ¶ added in v0.5.0
type StateAPI ¶
type StateAPI struct { fx.In // TODO: the wallet here is only needed because we have the MinerCreateBlock // API attached to the state API. It probably should live somewhere better Wallet *wallet.Wallet ProofVerifier ffiwrapper.Verifier StateManager *stmgr.StateManager Chain *store.ChainStore Beacon beacon.RandomBeacon }
func (*StateAPI) MinerCreateBlock ¶
func (*StateAPI) MinerGetBaseInfo ¶ added in v0.3.0
func (a *StateAPI) MinerGetBaseInfo(ctx context.Context, maddr address.Address, epoch abi.ChainEpoch, tsk types.TipSetKey) (*api.MiningBaseInfo, error)
This is on StateAPI because miner.Miner requires this, and MinerAPI requires miner.Miner
func (*StateAPI) MsigGetAvailableBalance ¶ added in v0.2.8
func (*StateAPI) StateAccountKey ¶ added in v0.3.0
func (*StateAPI) StateAllMinerFaults ¶ added in v0.3.1
func (*StateAPI) StateChangedActors ¶
func (*StateAPI) StateCirculatingSupply ¶ added in v0.5.0
func (*StateAPI) StateCompute ¶ added in v0.2.5
func (*StateAPI) StateDealProviderCollateralBounds ¶ added in v0.5.0
func (a *StateAPI) StateDealProviderCollateralBounds(ctx context.Context, size abi.PaddedPieceSize, verified bool, tsk types.TipSetKey) (api.DealCollateralBounds, error)
StateDealProviderCollateralBounds returns the min and max collateral a storage provider can issue. It takes the deal size and verified status as parameters.
func (*StateAPI) StateGetActor ¶
func (*StateAPI) StateGetReceipt ¶
func (*StateAPI) StateListActors ¶
func (*StateAPI) StateListMessages ¶ added in v0.1.6
func (*StateAPI) StateListMiners ¶
func (*StateAPI) StateLookupID ¶
func (*StateAPI) StateMarketBalance ¶
func (*StateAPI) StateMarketDeals ¶
func (*StateAPI) StateMarketParticipants ¶
func (*StateAPI) StateMarketStorageDeal ¶
func (*StateAPI) StateMinerActiveSectors ¶ added in v0.5.0
func (*StateAPI) StateMinerAvailableBalance ¶ added in v0.3.0
func (*StateAPI) StateMinerDeadlines ¶ added in v0.3.0
func (*StateAPI) StateMinerFaults ¶ added in v0.2.8
func (*StateAPI) StateMinerInfo ¶ added in v0.3.0
func (*StateAPI) StateMinerInitialPledgeCollateral ¶ added in v0.3.0
func (*StateAPI) StateMinerPartitions ¶ added in v0.5.0
func (*StateAPI) StateMinerPower ¶
func (*StateAPI) StateMinerPreCommitDepositForPower ¶ added in v0.5.0
func (*StateAPI) StateMinerProvingDeadline ¶ added in v0.3.0
func (*StateAPI) StateMinerRecoveries ¶ added in v0.3.1
func (*StateAPI) StateMinerSectorCount ¶ added in v0.1.5
func (*StateAPI) StateMinerSectors ¶
func (*StateAPI) StateNetworkName ¶ added in v0.3.0
func (*StateAPI) StateReadState ¶
func (*StateAPI) StateReplay ¶
func (*StateAPI) StateSearchMsg ¶ added in v0.3.0
func (*StateAPI) StateSectorExpiration ¶ added in v0.5.0
func (a *StateAPI) StateSectorExpiration(ctx context.Context, maddr address.Address, sectorNumber abi.SectorNumber, tsk types.TipSetKey) (*api.SectorExpiration, error)
func (*StateAPI) StateSectorGetInfo ¶ added in v0.3.1
func (a *StateAPI) StateSectorGetInfo(ctx context.Context, maddr address.Address, n abi.SectorNumber, tsk types.TipSetKey) (*miner.SectorOnChainInfo, error)
func (*StateAPI) StateSectorPartition ¶ added in v0.5.0
func (a *StateAPI) StateSectorPartition(ctx context.Context, maddr address.Address, sectorNumber abi.SectorNumber, tsk types.TipSetKey) (*api.SectorLocation, error)
func (*StateAPI) StateSectorPreCommitInfo ¶ added in v0.3.0
func (a *StateAPI) StateSectorPreCommitInfo(ctx context.Context, maddr address.Address, n abi.SectorNumber, tsk types.TipSetKey) (miner.SectorPreCommitOnChainInfo, error)
func (*StateAPI) StateVerifiedClientStatus ¶ added in v0.5.0
func (a *StateAPI) StateVerifiedClientStatus(ctx context.Context, addr address.Address, tsk types.TipSetKey) (*verifreg.DataCap, error)
StateVerifiedClientStatus returns the data cap for the given address. Returns nil if there is no entry in the data cap table for the address.
type SyncAPI ¶
type SyncAPI struct { fx.In SlashFilter *slashfilter.SlashFilter Syncer *chain.Syncer PubSub *pubsub.PubSub NetName dtypes.NetworkName }
func (*SyncAPI) SyncCheckBad ¶ added in v0.2.8
func (*SyncAPI) SyncCheckpoint ¶ added in v0.6.2
func (*SyncAPI) SyncIncomingBlocks ¶
func (*SyncAPI) SyncMarkBad ¶ added in v0.1.6
func (*SyncAPI) SyncSubmitBlock ¶
type WalletAPI ¶
func (*WalletAPI) WalletBalance ¶
func (*WalletAPI) WalletDefaultAddress ¶
func (*WalletAPI) WalletDelete ¶ added in v0.4.0
func (*WalletAPI) WalletExport ¶
func (*WalletAPI) WalletImport ¶
func (*WalletAPI) WalletList ¶
func (*WalletAPI) WalletSetDefault ¶
func (*WalletAPI) WalletSign ¶
func (*WalletAPI) WalletSignMessage ¶
Source Files ¶
Click to show internal directories.
Click to hide internal directories.