Types

In Typescript, import types from the lotus-client-rpc module e.g.

import { Cid, BlockHeader } from '@filecoin-shipyard/lotus-client-rpc'

Type Reference

• ActiveSync
• Actor
• ActorState
• AddrInfo
• Ask
• BeaconEntry
• BitField
• BlockHeader
• BlockLocation
• BlockMessages
• BlockMsg
• BlockTemplate
• CIDInfo
• CborTime
• ChannelAvailableFunds
• ChannelID
• ChannelInfo
• Cid
• CirculatingSupply
• Claim
• ClientDealProposal
• CommPRet
• ComputeStateOutput
• DataRef
• DataSize
• DataTransferChannel
• Deadline
• DealCollateralBounds
• DealInfo
• DealInfo1
• DealProposal
• DealProposal1
• DealProposal2
• DealState
• Decl
• Deferred
• ElectionProof
• ExecutionTrace
• ExpTipSet
• Fault
• FileRef
• FsStat
• GasTrace
• HeadChange
• HealthReport
• Import
• ImportRes
• Info
• InvocResult
• IpldObject
• KeyInfo
• Loc
• MarketBalance
• MarketDeal
• Merge
• Message
• Message1
• MessageMatch
• MessageReceipt
• MessageSendSpec
• MinerDeal
• MinerInfo
• MinerPower
• MinerSectors
• MiningBaseInfo
• ModVerifyParams
• MpoolConfig
• MpoolUpdate
• MsgGasCost
• MsgLookup
• MsigVesting
• NatInfo
• ObjStat
• Params
• Partition
• PaychStatus
• PaymentInfo
• PeerScoreSnapshot
• PieceBlockLocation
• PieceInfo
• PieceInfo1
• PoStProof
• ProviderDealState
• PubsubScore
• QueryOffer
• Range
• RetrievalEvent
• RetrievalOrder
• RetrievalPeer
• SealSeed
• SealTicket
• SealedRef
• SectorCids
• SectorExpiration
• SectorID
• SectorInfo
• SectorInfo1
• SectorLocation
• SectorLog
• SectorOnChainInfo
• SectorPreCommitInfo
• SectorPreCommitOnChainInfo
• SectorStorageInfo
• Signature
• SignedMessage
• SignedStorageAsk
• SignedVoucher
• StartDealParams
• Stats
• StorageAsk
• StorageInfo
• StoragePath
• SyncState
• Ticket
• Time
• TipSet
• TopicScoreSnapshot
• Version
• VoucherCreateResult
• VoucherSpec
• WorkerInfo
• WorkerJob
• WorkerResources
• WorkerStats

ActiveSync

type ActiveSync = { Base: TipSet, End: Time, Height: number, Message: string, Stage: number, Start: Time, Target: TipSet }

Properties:

• Base: TipSet
• End: Time
• Height: number
• Message: string
• Stage: number
• Start: Time
• Target: TipSet

Actor

type Actor = { Balance: string, Code: Cid, Head: Cid, Nonce: number }

Properties:

• Balance: string
• Code: Cid
• Head: Cid
• Nonce: number

ActorState

type ActorState = { Balance: string, State: any }

Properties:

• Balance: string
• State: any

AddrInfo

type AddrInfo = { Addrs: Array<any>, ID: string }

Properties:

• Addrs: Array<any>
• ID: string

Ask

type Ask = { PaymentInterval: number, PaymentIntervalIncrease: number, PricePerByte: string, UnsealPrice: string }

Properties:

• PaymentInterval: number
• PaymentIntervalIncrease: number
• PricePerByte: string
• UnsealPrice: string

BeaconEntry

type BeaconEntry = { Data: string, Round: number }

Properties:

• Data: string
• Round: number

BitField

type BitField = {}

BlockHeader

type BlockHeader = { BLSAggregate: Signature, BeaconEntries: Array<BeaconEntry>, BlockSig: Signature, ElectionProof: ElectionProof, ForkSignaling: number, Height: number, Messages: Cid, Miner: string, ParentBaseFee: string, ParentMessageReceipts: Cid, ParentStateRoot: Cid, ParentWeight: string, Parents: Array<Cid>, Ticket: Ticket, Timestamp: number, WinPoStProof: Array<PoStProof> }

Properties:

