github.com/Finschia/finschia-sdk@v0.49.1/proto/lbm/token/v1/tx.proto (about)

     1  syntax = "proto3";
     2  package lbm.token.v1;
     3  
     4  import "gogoproto/gogo.proto";
     5  import "lbm/token/v1/token.proto";
     6  
     7  option go_package = "github.com/Finschia/finschia-sdk/x/token";
     8  
     9  option (gogoproto.equal_all)           = false;
    10  option (gogoproto.goproto_getters_all) = false;
    11  
    12  // Msg defines the token Msg service.
    13  service Msg {
    14    option deprecated = true;
    15  
    16    // Send defines a method to send tokens from one account to another account.
    17    // Fires:
    18    // - EventSent
    19    // - transfer (deprecated, not typed)
    20    rpc Send(MsgSend) returns (MsgSendResponse);
    21  
    22    // OperatorSend defines a method to send tokens from one account to another account by the operator.
    23    // Fires:
    24    // - EventSent
    25    // - transfer_from (deprecated, not typed)
    26    // Note: the approval has no value of limit (not ERC20 compliant).
    27    rpc OperatorSend(MsgOperatorSend) returns (MsgOperatorSendResponse);
    28  
    29    // RevokeOperator revoke the authorization of the operator to send the holder's tokens.
    30    // Fires:
    31    // - EventRevokedOperator
    32    // Note: it introduces breaking change, because the legacy clients cannot track this revocation.
    33    // Since: 0.46.0 (finschia)
    34    rpc RevokeOperator(MsgRevokeOperator) returns (MsgRevokeOperatorResponse);
    35  
    36    // AuthorizeOperator allows one to send tokens on behalf of the holder.
    37    // Fires:
    38    // - EventAuthorizedOperator
    39    // - approve_token (deprecated, not typed)
    40    rpc AuthorizeOperator(MsgAuthorizeOperator) returns (MsgAuthorizeOperatorResponse);
    41  
    42    // Issue defines a method to create a class of token.
    43    // it grants `mint`, `burn` and `modify` permissions on the token class to its creator (see also `mintable`).
    44    // Fires:
    45    // - EventIssue
    46    // - EventMinted
    47    // - issue (deprecated, not typed)
    48    rpc Issue(MsgIssue) returns (MsgIssueResponse);
    49  
    50    // GrantPermission allows one to mint or burn tokens or modify a token metadata.
    51    // Fires:
    52    // - EventGrant
    53    // - grant_perm (deprecated, not typed)
    54    rpc GrantPermission(MsgGrantPermission) returns (MsgGrantPermissionResponse);
    55  
    56    // RevokePermission abandons a permission.
    57    // Fires:
    58    // - EventAbandon
    59    // - revoke_perm (deprecated, not typed)
    60    rpc RevokePermission(MsgRevokePermission) returns (MsgRevokePermissionResponse);
    61  
    62    // Mint defines a method to mint tokens.
    63    // Fires:
    64    // - EventMinted
    65    // - mint (deprecated, not typed)
    66    rpc Mint(MsgMint) returns (MsgMintResponse);
    67  
    68    // Burn defines a method to burn tokens.
    69    // Fires:
    70    // - EventBurned
    71    // - burn (deprecated, not typed)
    72    rpc Burn(MsgBurn) returns (MsgBurnResponse);
    73  
    74    // OperatorBurn defines a method to burn tokens by the operator.
    75    // Fires:
    76    // - EventBurned
    77    // - burn_from (deprecated, not typed)
    78    rpc OperatorBurn(MsgOperatorBurn) returns (MsgOperatorBurnResponse);
    79  
    80    // Modify defines a method to modify a token class.
    81    // Fires:
    82    // - EventModified
    83    // - modify_token (deprecated, not typed)
    84    rpc Modify(MsgModify) returns (MsgModifyResponse);
    85  }
    86  
    87  // MsgSend defines the Msg/Send request type.
    88  //
    89  // Signer: `from`
    90  message MsgSend {
    91    option deprecated = true;
    92  
    93    // contract id associated with the token class.
    94    string contract_id = 1;
    95    // holder whose tokens are being sent.
    96    string from = 2;
    97    // recipient of the tokens.
    98    string to = 3;
    99    // number of tokens to send.
   100    string amount = 4
   101        [(gogoproto.customtype) = "github.com/Finschia/finschia-sdk/types.Int", (gogoproto.nullable) = false];
   102  }
   103  
   104  // MsgSendResponse defines the Msg/Send response type.
   105  message MsgSendResponse {
   106    option deprecated = true;
   107  }
   108  
   109  // MsgOperatorSend defines the Msg/OperatorSend request type.
   110  //
   111  // Signer: `operator`
   112  message MsgOperatorSend {
   113    option deprecated = true;
   114  
   115    // contract id associated with the token class.
   116    string contract_id = 1;
   117    // the address of the operator.
   118    string operator = 2;
   119    // the address which the transfer is from.
   120    string from = 3;
   121    // the address which the transfer is to.
   122    string to = 4;
   123    // the amount of the transfer.
   124    string amount = 5
   125        [(gogoproto.customtype) = "github.com/Finschia/finschia-sdk/types.Int", (gogoproto.nullable) = false];
   126  }
   127  
   128  // MsgOperatorSendResponse defines the Msg/OperatorSend response type.
   129  message MsgOperatorSendResponse {
   130    option deprecated = true;
   131  }
   132  
   133  // MsgRevokeOperator defines the Msg/RevokeOperator request type.
   134  //
   135  // Signer: `holder`
   136  //
   137  // Since: 0.46.0 (finschia)
   138  message MsgRevokeOperator {
   139    option deprecated = true;
   140  
   141    // contract id associated with the token class.
   142    string contract_id = 1;
   143    // address of a holder which revokes the `operator` address as an operator.
   144    string holder = 2;
   145    // address to rescind as an operator for `holder`.
   146    string operator = 3;
   147  }
   148  
   149  // MsgRevokeOperatorResponse defines the Msg/RevokeOperator response type.
   150  //
   151  // Since: 0.46.0 (finschia)
   152  message MsgRevokeOperatorResponse {
   153    option deprecated = true;
   154  }
   155  
   156  // MsgAuthorizeOperator defines the Msg/AuthorizeOperator request type.
   157  //
   158  // Signer: `holder`
   159  message MsgAuthorizeOperator {
   160    option deprecated = true;
   161  
   162    // contract id associated with the token class.
   163    string contract_id = 1;
   164    // address of the token holder which approves the authorization.
   165    string holder = 2;
   166    // address of the operator which the authorization is granted to.
   167    string operator = 3;
   168  }
   169  
   170  // MsgAuthorizeOperatorResponse defines the Msg/AuthorizeOperator response type.
   171  message MsgAuthorizeOperatorResponse {
   172    option deprecated = true;
   173  }
   174  
   175  // MsgIssue defines the Msg/Issue request type.
   176  //
   177  // Signer: `owner`
   178  message MsgIssue {
   179    option deprecated = true;
   180  
   181    // name defines the human-readable name of the token class. mandatory (not ERC20 compliant).
   182    string name = 1;
   183    // symbol is an abbreviated name for token class. mandatory (not ERC20 compliant).
   184    string symbol = 2;
   185    // uri for the image of the token class stored off chain.
   186    string uri = 3;
   187    // meta is a brief description of token class.
   188    string meta = 4;
   189    // decimals is the number of decimals which one must divide the amount by to get its user representation.
   190    int32 decimals = 5;
   191    // mintable represents whether the token is allowed to mint.
   192    bool mintable = 6;
   193  
   194    // the address which all permissions on the token class will be granted to (not a permanent property).
   195    string owner = 7;
   196  
   197    // the address to send the minted token to. mandatory.
   198    string to = 8;
   199    // amount of tokens to mint on issuance. mandatory.
   200    string amount = 9
   201        [(gogoproto.customtype) = "github.com/Finschia/finschia-sdk/types.Int", (gogoproto.nullable) = false];
   202  }
   203  
   204  // MsgIssueResponse defines the Msg/Issue response type.
   205  message MsgIssueResponse {
   206    option deprecated = true;
   207  
   208    // id of the new contract.
   209    string contract_id = 1;
   210  }
   211  
   212  // MsgGrantPermission defines the Msg/GrantPermission request type.
   213  //
   214  // Signer: `granter`
   215  message MsgGrantPermission {
   216    option deprecated = true;
   217  
   218    // contract id associated with the token class.
   219    string contract_id = 1;
   220    // address of the granter which must have the permission to give.
   221    string from = 2;
   222    // address of the grantee.
   223    string to = 3;
   224    // permission on the token class.
   225    string permission = 4;
   226  }
   227  
   228  // MsgGrantPermissionResponse defines the Msg/GrantPermission response type.
   229  message MsgGrantPermissionResponse {
   230    option deprecated = true;
   231  }
   232  
   233  // MsgRevokePermission defines the Msg/RevokePermission request type.
   234  //
   235  // Signer: `grantee`
   236  message MsgRevokePermission {
   237    option deprecated = true;
   238  
   239    // contract id associated with the token class.
   240    string contract_id = 1;
   241    // address of the grantee which abandons the permission.
   242    string from = 2;
   243    // permission on the token class.
   244    string permission = 3;
   245  }
   246  
   247  // MsgRevokePermissionResponse defines the Msg/RevokePermission response type.
   248  message MsgRevokePermissionResponse {
   249    option deprecated = true;
   250  }
   251  
   252  // MsgMint defines the Msg/Mint request type.
   253  //
   254  // Signer: `from`
   255  message MsgMint {
   256    option deprecated = true;
   257  
   258    // contract id associated with the token class.
   259    string contract_id = 1;
   260    // address which triggers the mint.
   261    string from = 2;
   262    // recipient of the tokens.
   263    string to = 3;
   264    // number of tokens to mint.
   265    string amount = 4
   266        [(gogoproto.customtype) = "github.com/Finschia/finschia-sdk/types.Int", (gogoproto.nullable) = false];
   267  }
   268  
   269  // MsgMintResponse defines the Msg/Mint response type.
   270  message MsgMintResponse {
   271    option deprecated = true;
   272  }
   273  
   274  // MsgBurn defines the Msg/Burn request type.
   275  //
   276  // Signer: `from`
   277  message MsgBurn {
   278    option deprecated = true;
   279  
   280    // contract id associated with the token class.
   281    string contract_id = 1;
   282    // address whose tokens are being burned.
   283    string from = 2;
   284    // number of tokens to burn.
   285    string amount = 3
   286        [(gogoproto.customtype) = "github.com/Finschia/finschia-sdk/types.Int", (gogoproto.nullable) = false];
   287  }
   288  
   289  // MsgBurnResponse defines the Msg/Burn response type.
   290  message MsgBurnResponse {
   291    option deprecated = true;
   292  }
   293  
   294  // MsgOperatorBurn defines the Msg/OperatorBurn request type.
   295  //
   296  // Signer: `operator`
   297  message MsgOperatorBurn {
   298    option deprecated = true;
   299  
   300    // contract id associated with the token class.
   301    string contract_id = 1;
   302    // address which triggers the burn.
   303    string operator = 2;
   304    // address which the tokens will be burnt from.
   305    string from = 3;
   306    // the amount of the burn.
   307    string amount = 4
   308        [(gogoproto.customtype) = "github.com/Finschia/finschia-sdk/types.Int", (gogoproto.nullable) = false];
   309  }
   310  
   311  // MsgOperatorBurnResponse defines the Msg/OperatorBurn response type.
   312  message MsgOperatorBurnResponse {
   313    option deprecated = true;
   314  }
   315  
   316  // MsgModify defines the Msg/Modify request type.
   317  //
   318  // Signer: `owner`
   319  message MsgModify {
   320    option deprecated = true;
   321  
   322    // contract id associated with the contract.
   323    string contract_id = 1;
   324    // the address of the grantee which must have modify permission.
   325    string owner = 2;
   326    // changes to apply.
   327    // possible attribute keys are: name, uri, img_uri (deprecated), meta
   328    repeated Attribute changes = 3 [(gogoproto.nullable) = false];
   329  }
   330  
   331  // MsgModifyResponse defines the Msg/Modify response type.
   332  message MsgModifyResponse {
   333    option deprecated = true;
   334  }