Merge pull request #43 from hyle-team/feature/token-info

extended token info fields and methods

docs/static/openapi.yml

@@ -740,6 +740,227 @@ paths:
                         }
       tags:
         - Query
+  '/cosmos/bridge/token-info/{chain}/{address}':
+    get:
+      summary: TokenInfo queries an according token info by chain and address.
+      operationId: CoreBridgeGetTokenInfo
+      responses:
+        '200':
+          description: A successful response.
+          schema:
+            type: object
+            properties:
+              info:
+                type: object
+                properties:
+                  address:
+                    type: string
+                  decimals:
+                    type: string
+                    format: uint64
+                  chain_id:
+                    type: string
+                  token_id:
+                    type: string
+                    format: uint64
+                  is_wrapped:
+                    type: boolean
+        default:
+          description: An unexpected error response.
+          schema:
+            type: object
+            properties:
+              code:
+                type: integer
+                format: int32
+              message:
+                type: string
+              details:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    '@type':
+                      type: string
+                      description: >-
+                        A URL/resource name that uniquely identifies the type of
+                        the serialized
+
+                        protocol buffer message. This string must contain at
+                        least
+
+                        one "/" character. The last segment of the URL's path
+                        must represent
+
+                        the fully qualified name of the type (as in
+
+                        `path/google.protobuf.Duration`). The name should be in
+                        a canonical form
+
+                        (e.g., leading "." is not accepted).
+
+
+                        In practice, teams usually precompile into the binary
+                        all types that they
+
+                        expect it to use in the context of Any. However, for
+                        URLs which use the
+
+                        scheme `http`, `https`, or no scheme, one can optionally
+                        set up a type
+
+                        server that maps type URLs to message definitions as
+                        follows:
+
+
+                        * If no scheme is provided, `https` is assumed.
+
+                        * An HTTP GET on the URL must yield a
+                        [google.protobuf.Type][]
+                          value in binary format, or produce an error.
+                        * Applications are allowed to cache lookup results based
+                        on the
+                          URL, or have them precompiled into a binary to avoid any
+                          lookup. Therefore, binary compatibility needs to be preserved
+                          on changes to types. (Use versioned type names to manage
+                          breaking changes.)
+
+                        Note: this functionality is not currently available in
+                        the official
+
+                        protobuf release, and it is not used for type URLs
+                        beginning with
+
+                        type.googleapis.com.
+
+
+                        Schemes other than `http`, `https` (or the empty scheme)
+                        might be
+
+                        used with implementation specific semantics.
+                  additionalProperties: {}
+                  description: >-
+                    `Any` contains an arbitrary serialized protocol buffer
+                    message along with a
+
+                    URL that describes the type of the serialized message.
+
+
+                    Protobuf library provides support to pack/unpack Any values
+                    in the form
+
+                    of utility functions or additional generated methods of the
+                    Any type.
+
+
+                    Example 1: Pack and unpack a message in C++.
+
+                        Foo foo = ...;
+                        Any any;
+                        any.PackFrom(foo);
+                        ...
+                        if (any.UnpackTo(&foo)) {
+                          ...
+                        }
+
+                    Example 2: Pack and unpack a message in Java.
+
+                        Foo foo = ...;
+                        Any any = Any.pack(foo);
+                        ...
+                        if (any.is(Foo.class)) {
+                          foo = any.unpack(Foo.class);
+                        }
+
+                     Example 3: Pack and unpack a message in Python.
+
+                        foo = Foo(...)
+                        any = Any()
+                        any.Pack(foo)
+                        ...
+                        if any.Is(Foo.DESCRIPTOR):
+                          any.Unpack(foo)
+                          ...
+
+                     Example 4: Pack and unpack a message in Go
+
+                         foo := &pb.Foo{...}
+                         any, err := anypb.New(foo)
+                         if err != nil {
+                           ...
+                         }
+                         ...
+                         foo := &pb.Foo{}
+                         if err := any.UnmarshalTo(foo); err != nil {
+                           ...
+                         }
+
+                    The pack methods provided by protobuf library will by
+                    default use
+
+                    'type.googleapis.com/full.type.name' as the type URL and the
+                    unpack
+
+                    methods only use the fully qualified type name after the
+                    last '/'
+
+                    in the type URL, for example "foo.bar.com/x/y.z" will yield
+                    type
+
+                    name "y.z".
+
+
+
+                    JSON
+
+                    ====
+
+                    The JSON representation of an `Any` value uses the regular
+
+                    representation of the deserialized, embedded message, with
+                    an
+
+                    additional field `@type` which contains the type URL.
+                    Example:
+
+                        package google.profile;
+                        message Person {
+                          string first_name = 1;
+                          string last_name = 2;
+                        }
+
+                        {
+                          "@type": "type.googleapis.com/google.profile.Person",
+                          "firstName": <string>,
+                          "lastName": <string>
+                        }
+
+                    If the embedded message type is well-known and has a custom
+                    JSON
+
+                    representation, that representation will be embedded adding
+                    a field
+
+                    `value` which holds the custom JSON in addition to the
+                    `@type`
+
+                    field. Example (for message [google.protobuf.Duration][]):
+
+                        {
+                          "@type": "type.googleapis.com/google.protobuf.Duration",
+                          "value": "1.212s"
+                        }
+      parameters:
+        - name: chain
+          in: path
+          required: true
+          type: string
+        - name: address
+          in: path
+          required: true
+          type: string
+      tags:
+        - Query
   '/cosmos/bridge/token-pair/{src_chain}/{src_address}/{dst_chain}':
     get:
       summary: >-
