@@ -38,7 +38,7 @@ enum KeyFormat {
3838 // format](https://developers.google.com/tink/wire-format#keyset_serialization).
3939 KEY_FORMAT_TINK_WIRE_FORMAT = 1 ;
4040
41- // A PEM-encoded elliptic curve signing key using the P-256 curve with
41+ // A PEM-encoded elliptic curve signing key using the P-256 curve with
4242 // SHA256 digest. Signatures must be provided in DER format.
4343 KEY_FORMAT_PEM_EC_P256_SHA256 = 2 ;
4444}
@@ -71,8 +71,8 @@ enum SettlementMode {
7171// transaction that needs to be sent to execute a settlement between the two
7272// token managers.
7373message SettlementRequest {
74- // Optional. Immutable. The account ID of the party that needs to make the
75- // fund transfer. Deprecated: use `payer_id` instead .
74+ // Optional. Immutable. Deprecated: use `payer_id` instead.
75+ // The account ID of the party that needs to make the fund transfer .
7676 Entity payer = 1 [
7777 deprecated = true ,
7878 (google.api.field_behavior ) = IMMUTABLE ,
@@ -86,8 +86,8 @@ message SettlementRequest {
8686 (google.api.field_behavior ) = OPTIONAL
8787 ];
8888
89- // Optional. Immutable. The account ID of the party that needs to be paid .
90- // Deprecated: use `beneficiary_id` instead .
89+ // Optional. Immutable. Deprecated: use `beneficiary_id` instead .
90+ // The account ID of the party that needs to be paid .
9191 Entity beneficiary = 2 [
9292 deprecated = true ,
9393 (google.api.field_behavior ) = IMMUTABLE ,
@@ -148,17 +148,18 @@ message CreateAccount {
148148 AccountStatus account_status = 3 [(google.api.field_behavior ) = OPTIONAL ];
149149
150150 // Optional. Immutable. An opaque comment field that is not interpreted by the
151- // system but stored on the ledger in the account. Maximum length is 128
152- // characters. May be left empty. Once created, the field is immutable.
151+ // system but stored on the ledger in the account. Considered public
152+ // information. Maximum length is 128 characters. May be left empty. Once
153+ // created, the field is immutable.
153154 string account_comment = 4 [
154155 (google.api.field_behavior ) = OPTIONAL ,
155156 (google.api.field_behavior ) = IMMUTABLE
156157 ];
157158
158- // Optional. The token manager for this account. This field is optional and if
159- // not supplied, the default token manager associated to the account manager
159+ // Optional. Deprecated: use `token_manager_id` instead.
160+ // The token manager for this account. This field is optional and if not
161+ // supplied, the default token manager associated to the account manager
160162 // (that is, the sender of this transaction) will be used.
161- // Deprecated: use `token_manager_id` instead.
162163 Entity token_manager = 5
163164 [deprecated = true , (google.api.field_behavior ) = OPTIONAL ];
164165
@@ -175,8 +176,8 @@ message CreateAccount {
175176// This implies that the account owner will not be able to make any transactions
176177// on the account regardless of the roles.
177178message DeactivateAccount {
178- // Optional. The ID of the account to be deactivated .
179- // Deprecated: use `account_id` instead .
179+ // Optional. Deprecated: use `account_id` instead .
180+ // The ID of the account to be deactivated .
180181 Entity account = 1
181182 [deprecated = true , (google.api.field_behavior ) = OPTIONAL ];
182183
@@ -191,8 +192,8 @@ message DeactivateAccount {
191192// The account owner can resume normal operations permitted by the roles on the
192193// account.
193194message ActivateAccount {
194- // Optional. The ID of the account to be activated .
195- // Deprecated: use `account_id` instead .
195+ // Optional. Deprecated: use `account_id` instead .
196+ // The ID of the account to be activated .
196197 Entity account = 1
197198 [deprecated = true , (google.api.field_behavior ) = OPTIONAL ];
198199
@@ -204,8 +205,8 @@ message ActivateAccount {
204205// Adds the specified roles to the account. The sender must be the account
205206// manager of the account to modify.
206207message AddRoles {
207- // Optional. The ID of the account to be modified .
208- // Deprecated: use `account_id` instead .
208+ // Optional. Deprecated: use `account_id` instead .
209+ // The ID of the account to be modified .
209210 Entity account = 1
210211 [deprecated = true , (google.api.field_behavior ) = OPTIONAL ];
211212
@@ -220,8 +221,8 @@ message AddRoles {
220221// Removes the specified roles from the account. The sender must be the account
221222// manager of the account to modify.
222223message RemoveRoles {
223- // Optional. The ID of the account to be modified .
224- // Deprecated: use `account_id` instead .
224+ // Optional. Deprecated: use `account_id` instead .
225+ // The ID of the account to be modified .
225226 Entity account = 1
226227 [deprecated = true , (google.api.field_behavior ) = OPTIONAL ];
227228
@@ -237,8 +238,8 @@ message RemoveRoles {
237238// manager. The sender must be the current account manager of the account and,
238239// to provide consent, the new manager must also sign this transaction.
239240message ChangeAccountManager {
240- // Optional. The ID of the account whose manager is to be changed .
241- // Deprecated: use `account_id` instead .
241+ // Optional. Deprecated: use `account_id` instead .
242+ // The ID of the account whose manager is to be changed .
242243 Entity account = 1
243244 [deprecated = true , (google.api.field_behavior ) = OPTIONAL ];
244245
@@ -247,9 +248,9 @@ message ChangeAccountManager {
247248 // characters.
248249 string account_id = 3 [(google.api.field_behavior ) = OPTIONAL ];
249250
250- // Optional. The ID of the new proposed account manager. Validation requires
251- // that the new manager has also signed this transaction. Deprecated: use
252- // `next_manager_id` instead .
251+ // Optional. Deprecated: use `next_manager_id` instead.
252+ // The ID of the new proposed account manager. Validation requires that the
253+ // new manager has also signed this transaction .
253254 Entity next_manager = 2
254255 [deprecated = true , (google.api.field_behavior ) = OPTIONAL ];
255256
@@ -265,9 +266,9 @@ message ChangeAccountManager {
265266// increases its token issuance limit. The sender must be a clearinghouse
266267// account.
267268message IncreaseTokenIssuanceLimit {
268- // Optional. The ID of the institutional account whose mint limit is to be
269- // raised. This account must be a token manager for the transaction to be
270- // valid. Deprecated: use `token_manager_id` instead .
269+ // Optional. Deprecated: use `token_manager_id` instead.
270+ // The ID of the institutional account whose mint limit is to be raised. This
271+ // account must be a token manager for the transaction to be valid .
271272 Entity token_manager = 1
272273 [deprecated = true , (google.api.field_behavior ) = OPTIONAL ];
273274
@@ -290,17 +291,16 @@ message IncreaseTokenIssuanceLimit {
290291// the transaction to fail (for example, if the minted amount is already above
291292// the requested reduced limit).
292293message DecreaseTokenIssuanceLimit {
293- // Optional. The ID of the institutional account whose mint limit is to be
294- // lowered. This account must have the `ADMIN_ROLE_TOKEN_MANAGER` permission
295- // on it for the transaction to be valid. Deprecated: use `token_manager_id`
296- // instead.
294+ // Optional. Deprecated: use `token_manager_id` instead.
295+ // The ID of the institutional account whose mint limit is to be lowered. This
296+ // account must be a token manager for the transaction to be valid.
297297 Entity token_manager = 1
298298 [deprecated = true , (google.api.field_behavior ) = OPTIONAL ];
299299
300300 // Optional. The ID of the institutional account whose mint limit is to be
301- // lowered. This account must have the `ADMIN_ROLE_TOKEN_MANAGER` permission
302- // on it for the transaction to be valid. One of `token_manager` or
303- // `token_manager_id` must be specified.
301+ // lowered. This account must be a token manager for the transaction to be
302+ // valid. One of `token_manager_id` (preferred) or `token_manager`
303+ // (deprecated) must be specified.
304304 string token_manager_id = 3 [(google.api.field_behavior ) = OPTIONAL ];
305305
306306 // Required. The amount by which to lower the limit. The amount must be
@@ -317,9 +317,9 @@ message Mint {
317317 // higher than that, the transaction must be rejected
318318 CurrencyValue mint_amount = 1 [(google.api.field_behavior ) = REQUIRED ];
319319
320- // Optional. The account to which the minted amount should be transferred.
320+ // Optional. Deprecated: use `beneficiary_id` instead.
321+ // The account to which the minted amount should be transferred.
321322 // The bene
C3FE
ficiary account must have the `ROLE_RECEIVER` enabled on it.
322- // Deprecated: use `beneficiary_id` instead.
323323 Entity beneficiary = 2
324324 [deprecated = true , (google.api.field_behavior ) = OPTIONAL ];
325325
@@ -340,8 +340,9 @@ message Burn {
340340 // Required. The amount to burn.
341341 CurrencyValue burn_amount = 1 [(google.api.field_behavior ) = REQUIRED ];
342342
343- // Optional. The account supplying the tokens to burn. The account must have
344- // the `ROLE_PAYER` enabled on it. Deprecated: use `payer_id` instead.
343+ // Optional. Deprecated: use `payer_id` instead.
344+ // The account supplying the tokens to burn. The account must have the
345+ // `ROLE_PAYER` enabled on it.
345346 Entity payer = 2 [deprecated = true , (google.api.field_behavior ) = OPTIONAL ];
346347
347348 // Optional. The ID of the account supplying the tokens to burn. The payer
@@ -357,8 +358,8 @@ message Burn {
357358// Additionally, the transaction sender must have the `ROLE_PAYER` enabled on
358359// it, while the receiver must have the `ROLE_RECEIVER` enabled on it.
359360message Transfer {
360- // Optional. The account that receives the tokens .
361- // Deprecated: use `beneficiary_id` instead .
361+ // Optional. Deprecated: use `beneficiary_id` instead .
362+ // The account that receives the tokens .
362363 Entity beneficiary = 1
363364 [deprecated = true , (google.api.field_behavior ) = OPTIONAL ];
364365
@@ -395,8 +396,9 @@ message CreateTokenManager {
395396 ];
396397
397398 // Optional. Immutable. An opaque comment field that is not interpreted by the
398- // system but stored on the ledger in the account. Maximum length is 128
399- // characters. May be left empty. Once created, the field is immutable.
399+ // system but stored on the ledger in the account. Considered public
400+ // information. Maximum length is 128 characters. May be left empty. Once
401+ // created, the field is immutable.
400402 string account_comment = 4 [
401403 (google.api.field_behavior ) = OPTIONAL ,
402404 (google.api.field_behavior ) = IMMUTABLE
@@ -427,8 +429,9 @@ message CreateAccountManager {
427429 (google.api.field_behavior ) = IMMUTABLE
428430 ];
429431
430- // Optional. The default token manager for the accounts that will be created
431- // by this manager. Deprecated: use `default_token_manager_id` instead.
432+ // Optional. Deprecated: use `default_token_manager_id` instead.
433+ // The default token manager for the accounts that will be created by this
434+ // manager.
432435 Entity default_token_manager = 2
433436 [deprecated = true , (google.api.field_behavior ) = OPTIONAL ];
434437
@@ -437,8 +440,9 @@ message CreateAccountManager {
437440 string default_token_manager_id = 3 [(google.api.field_behavior ) = OPTIONAL ];
438441
439442 // Optional. Immutable. An opaque comment field that is not interpreted by the
440- // system but stored on the ledger in the account. Maximum length is 128
441- // characters. May be left empty. Once created, the field is immutable.
443+ // system but stored on the ledger in the account. Considered public
444+ // information. Maximum length is 128 characters. May be left empty. Once
445+ // created, the field is immutable.
442446 string account_comment = 4 [
443447 (google.api.field_behavior ) = OPTIONAL ,
444448 (google.api.field_behavior ) = IMMUTABLE
@@ -469,8 +473,9 @@ message CreateClearinghouse {
469473 ];
470474
471475 // Optional. Immutable. An opaque comment field that is not interpreted by the
472- // system but stored on the ledger in the account. Maximum length is 128
473- // characters. May be left empty. Once created, the field is immutable.
476+ // system but stored on the ledger in the account. Considered public
477+ // information. Maximum length is 128 characters. May be left empty. Once
478+ // created, the field is immutable.
474479 string account_comment = 4 [
475480 (google.api.field_behavior ) = OPTIONAL ,
476481 (google.api.field_behavior ) = IMMUTABLE
@@ -505,8 +510,9 @@ message TransferPlatformOperator {
505510 ];
506511
507512 // Optional. Immutable. An opaque comment field that is not interpreted by the
508- // system but stored on the ledger in the account. Maximum length is 128
509- // characters. May be left empty. Once created, the field is immutable.
513+ // system but stored on the ledger in the account. Considered public
514+ // information. Maximum length is 128 characters. May be left empty. Once
515+ // created, the field is immutable.
510516 string account_comment = 2 [
511517 (google.api.field_behavior ) = OPTIONAL ,
512518 (google.api.field_behavior ) = IMMUTABLE
@@ -542,8 +548,9 @@ message CreateCurrencyOperator {
542548 ];
543549
544550 // Optional. Immutable. An opaque comment field that is not interpreted by the
545- // system but stored on the ledger in the account. Maximum length is 128
546- // characters. May be left empty. Once created, the field is immutable.
551+ // system but stored on the ledger in the account. Considered public
552+ // information. Maximum length is 128 characters. May be left empty. Once
553+ // created, the field is immutable.
547554 string account_comment = 2 [
548555 (google.api.field_behavior ) = OPTIONAL ,
549556 (google.api.field_behavior ) = IMMUTABLE
@@ -579,15 +586,16 @@ message TransferCurrencyOperator {
579586 ];
580587
581588 // Optional. Immutable. An opaque comment field that is not interpreted by the
582- // system but stored on the ledger in the account. Maximum length is 128
583- // characters. May be left empty. Once created, the field is immutable.
589+ // system but stored on the ledger in the account. Considered public
590+ // information. Maximum length is 128 characters. May be left empty. Once
591+ // created, the field is immutable.
584592 string account_comment = 2 [
585593 (google.api.field_behavior ) = OPTIONAL ,
586594 (google.api.field_behavior ) = IMMUTABLE
587595 ];
588596
589- // Optional. The currency operator to be replaced. Must be active .
590- // Deprecated: use `currency_operator_id` instead .
597+ // Optional. Deprecated: use `currency_operator_id` instead .
598+ // The currency operator to be replaced. Must be active .
591599 Entity currency_operator = 4
592600 [deprecated = true , (google.api.field_behavior ) = OPTIONAL ];
593601
@@ -609,16 +617,22 @@ message CreateContract {
609617 // Arguments for the `__init__` method.
610618 map <string , Value > arguments = 2 ;
611619
612- // An immutable opaque comment field that is associated with the contract.
613- string contract_comment = 3 ;
620+ // Optional. Immutable. An opaque comment field that is not interpreted by the
621+ // system but stored on the ledger in the contract. Considered public
622+ // information. Maximum length is 128 characters. May be left empty. Once
623+ // created, the field is immutable.
624+ string contract_comment = 3 [
625+ (google.api.field_behavior ) = OPTIONAL ,
626+ (google.api.field_behavior ) = IMMUTABLE
627+ ];
614628}
615629
616630// Grants permissions to the contract by the transaction sender.
617631//
618632// Note that, at the moment, there is no support for revoking permissions.
619633message GrantContractPermissions {
620- // Optional. ID of the contract to which permissions are being granted .
621- // Deprecated: use `contract_id` instead .
634+ // Optional. Deprecated: use `contract_id` instead .
635+ // ID of the contract to which permissions are being granted .
622636 Entity contract = 1
623637 [deprecated = true , (google.api.field_behavior ) = OPTIONAL ];
624638
@@ -632,8 +646,8 @@ message GrantContractPermissions {
632646
633647// Invokes the execution of a contract method.
634648message InvokeContractMethod {
635- // Optional. ID of the contract to run .
636- // Deprecated: use `contract_id` instead .
649+ // Optional. Deprecated: use `contract_id` instead .
650+ // ID of the contract to run .
637651 Entity contract = 1
638652 [deprecated = true , (google.api.field_behavior ) = OPTIONAL ];
639653
@@ -655,10 +669,10 @@ message InvokeContractMethod {
655669
656670// Creates a new contract token manager associated with the currency of the
657671// operator sending the request. The sender must be a currency operator.
658- // The newly created contract token manager will be active by default. If the
672+ // The newly created contract token manager is active by default. If the
659673// contract token manager has to be replaced, the TransferContractTokenManager
660674// transaction should be sent instead. If another contract token manager
661- // associated to the same currency exists, this transaction will fail.
675+ // associated with the same currency exists, this transaction will fail.
662676//
663677// Unlike regular token managers, contract token managers are not allowed to
664678// execute transactions such as mint or burn. They can, however, participate in
@@ -679,8 +693,9 @@ message CreateContractTokenManager {
679693 bytes public_key = 1 [(google.api.field_behavior ) = REQUIRED ];
680694
681695 // Optional. Immutable. An opaque comment field that is not interpreted by the
682- // system but stored on the ledger in the account. Maximum length is 128
683- // characters. May be left empty. Once created, the field is immutable.
696+ // system but stored on the ledger in the account. Considered public
697+ // information. Maximum length is 128 characters. May be left empty. Once
698+ // created, the field is immutable.
684699 string account_comment = 2 [
685700 (google.api.field_behavior ) = OPTIONAL ,
686701 (google.api.field_behavior ) = IMMUTABLE
@@ -714,8 +729,9 @@ message TransferContractTokenManager {
714729 bytes public_key = 1 [(google.api.field_behavior ) = REQUIRED ];
715730
716731 // Optional. Immutable. An opaque comment field that is not interpreted by the
717- // system but stored on the ledger in the account. Maximum length is 128
718- // characters. May be left empty. Once created, the field is immutable.
732+ // system but stored on the ledger in the account. Considered public
733+ // information. Maximum length is 128 characters. May be left empty. Once
734+ // created, the field is immutable.
719735 string account_comment = 2 [
720736 (google.api.field_behavior ) = OPTIONAL ,
721737 (google.api.field_behavior ) = IMMUTABLE
0 commit comments