apitypes

type BaseRequest struct {
	// contains filtered or unexported fields
}

type BlockInfo struct {
	BlockNumber       fftypes.FFuint64 `json:"blockNumber"`
	BlockHash         string           `json:"blockHash"`
	ParentHash        string           `json:"parentHash"`
	TransactionHashes []string         `json:"transactionHashes,omitempty"`
}

type CheckpointListeners map[fftypes.UUID]json.RawMessage

type Confirmation struct {
	BlockNumber fftypes.FFuint64 `json:"blockNumber"`
	BlockHash   string           `json:"blockHash"`
	ParentHash  string           `json:"parentHash"`
}

type ConfirmationRecord struct {
	dbsql.ResourceBase        // default persistence headers for this micro object
	TransactionID      string `json:"transaction"` // owning transaction
	*Confirmation
}

type ConfirmationsNotification struct {
	// Confirmed marks we've reached the confirmation threshold
	Confirmed bool
	// NewFork is true when NewConfirmations is a complete list of confirmations.
	// Otherwise, Confirmations is an additive delta on top of a previous list of confirmations.
	NewFork bool
	// Confirmations is the list of confirmations being notified - assured to be non-nil, but might be empty.
	Confirmations []*Confirmation
}

type ContractDeployRequest struct {
	Headers RequestHeaders `json:"headers"`
	ffcapi.ContractDeployPrepareRequest
}

type DistributionMode = fftypes.FFEnum

type ErrorHandlingType = fftypes.FFEnum

type EventBatch struct {
	BatchNumber int64               `json:"batchNumber"`
	Events      []*EventWithContext `json:"events"`
}

type EventContext struct {
	StreamID       *fftypes.UUID `json:"streamId"`     // the ID of the event stream for this event
	EthCompatSubID *fftypes.UUID `json:"subId"`        // ID of the listener - EthCompat "subscription" naming
	ListenerName   string        `json:"listenerName"` // name of the listener
}

type EventStream struct {
	ID        *fftypes.UUID    `ffstruct:"eventstream" json:"id"`
	Created   *fftypes.FFTime  `ffstruct:"eventstream" json:"created"`
	Updated   *fftypes.FFTime  `ffstruct:"eventstream" json:"updated"`
	Name      *string          `ffstruct:"eventstream" json:"name,omitempty"`
	Suspended *bool            `ffstruct:"eventstream" json:"suspended,omitempty"`
	Type      *EventStreamType `ffstruct:"eventstream" json:"type,omitempty" ffenum:"estype"`

	ErrorHandling     *ErrorHandlingType  `ffstruct:"eventstream" json:"errorHandling"`
	BatchSize         *uint64             `ffstruct:"eventstream" json:"batchSize"`
	BatchTimeout      *fftypes.FFDuration `ffstruct:"eventstream" json:"batchTimeout"`
	RetryTimeout      *fftypes.FFDuration `ffstruct:"eventstream" json:"retryTimeout"`
	BlockedRetryDelay *fftypes.FFDuration `ffstruct:"eventstream" json:"blockedRetryDelay"`

	EthCompatBatchTimeoutMS       *uint64 `ffstruct:"eventstream" json:"batchTimeoutMS,omitempty"`       // input only, for backwards compatibility
	EthCompatRetryTimeoutSec      *uint64 `ffstruct:"eventstream" json:"retryTimeoutSec,omitempty"`      // input only, for backwards compatibility
	EthCompatBlockedRetryDelaySec *uint64 `ffstruct:"eventstream" json:"blockedRetryDelaySec,omitempty"` // input only, for backwards compatibility

	Webhook   *WebhookConfig   `ffstruct:"eventstream" json:"webhook,omitempty"`
	WebSocket *WebSocketConfig `ffstruct:"eventstream" json:"websocket,omitempty"`
}

type EventStreamCheckpoint struct {
	StreamID        *fftypes.UUID       `json:"streamId"`
	Time            *fftypes.FFTime     `json:"time"`            // this is the latest checkpoint time
	FirstCheckpoint *fftypes.FFTime     `json:"firstCheckpoint"` // this is the initial create time
	Listeners       CheckpointListeners `json:"listeners"`
}

type EventStreamStatus string

type EventStreamType = fftypes.FFEnum

type EventStreamWithStatus struct {
	EventStream
	Status EventStreamStatus `ffstruct:"eventstream" json:"status"`
}