• BLSAggregate: Signature
• BeaconEntries: Array<BeaconEntry>
• BlockSig: Signature
• ElectionProof: ElectionProof
• ForkSignaling: number
• Height: number
• Messages: Cid
• Miner: string
• ParentBaseFee: string
• ParentMessageReceipts: Cid
• ParentStateRoot: Cid
• ParentWeight: string
• Parents: Array<Cid>
• Ticket: Ticket
• Timestamp: number
• WinPoStProof: Array<PoStProof>

BlockLocation

type BlockLocation = { BlockSize: number, RelOffset: number }

Properties:

• BlockSize: number
• RelOffset: number

BlockMessages

type BlockMessages = { BlsMessages: Array<Message>, Cids: Array<Cid>, SecpkMessages: Array<SignedMessage> }

Properties:

• BlsMessages: Array<Message>
• Cids: Array<Cid>
• SecpkMessages: Array<SignedMessage>

BlockMsg

type BlockMsg = { BlsMessages: Array<Cid>, Header: BlockHeader, SecpkMessages: Array<Cid> }

Properties:

• BlsMessages: Array<Cid>
• Header: BlockHeader
• SecpkMessages: Array<Cid>

BlockTemplate

type BlockTemplate = { BeaconValues: Array<BeaconEntry>, Epoch: number, Eproof: ElectionProof, Messages: Array<SignedMessage>, Miner: string, Parents: Cid[], Ticket: Ticket, Timestamp: number, WinningPoStProof: Array<PoStProof> }

Properties:

• BeaconValues: Array<BeaconEntry>
• Epoch: number
• Eproof: ElectionProof
• Messages: Array<SignedMessage>
• Miner: string
• Parents: Cid[]
• Ticket: Ticket
• Timestamp: number
• WinningPoStProof: Array<PoStProof>

CIDInfo

type CIDInfo = { CID: Cid, PieceBlockLocations: Array<PieceBlockLocation> }

Properties:

• CID: Cid
• PieceBlockLocations: Array<PieceBlockLocation>

CborTime

type CborTime = {}

ChannelAvailableFunds

type ChannelAvailableFunds = { Channel: string, ConfirmedAmt: string, From: string, PendingAmt: string, PendingWaitSentinel: Cid, QueuedAmt: string, To: string, VoucherReedeemedAmt: string }

Properties:

• Channel: string
• ConfirmedAmt: string
• From: string
• PendingAmt: string
• PendingWaitSentinel: Cid
• QueuedAmt: string
• To: string
• VoucherReedeemedAmt: string

ChannelID

type ChannelID = { ID: number, Initiator: string, Responder: string }

Properties:

• ID: number
• Initiator: string
• Responder: string

ChannelInfo

type ChannelInfo = { Channel: string, WaitSentinel: Cid }

Properties:

• Channel: string
• WaitSentinel: Cid

Cid

type Cid = { /: string }

Properties:

• /: string

CirculatingSupply

type CirculatingSupply = { FilBurnt: string, FilCirculating: string, FilLocked: string, FilMined: string, FilVested: string }

Properties:

• FilBurnt: string
• FilCirculating: string
• FilLocked: string
• FilMined: string
• FilVested: string

Claim

type Claim = { QualityAdjPower: string, RawBytePower: string }

Properties:

• QualityAdjPower: string
• RawBytePower: string

ClientDealProposal

type ClientDealProposal = { ClientSignature: Signature, Proposal: DealProposal1 }

Properties:

• ClientSignature: Signature
• Proposal: DealProposal1

CommPRet

type CommPRet = { Root: Cid, Size: number }

Properties:

• Root: Cid
• Size: number

ComputeStateOutput

type ComputeStateOutput = { Root: Cid, Trace: Array<InvocResult> }

Properties:

• Root: Cid
• Trace: Array<InvocResult>

DataRef

type DataRef = { PieceCid: Cid, PieceSize: number, Root: Cid, TransferType: string }

Properties:

• PieceCid: Cid
• PieceSize: number
• Root: Cid
• TransferType: string

DataSize

type DataSize = { PayloadSize: number, PieceSize: number }

Properties:

• PayloadSize: number
• PieceSize: number

DataTransferChannel

type DataTransferChannel = { BaseCID: Cid, IsInitiator: boolean, IsSender: boolean, Message: string, OtherPeer: string, Status: number, TransferID: number, Transferred: number, Voucher: string }

Properties:

• BaseCID: Cid
• IsInitiator: boolean
• IsSender: boolean
• Message: string
• OtherPeer: string
• Status: number
• TransferID: number
• Transferred: number
• Voucher: string

