@rsdk/builtin-contract 4.0.0-next.9 → 4.0.1-next.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (23) hide show
  1. package/CHANGELOG.md +64 -7
  2. package/dist/google/protobuf/struct.js.map +1 -1
  3. package/dist/grpc/error/v1/error.js.map +1 -1
  4. package/dist/grpc/health/v1/health.js.map +1 -1
  5. package/dist/grpc/metrics/v1/metrics.js.map +1 -1
  6. package/dist/grpc/reflection/v1/reflection.js.map +1 -1
  7. package/dist/grpc/reflection/v1alpha/reflection.js.map +1 -1
  8. package/dist/grpc.health.v1.js.map +1 -1
  9. package/dist/grpc.metrics.v1.d.ts +2 -2
  10. package/dist/grpc.metrics.v1.js +3 -3
  11. package/dist/grpc.metrics.v1.js.map +1 -1
  12. package/dist/grpc.reflection.v1.d.ts +8 -8
  13. package/dist/grpc.reflection.v1.js +9 -9
  14. package/dist/grpc.reflection.v1.js.map +1 -1
  15. package/dist/grpc.reflection.v1alpha.d.ts +6 -6
  16. package/dist/grpc.reflection.v1alpha.js +9 -9
  17. package/dist/grpc.reflection.v1alpha.js.map +1 -1
  18. package/docs/README.md +157 -316
  19. package/docs/index.md +53 -94
  20. package/docs/schemas/Health.svg +216 -142
  21. package/docs/schemas/Metrics.svg +98 -69
  22. package/docs/schemas/ServerReflection.svg +503 -298
  23. package/package.json +2 -2
package/docs/index.md CHANGED
@@ -1,4 +1,5 @@
1
1
  # Protocol Documentation
2
+
2
3
  <a name="top"></a>
3
4
 
4
5
  ## Table of Contents
