Skip to content

API_IMPLEMENTATION.md

Latest commit

 

History

History
256 lines (241 loc) · 19.5 KB

API_IMPLEMENTATION.md

File metadata and controls

256 lines (241 loc) · 19.5 KB

Forest API Implementation Report

Stats

  • Forest method count: 71
  • Lotus method count: 173
  • API coverage: 41.04%

Forest-only Methods

These methods exist in Forest only and cannot be compared:

  • Filecoin.AuthNew
  • Filecoin.AuthVerify
  • Filecoin.ChainExport
  • Filecoin.ChainGetName
  • Filecoin.ChainGetTipSetHash
  • Filecoin.ChainGetTipsetByHeight
  • Filecoin.ChainHeadSubscription
  • Filecoin.ChainNotify
  • Filecoin.MpoolEstimateGasPrice
  • Filecoin.NetAddrsListen
  • Filecoin.NetPeers
  • Filecoin.StateGetReceipt
  • Filecoin.StateLookupId
  • Filecoin.StateSectorPrecommitInfo
  • Filecoin.Version

Type Mismatches

Some methods contain possible inconsistencies between Forest and Lotus.

Params Mismatches

Method Param Index Forest Param Lotus Param
Filecoin.GasEstimateFeeCap 0 MessageJson UnsignedMessageJson
Filecoin.GasEstimateGasLimit 0 MessageJson UnsignedMessageJson
Filecoin.GasEstimateMessageGas 0 MessageJson UnsignedMessageJson
Filecoin.MpoolGetNonce 0 String Address
Filecoin.MpoolPending 0 CidJsonVec TipsetKeys
Filecoin.MpoolPushMessage 0 MessageJson UnsignedMessageJson
Filecoin.StateCall 0 MessageJson UnsignedMessageJson
Filecoin.StateMinerSectorAllocated 1 u64 SectorNumber
Filecoin.StateReplay 0 CidJson TipsetKeys
Filecoin.StateReplay 1 TipsetKeysJson Cid
Filecoin.StateWaitMsg 1 i64 u64
Filecoin.WalletBalance 0 String Address
Filecoin.WalletExport 0 String Address
Filecoin.WalletHas 0 String Address
Filecoin.WalletNew 0 SignatureTypeJson KeyType
Filecoin.WalletSignMessage 0 String Address
Filecoin.WalletSignMessage 1 MessageJson UnsignedMessageJson
Filecoin.WalletVerify 0 String Address
Filecoin.WalletVerify 1 String Vec<u8>

Results Mismatches

Method Forest Result Lotus Result
Filecoin.ChainGetMessage MessageJson UnsignedMessageJson
Filecoin.ChainReadObj String Vec<u8>
Filecoin.ChainTipSetWeight String BigInt
Filecoin.GasEstimateFeeCap String BigInt
Filecoin.GasEstimateGasPremium String BigInt
Filecoin.GasEstimateMessageGas MessageJson UnsignedMessageJson
Filecoin.StateMinerInitialPledgeCollateral String BigInt
Filecoin.StateMinerPreCommitDepositForPower String BigInt
Filecoin.StateNetworkName String dNetworkName
Filecoin.WalletBalance String BigInt
Filecoin.WalletDefaultAddress String Address
Filecoin.WalletImport String Address
Filecoin.WalletNew String Address

Method Table