@@ -765,6 +986,8 @@ paths:
                   token_id:
                     type: string
                     format: uint64
+                  is_wrapped:
+                    type: boolean
         default:
           description: An unexpected error response.
           schema:
@@ -1007,6 +1230,8 @@ paths:
                           token_id:
                             type: string
                             format: uint64
+                          is_wrapped:
+                            type: boolean
                       title: info is the token information on different chains
               pagination:
                 type: object
@@ -1320,6 +1545,8 @@ paths:
                         token_id:
                           type: string
                           format: uint64
+                        is_wrapped:
+                          type: boolean
                     title: info is the token information on different chains
         default:
           description: An unexpected error response.
@@ -46379,7 +46606,27 @@ definitions:
                 token_id:
                   type: string
                   format: uint64
+                is_wrapped:
+                  type: boolean
             title: info is the token information on different chains
+  core.bridge.QueryGetTokenInfoResponse:
+    type: object
+    properties:
+      info:
+        type: object
+        properties:
+          address:
+            type: string
+          decimals:
+            type: string
+            format: uint64
+          chain_id:
+            type: string
+          token_id:
+            type: string
+            format: uint64
+          is_wrapped:
+            type: boolean
   core.bridge.QueryGetTokenPairResponse:
     type: object
     properties:
@@ -46396,6 +46643,8 @@ definitions:
           token_id:
             type: string
             format: uint64
+          is_wrapped:
+            type: boolean
   core.bridge.QueryGetTokensResponse:
     type: object
     properties:
@@ -46431,6 +46680,8 @@ definitions:
                   token_id:
                     type: string
                     format: uint64
+                  is_wrapped:
+                    type: boolean
               title: info is the token information on different chains
       pagination:
         type: object
@@ -46593,6 +46844,8 @@ definitions:
             token_id:
               type: string
               format: uint64
+            is_wrapped:
+              type: boolean
         title: info is the token information on different chains
   core.bridge.TokenInfo:
     type: object
@@ -46607,6 +46860,8 @@ definitions:
       token_id:
         type: string
         format: uint64
+      is_wrapped:
+        type: boolean
   core.bridge.TokenMetadata:
     type: object
     properties:

proto/bridge/models/token.proto

@@ -13,6 +13,7 @@ message TokenInfo {
   uint64 decimals = 2;
   string chain_id = 3;;
   uint64 token_id = 4;
+  bool is_wrapped = 5;
 }
 
 

proto/bridge/models/transaction.proto

@@ -20,6 +20,4 @@ message Transaction {
   string withdrawal_chain_id = 9;
   string withdrawal_tx_hash = 10;
   string withdrawal_token = 11;
-
-  // TODO: add status field, withdrawal_block...
 }

proto/bridge/query.proto

@@ -44,6 +44,10 @@ service Query {
     option (google.api.http).get = "/cosmos/bridge/token-pair/{src_chain}/{src_address}/{dst_chain}";
   }
 
+  // TokenInfo queries an according token info by chain and address.
+  rpc GetTokenInfo(QueryGetTokenInfo) returns (QueryGetTokenInfoResponse) {
+    option (google.api.http).get = "/cosmos/bridge/token-info/{chain}/{address}";
+  }
 
   rpc GetChainById(QueryGetChainById) returns (QueryGetChainByIdResponse) {
     option (google.api.http).get = "/cosmos/bridge/chains/{id}";
@@ -120,6 +124,15 @@ message QueryGetTokenPair {
   string dst_chain = 3;
 }
 
+message QueryGetTokenInfo {
+  string chain = 1;
+  string address = 2;
+}
+
+message QueryGetTokenInfoResponse {
+  TokenInfo info = 1 [(gogoproto.nullable) = false];;
+}
+
 message QueryGetTokenPairResponse {
   TokenInfo info = 1 [(gogoproto.nullable) = false];;
 }

x/bridge/client/cli/query.go

@@ -33,6 +33,7 @@ func GetQueryCmd(queryRoute string) *cobra.Command {
 		CmdQueryTokens(),
 		CmdQueryTokenById(),
 		CmdQueryTokenPair(),
+		CmdQueryTokenInfo(),
 	)
 
 	// this line is used by starport scaffolding # 1