cdk-signatory 0.17.3

CDK signatory default implementation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

syntax = "proto3";

package signatory;

service Signatory {
  rpc BlindSign(BlindedMessages) returns (BlindSignResponse);
  rpc VerifyProofs(Proofs) returns (BooleanResponse);
  // returns all the keysets for the mint
  rpc Keysets(EmptyRequest) returns (KeysResponse);
  // rotates the keysets
  rpc RotateKeyset(RotationRequest) returns (KeyRotationResponse);
}

enum Constants {
  CONSTANTS_UNSPECIFIED = 0;
  // this constant should be sent on the header of the grpc code for verification
  CONSTANTS_SCHEMA_VERSION = 1;
}

message BlindSignResponse {
  Error error = 1;
  BlindSignatures sigs = 2;
}

message BlindedMessages {
  repeated BlindedMessage blinded_messages = 1;
}

// Represents a blinded message
message BlindedMessage {
  uint64 amount = 1;
  bytes keyset_id = 2;
  bytes blinded_secret = 3;
}

message BooleanResponse {
  Error error = 1;
  bool success = 2;
}

message KeyRotationResponse {
  Error error = 1;
  KeySet keyset = 2;
}

message KeysResponse {
  Error error = 1;
  SignatoryKeysets keysets = 2;
}

message SignatoryKeysets {
  bytes pubkey = 1;
  repeated KeySet keysets = 2;
}

message KeySet {
  bytes id = 1;
  CurrencyUnit unit = 2;
  bool active = 3;
  uint64 input_fee_ppk = 4;
  Keys keys = 5;
  optional uint64 final_expiry = 6;
  uint32 version = 7;
  optional string issuer_version = 8;
}

message Keys {
  map<uint64, bytes> keys = 1;
}

enum KeysetVersion {
  KEYSET_VERSION_UNSPECIFIED = 0;
  KEYSET_VERSION_V1 = 1;
  KEYSET_VERSION_V2 = 2;
}
message RotationRequest {
  CurrencyUnit unit = 1;
  uint64 input_fee_ppk = 2;
  repeated uint64 amounts = 3;
  optional uint64 final_expiry = 4;
  KeysetVersion keyset_id_type = 5;
}

enum CurrencyUnitType {
  CURRENCY_UNIT_TYPE_UNSPECIFIED = 0;
  CURRENCY_UNIT_TYPE_SAT = 1;
  CURRENCY_UNIT_TYPE_MSAT = 2;
  CURRENCY_UNIT_TYPE_USD = 3;
  CURRENCY_UNIT_TYPE_EUR = 4;
  CURRENCY_UNIT_TYPE_AUTH = 5;
}

message CurrencyUnit {
  oneof currency_unit {
    CurrencyUnitType unit = 1;
    string custom_unit = 2;
  }
}

message Proofs {
  repeated Proof proof = 1;
}

message Proof {
  uint64 amount = 1;
  bytes keyset_id = 2;
  bytes secret = 3;
  bytes c = 4;
}

message BlindSignatures {
  repeated BlindSignature blind_signatures = 1;
}

message BlindSignature {
  uint64 amount = 1;
  bytes keyset_id = 2;
  bytes blinded_secret = 3;
  optional BlindSignatureDLEQ dleq = 4;
}

message BlindSignatureDLEQ {
  bytes e = 1;
  bytes s = 2;
}

enum ErrorCode {
  ERROR_CODE_UNSPECIFIED = 0;
  ERROR_CODE_AMOUNT_OUTSIDE_LIMIT = 1;
  ERROR_CODE_DUPLICATE_INPUTS_PROVIDED = 2;
  ERROR_CODE_DUPLICATE_OUTPUTS_PROVIDED = 3;
  ERROR_CODE_KEYSET_NOT_KNOWN = 4;
  ERROR_CODE_KEYSET_INACTIVE = 5;
  ERROR_CODE_MINTING_DISABLED = 6;
  ERROR_CODE_COULD_NOT_ROTATE_KEYSET = 7;
  ERROR_CODE_INVALID_PROOF = 8;
  ERROR_CODE_INVALID_BLIND_MESSAGE = 9;
  ERROR_CODE_UNIT_NOT_SUPPORTED = 10;
}

message Error {
  ErrorCode code = 1;
  string detail = 2;
}

message EmptyRequest {}