Deadline

type Deadline = { PostSubmissions: BitField }

Properties:

• PostSubmissions: BitField

DealCollateralBounds

type DealCollateralBounds = { Max: string, Min: string }

Properties:

• Max: string
• Min: string

DealInfo

type DealInfo = { CreationTime: Time, DataRef: DataRef, DealID: number, Duration: number, Message: string, PieceCID: Cid, PricePerEpoch: string, ProposalCid: Cid, Provider: string, Size: number, State: number, Verified: boolean }

Properties:

• CreationTime: Time
• DataRef: DataRef
• DealID: number
• Duration: number
• Message: string
• PieceCID: Cid
• PricePerEpoch: string
• ProposalCid: Cid
• Provider: string
• Size: number
• State: number
• Verified: boolean

DealInfo1

type DealInfo1 = { DealID: number, Length: number, Offset: number, SectorID: number }

Properties:

• DealID: number
• Length: number
• Offset: number
• SectorID: number

DealProposal

type DealProposal = { Client: string, ClientCollateral: string, EndEpoch: number, Label: string, PieceCID: Cid, PieceSize: number, Provider: string, ProviderCollateral: string, StartEpoch: number, StoragePricePerEpoch: string, VerifiedDeal: boolean }

Properties:

• Client: string
• ClientCollateral: string
• EndEpoch: number
• Label: string
• PieceCID: Cid
• PieceSize: number
• Provider: string
• ProviderCollateral: string
• StartEpoch: number
• StoragePricePerEpoch: string
• VerifiedDeal: boolean

DealProposal1

type DealProposal1 = { Client: string, ClientCollateral: string, EndEpoch: number, Label: string, PieceCID: Cid, PieceSize: number, Provider: string, ProviderCollateral: string, StartEpoch: number, StoragePricePerEpoch: string, VerifiedDeal: boolean }

Properties:

• Client: string
• ClientCollateral: string
• EndEpoch: number
• Label: string
• PieceCID: Cid
• PieceSize: number
• Provider: string
• ProviderCollateral: string
• StartEpoch: number
• StoragePricePerEpoch: string
• VerifiedDeal: boolean

DealProposal2

type DealProposal2 = { ID: number, Params: Params, PayloadCID: Cid }

Properties:

• ID: number
• Params: Params
• PayloadCID: Cid

DealState

type DealState = { LastUpdatedEpoch: number, SectorStartEpoch: number, SlashEpoch: number }

Properties:

• LastUpdatedEpoch: number
• SectorStartEpoch: number
• SlashEpoch: number

Decl

type Decl = { SectorFileType: number, SectorID: SectorID }

Properties:

• SectorFileType: number
• SectorID: SectorID

Deferred

type Deferred = { Raw: string }

Properties:

• Raw: string

ElectionProof

type ElectionProof = { VRFProof: string, WinCount: number }

Properties:

• VRFProof: string
• WinCount: number

ExecutionTrace

type ExecutionTrace = { Duration: number, Error: string, GasCharges: Array<GasTrace>, Msg: Message, MsgRct: MessageReceipt, Subcalls: ExecutionTrace[] }

Properties:

• Duration: number
• Error: string
• GasCharges: Array<GasTrace>
• Msg: Message
• MsgRct: MessageReceipt
• Subcalls: ExecutionTrace[]

ExpTipSet

type ExpTipSet = { Blocks: Array<BlockHeader>, Cids: Array<Cid>, Height: number }

Properties:

• Blocks: Array<BlockHeader>
• Cids: Array<Cid>
• Height: number

Fault

type Fault = { Epoch: number, Miner: string }

Properties:

• Epoch: number
• Miner: string

FileRef

type FileRef = { IsCAR: boolean, Path: string }

Properties:

• IsCAR: boolean
• Path: string

FsStat

type FsStat = { Available: number, Capacity: number, Reserved: number }

Properties:

• Available: number
• Capacity: number
• Reserved: number

GasTrace

type GasTrace = { Callers: Array<number>, ComputeGas: number, Extra: any, Location: Array<Loc>, Name: string, StorageGas: number, TimeTaken: number, TotalGas: number, TotalVirtualGas: number, VirtualComputeGas: number, VirtualStorageGas: number }

Properties:

• Callers: Array<number>
• ComputeGas: number
• Extra: any
• Location: Array<Loc>
• Name: string
• StorageGas: number
• TimeTaken: number
• TotalGas: number
• TotalVirtualGas: number
• VirtualComputeGas: number
• VirtualStorageGas: number

