Skip to content

Commit e07effd

Browse files
committed
Update Session Pro naming scheme for some apis
get_pro_proof -> generate_pro_proofs GetProProof -> GenerateProProofs get_pro_status -> get_pro_details GetProStatus -> GetProDetails
1 parent 0fd3d5c commit e07effd

File tree

4 files changed

+195
-188
lines changed

4 files changed

+195
-188
lines changed

include/session/pro_backend.h

Lines changed: 55 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,11 @@ typedef enum SESSION_PRO_BACKEND_USER_PRO_STATUS {
5858
SESSION_PRO_BACKEND_USER_PRO_STATUS_COUNT,
5959
} SESSION_PRO_BACKEND_USER_PRO_STATUS;
6060

61-
typedef enum SESSION_PRO_BACKEND_GET_PRO_STATUS_ERROR_REPORT {
62-
SESSION_PRO_BACKEND_GET_PRO_STATUS_ERROR_REPORT_SUCCESS,
63-
SESSION_PRO_BACKEND_GET_PRO_STATUS_ERROR_REPORT_GENERIC_ERROR,
64-
SESSION_PRO_BACKEND_GET_PRO_STATUS_ERROR_REPORT_COUNT,
65-
} SESSION_PRO_BACKEND_GET_PRO_STATUS_ERROR_REPORT;
61+
typedef enum SESSION_PRO_BACKEND_GET_PRO_DETAILS_ERROR_REPORT {
62+
SESSION_PRO_BACKEND_GET_PRO_DETAILS_ERROR_REPORT_SUCCESS,
63+
SESSION_PRO_BACKEND_GET_PRO_DETAILS_ERROR_REPORT_GENERIC_ERROR,
64+
SESSION_PRO_BACKEND_GET_PRO_DETAILS_ERROR_REPORT_COUNT,
65+
} SESSION_PRO_BACKEND_GET_PRO_DETAILS_ERROR_REPORT;
6666

6767
/// Must match:
6868
/// https://github.com/Doy-lee/session-pro-backend/blob/41a794e2998b528566d0c27d34c4faeed5602e26/server.py#L461
@@ -219,8 +219,9 @@ struct session_pro_backend_add_pro_payment_request {
219219
bytes64 rotating_sig;
220220
};
221221

