api

Documentation

Index

• Constants
• func EncodeTx(tx *entity.Tx) ([]byte, error)
• func SignTx(txSigner *entity.TxSigner, chainId string, nonceTime entity.Time, ...) *entity.Tx
• func UnmarshalApiResponse(apiResponse *entityApi.RawResponse, dest interface{}) error
• type Client
• type FastHttpClient
  • func NewFastHttpClient(apiUrl string) *FastHttpClient
  • func (c FastHttpClient) AddHeader(key string, value string)
  • func (c FastHttpClient) Get(route string, headers map[string]string, queryValues map[string]string) (*api.RawResponse, error)
  • func (c FastHttpClient) Post(route string, body []byte, headers map[string]string, ...) (*api.RawResponse, error)
  • func (c FastHttpClient) RemoveHeader(key string)
• type Handler
  • func NewHandler(apiUrl string) *Handler
  • func (h *Handler) GetAndFormat(route string, queryParams map[string]string, instance interface{}) error
  • func (h *Handler) RetrieveCertificate(fqId string) (entity.TxData, error)
  • func (h *Handler) RetrieveCertificateTxs(fqId string, page int, txPerPage int) (*entityApi.TxResults, error)
  • func (h *Handler) RetrieveCompanyKeys(companyBcId string, page int, txPerPage int) ([]*account.KeyV1, error)
  • func (h *Handler) RetrieveKey(fqId string) (*account.KeyV1, error)
  • func (h *Handler) RetrieveKeyTxs(fqId string, page int, txPerPage int) (*entityApi.TxResults, error)
  • func (h *Handler) RetrieveLastCertificateTx(fqId string) (*entityApi.TxResult, error)
  • func (h *Handler) RetrieveLastKeyTx(fqId string) (*entityApi.TxResult, error)
  • func (h *Handler) RetrieveLastSecretTx(fqId string) (*entityApi.TxResult, error)
  • func (h *Handler) RetrieveSecret(fqId string) (entity.TxData, error)
  • func (h *Handler) RetrieveSecretTxs(fqId string, page int, txPerPage int) (*entityApi.TxResults, error)
  • func (h *Handler) RetrieveTx(hash string) (*entityApi.TxResult, error)
  • func (h *Handler) SafeGet(route string, queryParams map[string]string) (_ *entityApi.RawResponse, katenaError error)
  • func (h *Handler) SafePost(route string, body []byte) (_ *entityApi.RawResponse, katenaError error)
  • func (h *Handler) SendRawTx(txBytes []byte) (*entityApi.SendTxResult, error)
  • func (h *Handler) SendTx(txData entity.TxData, txSigner *entity.TxSigner, chainId string) (status *entityApi.SendTxResult, err error)

Constants

const (
	LastPath         = "/last"
	StatePath        = "/state"
	TxsPath          = "/txs"
	CertificatesPath = "/certificates"
	SecretsPath      = "/secrets"
	CompaniesPath    = "/companies"
	KeysPath         = "/keys"
)

Functions

func EncodeTx

func EncodeTx(tx *entity.Tx) ([]byte, error)

EncodeTx defines the way the tx is encoded (here with the json marshaller).

func SignTx

func SignTx(txSigner *entity.TxSigner, chainId string, nonceTime entity.Time, txData entity.TxData) *entity.Tx

SignTx creates a tx data state, signs it and returns a tx ready to be encoded and sent.

func UnmarshalApiResponse

func UnmarshalApiResponse(apiResponse *entityApi.RawResponse, dest interface{}) error

UnmarshalApiResponse tries to parse the api response body into the provided interface if the API returns a 200 or a 202 HTTP code. If not, it tries to parse it in a PublicError.

Types

type Client

type Client interface {
	Get(route string, headers map[string]string, queryValues map[string]string) (*api.RawResponse, error)
	Post(route string, body []byte, headers map[string]string, queryValues map[string]string) (*api.RawResponse, error)
	AddHeader(key string, value string)
	RemoveHeader(key string)
}

Client interface defines the methods a concrete client must implement.

type FastHttpClient

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

FastHttpClient is a fasthttp.FastHttpClient wrapper to dialog with a JSON API.

func NewFastHttpClient

func NewFastHttpClient(apiUrl string) *FastHttpClient

FastHttpClient constructor.

func (FastHttpClient) AddHeader

func (c FastHttpClient) AddHeader(key string, value string)

AddHeader adds a persistent header that will be sent in every future doRequest calls.