HeadChange

type HeadChange = { Type: string, Val: TipSet }

Properties:

• Type: string
• Val: TipSet

HealthReport

type HealthReport = { Err: any, Stat: FsStat }

Properties:

• Err: any
• Stat: FsStat

Import

type Import = { Err: string, FilePath: string, Key: number, Root: Cid, Source: string }

Properties:

• Err: string
• FilePath: string
• Key: number
• Root: Cid
• Source: string

ImportRes

type ImportRes = { ImportID: number, Root: Cid }

Properties:

• ImportID: number
• Root: Cid

Info

type Info = { Challenge: number, Close: number, CurrentEpoch: number, FaultCutoff: number, FaultDeclarationCutoff: number, Index: number, Open: number, PeriodStart: number, WPoStChallengeLookback: number, WPoStChallengeWindow: number, WPoStPeriodDeadlines: number, WPoStProvingPeriod: number }

Properties:

• Challenge: number
• Close: number
• CurrentEpoch: number
• FaultCutoff: number
• FaultDeclarationCutoff: number
• Index: number
• Open: number
• PeriodStart: number
• WPoStChallengeLookback: number
• WPoStChallengeWindow: number
• WPoStPeriodDeadlines: number
• WPoStProvingPeriod: number

InvocResult

type InvocResult = { Duration: number, Error: string, ExecutionTrace: ExecutionTrace, GasCost: MsgGasCost, Msg: Message, MsgCid: Cid, MsgRct: MessageReceipt }

Properties:

• Duration: number
• Error: string
• ExecutionTrace: ExecutionTrace
• GasCost: MsgGasCost
• Msg: Message
• MsgCid: Cid
• MsgRct: MessageReceipt

IpldObject

type IpldObject = { Cid: Cid, Obj: any }

Properties:

• Cid: Cid
• Obj: any

KeyInfo

type KeyInfo = { PrivateKey: string, Type: string }

Properties:

• PrivateKey: string
• Type: string

Loc

type Loc = { File: string, Function: string, Line: number }

Properties:

• File: string
• Function: string
• Line: number

MarketBalance

type MarketBalance = { Escrow: string, Locked: string }

Properties:

• Escrow: string
• Locked: string

MarketDeal

type MarketDeal = { Proposal: DealProposal, State: DealState }

Properties:

• Proposal: DealProposal
• State: DealState

Merge

type Merge = { Lane: number, Nonce: number }

Properties:

• Lane: number
• Nonce: number

Message

type Message = { From: string, GasFeeCap: string, GasLimit: number, GasPremium: string, Method: number, Nonce: number, Params: string, To: string, Value: string, Version: number }

Properties:

• From: string
• GasFeeCap: string
• GasLimit: number
• GasPremium: string
• Method: number
• Nonce: number
• Params: string
• To: string
• Value: string
• Version: number

Message1

type Message1 = { Cid: Cid, Message: Message }

Properties:

• Cid: Cid
• Message: Message

MessageMatch

type MessageMatch = { From: string, To: string }

Properties:

• From: string
• To: string

MessageReceipt

type MessageReceipt = { ExitCode: number, GasUsed: number, Return: string }

Properties:

• ExitCode: number
• GasUsed: number
• Return: string

MessageSendSpec

type MessageSendSpec = { MaxFee: string }

Properties:

• MaxFee: string

MinerDeal

type MinerDeal = { AddFundsCid: Cid, AvailableForRetrieval: boolean, Client: string, ClientDealProposal: ClientDealProposal, CreationTime: CborTime, DealID: number, FastRetrieval: boolean, FundsReserved: string, Message: string, MetadataPath: string, Miner: string, PiecePath: string, ProposalCid: Cid, PublishCid: Cid, Ref: DataRef, SlashEpoch: number, State: number, StoreID: number, TransferChannelId: ChannelID }

Properties:

• AddFundsCid: Cid
• AvailableForRetrieval: boolean
• Client: string
• ClientDealProposal: ClientDealProposal
• CreationTime: CborTime
• DealID: number
• FastRetrieval: boolean
• FundsReserved: string
• Message: string
• MetadataPath: string
• Miner: string
• PiecePath: string
• ProposalCid: Cid
• PublishCid: Cid
• Ref: DataRef
• SlashEpoch: number
• State: number
• StoreID: number
• TransferChannelId: ChannelID