@@ -6,162 +7,120 @@
6
7
  - [grpc/health/v1/health.proto](#grpc_health_v1_health-proto)
7
8
  - [HealthCheckRequest](#grpc-health-v1-HealthCheckRequest)
8
9
  - [HealthCheckResponse](#grpc-health-v1-HealthCheckResponse)
9
-
10
+
10
11
  - [HealthCheckResponse.ServingStatus](#grpc-health-v1-HealthCheckResponse-ServingStatus)
11
-
12
+
12
13
  - [Health](#grpc-health-v1-Health)
13
-
14
+
14
15
  - [grpc/metrics/v1/metrics.proto](#grpc_metrics_v1_metrics-proto)
15
16
  - [GetRequest](#grpc-metrics-v1-GetRequest)
16
17
  - [GetResponse](#grpc-metrics-v1-GetResponse)
17
-
18
- - [Metrics](#grpc-metrics-v1-Metrics)
19
-
20
- - [Scalar Value Types](#scalar-value-types)
21
18
 
19
+ - [Metrics](#grpc-metrics-v1-Metrics)
22
20
 
21
+ - [Scalar Value Types](#scalar-value-types)
23
22
 
24
23
  <a name="grpc_health_v1_health-proto"></a>
25
24
  <p align="right"><a href="#top">Top</a></p>
26
25
 
27
26
  ## grpc/health/v1/health.proto
28
27
 
29
-
30
-
31
28
  <a name="grpc-health-v1-HealthCheckRequest"></a>
32
29
 
33
30
  ### HealthCheckRequest
34
- HealthCheckRequest
35
-
36
-
37
- | Field | Type | Label | Description |
38
- | ----- | ---- | ----- | ----------- |
39
- | service | [string](#string) | | service |
40
-
41
-
42
-
43
31
 
32
+ HealthCheckRequest
44
33
 
34
+ | Field | Type | Label | Description |
35
+ |---------|-------------------|-------|-------------|
36
+ | service | [string](#string) | | service |
45
37
 
46
38
  <a name="grpc-health-v1-HealthCheckResponse"></a>
47
39
 
48
40
  ### HealthCheckResponse
49
- HealthCheckResponse
50
-
51
-
52
- | Field | Type | Label | Description |
53
- | ----- | ---- | ----- | ----------- |
54
- | status | [HealthCheckResponse.ServingStatus](#grpc-health-v1-HealthCheckResponse-ServingStatus) | | status |
55
-
56
41
 
42
+ HealthCheckResponse
57
43
 
58
-
59
-
60
-
61
-
44
+ | Field | Type | Label | Description |
45
+ |--------|----------------------------------------------------------------------------------------|-------|-------------|
46
+ | status | [HealthCheckResponse.ServingStatus](#grpc-health-v1-HealthCheckResponse-ServingStatus) | | status |
62
47
 
63
48
  <a name="grpc-health-v1-HealthCheckResponse-ServingStatus"></a>
64
49
 
65
50
  ### HealthCheckResponse.ServingStatus
66
- ServingStatus
67
-
68
- | Name | Number | Description |
69
- | ---- | ------ | ----------- |
70
- | UNKNOWN | 0 | buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX buf:lint:ignore ENUM_VALUE_PREFIX UNKNOWN |
71
- | SERVING | 1 | buf:lint:ignore ENUM_VALUE_PREFIX SERVING |
72
- | NOT_SERVING | 2 | buf:lint:ignore ENUM_VALUE_PREFIX NOT_SERVING |
73
- | SERVICE_UNKNOWN | 3 | buf:lint:ignore ENUM_VALUE_PREFIX SERVICE_UNKNOWN — Used only by the Watch method. |
74
-
75
51
 
76
-
77
-
78
-
52
+ ServingStatus
79
53
 
54
+ | Name | Number | Description |
55
+ |-----------------|--------|------------------------------------------------------------------------------------|
56
+ | UNKNOWN | 0 | buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX buf:lint:ignore ENUM_VALUE_PREFIX UNKNOWN |
57
+ | SERVING | 1 | buf:lint:ignore ENUM_VALUE_PREFIX SERVING |
58
+ | NOT_SERVING | 2 | buf:lint:ignore ENUM_VALUE_PREFIX NOT_SERVING |
59
+ | SERVICE_UNKNOWN | 3 | buf:lint:ignore ENUM_VALUE_PREFIX SERVICE_UNKNOWN — Used only by the Watch method. |
80
60
 
81
61
  <a name="grpc-health-v1-Health"></a>
82
62
 
83
63
  ### Health
64
+
84
65
  buf:lint:ignore SERVICE_SUFFIX
85
66
  Health
86
67
 
87
- | Method Name | Request Type | Response Type | Description |
88
- | ----------- | ------------ | ------------- | ------------|
89
- | Check | [HealthCheckRequest](#grpc-health-v1-HealthCheckRequest) | [HealthCheckResponse](#grpc-health-v1-HealthCheckResponse) | buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_REQUEST_STANDARD_NAME buf:lint:ignore RPC_RESPONSE_STANDARD_NAME Check |
90
- | Watch | [HealthCheckRequest](#grpc-health-v1-HealthCheckRequest) | [HealthCheckResponse](#grpc-health-v1-HealthCheckResponse) stream | buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_REQUEST_STANDARD_NAME buf:lint:ignore RPC_RESPONSE_STANDARD_NAME Watch |
91
-
92
-
93
-
94
-
68
+ | Method Name | Request Type | Response Type | Description |
69
+ |-------------|----------------------------------------------------------|-------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
70
+ | Check | [HealthCheckRequest](#grpc-health-v1-HealthCheckRequest) | [HealthCheckResponse](#grpc-health-v1-HealthCheckResponse) | buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_REQUEST_STANDARD_NAME buf:lint:ignore RPC_RESPONSE_STANDARD_NAME Check |
71
+ | Watch | [HealthCheckRequest](#grpc-health-v1-HealthCheckRequest) | [HealthCheckResponse](#grpc-health-v1-HealthCheckResponse) stream | buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_REQUEST_STANDARD_NAME buf:lint:ignore RPC_RESPONSE_STANDARD_NAME Watch |
95
72
 
96
73
  <a name="grpc_metrics_v1_metrics-proto"></a>
97
74
  <p align="right"><a href="#top">Top</a></p>
98
75
 
99
76
  ## grpc/metrics/v1/metrics.proto
100
- metrics
101
77
 
78
+ metrics
102
79
 
103
80
  <a name="grpc-metrics-v1-GetRequest"></a>
104
81
 
105
82
  ### GetRequest
106
- Empty request
107
-
108
-
109
-
110
-
111
83
 
84
+ Empty request
112
85
 
113
86
  <a name="grpc-metrics-v1-GetResponse"></a>
114
87
 
115
88
  ### GetResponse
116
- Metrics response
117
-
118
-
119
- | Field | Type | Label | Description |
120
- | ----- | ---- | ----- | ----------- |
121
- | metrics | [string](#string) | | String in prometheus format |
122
-
123
-
124
-
125
-
126
89
 
127
-
128
-
129
-
130
-
131
-
90
+ Metrics response
132
91
 
92
+ | Field | Type | Label | Description |
93
+ |---------|-------------------|-------|-----------------------------|
94
+ | metrics | [string](#string) | | String in prometheus format |
133
95
 
134
96
  <a name="grpc-metrics-v1-Metrics"></a>
135
97
 
136
98
  ### Metrics
99
+
137
100
  buf:lint:ignore SERVICE_SUFFIX
138
101
  MetricsService
139
102
 
140
- | Method Name | Request Type | Response Type | Description |
141
- | ----------- | ------------ | ------------- | ------------|
142
- | Get | [GetRequest](#grpc-metrics-v1-GetRequest) | [GetResponse](#grpc-metrics-v1-GetResponse) | Get metrics in prometheus format |
143
-
144
-
145
-
146
-
103
+ | Method Name | Request Type | Response Type | Description |
104
+ |-------------|-------------------------------------------|---------------------------------------------|----------------------------------|
105
+ | Get | [GetRequest](#grpc-metrics-v1-GetRequest) | [GetResponse](#grpc-metrics-v1-GetResponse) | Get metrics in prometheus format |
147
106
 
148
107
  ## Scalar Value Types
149
108
 
150
- | .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
151
- | ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- |
152
- | <a name="double" /> double | | double | double | float | float64 | double | float | Float |
153
- | <a name="float" /> float | | float | float | float | float32 | float | float | Float |
154
- | <a name="int32" /> int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
155
- | <a name="int64" /> int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
156
- | <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
157
- | <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
158
- | <a name="sint32" /> sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
159
- | <a name="sint64" /> sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
160
- | <a name="fixed32" /> fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
161
- | <a name="fixed64" /> fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
162
- | <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
163
- | <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
164
- | <a name="bool" /> bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass |
165
- | <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
166
- | <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |
109
+ | .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
110
+ |--------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|--------|------------|-------------|---------|------------|----------------|--------------------------------|
111
+ | <a name="double" /> double | | double | double | float | float64 | double | float | Float |
112
+ | <a name="float" /> float | | float | float | float | float32 | float | float | Float |
113
+ | <a name="int32" /> int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
114
+ | <a name="int64" /> int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
115
+ | <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
116
+ | <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
117
+ | <a name="sint32" /> sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
118
+ | <a name="sint64" /> sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
119
+ | <a name="fixed32" /> fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
120
+ | <a name="fixed64" /> fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
121
+ | <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
122
+ | <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
123
+ | <a name="bool" /> bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass |
124
+ | <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
125
+ | <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |
167
126