package
1.0.0-rc2
Repository: https://github.com/bbva/qed.git
Documentation: pkg.go.dev

# Functions

Add posts an event into the system: The http post url is: POST /events The following statuses are expected: If everything is alright, the HTTP status is 201 and the body contains: { "EventDigest": "5beeaf427ee0bfcd1a7b6f63010f2745110cf23ae088b859275cd0aad369561b", "HistoryDigest": "b8fdd4b2146fe560f94d7a48f8bb3eaf6938f7de6ac6d05bbe033787d8b71846", "HyperDigest": "6a050f12acfc22989a7681f901a68ace8a9a3672428f8a877f4d21568123a0cb", "Version": 0 }.
AddBulk posts a bulk of events into the system: The http post url is: POST /events/bulk The following statuses are expected: If everything is alright, the HTTP status is 201 and the body contains: [ { "EventDigest": "5beeaf427ee0bfcd1a7b6f63010f2745110cf23ae088b859275cd0aad369561b", "HistoryDigest": "b8fdd4b2146fe560f94d7a48f8bb3eaf6938f7de6ac6d05bbe033787d8b71846", "HyperDigest": "6a050f12acfc22989a7681f901a68ace8a9a3672428f8a877f4d21568123a0cb", "Version": 0 }, { "EventDigest": "5beeaf427ee0bfcd1a7b6f63010f2745110cf23ae088b859275cd0aad369561b", "HistoryDigest": "4f95cd9fd828abe86b092e506bbffd4662d9431c5755d68eed1ba5e5156fdb13", "HyperDigest": "7bd6cee5eb0b92801ed4ce58c54a76907221bb4e056165679977b16487e5f015", "Version": 1 }, ..
DigestMembership returns the membership proof for a given event digest The http post url is: POST /proofs/digest-membership Differs from Membership in that instead of sending the raw event we query with the keyDigest which is the digest of the event.
GetReqSanitizer function checks that certain request info exists and it is correct.
HealthCheckHandler checks the system status and returns it accordinly.
Incremental returns an incremental proof for between initial and end events The http post url is: POST /proofs/incremental The following statuses are expected: If everything is alright, the HTTP status is 200 and the body contains: { "Start": "2", "End": "8", "AuditPath": ["<truncated for clarity in docs>"] }.
InfoHandler returns information about the QED server.
No description provided by the author
LogHandler Logs the Http Status for a request into fileHandler and returns a httphandler function which is a wrapper to log the requests.
Membership returns the membership proof for a given event The http post url is: POST /proofs/membership The following statuses are expected: If everything is alright, the HTTP status is 200 and the body contains: { "Exists": true, "HyperProof": "<truncated for clarity in docs>"], "HistoryProof": "<truncated for clarity in docs>"], "CurrentVersion": 3, "QueryVersion": 3, "ActualVersion": 0, "KeyDigest": "5beeaf427ee0bfcd1a7b6f63010f2745110cf23ae088b859275cd0aad369561b" }.
NewApiHttp returns a new *http.ServeMux containing the current API handlers.
PostReqSanitizer function checks that certain request info exists and it is correct.
No description provided by the author

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

HealthCheckResponse contains the response from HealthCheckHandler.

# Interfaces

No description provided by the author