MinerInfo

type MinerInfo = { ConsensusFaultElapsed: number, ControlAddresses: Array<string>, Multiaddrs: Array<string>, NewWorker: string, Owner: string, PeerId: string, SealProofType: number, SectorSize: number, WindowPoStPartitionSectors: number, Worker: string, WorkerChangeEpoch: number }

Properties:

• ConsensusFaultElapsed: number
• ControlAddresses: Array<string>
• Multiaddrs: Array<string>
• NewWorker: string
• Owner: string
• PeerId: string
• SealProofType: number
• SectorSize: number
• WindowPoStPartitionSectors: number
• Worker: string
• WorkerChangeEpoch: number

MinerPower

type MinerPower = { HasMinPower: boolean, MinerPower: Claim, TotalPower: Claim }

Properties:

• HasMinPower: boolean
• MinerPower: Claim
• TotalPower: Claim

MinerSectors

type MinerSectors = { Active: number, Faulty: number, Live: number }

Properties:

• Active: number
• Faulty: number
• Live: number

MiningBaseInfo

type MiningBaseInfo = { BeaconEntries: Array<BeaconEntry>, EligibleForMining: boolean, MinerPower: string, NetworkPower: string, PrevBeaconEntry: BeaconEntry, SectorSize: number, Sectors: Array<SectorInfo>, WorkerKey: string }

Properties:

• BeaconEntries: Array<BeaconEntry>
• EligibleForMining: boolean
• MinerPower: string
• NetworkPower: string
• PrevBeaconEntry: BeaconEntry
• SectorSize: number
• Sectors: Array<SectorInfo>
• WorkerKey: string

ModVerifyParams

type ModVerifyParams = { Actor: string, Data: string, Method: number }

Properties:

• Actor: string
• Data: string
• Method: number

MpoolConfig

type MpoolConfig = { GasLimitOverestimation: number, PriorityAddrs: Array<string>, PruneCooldown: number, ReplaceByFeeRatio: number, SizeLimitHigh: number, SizeLimitLow: number }

Properties:

• GasLimitOverestimation: number
• PriorityAddrs: Array<string>
• PruneCooldown: number
• ReplaceByFeeRatio: number
• SizeLimitHigh: number
• SizeLimitLow: number

MpoolUpdate

type MpoolUpdate = { Message: SignedMessage, Type: number }

Properties:

• Message: SignedMessage
• Type: number

MsgGasCost

type MsgGasCost = { BaseFeeBurn: string, GasUsed: string, Message: Cid, MinerPenalty: string, MinerTip: string, OverEstimationBurn: string, Refund: string, TotalCost: string }

Properties:

• BaseFeeBurn: string
• GasUsed: string
• Message: Cid
• MinerPenalty: string
• MinerTip: string
• OverEstimationBurn: string
• Refund: string
• TotalCost: string

MsgLookup

type MsgLookup = { Height: number, Message: Cid, Receipt: MessageReceipt, ReturnDec: any, TipSet: Cid[] }

Properties:

• Height: number
• Message: Cid
• Receipt: MessageReceipt
• ReturnDec: any
• TipSet: Cid[]

MsigVesting

type MsigVesting = { InitialBalance: string, StartEpoch: number, UnlockDuration: number }

Properties:

• InitialBalance: string
• StartEpoch: number
• UnlockDuration: number

NatInfo

type NatInfo = { PublicAddr: string, Reachability: number }

Properties:

• PublicAddr: string
• Reachability: number

ObjStat

type ObjStat = { Links: number, Size: number }

Properties:

• Links: number
• Size: number

Params

type Params = { PaymentInterval: number, PaymentIntervalIncrease: number, PieceCID: Cid, PricePerByte: string, Selector: Deferred, UnsealPrice: string }

Properties:

• PaymentInterval: number
• PaymentIntervalIncrease: number
• PieceCID: Cid
• PricePerByte: string
• Selector: Deferred
• UnsealPrice: string

Partition

type Partition = { ActiveSectors: BitField, AllSectors: BitField, FaultySectors: BitField, LiveSectors: BitField, RecoveringSectors: BitField }

Properties:

• ActiveSectors: BitField
• AllSectors: BitField
• FaultySectors: BitField
• LiveSectors: BitField
• RecoveringSectors: BitField

PaychStatus

type PaychStatus = { ControlAddr: string, Direction: number }

Properties:

• ControlAddr: string
• Direction: number

