Submit transactions in bulk

.vscode/settings.json

@@ -13,7 +13,7 @@
   "[json]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"
   },
-  "cSpell.words": ["gemwallet"],
+  "cSpell.words": ["gemwallet", "xrpl"],
   "[typescriptreact]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"
   }

packages/api/src/index.ts

@@ -17,6 +17,7 @@ export * from './setTrustline';
 export * from './signMessage';
 export * from './signTransaction';
 export * from './submitTransaction';
+export * from './submitBulkTransactions';
 
 export type { Amount } from 'xrpl/dist/npm/models/common';
 export type {
@@ -43,7 +44,8 @@ export type {
   SetTrustlineRequest,
   SignMessageRequest,
   SignTransactionRequest,
-  SubmitTransactionRequest
+  SubmitTransactionRequest,
+  SubmitBulkTransactionsRequest
 } from '@gemwallet/constants';
 
 // API response types
@@ -65,5 +67,6 @@ export type {
   SetTrustlineResponse,
   SignMessageResponse,
   SignTransactionResponse,
-  SubmitTransactionResponse
+  SubmitTransactionResponse,
+  SubmitBulkTransactionsResponse
 } from '@gemwallet/constants';

packages/api/src/submitBulkTransactions/index.ts

@@ -0,0 +1 @@
+export * from './submitBulkTransactions';

packages/api/src/submitBulkTransactions/submitBulkTransactions.ts

@@ -0,0 +1,55 @@
+import {
+  SubmitBulkTransactionsResponse,
+  GEM_WALLET,
+  ResponseType,
+  RequestSubmitBulkTransactionsMessage,
+  TransactionWithID,
+  SubmitBulkTransactionsRequest
+} from '@gemwallet/constants';
+
+import { deserializeError } from '../helpers/errors';
+import { sendMessageToContentScript } from '../helpers/extensionMessaging';
+
+const MAX_TRANSACTIONS = 50;
+
+export const submitBulkTransactions = async (
+  payload: SubmitBulkTransactionsRequest
+): Promise<SubmitBulkTransactionsResponse> => {
+  let response: SubmitBulkTransactionsResponse = {
+    type: ResponseType.Reject,
+    result: undefined
+  };
+
+  if (payload.transactions.length === 0 || payload.transactions.length > MAX_TRANSACTIONS) {
+    throw new Error(`Invalid number of transactions (must be between 1 and ${MAX_TRANSACTIONS})`);
+  }
+
+  try {
+    const message: RequestSubmitBulkTransactionsMessage = {
+      app: GEM_WALLET,
+      type: 'REQUEST_SUBMIT_BULK_TRANSACTIONS/V3',
+      payload: {
+        ...payload,
+        // Add an index to each transaction so that we can process them in order
+        transactions: payload.transactions.reduce((acc, transaction, index) => {
+          acc[index] = transaction;
+          return acc;
+        }, {} as Record<number, TransactionWithID>)
+      }
+    };
+
+    const { result, error } = await sendMessageToContentScript(message);
+    const parsedError = error ? deserializeError(error) : undefined;
+    if (parsedError) {
+      throw parsedError;
+    }
+
+    if (result) {
+      response.type = ResponseType.Response;
+      response.result = result;
+    }
+  } catch (e) {
+    throw e;
+  }
+  return response;
+};

packages/api/templates/index.html

@@ -27,6 +27,9 @@
       <button onclick="handleCancelOffer()">Cancel Offer (check the console)</button>
       <button onclick="handleSubmitTransaction()">Submit transaction (check the console)</button>
       <button onclick="handleSignTransaction()">Sign transaction (check the console)</button>
+      <button onclick="handlesubmitBulkTransactions()">
+        Submit transactions (Bulk) (check the console)
+      </button>
       <button onclick="handleEvents()">Activate events (check the console)</button>
       <div id="address"></div>
     </div>
@@ -547,6 +550,69 @@
         console.error('GemWallet is not connected: ', e);
       });
   }
