github.com/Finschia/finschia-sdk@v0.49.1/proto/cosmos/bank/v1beta1/bank.proto (about)

     1  syntax = "proto3";
     2  package cosmos.bank.v1beta1;
     3  
     4  import "gogoproto/gogo.proto";
     5  import "cosmos_proto/cosmos.proto";
     6  import "cosmos/base/v1beta1/coin.proto";
     7  
     8  option go_package = "github.com/Finschia/finschia-sdk/x/bank/types";
     9  
    10  // Params defines the parameters for the bank module.
    11  message Params {
    12    option (gogoproto.goproto_stringer)       = false;
    13    repeated SendEnabled send_enabled         = 1 [(gogoproto.moretags) = "yaml:\"send_enabled,omitempty\""];
    14    bool                 default_send_enabled = 2 [(gogoproto.moretags) = "yaml:\"default_send_enabled,omitempty\""];
    15  }
    16  
    17  // SendEnabled maps coin denom to a send_enabled status (whether a denom is
    18  // sendable).
    19  message SendEnabled {
    20    option (gogoproto.equal)            = true;
    21    option (gogoproto.goproto_stringer) = false;
    22    string denom                        = 1;
    23    bool   enabled                      = 2;
    24  }
    25  
    26  // Input models transaction input.
    27  message Input {
    28    option (gogoproto.equal)           = false;
    29    option (gogoproto.goproto_getters) = false;
    30  
    31    string   address                        = 1;
    32    repeated cosmos.base.v1beta1.Coin coins = 2
    33        [(gogoproto.nullable) = false, (gogoproto.castrepeated) = "github.com/Finschia/finschia-sdk/types.Coins"];
    34  }
    35  
    36  // Output models transaction outputs.
    37  message Output {
    38    option (gogoproto.equal)           = false;
    39    option (gogoproto.goproto_getters) = false;
    40  
    41    string   address                        = 1;
    42    repeated cosmos.base.v1beta1.Coin coins = 2
    43        [(gogoproto.nullable) = false, (gogoproto.castrepeated) = "github.com/Finschia/finschia-sdk/types.Coins"];
    44  }
    45  
    46  // Supply represents a struct that passively keeps track of the total supply
    47  // amounts in the network.
    48  // This message is deprecated now that supply is indexed by denom.
    49  message Supply {
    50    option deprecated = true;
    51  
    52    option (gogoproto.equal)           = true;
    53    option (gogoproto.goproto_getters) = false;
    54  
    55    option (cosmos_proto.implements_interface) = "*github.com/Finschia/finschia-sdk/x/bank/legacy/v040.SupplyI";
    56  
    57    repeated cosmos.base.v1beta1.Coin total = 1
    58        [(gogoproto.nullable) = false, (gogoproto.castrepeated) = "github.com/Finschia/finschia-sdk/types.Coins"];
    59  }
    60  
    61  // DenomUnit represents a struct that describes a given
    62  // denomination unit of the basic token.
    63  message DenomUnit {
    64    // denom represents the string name of the given denom unit (e.g uatom).
    65    string denom = 1;
    66    // exponent represents power of 10 exponent that one must
    67    // raise the base_denom to in order to equal the given DenomUnit's denom
    68    // 1 denom = 1^exponent base_denom
    69    // (e.g. with a base_denom of uatom, one can create a DenomUnit of 'atom' with
    70    // exponent = 6, thus: 1 atom = 10^6 uatom).
    71    uint32 exponent = 2;
    72    // aliases is a list of string aliases for the given denom
    73    repeated string aliases = 3;
    74  }
    75  
    76  // Metadata represents a struct that describes
    77  // a basic token.
    78  message Metadata {
    79    string description = 1;
    80    // denom_units represents the list of DenomUnit's for a given coin
    81    repeated DenomUnit denom_units = 2;
    82    // base represents the base denom (should be the DenomUnit with exponent = 0).
    83    string base = 3;
    84    // display indicates the suggested denom that should be
    85    // displayed in clients.
    86    string display = 4;
    87    // name defines the name of the token (eg: Cosmos Atom)
    88    //
    89    // Since: cosmos-sdk 0.43
    90    string name = 5;
    91    // symbol is the token symbol usually shown on exchanges (eg: ATOM). This can
    92    // be the same as the display.
    93    //
    94    // Since: cosmos-sdk 0.43
    95    string symbol = 6;
    96  }