Present Method Params Result
✔️ Filecoin.BeaconGetEntry (ChainEpoch) BeaconEntryJson
❌ Filecoin.ChainBlockstoreInfo - -
❌ Filecoin.ChainCheckBlockstore - -
❌ Filecoin.ChainDeleteObj - -
✔️ Filecoin.ChainGetBlock (CidJson) BlockHeaderJson
✔️ Filecoin.ChainGetBlockMessages (CidJson) BlockMessages
✔️ Filecoin.ChainGetGenesis () Option<TipsetJson>
✔️ Filecoin.ChainGetMessage (CidJson) MessageJson
❌ Filecoin.ChainGetMessagesInTipset - -
❌ Filecoin.ChainGetNode - -
❌ Filecoin.ChainGetParentMessages - -
❌ Filecoin.ChainGetParentReceipts - -
❌ Filecoin.ChainGetPath - -
❌ Filecoin.ChainGetRandomnessFromBeacon - -
❌ Filecoin.ChainGetRandomnessFromTickets - -
✔️ Filecoin.ChainGetTipSet (TipsetKeysJson) TipsetJson
❌ Filecoin.ChainGetTipSetAfterHeight - -
❌ Filecoin.ChainGetTipSetByHeight - -
✔️ Filecoin.ChainHasObj (CidJson) bool
✔️ Filecoin.ChainHead () TipsetJson
✔️ Filecoin.ChainReadObj (CidJson) String
❌ Filecoin.ChainSetHead - -
❌ Filecoin.ChainStatObj - -
✔️ Filecoin.ChainTipSetWeight (TipsetKeysJson) String
❌ Filecoin.ClientCalcCommP - -
❌ Filecoin.ClientCancelDataTransfer - -
❌ Filecoin.ClientCancelRetrievalDeal - -
❌ Filecoin.ClientDealPieceCID - -
❌ Filecoin.ClientDealSize - -
❌ Filecoin.ClientFindData - -
❌ Filecoin.ClientGenCar - -
❌ Filecoin.ClientGetDealInfo - -
❌ Filecoin.ClientGetDealStatus - -
❌ Filecoin.ClientHasLocal - -
❌ Filecoin.ClientImport - -
❌ Filecoin.ClientListDataTransfers - -
❌ Filecoin.ClientListDeals - -
❌ Filecoin.ClientListImports - -
❌ Filecoin.ClientListRetrievals - -
❌ Filecoin.ClientMinerQueryOffer - -
❌ Filecoin.ClientQueryAsk - -
❌ Filecoin.ClientRemoveImport - -
❌ Filecoin.ClientRestartDataTransfer - -
❌ Filecoin.ClientRetrieve - -
❌ Filecoin.ClientRetrieveTryRestartInsufficientFunds - -
❌ Filecoin.ClientStartDeal - -
❌ Filecoin.ClientStatelessDeal - -
❌ Filecoin.CreateBackup - -
✔️ Filecoin.GasEstimateFeeCap (MessageJson, i64, TipsetKeysJson) String
✔️ Filecoin.GasEstimateGasLimit (MessageJson, TipsetKeysJson) i64
✔️ Filecoin.GasEstimateGasPremium (u64, AddressJson, i64, TipsetKeysJson) String
✔️ Filecoin.GasEstimateMessageGas (MessageJson, Option<MessageSendSpec>, TipsetKeysJson) MessageJson
❌ Filecoin.MarketAddBalance - -
❌ Filecoin.MarketGetReserved - -
❌ Filecoin.MarketReleaseFunds - -
❌ Filecoin.MarketReserveFunds - -
❌ Filecoin.MarketWithdraw - -
✔️ Filecoin.MinerCreateBlock (BlockTemplate) BlockMsgJson
✔️ Filecoin.MinerGetBaseInfo (AddressJson, ChainEpoch, TipsetKeysJson) Option<MiningBaseInfoJson>
❌ Filecoin.MpoolBatchPush - -
❌ Filecoin.MpoolBatchPushMessage - -
❌ Filecoin.MpoolBatchPushUntrusted - -
❌ Filecoin.MpoolCheckMessages - -
❌ Filecoin.MpoolCheckPendingMessages - -
❌ Filecoin.MpoolCheckReplaceMessages - -
❌ Filecoin.MpoolClear - -
❌ Filecoin.MpoolGetConfig - -
✔️ Filecoin.MpoolGetNonce (String) u64
✔️ Filecoin.MpoolPending (CidJsonVec) Vec<SignedMessage>
✔️ Filecoin.MpoolPush (SignedMessageJson) CidJson
✔️ Filecoin.MpoolPushMessage (MessageJson, Option<MessageSendSpec>) SignedMessageJson
❌ Filecoin.MpoolPushUntrusted - -
✔️ Filecoin.MpoolSelect (TipsetKeysJson, f64) Vec<SignedMessageJson>
❌ Filecoin.MpoolSetConfig - -
❌ Filecoin.MsigAddApprove - -
❌ Filecoin.MsigAddCancel - -
❌ Filecoin.MsigAddPropose - -
❌ Filecoin.MsigApprove - -
❌ Filecoin.MsigApproveTxnHash - -
❌ Filecoin.MsigCancel - -
❌ Filecoin.MsigCreate - -
❌ Filecoin.MsigGetAvailableBalance - -
❌ Filecoin.MsigGetPending - -
❌ Filecoin.MsigGetVested - -
❌ Filecoin.MsigGetVestingSchedule - -
❌ Filecoin.MsigPropose - -
❌ Filecoin.MsigRemoveSigner - -
❌ Filecoin.MsigSwapApprove - -
❌ Filecoin.MsigSwapCancel - -
❌ Filecoin.MsigSwapPropose - -
❌ Filecoin.NodeStatus - -
❌ Filecoin.PaychAllocateLane - -
❌ Filecoin.PaychAvailableFunds - -
❌ Filecoin.PaychAvailableFundsByFromTo - -
❌ Filecoin.PaychCollect - -
❌ Filecoin.PaychGet - -
❌ Filecoin.PaychGetWaitReady - -
❌ Filecoin.PaychList - -
❌ Filecoin.PaychNewPayment - -
❌ Filecoin.PaychSettle - -
❌ Filecoin.PaychStatus - -
❌ Filecoin.PaychVoucherAdd - -
❌ Filecoin.PaychVoucherCheckSpendable - -
❌ Filecoin.PaychVoucherCheckValid - -
❌ Filecoin.PaychVoucherCreate - -
❌ Filecoin.PaychVoucherList - -
❌ Filecoin.PaychVoucherSubmit - -
✔️ Filecoin.StateAccountKey (AddressJson, TipsetKeysJson) Option<AddressJson>
✔️ Filecoin.StateAllMinerFaults (ChainEpoch, TipsetKeysJson) Vec<Fault>
✔️ Filecoin.StateCall (MessageJson, TipsetKeysJson) InvocResult
❌ Filecoin.StateChangedActors - -
❌ Filecoin.StateCirculatingSupply - -
❌ Filecoin.StateCompute - -
❌ Filecoin.StateDealProviderCollateralBounds - -
❌ Filecoin.StateDecodeParams - -
✔️ Filecoin.StateGetActor (AddressJson, TipsetKeysJson) Option<ActorStateJson>
✔️ Filecoin.StateListActors (TipsetKeysJson) Vec<AddressJson>
❌ Filecoin.StateListMessages - -
❌ Filecoin.StateListMiners - -
❌ Filecoin.StateLookupID - -
✔️ Filecoin.StateMarketBalance (AddressJson, TipsetKeysJson) MarketBalance
✔️ Filecoin.StateMarketDeals (TipsetKeysJson) HashMap<String, MarketDeal>
❌ Filecoin.StateMarketParticipants - -
❌ Filecoin.StateMarketStorageDeal - -
❌ Filecoin.StateMinerActiveSectors - -
❌ Filecoin.StateMinerAvailableBalance - -
✔️ Filecoin.StateMinerDeadlines (AddressJson, TipsetKeysJson) Vec<Deadline>
✔️ Filecoin.StateMinerFaults (AddressJson, TipsetKeysJson) BitFieldJson
✔️ Filecoin.StateMinerInfo (AddressJson, TipsetKeysJson) MinerInfo
✔️ Filecoin.StateMinerInitialPledgeCollateral (AddressJson, SectorPreCommitInfo, TipsetKeysJson) String
✔️ Filecoin.StateMinerPartitions (AddressJson, u64, TipsetKeysJson) Vec<Partition>
✔️ Filecoin.StateMinerPower (Option<AddressJson>, TipsetKeysJson) MinerPower
✔️ Filecoin.StateMinerPreCommitDepositForPower (AddressJson, SectorPreCommitInfo, TipsetKeysJson) String
✔️ Filecoin.StateMinerProvingDeadline (AddressJson, TipsetKeysJson) DeadlineInfo
✔️ Filecoin.StateMinerRecoveries (AddressJson, TipsetKeysJson) BitFieldJson
✔️ Filecoin.StateMinerSectorAllocated (AddressJson, u64, TipsetKeysJson) bool
❌ Filecoin.StateMinerSectorCount - -
✔️ Filecoin.StateMinerSectors (AddressJson, BitFieldJson, TipsetKeysJson) Vec<SectorOnChainInfo>
✔️ Filecoin.StateNetworkName () String
✔️ Filecoin.StateNetworkVersion (TipsetKeysJson) NetworkVersion
❌ Filecoin.StateReadState - -
✔️ Filecoin.StateReplay (CidJson, TipsetKeysJson) InvocResult
❌ Filecoin.StateSearchMsg - -
❌ Filecoin.StateSectorExpiration - -
✔️ Filecoin.StateSectorGetInfo (AddressJson, SectorNumber, TipsetKeysJson) Option<SectorOnChainInfo>
❌ Filecoin.StateSectorPartition - -
❌ Filecoin.StateSectorPreCommitInfo - -
❌ Filecoin.StateVMCirculatingSupplyInternal - -
❌ Filecoin.StateVerifiedClientStatus - -
❌ Filecoin.StateVerifiedRegistryRootKey - -
❌ Filecoin.StateVerifierStatus - -
✔️ Filecoin.StateWaitMsg (CidJson, i64) MessageLookup
✔️ Filecoin.SyncCheckBad (CidJson) String
❌ Filecoin.SyncCheckpoint - -
❌ Filecoin.SyncMarkBad - -
✔️ Filecoin.SyncState () RPCSyncState
❌ Filecoin.SyncSubmitBlock - -
❌ Filecoin.SyncUnmarkAllBad - -
❌ Filecoin.SyncUnmarkBad - -
❌ Filecoin.SyncValidateTipset - -
✔️ Filecoin.WalletBalance (String) String
✔️ Filecoin.WalletDefaultAddress () String
❌ Filecoin.WalletDelete - -
✔️ Filecoin.WalletExport (String) KeyInfoJson
✔️ Filecoin.WalletHas (String) bool
✔️ Filecoin.WalletImport () String
✔️ Filecoin.WalletList () Vec<AddressJson>
✔️ Filecoin.WalletNew (SignatureTypeJson) String
❌ Filecoin.WalletSetDefault - -
✔️ Filecoin.WalletSign (AddressJson, Vec<u8>) SignatureJson
✔️ Filecoin.WalletSignMessage (String, MessageJson) SignedMessageJson
❌ Filecoin.WalletValidateAddress - -
✔️ Filecoin.WalletVerify (String, String, SignatureJson) bool

Help & Contributions

If there's a particular API that's needed that we're missing, be sure to let us know.

Feel free to reach out in #fil-forest-help in the Filecoin Slack, file a GitHub issue, or contribute a pull request.