PaymentInfo

type PaymentInfo = { Channel: string, Vouchers: Array<SignedVoucher>, WaitSentinel: Cid }

Properties:

• Channel: string
• Vouchers: Array<SignedVoucher>
• WaitSentinel: Cid

PeerScoreSnapshot

type PeerScoreSnapshot = { AppSpecificScore: number, BehaviourPenalty: number, IPColocationFactor: number, Score: number, Topics: { [k: string]: TopicScoreSnapshot } }

Properties:

• AppSpecificScore: number
• BehaviourPenalty: number
• IPColocationFactor: number
• Score: number
• Topics: { [k: string]: TopicScoreSnapshot }

PieceBlockLocation

type PieceBlockLocation = { BlockLocation: BlockLocation, PieceCID: Cid }

Properties:

• BlockLocation: BlockLocation
• PieceCID: Cid

PieceInfo

type PieceInfo = { Deals: Array<DealInfo1>, PieceCID: Cid }

Properties:

• Deals: Array<DealInfo1>
• PieceCID: Cid

PieceInfo1

type PieceInfo1 = { PieceCID: Cid, Size: number }

Properties:

• PieceCID: Cid
• Size: number

PoStProof

type PoStProof = { PoStProof: number, ProofBytes: string }

Properties:

• PoStProof: number
• ProofBytes: string

ProviderDealState

type ProviderDealState = { ChannelID: ChannelID, CurrentInterval: number, DealProposal: DealProposal2, FundsReceived: string, LegacyProtocol: boolean, Message: string, PieceInfo: PieceInfo, Receiver: string, Status: number, StoreID: number, TotalSent: number }

Properties:

• ChannelID: ChannelID
• CurrentInterval: number
• DealProposal: DealProposal2
• FundsReceived: string
• LegacyProtocol: boolean
• Message: string
• PieceInfo: PieceInfo
• Receiver: string
• Status: number
• StoreID: number
• TotalSent: number

PubsubScore

type PubsubScore = { ID: string, Score: PeerScoreSnapshot }

Properties:

• ID: string
• Score: PeerScoreSnapshot

QueryOffer

type QueryOffer = { Err: string, MinPrice: string, Miner: string, MinerPeer: RetrievalPeer, PaymentInterval: number, PaymentIntervalIncrease: number, Piece: Cid, Root: Cid, Size: number, UnsealPrice: string }

Properties:

• Err: string
• MinPrice: string
• Miner: string
• MinerPeer: RetrievalPeer
• PaymentInterval: number
• PaymentIntervalIncrease: number
• Piece: Cid
• Root: Cid
• Size: number
• UnsealPrice: string

Range

type Range = { Offset: number, Size: number }

Properties:

• Offset: number
• Size: number

RetrievalEvent

type RetrievalEvent = { BytesReceived: number, Err: string, Event: number, FundsSpent: string, Status: number }

Properties:

• BytesReceived: number
• Err: string
• Event: number
• FundsSpent: string
• Status: number

RetrievalOrder

type RetrievalOrder = { Client: string, Miner: string, MinerPeer: RetrievalPeer, PaymentInterval: number, PaymentIntervalIncrease: number, Piece: Cid, Root: Cid, Size: number, Total: string, UnsealPrice: string }

Properties:

• Client: string
• Miner: string
• MinerPeer: RetrievalPeer
• PaymentInterval: number
• PaymentIntervalIncrease: number
• Piece: Cid
• Root: Cid
• Size: number
• Total: string
• UnsealPrice: string

RetrievalPeer

type RetrievalPeer = { Address: string, ID: string, PieceCID: Cid }

Properties:

• Address: string
• ID: string
• PieceCID: Cid

SealSeed

type SealSeed = { Epoch: number, Value: Array<number> }

Properties:

• Epoch: number
• Value: Array<number>

SealTicket

type SealTicket = { Epoch: number, Value: Array<number> }

Properties:

• Epoch: number
• Value: Array<number>

SealedRef

type SealedRef = { Offset: number, SectorID: number, Size: number }

Properties:

• Offset: number
• SectorID: number
• Size: number

SectorCids

type SectorCids = { Sealed: Cid, Unsealed: Cid }

Properties:

• Sealed: Cid
• Unsealed: Cid

SectorExpiration

type SectorExpiration = { Early: number, OnTime: number }

Properties:

• Early: number
• OnTime: number

SectorID

type SectorID = { Miner: number, Number: number }