+  function handlesubmitBulkTransactions() {
+    GemWalletApi.isInstalled()
+      .then(({ result }) => {
+        if (result.isInstalled) {
+          const transactions = [
+            ...[
+              {
+                ID: '001',
+                TransactionType: 'TrustSet',
+                LimitAmount: {
+                  currency: 'ETH',
+                  issuer: 'rnm76Qgz4G9G4gZBJVuXVvkbt7gVD7szey',
+                  value: '10000000'
+                },
+                Memos: [
+                  {
+                    Memo: {
+                      MemoType: '4465736372697074696f6e',
+                      MemoData: '54657374206d656d6f'
+                    }
+                  }
+                ],
+                Fee: '199'
+              },
+              {
+                ID: '002',
+                TransactionType: 'NFTokenMint',
+                URI: '516D6654463665756E47726A57597642666A72614B486D765572354444566D525351424373513252564D71764A72',
+                NFTokenTaxon: 0
+              }
+            ],
+            ...Array.from({ length: 48 }, (_, index) => ({
+              ID: String(index + 1).padStart(3, '3'),
+              TransactionType: 'Payment',
+              Destination: 'rhikRdkFw28csKw9z7fVoBjWncz1HSoQij',
+              Amount: '100000',
+              Memos: [
+                {
+                  Memo: {
+                    MemoData: '54657374206D656D6F',
+                    MemoType: '4465736372697074696F6E'
+                  }
+                }
+              ]
+            }))
+          ];
+          GemWalletApi.submitBulkTransactions({
+            transactions,
+            onError: 'abort',
+            waitForHashes: false
+          })
+            .then((res) => {
+              console.log('Received response: ', res);
+            })
+            .catch((e) => {
+              console.error('Something went wrong: ', e);
+            });
+        }
+      })
+      .catch((e) => {
+        console.error('GemWallet is not connected: ', e);
+      });
+  }
   function handleEvents() {
     GemWalletApi.isInstalled()
       .then(({ result }) => {

packages/constants/src/event/event.types.ts

@@ -20,6 +20,7 @@ import {
   SignMessageRequest,
   SignTransactionRequest,
   SubmitTransactionRequest,
+  SubmitBulkTransactionsWithKeysRequest,
   WebsiteRequest
 } from '../payload/payload.types';
 
@@ -45,6 +46,7 @@ interface MessageEventData {
     | SetTrustlineRequestDeprecated
     | SignMessageRequest
     | SubmitTransactionRequest
+    | SubmitBulkTransactionsWithKeysRequest
     | WebsiteRequest;
 }
 
@@ -256,6 +258,16 @@ export interface SignTransactionEventListener extends MessageEvent<MessageEventD
   };
 }
 
+export interface SubmitBulkTransactionsEventListener extends MessageEvent<MessageEventData> {
+  data: {
+    app: typeof GEM_WALLET;
+    type: 'REQUEST_SUBMIT_BULK_TRANSACTIONS/V3';
+    source: 'GEM_WALLET_MSG_REQUEST';
+    messageId: number;
+    payload: SubmitBulkTransactionsWithKeysRequest;
+  };
+}
+
 export interface SetAccountEventListener extends MessageEvent<MessageEventData> {
   data: {
     app: typeof GEM_WALLET;
@@ -310,7 +322,8 @@ export type EventListener =
   | SignMessageListener
   | SignMessageListenerDeprecated
   | SignTransactionEventListener
-  | SubmitTransactionEventListener;
+  | SubmitTransactionEventListener
+  | SubmitBulkTransactionsEventListener;
 
 // Events
 interface EventEventData {

packages/constants/src/message/message.types.ts

@@ -46,6 +46,8 @@ import {
   SignTransactionRequest,
   SubmitTransactionResponse,
   SubmitTransactionRequest,
+  SubmitBulkTransactionsWithKeysRequest,
+  SubmitBulkTransactionsResponse,
   WebsiteRequest
 } from '../payload/payload.types';
 import {
@@ -79,6 +81,7 @@ export type RequestMessage =
   | 'REQUEST_SIGN_MESSAGE/V3'
   | 'REQUEST_SIGN_TRANSACTION/V3'
   | 'REQUEST_SUBMIT_TRANSACTION/V3'
+  | 'REQUEST_SUBMIT_BULK_TRANSACTIONS/V3'
   | 'SEND_PAYMENT';
 
 export type ReceiveMessage =
@@ -105,7 +108,8 @@ export type ReceiveMessage =
   | 'RECEIVE_SIGN_MESSAGE'
   | 'RECEIVE_SIGN_MESSAGE/V3'
   | 'RECEIVE_SIGN_TRANSACTION/V3'
-  | 'RECEIVE_SUBMIT_TRANSACTION/V3';
+  | 'RECEIVE_SUBMIT_TRANSACTION/V3'
+  | 'RECEIVE_SUBMIT_BULK_TRANSACTIONS/V3';
 
 export type EventMessage =
   | 'EVENT_NETWORK_CHANGED'
@@ -260,6 +264,12 @@ export interface RequestSignTransactionMessage {
   payload: SignTransactionRequest;
 }
 
+export interface RequestSubmitBulkTransactionsMessage {
+  app: typeof GEM_WALLET;
+  type: 'REQUEST_SUBMIT_BULK_TRANSACTIONS/V3';
+  payload: SubmitBulkTransactionsWithKeysRequest;
+}
+
 // Internal
 export interface InternalRequestPasswordMessage {
   app: typeof GEM_WALLET;
@@ -312,6 +322,8 @@ export type SignMessageMessagingResponseDeprecated = MessagingResponse &
   SignMessageResponseDeprecated;
 export type SignTransactionMessagingResponse = MessagingResponse & SignTransactionResponse;
 export type SubmitTransactionMessagingResponse = MessagingResponse & SubmitTransactionResponse;
+export type SubmitBulkTransactionsMessagingResponse = MessagingResponse &
+  SubmitBulkTransactionsResponse;
 export type IsInstalledMessagingResponse = MessagingResponse & IsInstalledResponse;
 export type SendPaymentMessagingResponse = MessagingResponse & SendPaymentResponse;
 export type SendPaymentMessagingResponseDeprecated = MessagingResponse &
@@ -478,6 +490,12 @@ export interface ReceiveSignTransactionContentMessage {
   payload: SignTransactionMessagingResponse;
 }
 
+export interface ReceiveSubmitBulkTransactionsContentMessage {
+  app: typeof GEM_WALLET;
+  type: 'RECEIVE_SUBMIT_BULK_TRANSACTIONS/V3';
+  payload: SubmitBulkTransactionsMessagingResponse;
+}
+
 // Internal
 export interface InternalReceivePasswordContentMessage {
   app: typeof GEM_WALLET;
@@ -605,6 +623,9 @@ export type ReceiveSignTransactionBackgroundMessage = ReceiveSignTransactionCont
 export type ReceiveSubmitTransactionBackgroundMessage = ReceiveSubmitTransactionContentMessage &
   BackgroundMessagePayload;
 
+export type ReceiveSubmitBulkTransactionsBackgroundMessage =
+  ReceiveSubmitBulkTransactionsContentMessage & BackgroundMessagePayload;
+
 export type InternalReceivePasswordBackgroundMessage = InternalReceivePasswordContentMessage &
   BackgroundMessagePayload;
 
@@ -650,6 +671,7 @@ export type BackgroundMessage =
   | RequestSignMessageMessageDeprecated
   | RequestSignTransactionMessage
   | RequestSubmitTransactionMessage
+  | RequestSubmitBulkTransactionsMessage
   // Outputted Messages - DO contain ID within the payloads
   | EventLoginBackgroundMessage
   | EventLogoutBackgroundMessage
@@ -679,6 +701,7 @@ export type BackgroundMessage =
   | ReceiveSignMessageBackgroundMessageDeprecated
   | ReceiveSignTransactionBackgroundMessage
   | ReceiveSubmitTransactionBackgroundMessage
+  | ReceiveSubmitBulkTransactionsBackgroundMessage
   //
   // Internal message - Messages between the extension and the background script
   //
@@ -712,4 +735,5 @@ export type APIMessages =
   | RequestSetTrustlineMessage
   | RequestSignMessageMessage
   | RequestSignTransactionMessage
-  | RequestSubmitTransactionMessage;
+  | RequestSubmitTransactionMessage
+  | RequestSubmitBulkTransactionsMessage;

packages/constants/src/network/network.constant.ts

@@ -10,7 +10,9 @@ export enum NetworkServer {
   MAINNET = 'wss://xrplcluster.com',
   TESTNET = 'wss://s.altnet.rippletest.net:51233',
   DEVNET = 'wss://s.devnet.rippletest.net:51233',
-  AMM_DEVNET = 'wss://amm.devnet.rippletest.net:51233'
+  AMM_DEVNET = 'wss://amm.devnet.rippletest.net:51233',
+  MAINNET_S1 = 'wss://s1.ripple.com', // Clio
+  MAINNET_S2 = 'wss://s2.ripple.com' // Clio
 }
 
 export const NETWORK = {