Implement btc batch withdrawal

local_node.sh

@@ -21,6 +21,7 @@ MAX_GAS=10000000000
 BTC_VAULT=() # ("<address>" "<pk>" "<asset type>")
 RUNES_VAULT=()
 TRUSTED_NON_BTC_RELAYER=""
+TRUSTED_ORACLE=""
 PROTOCOL_FEE_COLLECTOR=""
 
 # Remember to change to other types of keyring like 'file' in-case exposing to outside world,
@@ -107,7 +108,12 @@ if [[ $overwrite == "y" || $overwrite == "Y" ]]; then
 
     # set trusted non btc relayer
 	if [ -n "$TRUSTED_NON_BTC_RELAYER" ]; then
-	    jq --arg relayer "$TRUSTED_NON_BTC_RELAYER" '.app_state["btcbridge"]["params"]["non_btc_relayers"][0]=$relayer' "$GENESIS" >"$TMP_GENESIS" && mv "$TMP_GENESIS" "$GENESIS"
+	    jq --arg relayer "$TRUSTED_NON_BTC_RELAYER" '.app_state["btcbridge"]["params"]["trusted_non_btc_relayers"][0]=$relayer' "$GENESIS" >"$TMP_GENESIS" && mv "$TMP_GENESIS" "$GENESIS"
+    fi
+
+	# set trusted oracle
+	if [ -n "$TRUSTED_ORACLE" ]; then
+	    jq --arg oracle "$TRUSTED_ORACLE" '.app_state["btcbridge"]["params"]["trusted_oracles"][0]=$oracle' "$GENESIS" >"$TMP_GENESIS" && mv "$TMP_GENESIS" "$GENESIS"
     fi
 
 	# set protocol fee collector

local_node_dev.sh

@@ -21,6 +21,7 @@ MAX_GAS=10000000000
 BTC_VAULT=() # ("<address>" "<pk>" "<asset type>")
 RUNES_VAULT=()
 TRUSTED_NON_BTC_RELAYER=""
+TRUSTED_ORACLE=""
 PROTOCOL_FEE_COLLECTOR=""
 
 # gov params
@@ -115,7 +116,12 @@ if [[ $overwrite == "y" || $overwrite == "Y" ]]; then
 
 	# set trusted non btc relayer
 	if [ -n "$TRUSTED_NON_BTC_RELAYER" ]; then
-	    jq --arg relayer "$TRUSTED_NON_BTC_RELAYER" '.app_state["btcbridge"]["params"]["non_btc_relayers"][0]=$relayer' "$GENESIS" >"$TMP_GENESIS" && mv "$TMP_GENESIS" "$GENESIS"
+	    jq --arg relayer "$TRUSTED_NON_BTC_RELAYER" '.app_state["btcbridge"]["params"]["trusted_non_btc_relayers"][0]=$relayer' "$GENESIS" >"$TMP_GENESIS" && mv "$TMP_GENESIS" "$GENESIS"
+    fi
+
+	# set trusted oracle
+	if [ -n "$TRUSTED_ORACLE" ]; then
+	    jq --arg oracle "$TRUSTED_ORACLE" '.app_state["btcbridge"]["params"]["trusted_oracles"][0]=$oracle' "$GENESIS" >"$TMP_GENESIS" && mv "$TMP_GENESIS" "$GENESIS"
     fi
 
 	# set protocol fee collector

proto/side/btcbridge/btcbridge.proto

@@ -46,6 +46,14 @@ message SigningRequest {
   SigningStatus status = 5;
 }
 