Properties:

• Miner: number
• Number: number

SectorInfo

type SectorInfo = { SealProof: number, SealedCID: Cid, SectorNumber: number }

Properties:

• SealProof: number
• SealedCID: Cid
• SectorNumber: number

SectorInfo1

type SectorInfo1 = { Activation: number, CommD: Cid, CommR: Cid, CommitMsg: Cid, DealWeight: string, Deals: Array<number>, Early: number, Expiration: number, InitialPledge: string, LastErr: string, Log: Array<SectorLog>, OnTime: number, PreCommitMsg: Cid, Proof: string, Retries: number, SealProof: number, SectorID: number, Seed: SealSeed, State: string, Ticket: SealTicket, ToUpgrade: boolean, VerifiedDealWeight: string }

Properties:

• Activation: number
• CommD: Cid
• CommR: Cid
• CommitMsg: Cid
• DealWeight: string
• Deals: Array<number>
• Early: number
• Expiration: number
• InitialPledge: string
• LastErr: string
• Log: Array<SectorLog>
• OnTime: number
• PreCommitMsg: Cid
• Proof: string
• Retries: number
• SealProof: number
• SectorID: number
• Seed: SealSeed
• State: string
• Ticket: SealTicket
• ToUpgrade: boolean
• VerifiedDealWeight: string

SectorLocation

type SectorLocation = { Deadline: number, Partition: number }

Properties:

• Deadline: number
• Partition: number

SectorLog

type SectorLog = { Kind: string, Message: string, Timestamp: number, Trace: string }

Properties:

• Kind: string
• Message: string
• Timestamp: number
• Trace: string

SectorOnChainInfo

type SectorOnChainInfo = { Activation: number, DealIDs: Array<number>, DealWeight: string, ExpectedDayReward: string, ExpectedStoragePledge: string, Expiration: number, InitialPledge: string, SealProof: number, SealedCID: Cid, SectorNumber: number, VerifiedDealWeight: string }

Properties:

• Activation: number
• DealIDs: Array<number>
• DealWeight: string
• ExpectedDayReward: string
• ExpectedStoragePledge: string
• Expiration: number
• InitialPledge: string
• SealProof: number
• SealedCID: Cid
• SectorNumber: number
• VerifiedDealWeight: string

SectorPreCommitInfo

type SectorPreCommitInfo = { DealIDs: Array<number>, Expiration: number, ReplaceCapacity: boolean, ReplaceSectorDeadline: number, ReplaceSectorNumber: number, ReplaceSectorPartition: number, SealProof: number, SealRandEpoch: number, SealedCID: Cid, SectorNumber: number }

Properties:

• DealIDs: Array<number>
• Expiration: number
• ReplaceCapacity: boolean
• ReplaceSectorDeadline: number
• ReplaceSectorNumber: number
• ReplaceSectorPartition: number
• SealProof: number
• SealRandEpoch: number
• SealedCID: Cid
• SectorNumber: number

SectorPreCommitOnChainInfo

type SectorPreCommitOnChainInfo = { DealWeight: string, Info: SectorPreCommitInfo, PreCommitDeposit: string, PreCommitEpoch: number, VerifiedDealWeight: string }

Properties:

• DealWeight: string
• Info: SectorPreCommitInfo
• PreCommitDeposit: string
• PreCommitEpoch: number
• VerifiedDealWeight: string

SectorStorageInfo

type SectorStorageInfo = { CanSeal: boolean, CanStore: boolean, ID: string, Primary: boolean, URLs: Array<string>, Weight: number }

Properties:

• CanSeal: boolean
• CanStore: boolean
• ID: string
• Primary: boolean
• URLs: Array<string>
• Weight: number

Signature

type Signature = { Data: string, Type: number }

Properties:

• Data: string
• Type: number

SignedMessage

type SignedMessage = { Message: Message, Signature: Signature }

Properties:

• Message: Message
• Signature: Signature

SignedStorageAsk

type SignedStorageAsk = { Ask: StorageAsk, Signature: Signature }

Properties:

• Ask: StorageAsk
• Signature: Signature

SignedVoucher

type SignedVoucher = { Amount: string, ChannelAddr: string, Extra: ModVerifyParams, Lane: number, Merges: Array<Merge>, MinSettleHeight: number, Nonce: number, SecretPreimage: string, Signature: Signature, TimeLockMax: number, TimeLockMin: number }

Properties:

