feat: ec: Integrate Fast Finality for Filecoin

api/api_full.go

@@ -11,6 +11,7 @@ import (
 
  "github.com/filecoin-project/go-address"
  "github.com/filecoin-project/go-bitfield"
+ "github.com/filecoin-project/go-f3/certs"
  "github.com/filecoin-project/go-jsonrpc"
  "github.com/filecoin-project/go-state-types/abi"
  "github.com/filecoin-project/go-state-types/big"
@@ -859,6 +860,19 @@ type FullNode interface {
  // Note: this API is only available via websocket connections.
  // This is an EXPERIMENTAL API and may be subject to change.
  SubscribeActorEventsRaw(ctx context.Context, filter *types.ActorEventFilter) (<-chan *types.ActorEvent, error) //perm:read
+
+ // F3Participate should be called by a miner node to particpate in signing F3 consensus.
+ // The address should be of type ID
+ // F3Participate can only be used through websocket connection
+ // The returned channel will never be closed by the F3
+ // If it is closed without the context being cancelled, the caller should retry.
+ // The values returned on the channel will inform the caller about participation
+ // Empty strings will be sent if participation succeeded, non-empty strings explain possible errors.
+ F3Participate(ctx context.Context, minerID address.Address) (<-chan string, error) //perm:admin
+ // F3GetCertificate returns a finality certificate at given instance number
+ F3GetCertificate(ctx context.Context, instance uint64) (*certs.FinalityCertificate, error) //perm:read
+ // F3GetLatestCertificate returns the latest finality certificate
+ F3GetLatestCertificate(ctx context.Context) (*certs.FinalityCertificate, error) //perm:read
 }
 
 // reverse interface to the client, called after EthSubscribe

api/docgen/docgen.go

@@ -25,6 +25,7 @@ import (
 
  "github.com/filecoin-project/go-address"
  "github.com/filecoin-project/go-bitfield"
+ "github.com/filecoin-project/go-f3/certs"
  "github.com/filecoin-project/go-jsonrpc/auth"
  "github.com/filecoin-project/go-state-types/abi"
  "github.com/filecoin-project/go-state-types/builtin/v9/verifreg"
@@ -399,6 +400,7 @@ func init() {
  FromHeight: epochPtr(1010),
  ToHeight: epochPtr(1020),
  })
+ addExample(&certs.FinalityCertificate{})
 }
 
 func GetAPIType(name, pkg string) (i interface{}, t reflect.Type, permStruct []reflect.Type) {