222-
typedef struct session_pro_backend_get_pro_proof_request session_pro_backend_get_pro_proof_request;
223-
struct session_pro_backend_get_pro_proof_request {
222+
typedef struct session_pro_backend_generate_pro_proof_request
223+
session_pro_backend_generate_pro_proof_request;
224+
struct session_pro_backend_generate_pro_proof_request {
224225
uint8_t version;
225226
bytes32 master_pkey;
226227
bytes32 rotating_pkey;
@@ -229,9 +230,9 @@ struct session_pro_backend_get_pro_proof_request {
229230
bytes64 rotating_sig;
230231
};
231232

232-
typedef struct session_pro_backend_add_pro_payment_or_get_pro_proof_response
233-
session_pro_backend_add_pro_payment_or_get_pro_proof_response;
234-
struct session_pro_backend_add_pro_payment_or_get_pro_proof_response {
233+
typedef struct session_pro_backend_add_pro_payment_or_generate_pro_proof_response
234+
session_pro_backend_add_pro_payment_or_generate_pro_proof_response;
235+
struct session_pro_backend_add_pro_payment_or_generate_pro_proof_response {
235236
session_pro_backend_response_header header;
236237
session_protocol_pro_proof proof;
237238
};
@@ -259,9 +260,9 @@ struct session_pro_backend_get_pro_revocations_response {
259260
size_t items_count;
260261
};
261262

262-
typedef struct session_pro_backend_get_pro_status_request
263-
session_pro_backend_get_pro_status_request;
264-
struct session_pro_backend_get_pro_status_request {
263+
typedef struct session_pro_backend_get_pro_details_request
264+
session_pro_backend_get_pro_details_request;
265+
struct session_pro_backend_get_pro_details_request {
265266
uint8_t version;
266267
bytes32 master_pkey;
267268
bytes64 master_sig;
@@ -298,15 +299,15 @@ struct session_pro_backend_pro_payment_item {
298299
size_t apple_web_line_order_id_count;
299300
};
300301

301-
typedef struct session_pro_backend_get_pro_status_response
302-
session_pro_backend_get_pro_status_response;
303-
struct session_pro_backend_get_pro_status_response {
302+
typedef struct session_pro_backend_get_pro_details_response
303+
session_pro_backend_get_pro_details_response;
304+
struct session_pro_backend_get_pro_details_response {
304305
session_pro_backend_response_header header;
305306
/// Array of payment items, with items_count elements
306307
session_pro_backend_pro_payment_item* items;
307308
size_t items_count;
308309
SESSION_PRO_BACKEND_USER_PRO_STATUS status;
309-
SESSION_PRO_BACKEND_GET_PRO_STATUS_ERROR_REPORT error_report;
310+
SESSION_PRO_BACKEND_GET_PRO_DETAILS_ERROR_REPORT error_report;
310311
bool auto_renewing;
311312
uint64_t expiry_unix_ts_ms;
312313
uint64_t grace_period_duration_ms;
@@ -373,9 +374,9 @@ session_pro_backend_to_json session_pro_backend_add_pro_payment_request_build_to
373374
const uint8_t* payment_tx_order_id,
374375
size_t payment_tx_order_id_len) NON_NULL_ARG(2, 4, 7, 9);
375376

376-
/// API: session_pro_backend/get_pro_proof_request_build_sigs
377+
/// API: session_pro_backend/generate_pro_proof_request_build_sigs
377378
///
378-
/// Builds master and rotating signatures for a `get_pro_proof_request`.
379+
/// Builds master and rotating signatures for a `generate_pro_proof_request`.
379380
/// Returns false if the keys (32-byte or 64-byte libsodium format) are incorrectly sized.
380381
/// Using 64-byte libsodium keys is more efficient.
381382
///
@@ -394,33 +395,34 @@ session_pro_backend_to_json session_pro_backend_add_pro_payment_request_build_to
394395
/// - `master_sig` - Master signature
395396
/// - `rotating_sig` - Rotating signature
396397
LIBSESSION_EXPORT
397-
session_pro_backend_master_rotating_signatures session_pro_backend_get_pro_proof_request_build_sigs(
398+
session_pro_backend_master_rotating_signatures
399+
session_pro_backend_generate_pro_proof_request_build_sigs(
398400
uint8_t request_version,
399401
const uint8_t* master_privkey,
400402
size_t master_privkey_len,
401403
const uint8_t* rotating_privkey,
402404
size_t rotating_privkey_len,
403405
uint64_t unix_ts_ms) NON_NULL_ARG(2, 4);
404406

405-
/// API: session_pro_backend/get_pro_proof_request_build_to_json
407+
/// API: session_pro_backend/generate_pro_proof_request_build_to_json
406408
///
407-
/// Builds the JSON for a `get_pro_proof_request`. This function is the same as filling in the
409+
/// Builds the JSON for a `generate_pro_proof_request`. This function is the same as filling in the
408410
/// struct and calling the corresponding `to_json` function.
409411
/// The caller must free the returned string using `session_pro_backend_to_json_free`.
410412
///
411-
/// See: `session_pro_backend_get_pro_proof_request_build_sigs`
413+
/// See: `session_pro_backend_generate_pro_proof_request_build_sigs`
412414
LIBSESSION_EXPORT
413-
session_pro_backend_to_json session_pro_backend_get_pro_proof_request_build_to_json(
415+
session_pro_backend_to_json session_pro_backend_generate_pro_proof_request_build_to_json(
414416
uint8_t request_version,
415417
const uint8_t* master_privkey,
416418
size_t master_privkey_len,
417419
const uint8_t* rotating_privkey,
418420
size_t rotating_privkey_len,
419421
uint64_t unix_ts_ms) NON_NULL_ARG(2, 4);
420422

421-
/// API: session_pro_backend/get_pro_status_request_build_sig
423+
/// API: session_pro_backend/get_pro_details_request_build_sig
422424
///
423-
/// Builds the JSON for a `get_pro_status_request`. Returns false if the keys (32-byte or
425+
/// Builds the JSON for a `get_pro_details_request`. Returns false if the keys (32-byte or
424426
/// 64-byte libsodium format) are incorrectly sized. Using 64-byte libsodium keys is more efficient.
425427
///
426428
/// Inputs:
@@ -436,22 +438,22 @@ session_pro_backend_to_json session_pro_backend_get_pro_proof_request_build_to_j
436438
/// - `errors_count` -- length of the error if `success` is false
437439
/// - `sig` -- The generated signature
438440
LIBSESSION_EXPORT
439-
session_pro_backend_signature session_pro_backend_get_pro_status_request_build_sig(
441+
session_pro_backend_signature session_pro_backend_get_pro_details_request_build_sig(
440442
uint8_t request_version,
441443
const uint8_t* master_privkey,
442444
size_t master_privkey_len,
443445
uint64_t unix_ts_ms,
444446
uint32_t count) NON_NULL_ARG(2);
445447

446-
/// API: session_pro_backend/get_pro_status_request_build_to_json
448+
/// API: session_pro_backend/get_pro_details_request_build_to_json
447449
///
448-
/// Builds the JSON for a `get_pro_status_request`. This function is the same as filling in the
450+
/// Builds the JSON for a `get_pro_details_request`. This function is the same as filling in the
449451
/// struct and calling the corresponding `to_json` function.
450452
/// The caller must free the returned string using `session_pro_backend_to_json_free`.
451453
///
452-
/// See: `session_pro_backend_get_pro_status_request_build_sig`
454+
/// See: `session_pro_backend_get_pro_details_request_build_sig`
453455
LIBSESSION_EXPORT
454-
session_pro_backend_to_json session_pro_backend_get_pro_status_request_build_to_json(
456+
session_pro_backend_to_json session_pro_backend_get_pro_details_request_build_to_json(
455457
uint8_t request_version,
456458
const uint8_t* master_privkey,
457459
size_t master_privkey_len,
@@ -469,16 +471,16 @@ LIBSESSION_EXPORT
469471
session_pro_backend_to_json session_pro_backend_add_pro_payment_request_to_json(
470472
const session_pro_backend_add_pro_payment_request* request);
471473

472-
/// API: session_pro_backend/get_pro_proof_request_to_json
474+
/// API: session_pro_backend/generate_pro_proof_request_to_json
473475
///
474-
/// Serializes a `get_pro_proof_request` to a JSON string.
476+
/// Serializes a `generate_pro_proof_request` to a JSON string.
475477
/// The caller must free the returned string using `session_pro_backend_to_json_free`.
476478
///
477479
/// Inputs:
478480
/// - `request` -- Pointer to the request struct.
479481
LIBSESSION_EXPORT
480-
session_pro_backend_to_json session_pro_backend_get_pro_proof_request_to_json(
481-
const session_pro_backend_get_pro_proof_request* request);
482+
session_pro_backend_to_json session_pro_backend_generate_pro_proof_request_to_json(
483+
const session_pro_backend_generate_pro_proof_request* request);
482484

483485
/// API: session_pro_backend/get_pro_revocations_request_to_json
484486
///
@@ -488,26 +490,26 @@ LIBSESSION_EXPORT
488490
session_pro_backend_to_json session_pro_backend_get_pro_revocations_request_to_json(
489491
const session_pro_backend_get_pro_revocations_request* request);
490492

491-
/// API: session_pro_backend/get_pro_status_request_to_json
493+
/// API: session_pro_backend/get_pro_details_request_to_json
492494
///
493-
/// Serializes a `get_pro_status_request` to a JSON string.
495+
/// Serializes a `get_pro_details_request` to a JSON string.
494496
/// The caller must free the returned string using `session_pro_backend_to_json_free`.
495497
LIBSESSION_EXPORT
496-
session_pro_backend_to_json session_pro_backend_get_pro_status_request_to_json(
497-
const session_pro_backend_get_pro_status_request* request);
498+
session_pro_backend_to_json session_pro_backend_get_pro_details_request_to_json(
499+
const session_pro_backend_get_pro_details_request* request);
498500

499-
/// API: session_pro_backend/add_pro_payment_or_get_pro_proof_response_parse
501+
/// API: session_pro_backend/add_pro_payment_or_generate_pro_proof_response_parse
500502
///
501-
/// Parses a JSON string into an `add_pro_payment_or_get_pro_proof_response` struct.
503+
/// Parses a JSON string into an `add_pro_payment_or_generate_pro_proof_response` struct.
502504
/// The caller must free the response using
503-
/// `session_pro_backend_add_pro_payment_or_get_pro_proof_response_free`.
505+
/// `session_pro_backend_add_pro_payment_or_generate_pro_proof_response_free`.
504506
///
505507
/// Inputs:
506508
/// - `json` -- JSON string to parse.
507509
/// - `json_len` -- Length of the JSON string.
508510
LIBSESSION_EXPORT
509-
session_pro_backend_add_pro_payment_or_get_pro_proof_response
510-
session_pro_backend_add_pro_payment_or_get_pro_proof_response_parse(
511+
session_pro_backend_add_pro_payment_or_generate_pro_proof_response
512+
session_pro_backend_add_pro_payment_or_generate_pro_proof_response_parse(
511513
const char* json, size_t json_len);
512514

513515
/// API: session_pro_backend/get_pro_revocations_response_parse
@@ -522,16 +524,16 @@ LIBSESSION_EXPORT
522524
session_pro_backend_get_pro_revocations_response
523525
session_pro_backend_get_pro_revocations_response_parse(const char* json, size_t json_len);
524526

525-
/// API: session_pro_backend/get_pro_status_response_parse
527+
/// API: session_pro_backend/get_pro_details_response_parse
526528
///
527529
/// Parses a JSON string into a GetProPaymentsResponse struct.
528-
/// The caller must free the response using session_pro_backend_get_pro_status_response_free.
530+
/// The caller must free the response using session_pro_backend_get_pro_details_response_free.
529531
///
530532
/// Inputs:
531533
/// - `json` -- JSON string to parse.
532534
/// - `json_len` -- Length of the JSON string.
533535
LIBSESSION_EXPORT
534-
session_pro_backend_get_pro_status_response session_pro_backend_get_pro_status_response_parse(
536+
session_pro_backend_get_pro_details_response session_pro_backend_get_pro_details_response_parse(
535537
const char* json, size_t json_len);
536538

537539
/// API: session_pro_backend/to_json_free
@@ -540,12 +542,12 @@ session_pro_backend_get_pro_status_response session_pro_backend_get_pro_status_r
540542
LIBSESSION_EXPORT
541543
void session_pro_backend_to_json_free(session_pro_backend_to_json* to_json);
542544

543-
/// API: session_pro_backend/add_pro_payment_or_get_pro_proof_response_free
545+
/// API: session_pro_backend/add_pro_payment_or_generate_pro_proof_response_free
544546
///
545547
/// Frees the response
546548
LIBSESSION_EXPORT
547-
void session_pro_backend_add_pro_payment_or_get_pro_proof_response_free(
548-
session_pro_backend_add_pro_payment_or_get_pro_proof_response* response);
549+
void session_pro_backend_add_pro_payment_or_generate_pro_proof_response_free(
550+
session_pro_backend_add_pro_payment_or_generate_pro_proof_response* response);
549551

550552
/// API: session_pro_backend/get_pro_revocations_response_free
551553
///
@@ -554,12 +556,12 @@ LIBSESSION_EXPORT
554556
void session_pro_backend_get_pro_revocations_response_free(
555557
session_pro_backend_get_pro_revocations_response* response);
556558

557-
/// API: session_pro_backend/get_pro_status_response_free
559+
/// API: session_pro_backend/get_pro_details_response_free
558560
///
559561
/// Frees the respone
560562
LIBSESSION_EXPORT
561-
void session_pro_backend_get_pro_status_response_free(
562-
session_pro_backend_get_pro_status_response* response);
563+
void session_pro_backend_get_pro_details_response_free(
564+
session_pro_backend_get_pro_details_response* response);
563565

564566
#ifdef __cplusplus
565567
} // extern "C"

0 commit comments

Comments
 (0)