 Documentation
      ¶
      Documentation
      ¶
    
    
  
    
  
    Index ¶
- Constants
- func ExecuteCurrentEpochScript(c flow.Chain, payload []ledger.Payload) (*fvm.ScriptProcedure, flow.Address, error)
- func FlowTokenTypeID(chain flow.Chain) string
- func NewBalanceReporter(chain flow.Chain, view state.View) *balanceProcessor
- type AccountReporter
- type AtreeReporter
- type ExportReport
- type ExportReporter
- type FungibleTokenTracker
- type GetStateCommitmentFunc
- type ReportFileWriter
- type ReportFileWriterFactory
- type ReportNilWriter
- type ReportWriter
- type ReportWriterFactory
- type TokenDataPoint
Constants ¶
      View Source
      
  
    const ( CBORTagInlineCollisionGroup = 253 CBORTagExternalCollisionGroup = 254 )
      View Source
      
  
const FungibleTokenTrackerReportPrefix = "fungible_token_report"
    Variables ¶
This section is empty.
Functions ¶
func ExecuteCurrentEpochScript ¶ added in v0.26.0
func ExecuteCurrentEpochScript(c flow.Chain, payload []ledger.Payload) (*fvm.ScriptProcedure, flow.Address, error)
Executes script to get current epoch from chain
func FlowTokenTypeID ¶ added in v0.25.1
Types ¶
type AccountReporter ¶
type AccountReporter struct {
	Log   zerolog.Logger
	RWF   ReportWriterFactory
	Chain flow.Chain
}
    AccountReporter iterates through registers keeping a map of register sizes reports on storage metrics
func (*AccountReporter) Name ¶
func (r *AccountReporter) Name() string
type AtreeReporter ¶ added in v0.26.2
type AtreeReporter struct {
	Log zerolog.Logger
	RWF ReportWriterFactory
}
    AtreeReporter iterates payloads and generates payload and atree stats.
func (*AtreeReporter) Name ¶ added in v0.26.2
func (r *AtreeReporter) Name() string
type ExportReport ¶ added in v0.26.0
type ExportReport struct {
	EpochCounter            uint64
	PreviousStateCommitment flow.StateCommitment
	CurrentStateCommitment  flow.StateCommitment
	ReportSucceeded         bool
}
    type ExportReporter ¶ added in v0.26.0
type ExportReporter struct {
	// contains filtered or unexported fields
}
    ExportReporter writes data that can be leveraged outside of extraction
func NewExportReporter ¶ added in v0.26.0
func NewExportReporter( logger zerolog.Logger, chain flow.Chain, getBeforeMigrationSCFunc GetStateCommitmentFunc, ) *ExportReporter
func (*ExportReporter) Name ¶ added in v0.26.0
func (e *ExportReporter) Name() string
type FungibleTokenTracker ¶ added in v0.25.1
type FungibleTokenTracker struct {
	// contains filtered or unexported fields
}
    FungibleTokenTracker iterates through stored cadence values over all accounts and check for any value with the given resource typeID
func NewFungibleTokenTracker ¶ added in v0.25.1
func NewFungibleTokenTracker(logger zerolog.Logger, rwf ReportWriterFactory, chain flow.Chain, vaultTypeIDs []string) *FungibleTokenTracker
func (*FungibleTokenTracker) Name ¶ added in v0.25.1
func (r *FungibleTokenTracker) Name() string
type GetStateCommitmentFunc ¶ added in v0.26.0
type GetStateCommitmentFunc func() flow.StateCommitment
type ReportFileWriter ¶
type ReportFileWriter struct {
	// contains filtered or unexported fields
}
    func (*ReportFileWriter) Close ¶
func (r *ReportFileWriter) Close()
func (*ReportFileWriter) Write ¶
func (r *ReportFileWriter) Write(dataPoint interface{})
type ReportFileWriterFactory ¶
type ReportFileWriterFactory struct {
	// contains filtered or unexported fields
}
    func NewReportFileWriterFactory ¶
func NewReportFileWriterFactory(outputDir string, log zerolog.Logger) *ReportFileWriterFactory
func (*ReportFileWriterFactory) Filename ¶ added in v0.25.1
func (r *ReportFileWriterFactory) Filename(dataNamespace string) string
func (*ReportFileWriterFactory) ReportWriter ¶
func (r *ReportFileWriterFactory) ReportWriter(dataNamespace string) ReportWriter
type ReportNilWriter ¶
type ReportNilWriter struct {
}
    ReportNilWriter does nothing. Can be used as the final fallback writer
func (ReportNilWriter) Close ¶
func (r ReportNilWriter) Close()
func (ReportNilWriter) Write ¶
func (r ReportNilWriter) Write(_ interface{})
type ReportWriter ¶
type ReportWriter interface {
	Write(dataPoint interface{})
	Close()
}
    ReportWriter writes data from reports
func NewReportFileWriter ¶
func NewReportFileWriter(fileName string, log zerolog.Logger) ReportWriter
type ReportWriterFactory ¶
type ReportWriterFactory interface {
	ReportWriter(dataNamespace string) ReportWriter
}
    TODO janezp: we should be able to swithch the report writer to write to a database.
type TokenDataPoint ¶ added in v0.25.1
type TokenDataPoint struct {
	// Path is the storage path of the composite the vault was found in
	Path string `json:"path"`
	// Address is the owner of the composite the vault was found in
	Address string `json:"address"`
	// Balance is the balance of the flow vault
	Balance uint64 `json:"balance"`
	// token type
	TypeID string `json:"type_id"`
}
    
       Source Files
      ¶
      Source Files
      ¶
    
   Click to show internal directories. 
   Click to hide internal directories.