func (FastHttpClient) Get

func (c FastHttpClient) Get(
	route string,
	headers map[string]string,
	queryValues map[string]string,
) (*api.RawResponse, error)

Get wraps the doRequest method to do a GET HTTP request.

func (FastHttpClient) Post

func (c FastHttpClient) Post(
	route string,
	body []byte,
	headers map[string]string,
	queryValues map[string]string,
) (*api.RawResponse, error)

Post wraps the doRequest method to do a POST HTTP request.

func (FastHttpClient) RemoveHeader

func (c FastHttpClient) RemoveHeader(key string)

RemoveHeader removes a persistent header.

type Handler

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

Handler provides helper methods to send and retrieve txs without directly interacting with the HTTP Client.

func NewHandler

func NewHandler(apiUrl string) *Handler

Handler constructor.

func (*Handler) GetAndFormat

func (h *Handler) GetAndFormat(route string, queryParams map[string]string, instance interface{}) error

GetAndFormat fetches the API route and try to unmarshal the response in the provided instance.

func (*Handler) RetrieveCertificate

func (h *Handler) RetrieveCertificate(fqId string) (entity.TxData, error)

RetrieveCertificate fetches the API and returns a certificate from the state.

func (*Handler) RetrieveCertificateTxs

func (h *Handler) RetrieveCertificateTxs(fqId string, page int, txPerPage int) (*entityApi.TxResults, error)

RetrieveCertificateTxs fetches the API to return all txs related to a certificate fqid.

func (*Handler) RetrieveCompanyKeys

func (h *Handler) RetrieveCompanyKeys(companyBcId string, page int, txPerPage int) ([]*account.KeyV1, error)

RetrieveCompanyKeys fetches the API and returns a list of keys for a company from the state.

func (*Handler) RetrieveKey

func (h *Handler) RetrieveKey(fqId string) (*account.KeyV1, error)

RetrieveKey fetches the API and returns a key from the state.

func (*Handler) RetrieveKeyTxs

func (h *Handler) RetrieveKeyTxs(fqId string, page int, txPerPage int) (*entityApi.TxResults, error)

RetrieveKeyTxs fetches the API to return all txs related to a key fqid.

func (*Handler) RetrieveLastCertificateTx

func (h *Handler) RetrieveLastCertificateTx(fqId string) (*entityApi.TxResult, error)

RetrieveLastCertificateTx fetches the API to return the last tx related to a certificate fqid.

func (*Handler) RetrieveLastKeyTx

func (h *Handler) RetrieveLastKeyTx(fqId string) (*entityApi.TxResult, error)

RetrieveLastKeyTxs fetches the API to return the last txs related to a key fqid.

func (*Handler) RetrieveLastSecretTx

func (h *Handler) RetrieveLastSecretTx(fqId string) (*entityApi.TxResult, error)

RetrieveLastSecretTxs fetches the API to return the last tx related to a secret fqid.

func (*Handler) RetrieveSecret

func (h *Handler) RetrieveSecret(fqId string) (entity.TxData, error)

RetrieveSecret fetches the API and returns a secret from the state.

func (*Handler) RetrieveSecretTxs

func (h *Handler) RetrieveSecretTxs(fqId string, page int, txPerPage int) (*entityApi.TxResults, error)

RetrieveSecretTxs fetches the API to return all txs related to a secret fqid.

func (*Handler) RetrieveTx

func (h *Handler) RetrieveTx(hash string) (*entityApi.TxResult, error)

RetrieveTx fetches the API to return any tx by its hash.

func (*Handler) SafeGet

func (h *Handler) SafeGet(route string, queryParams map[string]string) (_ *entityApi.RawResponse, katenaError error)

SafeGet calls the api handler get method and recover if it panics.

func (*Handler) SafePost

func (h *Handler) SafePost(route string, body []byte) (_ *entityApi.RawResponse, katenaError error)

SafePost calls the api handler post method and recover if it panics.

func (*Handler) SendRawTx

func (h *Handler) SendRawTx(txBytes []byte) (*entityApi.SendTxResult, error)

SendTx accepts an encoded tx and sends it to the Api to return its status and its hash.

func (*Handler) SendTx

func (h *Handler) SendTx(txData entity.TxData, txSigner *entity.TxSigner, chainId string) (status *entityApi.SendTxResult, err error)

SendTx creates a tx from a tx data and the provided tx signer info and chain id, signs it, encodes it and sends it to the api.