Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
225 changes: 225 additions & 0 deletions docs/static/openapi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51956,6 +51956,222 @@ paths:
type: string
tags:
- Query
/side/btcbridge/withdrawal/fee:
get:
summary: QueryWithdrawNetworkFee queries the bitcoin network fee for withdrawal.
operationId: SideBtcbridgeQueryWithdrawNetworkFee
responses:
'200':
description: A successful response.
schema:
type: object
properties:
fee:
type: string
format: int64
description: >-
QueryWithdrawNetworkFeeResponse is response type for the
Query/WithdrawNetworkFee RPC method.
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: sender
in: query
required: false
type: string
- name: amount
in: query
required: false
type: string
- name: fee_rate
in: query
required: false
type: string
tags:
- Query
/side/btcbridge/withdrawal/request:
get:
summary: >-
Expand Down Expand Up @@ -83279,6 +83495,15 @@ definitions:
title: rune balances associated with the UTXO
title: Bitcoin UTXO
description: QueryUTXOsResponse is the response type for the Query/UTXOs RPC method.
side.btcbridge.QueryWithdrawNetworkFeeResponse:
type: object
properties:
fee:
type: string
format: int64
description: >-
QueryWithdrawNetworkFeeResponse is response type for the
Query/WithdrawNetworkFee RPC method.
side.btcbridge.QueryWithdrawRequestByTxHashResponse:
type: object
properties:
Expand Down
16 changes: 16 additions & 0 deletions proto/side/btcbridge/query.proto
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ service Query {
rpc QueryWithdrawRequestByTxHash(QueryWithdrawRequestByTxHashRequest) returns (QueryWithdrawRequestByTxHashResponse) {
option (google.api.http).get = "/side/btcbridge/withdrawal/request/tx/{txid}";
}
// QueryWithdrawNetworkFee queries the bitcoin network fee for withdrawal.
rpc QueryWithdrawNetworkFee(QueryWithdrawNetworkFeeRequest) returns (QueryWithdrawNetworkFeeResponse) {
option (google.api.http).get = "/side/btcbridge/withdrawal/fee";
}
// QueryUTXOs queries all utxos.
rpc QueryUTXOs(QueryUTXOsRequest) returns (QueryUTXOsResponse) {
option (google.api.http).get = "/side/btcbridge/utxos";
Expand Down Expand Up @@ -99,6 +103,18 @@ message QueryWithdrawRequestByTxHashResponse {
BitcoinWithdrawRequest request = 1;
}

// QueryWithdrawNetworkFeeRequest is request type for the Query/WithdrawNetworkFee RPC method.
message QueryWithdrawNetworkFeeRequest {
string sender = 1;
string amount = 2;
string fee_rate = 3;
}

// QueryWithdrawNetworkFeeResponse is response type for the Query/WithdrawNetworkFee RPC method.
message QueryWithdrawNetworkFeeResponse {
int64 fee = 1;
}

// QueryParamsRequest is request type for the Query/Params RPC method.
message QueryParamsRequest {}

Expand Down
30 changes: 30 additions & 0 deletions x/btcbridge/keeper/queries.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package keeper

import (
"context"
"strconv"

"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
Expand Down Expand Up @@ -108,6 +109,35 @@ func (k Keeper) QueryWithdrawRequestByTxHash(goCtx context.Context, req *types.Q
return &types.QueryWithdrawRequestByTxHashResponse{Request: request}, nil
}

func (k Keeper) QueryWithdrawNetworkFee(goCtx context.Context, req *types.QueryWithdrawNetworkFeeRequest) (*types.QueryWithdrawNetworkFeeResponse, error) {
if req == nil {
return nil, status.Error(codes.InvalidArgument, "invalid request")
}
ctx := sdk.UnwrapSDKContext(goCtx)

amount, err := sdk.ParseCoinNormalized(req.Amount)
if err != nil {
return nil, err
}

feeRate, err := strconv.ParseInt(req.FeeRate, 10, 64)
if err != nil {
return nil, types.ErrInvalidFeeRate
}

withdrawReq, err := k.NewWithdrawRequest(ctx, req.Sender, amount, feeRate)
if err != nil {
return nil, err
}

fee, err := k.getBtcNetworkFee(ctx, withdrawReq.Psbt)
if err != nil {
return nil, err
}

return &types.QueryWithdrawNetworkFeeResponse{Fee: fee.Amount.Int64()}, nil
}

func (k Keeper) QueryUTXOs(goCtx context.Context, req *types.QueryUTXOsRequest) (*types.QueryUTXOsResponse, error) {
if req == nil {
return nil, status.Error(codes.InvalidArgument, "invalid request")
Expand Down
Loading