+// Withdrawal Request
+message WithdrawRequest {
+  string address = 1;
+  string amount = 2;
+  uint64 sequence = 3;
+  string txid = 4;
+}
+
 // Bitcoin UTXO
 message UTXO {
   string txid = 1;

proto/side/btcbridge/params.proto

@@ -20,15 +20,19 @@ message Params {
   // Indicates if withdrawal is enabled
   bool withdraw_enabled = 5;
   // Trusted relayers for non-btc asset deposit
-  repeated string non_btc_relayers = 6;
+  repeated string trusted_non_btc_relayers = 6;
+  // Trusted oracles for providing offchain data, e.g. bitcoin fee rate
+  repeated string trusted_oracles = 7;
   // Asset vaults
-  repeated Vault vaults = 7;
+  repeated Vault vaults = 8;
+  // Withdrawal params
+  WithdrawParams withdraw_params = 9 [(gogoproto.nullable) = false];
   // Protocol limitations
-  ProtocolLimits protocol_limits = 8 [(gogoproto.nullable) = false];
+  ProtocolLimits protocol_limits = 10 [(gogoproto.nullable) = false];
   // Protocol fees
-  ProtocolFees protocol_fees = 9 [(gogoproto.nullable) = false];
+  ProtocolFees protocol_fees = 11 [(gogoproto.nullable) = false];
   // TSS params
-  TSSParams tss_params = 10 [(gogoproto.nullable) = false];
+  TSSParams tss_params = 12 [(gogoproto.nullable) = false];
 }
 
 // AssetType defines the type of asset
@@ -55,6 +59,15 @@ message Vault {
   uint64 version = 4;
 }
 
+message WithdrawParams {
+  // Maximum number of utxos used to build the signing request; O means unlimited
+  uint32 max_utxo_num = 1;
+  // Period for handling btc withdrawal requests
+  int64 btc_batch_withdraw_period = 2;
+  // Maximum number of btc withdrawal requests to be handled per batch
+  uint32 max_btc_batch_withdraw_num = 3;
+}
+
 // ProtocolLimits defines the params related to the the protocol limitations
 message ProtocolLimits {
   // The minimum deposit amount for btc in sat

proto/side/btcbridge/query.proto

@@ -27,6 +27,10 @@ service Query {
   rpc QueryBlockHeaderByHash(QueryBlockHeaderByHashRequest) returns (QueryBlockHeaderByHashResponse) {
     option (google.api.http).get = "/side/btcbridge/hash/{hash}";
   }
+  // QueryFeeRate queries the current bitcoin network fee rate on the side chain.
+  rpc QueryFeeRate(QueryFeeRateRequest) returns (QueryFeeRateResponse) {
+    option (google.api.http).get = "/side/btcbridge/feerate";
+  }
   // QuerySigningRequests queries the signing requests by the given status.
   rpc QuerySigningRequests(QuerySigningRequestsRequest) returns (QuerySigningRequestsResponse) {
     option (google.api.http).get = "/side/btcbridge/signing/requests";
@@ -39,10 +43,6 @@ service Query {
   rpc QuerySigningRequestByTxHash(QuerySigningRequestByTxHashRequest) returns (QuerySigningRequestByTxHashResponse) {
     option (google.api.http).get = "/side/btcbridge/signing/requests/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";
@@ -107,16 +107,12 @@ message QuerySigningRequestByTxHashResponse {
   SigningRequest request = 1;
 }
 
-// QueryWithdrawNetworkFeeRequest is request type for the Query/WithdrawNetworkFee RPC method.
-message QueryWithdrawNetworkFeeRequest {
-  string sender = 1;
-  string amount = 2;
-  string fee_rate = 3;
-}
+// QueryFeeRateRequest is request type for the Query/FeeRate RPC method.
+message QueryFeeRateRequest {}
 
-// QueryWithdrawNetworkFeeResponse is response type for the Query/WithdrawNetworkFee RPC method.
-message QueryWithdrawNetworkFeeResponse {
-  int64 fee = 1;
+// QueryFeeRateResponse is response type for the Query/FeeRate RPC method.
+message QueryFeeRateResponse {
+  int64 fee_rate = 1;
 }
 
 // QueryParamsRequest is request type for the Query/Params RPC method.

proto/side/btcbridge/tx.proto

@@ -12,12 +12,16 @@ option go_package = "github.com/sideprotocol/side/x/btcbridge/types";
 service Msg {
   // SubmitBlockHeaders submits bitcoin block headers to the side chain.
   rpc SubmitBlockHeaders (MsgSubmitBlockHeaders) returns (MsgSubmitBlockHeadersResponse);
-  // UpdateNonBtcRelayers updates the trusted non-btc asset relayers.
-  rpc UpdateNonBtcRelayers (MsgUpdateNonBtcRelayers) returns (MsgUpdateNonBtcRelayersResponse);
-  // SubmitDepositTransaction submits bitcoin transaction to the side chain.
+  // SubmitDepositTransaction submits the bitcoin deposit transaction to the side chain.
   rpc SubmitDepositTransaction (MsgSubmitDepositTransaction) returns (MsgSubmitDepositTransactionResponse);
-  // SubmitWithdrawalTransaction submits bitcoin transaction to the side chain.
+  // SubmitWithdrawalTransaction submits the bitcoin withdrawal transaction to the side chain.
   rpc SubmitWithdrawTransaction (MsgSubmitWithdrawTransaction) returns (MsgSubmitWithdrawTransactionResponse);
+  // SubmitFeeRate submits the bitcoin network fee rate to the side chain.
+  rpc SubmitFeeRate (MsgSubmitFeeRate) returns (MsgSubmitFeeRateResponse);
+  // UpdateTrustedNonBtcRelayers updates the trusted non-btc asset relayers.
+  rpc UpdateTrustedNonBtcRelayers (MsgUpdateTrustedNonBtcRelayers) returns (MsgUpdateTrustedNonBtcRelayersResponse);
+  // UpdateTrustedOracles updates the trusted oracles.
+  rpc UpdateTrustedOracles (MsgUpdateTrustedOracles) returns (MsgUpdateTrustedOraclesResponse);
   // WithdrawToBitcoin withdraws the asset to bitcoin.
   rpc WithdrawToBitcoin (MsgWithdrawToBitcoin) returns (MsgWithdrawToBitcoinResponse);
   // SubmitSignatures submits the signatures of the signing request to the side chain.
@@ -47,16 +51,6 @@ message MsgSubmitBlockHeaders {
 message MsgSubmitBlockHeadersResponse {
 }
 
-// MsgUpdateNonBtcRelayers defines the Msg/UpdateNonBtcRelayers request type.
-message MsgUpdateNonBtcRelayers {
-  string sender = 1;
-  repeated string relayers = 2;
-}
-
-// MsgUpdateNonBtcRelayersResponse defines the Msg/UpdateNonBtcRelayers response type.
-message MsgUpdateNonBtcRelayersResponse {
-}
-
 // MsgSubmitDepositTransaction defines the Msg/SubmitDepositTransaction request type.
 message MsgSubmitDepositTransaction {
   // this is the relayer address who submits the bitcoin transaction to the side chain
@@ -88,13 +82,41 @@ message MsgSubmitWithdrawTransaction {
 message MsgSubmitWithdrawTransactionResponse {
 }
 
+// MsgSubmitFeeRate defines the Msg/SubmitFeeRate request type.
+message MsgSubmitFeeRate {
+  string sender = 1;
+  int64 fee_rate = 2;
+}
+
+// MsgSubmitFeeRateResponse defines the Msg/SubmitFeeRate response type.
+message MsgSubmitFeeRateResponse {
+}
+
+// MsgUpdateTrustedNonBtcRelayers defines the Msg/UpdateTrustedNonBtcRelayers request type.
+message MsgUpdateTrustedNonBtcRelayers {
+  string sender = 1;
+  repeated string relayers = 2;
+}
+
+// MsgUpdateTrustedNonBtcRelayersResponse defines the Msg/UpdateTrustedNonBtcRelayers response type.
+message MsgUpdateTrustedNonBtcRelayersResponse {
+}
+
+// MsgUpdateTrustedOracles defines the Msg/UpdateTrustedOracles request type.
+message MsgUpdateTrustedOracles {
+  string sender = 1;
+  repeated string oracles = 2;
+}
+
+// MsgUpdateTrustedOraclesResponse defines the Msg/UpdateTrustedOracles response type.
+message MsgUpdateTrustedOraclesResponse {
+}
+
 // MsgWithdrawToBitcoin defines the Msg/WithdrawToBitcoin request type.
 message MsgWithdrawToBitcoin {
   string sender = 1;
   // withdraw amount in satoshi, etc: 100000000sat = 1btc
   string amount = 2;
-  // fee rate in sats/vB
-  string fee_rate = 3;
 }
 
 // MsgWithdrawToBitcoinResponse defines the Msg/WithdrawToBitcoin response type.

x/btcbridge/abci.go

@@ -7,12 +7,59 @@ import (
 	"github.com/sideprotocol/side/x/btcbridge/types"
 )
 
-// EndBlocker called at every block to handle DKG requests
+// EndBlocker called at every block
 func EndBlocker(ctx sdk.Context, k keeper.Keeper) {
+	handleBtcWithdrawRequests(ctx, k)
 	handleDKGRequests(ctx, k)
 	handleVaultTransfer(ctx, k)
 }
 
+// handleBtcWithdrawRequests performs the batch btc withdrawal request handling
+func handleBtcWithdrawRequests(ctx sdk.Context, k keeper.Keeper) {
+	p := k.GetParams(ctx)
+
+	// check block height
+	if ctx.BlockHeight()%p.WithdrawParams.BtcBatchWithdrawPeriod != 0 {
+		return
+	}
+
+	// get the pending btc withdrawal request
+	pendingWithdrawRequests := k.GetPendingBtcWithdrawRequests(ctx, p.WithdrawParams.MaxBtcBatchWithdrawNum)
+	if len(pendingWithdrawRequests) == 0 {
+		return
+	}
+
+	feeRate := k.GetFeeRate(ctx)
+	if feeRate == 0 {
+		k.Logger(ctx).Error("invalid fee rate", feeRate)
+		return
+	}
+
+	vault := types.SelectVaultByAssetType(p.Vaults, types.AssetType_ASSET_TYPE_BTC)
+	if vault == nil {
+		k.Logger(ctx).Error("btc vault does not exist")
+		return
+	}
+
+	signingRequest, err := k.BuildBtcBatchWithdrawSigningRequest(ctx, pendingWithdrawRequests, feeRate, vault.Address)
+	if err != nil {
+		k.Logger(ctx).Error("failed to build signing request", "err", err)
+		return
+	}
+
+	for _, req := range pendingWithdrawRequests {
+		// update withdrawal request
+		req.Txid = signingRequest.Txid
+		k.SetWithdrawRequest(ctx, req)
+
+		// remove from the pending queue
+		k.RemoveFromBtcWithdrawRequestQueue(ctx, req)
+
+		// emit event
+		k.EmitEvent(ctx, req.Address, sdk.NewAttribute("txid", req.Txid))
+	}
+}
+
 // handleDKGRequests performs the DKG request handling
 func handleDKGRequests(ctx sdk.Context, k keeper.Keeper) {
 	pendingDKGRequests := k.GetPendingDKGRequests(ctx)
@@ -72,13 +119,15 @@ func handleVaultTransfer(ctx sdk.Context, k keeper.Keeper) {
 			if !k.VaultTransferCompleted(ctx, sourceRunesVault) {
 				if err := k.TransferVault(ctx, sourceVersion, destVersion, types.AssetType_ASSET_TYPE_RUNES, nil, req.TargetUtxoNum, req.FeeRate); err != nil {
 					k.Logger(ctx).Error("transfer vault errored", "source version", sourceVersion, "destination version", destVersion, "asset type", types.AssetType_ASSET_TYPE_RUNES, "target utxo num", req.TargetUtxoNum, "fee rate", req.FeeRate, "err", err)
+					continue
 				}
 			}
 
 			// transfer btc only when runes transfer completed
 			if k.VaultTransferCompleted(ctx, sourceRunesVault) && !k.VaultTransferCompleted(ctx, sourceBtcVault) {
 				if err := k.TransferVault(ctx, sourceVersion, destVersion, types.AssetType_ASSET_TYPE_BTC, nil, req.TargetUtxoNum, req.FeeRate); err != nil {
 					k.Logger(ctx).Error("transfer vault errored", "source version", sourceVersion, "destination version", destVersion, "asset type", types.AssetType_ASSET_TYPE_BTC, "target utxo num", req.TargetUtxoNum, "fee rate", req.FeeRate, "err", err)
+					continue
 				}
 			}
 

x/btcbridge/client/cli/query.go

@@ -133,6 +133,34 @@ func CmdQueryBlock() *cobra.Command {
 	return cmd
 }
 
+// CmdQueryFeeRate returns the command to query the bitcoin network fee rate
+func CmdQueryFeeRate() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "fee-rate",
+		Short: "Query the current bitcoin network fee rate on the side chain",
+		Args:  cobra.NoArgs,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			clientCtx, err := client.GetClientQueryContext(cmd)
+			if err != nil {
+				return err
+			}
+
+			queryClient := types.NewQueryClient(clientCtx)
+
+			res, err := queryClient.QueryFeeRate(cmd.Context(), &types.QueryFeeRateRequest{})
+			if err != nil {
+				return err
+			}
+
+			return clientCtx.PrintProto(res)
+		},
+	}
+
+	flags.AddQueryFlagsToCmd(cmd)
+
+	return cmd
+}
+
 // CmdQuerySigningRequests returns the command to query signing requests
 func CmdQuerySigningRequests() *cobra.Command {
 	cmd := &cobra.Command{