types

type Block interface {
	Hash() string
	Transactions() []Transaction
}

type Config interface {
	Fn(*RequestOptions)
}

type Error interface {
	error

	// Code returns a numeric code categorizing the error.
	Code() int

	// Message returns a generic error message that corresponds to the
	// error Code.
	Message() string

	// DataJSON returns JSON data returned by the application with the
	// error, if any was provided. The slice returned by DataJSON will
	// either be empty or it will contain valid serialized JSON data.
	DataJSON() []byte
}

type RequestOptions struct {
	HTTPClient          *http.Client
	Log                 *logrus.Logger
	LogFields           logrus.Fields
	Headers             map[string]string
	Endpoint            string
	ID                  string
	AuthToken           string
	Params              interface{}
	Transient           map[string][]byte
	Target              *interface{}
	TimestampGenerator  func(context.Context) string
	MspFilter           []string
	TargetEndpoints     []string
	MinEndorsers        int
	Creator             string
	DependentTxID       string
	DisableWritePolling bool
	CcFetchURLDowngrade bool
	CcFetchURLProxy     *url.URL
	DependentBlock      string
	PhylumVersion       string
	NewPhylumVersion    string
}

type ShiroClient interface {
	// Seed re-opens the ShiroClient, specifying the phylum version to
	// target.
	Seed(ctx context.Context, version string, config ...Config) error

	// ShiroPhylum returns a non-empty string which should act as an
	// indentifier indicating the deployed phylum code being executed by
	// the shiro server.
	ShiroPhylum(ctx context.Context, config ...Config) (string, error)

	// Init initializes the chaincode given a string containing
	// base64-encoded phylum code.  The phylum code should be deployed
	// with the identifier returned by method ShiroPhylum().
	Init(ctx context.Context, phylum string, config ...Config) error

	// Call executes method with the given parameters and commits the
	// results.  The method shuold be executed by the phylum code
	// matching the identifier returned by method ShiroPhylum().
	//
	// Caller may specify transient data that is accessible to the
	// chaincode but not comitted on to the blockchain.
	Call(ctx context.Context, method string, config ...Config) (ShiroResponse, error)

	// QueryInfo returns the blockchain height.
	QueryInfo(ctx context.Context, config ...Config) (uint64, error)

	// QueryBlock returns summary information about the block given by
	// blockNumber.
	QueryBlock(ctx context.Context, blockNumber uint64, config ...Config) (Block, error)
}

type ShiroResponse interface {
	UnmarshalTo(dst interface{}) error
	ResultJSON() []byte
	TransactionID() string
	Error() Error
}

type Transaction interface {
	ID() string
	Reason() string
	Event() []byte
	ChaincodeID() string
}