resources

Documentation

Index

• type Contract
• type ContractRole
  • func (c ContractRole) String() string
• type ContractState
  • func (c ContractState) String() string
• type GenericContractManager
• type ResourceType

Types

type Contract

type Contract interface {
	Run(ctx context.Context) error
	SyncState(ctx context.Context) error
	SetError(err error)

	Role() ContractRole                        // the role in the contract (buyer or seller or validator)
	State() ContractState                      // the state of the contract (pending or running)
	BlockchainState() hashrate.BlockchainState // the state of the contract in blockchain (pending or running)
	ValidationStage() hashrate.ValidationStage // the stage of the contract validation (only buyer)
	Error() error                              // the error that prevents contract from being fulfilled (only seller)

	ID() string        // ID is the unique identifier of the contract, for smart contract data source this is the smart contract address
	Seller() string    // ID of the seller (address of the seller for smart contract data source)
	Buyer() string     // ID of the buyer (address of the buyer for smart contract data source)
	Validator() string // ID of the validator (address of the validator for smart contract data source)
	Dest() string      // immediate destination of the contract resource (for example the validator address for hashrate contract)
	PoolDest() string  // destination to redirect hashrate after validation (for example the pool address for hashrate contract)

	Price() *big.Int
	ProfitTarget() int8

	Balance() *big.Int
	IsDeleted() bool
	HasFutureTerms() bool
	Version() uint32

	StartTime() time.Time
	FulfillmentStartTime() time.Time
	EndTime() time.Time
	Duration() time.Duration
	Elapsed() time.Duration

	ResourceType() string                  // resource is the name of the resource that the contract is for (hashrate, video stream etc)
	ResourceEstimates() map[string]float64 // map of resouce quantitative estimates, for example for hashrate this would be map[string]string{"hashrate GH/S": "1000"}
	ResourceEstimatesActual() map[string]float64
	StarvingGHS() int
}

type ContractRole

type ContractRole string

const (
	ContractRoleBuyer     ContractRole = "buyer"
	ContractRoleSeller    ContractRole = "seller"
	ContractRoleValidator ContractRole = "validator"
)

func (ContractRole) String

func (c ContractRole) String() string

type ContractState

type ContractState string

const (
	ContractStatePending ContractState = "pending"
	ContractStateRunning ContractState = "running"
)

func (ContractState) String

func (c ContractState) String() string

type GenericContractManager

type GenericContractManager interface {
	Run(ctx context.Context) error
}

type ResourceType

type ResourceType string