Documentation
¶
Index ¶
- func GetAccountDetailsHandler(w http.ResponseWriter, r *http.Request, ps httprouter.Params)
- func GetAccountsHandler(w http.ResponseWriter, r *http.Request, _ httprouter.Params)
- func GetPayloadDetailsHandler(w http.ResponseWriter, r *http.Request, ps httprouter.Params)
- func GetPayloadsHandler(w http.ResponseWriter, r *http.Request, _ httprouter.Params)
- func PostAccountsHandler(w http.ResponseWriter, r *http.Request, _ httprouter.Params)
- func PostPayloadsHandler(w http.ResponseWriter, r *http.Request, _ httprouter.Params)
- func SetEndpoint(addr string)
- type Account
- type Metadata
- type Payload
- type PrivateDataWrapper
- type Request
- type Result
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetAccountDetailsHandler ¶ added in v1.2.0
func GetAccountDetailsHandler(w http.ResponseWriter, r *http.Request, ps httprouter.Params)
GetAccountDetailsHandler uses BaseAPI for get conversion details by it id. Query parameters ID is required.
func GetAccountsHandler ¶ added in v1.2.0
func GetAccountsHandler(w http.ResponseWriter, r *http.Request, _ httprouter.Params)
GetAccountsHandler uses BaseAPI for search and list accounts. Query parameters: Query, Limit, Offset can be optional. Query - MongoDB query string. Limit - maximum 500 items. Offset - default 0.
func GetPayloadDetailsHandler ¶
func GetPayloadDetailsHandler(w http.ResponseWriter, r *http.Request, ps httprouter.Params)
GetPayloadDetailsHandler uses BaseAPI for get payload details by it id. Query parameters ID is required.
func GetPayloadsHandler ¶
func GetPayloadsHandler(w http.ResponseWriter, r *http.Request, _ httprouter.Params)
GetPayloadsHandler uses BaseAPI for search and list transaction data. Query parameters: Query, Limit, Offset can be optional. Query - MongoDB query string. Limit - maximum 500 items. Offset - default 0.
func PostAccountsHandler ¶
func PostAccountsHandler(w http.ResponseWriter, r *http.Request, _ httprouter.Params)
PostAccountsHandler uses FastAPI for sends new accounts requests in async mode to blockchain
func PostPayloadsHandler ¶
func PostPayloadsHandler(w http.ResponseWriter, r *http.Request, _ httprouter.Params)
PostPayloadsHandler uses FastAPI for sends new transaction data requests in async mode to blockchain.
Types ¶
type Account ¶
type Account struct { ID string `json:"id" mapstructure:"id"` Priv string `json:"private_key" mapstructure:"private_key"` Pub string `json:"public_key" mapstructure:"public_key"` }
Account struct describes account related fields
ID - unique identifier of account in blockchain Priv - private key of account Pub - public key of account
type Metadata ¶
type Metadata struct {
RemoteAddr string `msg:"remote_addr" json:"remote_addr" mapstructure:"remote_addr" bson:"remote_addr"`
}
Metadata struct keep information about requester remote address.
type Payload ¶
type Payload struct { ID string `msg:"_id" json:"_id" mapstructure:"_id" bson:"_id"` SenderAccountID string `msg:"sender_account_id" json:"sender_account_id" mapstructure:"sender_account_id" bson:"sender_account_id"` ReceiverAccountID string `msg:"receiver_account_id" json:"receiver_account_id" mapstructure:"receiver_account_id" bson:"receiver_account_id"` PublicData string `msg:"public_data" json:"public_data" mapstructure:"public_data" bson:"public_data"` PrivateData string `msg:"private_data" json:"private_data" mapstructure:"private_data" bson:"private_data"` CreatedAt float64 `msg:"created_at" json:"created_at" mapstructure:"created_at" bson:"created_at"` }
Payload struct keeps transaction data related fields.
- PublicData keeps open data;
- PrivateData keeps encrypted by affiliate's public key with ECDH algorithm data and represented as base64 string;
- CreatedAt is date of object creation in UNIX time (nanoseconds).
type PrivateDataWrapper ¶
type PrivateDataWrapper struct { PrivateData interface{} `msg:"private_data" json:"private_data" mapstructure:"private_data" bson:"private_data"` *Metadata `msg:"metadata" json:"metadata" mapstructure:"metadata" bson:"metadata"` }
PrivateDataWrapper structs wraps private data from requester with metadata.
type Request ¶
type Request struct { AccountID string `json:"account_id,omitempty"` PrivKey string `json:"private_key,omitempty"` PubKey string `json:"public_key,omitempty"` Data interface{} `json:"data"` }
Request struct represents request related fields.
AccountID - unique identifier of request-maker in blockchain PrivKey - private key of account PubKey - public key of account Data - arbitrary passed data (maybe any supported in system)