• Amount: string
• ChannelAddr: string
• Extra: ModVerifyParams
• Lane: number
• Merges: Array<Merge>
• MinSettleHeight: number
• Nonce: number
• SecretPreimage: string
• Signature: Signature
• TimeLockMax: number
• TimeLockMin: number

StartDealParams

type StartDealParams = { Data: DataRef, DealStartEpoch: number, EpochPrice: string, FastRetrieval: boolean, MinBlocksDuration: number, Miner: string, ProviderCollateral: string, VerifiedDeal: boolean, Wallet: string }

Properties:

• Data: DataRef
• DealStartEpoch: number
• EpochPrice: string
• FastRetrieval: boolean
• MinBlocksDuration: number
• Miner: string
• ProviderCollateral: string
• VerifiedDeal: boolean
• Wallet: string

Stats

type Stats = { RateIn: number, RateOut: number, TotalIn: number, TotalOut: number }

Properties:

• RateIn: number
• RateOut: number
• TotalIn: number
• TotalOut: number

StorageAsk

type StorageAsk = { Expiry: number, MaxPieceSize: number, MinPieceSize: number, Miner: string, Price: string, SeqNo: number, Timestamp: number, VerifiedPrice: string }

Properties:

• Expiry: number
• MaxPieceSize: number
• MinPieceSize: number
• Miner: string
• Price: string
• SeqNo: number
• Timestamp: number
• VerifiedPrice: string

StorageInfo

type StorageInfo = { CanSeal: boolean, CanStore: boolean, ID: string, URLs: Array<string>, Weight: number }

Properties:

• CanSeal: boolean
• CanStore: boolean
• ID: string
• URLs: Array<string>
• Weight: number

StoragePath

type StoragePath = { CanSeal: boolean, CanStore: boolean, ID: string, LocalPath: string, Weight: number }

Properties:

• CanSeal: boolean
• CanStore: boolean
• ID: string
• LocalPath: string
• Weight: number

SyncState

type SyncState = { ActiveSyncs: Array<ActiveSync>, VMApplied: number }

Properties:

• ActiveSyncs: Array<ActiveSync>
• VMApplied: number

Ticket

type Ticket = { VRFProof: string }

Properties:

• VRFProof: string

Time

type Time = {}

TipSet

type TipSet = { Blocks: Array<BlockHeader>, Cids: Array<Cid>, Height: number }

Properties:

• Blocks: Array<BlockHeader>
• Cids: Array<Cid>
• Height: number

TopicScoreSnapshot

type TopicScoreSnapshot = { FirstMessageDeliveries: number, InvalidMessageDeliveries: number, MeshMessageDeliveries: number, TimeInMesh: number }

Properties:

• FirstMessageDeliveries: number
• InvalidMessageDeliveries: number
• MeshMessageDeliveries: number
• TimeInMesh: number

Version

type Version = { APIVersion: number, BlockDelay: number, Version: string }

Properties:

• APIVersion: number
• BlockDelay: number
• Version: string

VoucherCreateResult

type VoucherCreateResult = { Shortfall: string, Voucher: SignedVoucher }

Properties:

• Shortfall: string
• Voucher: SignedVoucher

VoucherSpec

type VoucherSpec = { Amount: string, Extra: ModVerifyParams, MinSettle: number, TimeLockMax: number, TimeLockMin: number }

Properties:

• Amount: string
• Extra: ModVerifyParams
• MinSettle: number
• TimeLockMax: number
• TimeLockMin: number

WorkerInfo

type WorkerInfo = { Hostname: string, Resources: WorkerResources }

Properties:

• Hostname: string
• Resources: WorkerResources

WorkerJob

type WorkerJob = { ID: number, RunWait: number, Sector: SectorID, Start: Time, Task: string }

Properties:

• ID: number
• RunWait: number
• Sector: SectorID
• Start: Time
• Task: string

WorkerResources

type WorkerResources = { CPUs: number, GPUs: Array<string>, MemPhysical: number, MemReserved: number, MemSwap: number }

Properties:

• CPUs: number
• GPUs: Array<string>
• MemPhysical: number
• MemReserved: number
• MemSwap: number

WorkerStats

type WorkerStats = { CpuUse: number, GpuUsed: boolean, Info: WorkerInfo, MemUsedMax: number, MemUsedMin: number }

Properties:

• CpuUse: number
• GpuUsed: boolean
• Info: WorkerInfo
• MemUsedMax: number
• MemUsedMin: number