type EventWithContext struct {
	StandardContext EventContext
	ffcapi.Event
}

type Listener struct {
	ID               *fftypes.UUID    `ffstruct:"listener" json:"id,omitempty"`
	Created          *fftypes.FFTime  `ffstruct:"listener" json:"created"`
	Updated          *fftypes.FFTime  `ffstruct:"listener" json:"updated"`
	Name             *string          `ffstruct:"listener" json:"name"`
	StreamID         *fftypes.UUID    `ffstruct:"listener" json:"stream" ffexcludeoutput:"true"`
	EthCompatAddress *string          `ffstruct:"listener" json:"address,omitempty"`
	EthCompatEvent   *fftypes.JSONAny `ffstruct:"listener" json:"event,omitempty"`
	EthCompatMethods *fftypes.JSONAny `ffstruct:"listener" json:"methods,omitempty"`
	Filters          ListenerFilters  `ffstruct:"listener" json:"filters"`
	Options          *fftypes.JSONAny `ffstruct:"listener" json:"options"`
	Signature        *string          `ffstruct:"listener" json:"signature,omitempty" ffexcludeinput:"true"`
	FromBlock        *string          `ffstruct:"listener" json:"fromBlock,omitempty"`
}

type ListenerFilters []fftypes.JSONAny

type ListenerWithStatus struct {
	Listener
	ffcapi.EventListenerHWMResponse
}

type LiveAddressBalance struct {
	ffcapi.AddressBalanceResponse
}

type LiveGasPrice struct {
	ffcapi.GasPriceEstimateResponse
}

type LiveStatus struct {
	ffcapi.LiveResponse
}

type ManagedTX struct {
	ID              string          `json:"id"`
	Created         *fftypes.FFTime `json:"created"`
	Updated         *fftypes.FFTime `json:"updated"`
	Status          TxStatus        `json:"status"`
	DeleteRequested *fftypes.FFTime `json:"deleteRequested,omitempty"`
	SequenceID      string          `json:"sequenceId,omitempty"`
	ffcapi.TransactionHeaders
	GasPrice                     *fftypes.JSONAny           `json:"gasPrice"`
	TransactionData              string                     `json:"transactionData"`
	TransactionHash              string                     `json:"transactionHash,omitempty"`
	PolicyInfo                   *fftypes.JSONAny           `json:"policyInfo"`
	FirstSubmit                  *fftypes.FFTime            `json:"firstSubmit,omitempty"`
	LastSubmit                   *fftypes.FFTime            `json:"lastSubmit,omitempty"`
	ErrorMessage                 string                     `json:"errorMessage,omitempty"`
	DeprecatedTransactionHeaders *ffcapi.TransactionHeaders `json:"transactionHeaders,omitempty"` // LevelDB only: for lost-in-time historical reasons we duplicate these fields at the base too on this query structure
}

type ManagedTransactionEvent struct {
	Type    ManagedTransactionEventType
	Tx      *ManagedTX
	Receipt *ffcapi.TransactionReceiptResponse
	// ReceiptHandler can be passed on the event as a closure with extra variables
	ReceiptHandler func(ctx context.Context, txID string, receipt *ffcapi.TransactionReceiptResponse) error
	// ConfirmationHandler can be passed on the event as a closure with extra variables
	ConfirmationHandler func(ctx context.Context, txID string, notification *ConfirmationsNotification) error
}

type ManagedTransactionEventType int

type QueryRequest struct {
	Headers RequestHeaders `json:"headers"`
	ffcapi.TransactionInput
	BlockNumber *string `json:"blockNumber,omitempty"`
}

type QueryResponse ffcapi.QueryInvokeResponse

type ReadyStatus struct {
	ffcapi.ReadyResponse
}

type ReceiptRecord struct {
	TransactionID string          `json:"transaction"` // owning transaction
	Created       *fftypes.FFTime `json:"created"`
	Updated       *fftypes.FFTime `json:"updated"`
	*ffcapi.TransactionReceiptResponse
}

type ReplyHeaders struct {
	RequestID string    `json:"requestId"`
	Type      ReplyType `json:"type"`
}

type ReplyType string

type RequestHeaders struct {
	ID   string      `ffstruct:"fftmrequest" json:"id"`
	Type RequestType `json:"type"`
}

type RequestType string

