feat: add open btc transfer

.changeset/violet-masks-hunt.md

@@ -0,0 +1,5 @@
+---
+'@stacks/connect': minor
+---
+
+Add experimental support for BTC transfers

lerna.json

@@ -2,7 +2,7 @@
   "packages": [
     "packages/*"
   ],
-  "version": "5.0.5",
+  "version": "independent",
   "npmClient": "yarn",
   "command": {
     "version": {

packages/connect/src/index.ts

@@ -1,5 +1,6 @@
 export * from './auth';
 export * from './transactions';
+export * from './transactions/btc'; // todo: tmp
 export * from './signature';
 export * from './signature/structuredData';
 export * from './profile';

packages/connect/src/transactions/btc.ts

@@ -0,0 +1,55 @@
+import { createUnsecuredToken, Json } from 'jsontokens';
+import { BtcRecipient, BTCTransferOptions, BTCTransferPayload, TransactionTypes } from '../types';
+import { getStacksProvider } from '../utils';
+
+const openGenericTransactionPopup = async ({
+  token,
+  options,
+}: {
+  token: string;
+  options: BTCTransferOptions; // todo: add generic alternative
+}) => {
+  const provider = getStacksProvider();
+  if (!provider) {
+    throw new Error('Hiro Wallet not installed');
+  }
+
+  try {
+    const txResponse = await provider.transactionRequest(token);
+
+    options.onFinish?.(txResponse as any); // todo: add new `onFinish` for parsed BTC tx data
+  } catch (error) {
+    console.error('[Connect] Error during transaction request', error);
+    options.onCancel?.();
+  }
+};
+
+/**
+ * ⚠ Experimental method for opening a BTC transfer request. This API interface
+ * subject to change and does not adhere to semantic versioning.
+ * @experimental
+ */
+export function openBTCTransfer(options: BTCTransferOptions): Promise<void> {
+  const { recipients, ..._options } = {
+    // todo: do we maybe want userSession, stxAddress, ...?
+    // ...getDefaults(options),
+    ...options,
+  };
+
+  const payLoadRecipients: BtcRecipient[] = [];
+  recipients.forEach(recipient => {
+    payLoadRecipients.push({
+      recipient: recipient.recipient,
+      amount: recipient.amount.toString(10),
+    });
+  });
+
+  const payload: Partial<BTCTransferPayload> = {
+    ..._options,
+    recipients: payLoadRecipients,
+    txType: TransactionTypes.BTCTransfer,
+  };
+
+  const token = createUnsecuredToken(payload as Json);
+  return openGenericTransactionPopup({ token, options });
+}

packages/connect/src/transactions/index.ts

@@ -74,7 +74,8 @@ export function getStxAddress(options: TransactionOptions) {
   return address;
 }
 
-function getDefaults(options: TransactionOptions) {
+/** @internal */
+export function getDefaults(options: TransactionOptions) {
   const network = options.network || new StacksTestnet();
 
   const userSession = getUserSession(options.userSession);

packages/connect/src/types/transactions.ts

@@ -48,6 +48,7 @@ export enum TransactionTypes {
   ContractCall = 'contract_call',
   ContractDeploy = 'smart_contract',
   STXTransfer = 'token_transfer',
+  BTCTransfer = 'token_transfer_btc', // todo: `btc_transfer` ? (generice interface for selecting token/chain)
 }
 
 /**
@@ -153,10 +154,36 @@ export interface STXTransferPayload extends STXTransferBase {
  * Transaction Popup
  */
 
-export type TransactionOptions = ContractCallOptions | ContractDeployOptions | STXTransferOptions;
-export type TransactionPayload = ContractCallPayload | ContractDeployPayload | STXTransferPayload;
+export type TransactionOptions =
+  | ContractCallOptions
+  | ContractDeployOptions
+  | STXTransferOptions
+  | BTCTransferOptions;
+export type TransactionPayload =
+  | ContractCallPayload
+  | ContractDeployPayload
+  | STXTransferPayload
+  | BTCTransferPayload;
 
 export interface TransactionPopup {
   token: string;
   options: TransactionOptions;
 }
+
+/**
+ * BTC Transfer
+ */
+
+export interface BtcRecipient {
+  recipient: string;
+  amount: bigint | number | string;
+}
+
+export interface BTCTransferOptions extends RegularOptionsBase {
+  recipients: BtcRecipient[];
+}
+
+export interface BTCTransferPayload extends BTCTransferOptions {
+  recipients: BtcRecipient[];
+  txType: TransactionTypes.BTCTransfer;
+}