type TXHistoryRecord struct {
	ID            *fftypes.UUID `json:"id"`          // unique identifier for this entry
	TransactionID string        `json:"transaction"` // owning transaction
	SubStatus     TxSubStatus   `json:"subStatus"`
	TxHistoryActionEntry
}

type TXUpdates struct {
	Status          *TxStatus         `json:"status"`
	DeleteRequested *fftypes.FFTime   `json:"deleteRequested,omitempty"`
	From            *string           `json:"from,omitempty"`
	To              *string           `json:"to,omitempty"`
	Nonce           *fftypes.FFBigInt `json:"nonce,omitempty"`
	Gas             *fftypes.FFBigInt `json:"gas,omitempty"`
	Value           *fftypes.FFBigInt `json:"value,omitempty"`
	GasPrice        *fftypes.JSONAny  `json:"gasPrice"`
	TransactionData *string           `json:"transactionData"`
	TransactionHash *string           `json:"transactionHash,omitempty"`
	PolicyInfo      *fftypes.JSONAny  `json:"policyInfo"`
	FirstSubmit     *fftypes.FFTime   `json:"firstSubmit,omitempty"`
	LastSubmit      *fftypes.FFTime   `json:"lastSubmit,omitempty"`
	ErrorMessage    *string           `json:"errorMessage,omitempty"`
}

type TXWithStatus struct {
	*ManagedTX
	Receipt                  *ffcapi.TransactionReceiptResponse `json:"receipt,omitempty"`
	Confirmations            []*Confirmation                    `json:"confirmations,omitempty"`
	DeprecatedHistorySummary []*TxHistorySummaryEntry           `json:"historySummary,omitempty"` // LevelDB only: maintains a summary to retain data while limiting single JSON payload size
	History                  []*TxHistoryStateTransitionEntry   `json:"history,omitempty"`
}

type TransactionRequest struct {
	Headers RequestHeaders `json:"headers"`
	ffcapi.TransactionInput
}

type TransactionUpdateReply struct {
	Headers          ReplyHeaders     `json:"headers"`
	Status           TxStatus         `json:"status"`
	ProtocolID       string           `json:"protocolId"`
	TransactionHash  string           `json:"transactionHash,omitempty"`
	ContractLocation *fftypes.JSONAny `json:"contractLocation,omitempty"`
}

type TxAction string

type TxHistoryActionEntry struct {
	Time            *fftypes.FFTime  `json:"time"`
	Action          TxAction         `json:"action"`
	LastOccurrence  *fftypes.FFTime  `json:"lastOccurrence,omitempty"`
	OccurrenceCount int              `json:"count"` // serialized as count for historical reasons
	LastError       *fftypes.JSONAny `json:"lastError,omitempty"`
	LastErrorTime   *fftypes.FFTime  `json:"lastErrorTime,omitempty"`
	LastInfo        *fftypes.JSONAny `json:"lastInfo,omitempty"`
}

type TxHistoryStateTransitionEntry struct {
	Status  TxSubStatus             `json:"subStatus"` // the subStatus we entered
	Time    *fftypes.FFTime         `json:"time"`      // the time we transitioned to this subStatus
	Actions []*TxHistoryActionEntry `json:"actions"`   // the unique actions we attempted while in this sub-status
}

type TxHistorySummaryEntry struct {
	Status          TxSubStatus     `json:"subStatus,omitempty"`
	Action          TxAction        `json:"action,omitempty"`
	FirstOccurrence *fftypes.FFTime `json:"firstOccurrence"`
	LastOccurrence  *fftypes.FFTime `json:"lastOccurrence"`
	Count           int             `json:"count"`
}

type TxStatus string

type TxSubStatus string

type WebSocketConfig struct {
	DistributionMode *DistributionMode `ffstruct:"wsconfig" json:"distributionMode,omitempty"`
}

type WebhookConfig struct {
	URL                        *string             `ffstruct:"whconfig" json:"url,omitempty"`
	Headers                    map[string]string   `ffstruct:"whconfig" json:"headers,omitempty"`
	TLSkipHostVerify           *bool               `ffstruct:"whconfig" json:"tlsSkipHostVerify,omitempty"`
	RequestTimeout             *fftypes.FFDuration `ffstruct:"whconfig" json:"requestTimeout,omitempty"`
	EthCompatRequestTimeoutSec *int64              `ffstruct:"whconfig" json:"requestTimeoutSec,omitempty"` // input only, for backwards compatibility
}