eth-sign-and-broadcast (#61)

* eth-sign-and-broadcast

* nit

* move fireblocks destination id into integration

* bump version to 2.1.0

Author: nooxx

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@kilnfi/sdk",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "autor": "Kiln <[email protected]> (https://kiln.fi)",
   "license": "BUSL-1.1",
   "description": "JavaScript sdk for Kiln API",
@@ -43,7 +43,7 @@
     "crypto": "^1.0.1",
     "ethereumjs-util": "^7.1.5",
     "ethers": "^5.6.4",
-    "fireblocks-sdk": "^2.3.2",
+    "fireblocks-sdk": "^4.0.0",
     "js-sha256": "^0.9.0",
     "keccak256": "^1.0.6",
     "near-api-js": "^1.0.0",

package.json

@@ -2,11 +2,15 @@ import {
   CreateTransactionResponse,
   FireblocksSDK,
   PeerType,
+  TransactionArguments,
   TransactionOperation,
   TransactionResponse,
   TransactionStatus,
 } from 'fireblocks-sdk';
 
+import { utils } from 'ethers';
+import { EthTx } from '../types/eth';
+
 type AssetId =
   'SOL_TEST'
   | 'SOL'
@@ -56,29 +60,63 @@ export class FbSigner {
 
 
   /**
-   * Sign a transaction with fireblocks
+   * Sign a transaction with fireblocks using Fireblocks raw message signing feature
    * @param payloadToSign: transaction data in hexadecimal
    * @param assetId: fireblocks asset id
-   * @param note: fireblocks custom note
+   * @param note: optional fireblocks custom note
    */
   public async signWithFB(payloadToSign: any, assetId: AssetId, note?: string): Promise<TransactionResponse> {
     try {
-      const fbTx = await this.fireblocks.createTransaction(
-        {
-          assetId: assetId,
-          operation: TransactionOperation.RAW,
-          source: {
-            type: PeerType.VAULT_ACCOUNT,
-            id: this.vaultId.toString(),
-          },
-          note,
-          extraParameters: payloadToSign,
+      const tx: TransactionArguments = {
+        assetId: assetId,
+        operation: TransactionOperation.RAW,
+        source: {
+          type: PeerType.VAULT_ACCOUNT,
+          id: this.vaultId.toString(),
         },
-      );
+        note,
+        extraParameters: payloadToSign,
+      };
+      const fbTx = await this.fireblocks.createTransaction(tx);
       return (await this.waitForTxCompletion(fbTx));
     } catch (err: any) {
       throw new Error('Fireblocks signer (signWithFB): ' + err);
     }
   }
+
+  /**
+   * Sign and broadcast a transaction with fireblocks using Fireblocks contract call feature
+   * @param payloadToSign: transaction data in hexadecimal
+   * @param assetId: fireblocks asset id
+   * @param note: optional fireblocks custom note
+   * @param ethTx Ethereum transaction
+   * @param destinationId Fireblocks destination id, this corresponds to the Fireblocks whitelisted contract address id
+   */
+  public async signAndBroadcastWithFB(payloadToSign: any, assetId: AssetId, ethTx: EthTx, destinationId: string, note?: string): Promise<TransactionResponse> {
+    try {
+      const tx: TransactionArguments = {
+        assetId: assetId,
+        operation: TransactionOperation.CONTRACT_CALL,
+        source: {
+          type: PeerType.VAULT_ACCOUNT,
+          id: this.vaultId.toString(),
+        },
+        destination: {
+          type: PeerType.EXTERNAL_WALLET,
+          id: destinationId,
+        },
+        amount: utils.formatEther(ethTx.data.amount_wei),
+        note,
+        extraParameters: payloadToSign,
+        gasLimit: ethTx.data.gas_limit,
+        priorityFee: utils.formatUnits(ethTx.data.max_priority_fee_per_gas_wei, 'gwei'),
+        maxFee: utils.formatUnits(ethTx.data.max_fee_per_gas_wei, 'gwei'),
+      };
+      const fbTx = await this.fireblocks.createTransaction(tx);
+      return (await this.waitForTxCompletion(fbTx));
+    } catch (err: any) {
+      throw new Error('Fireblocks signer (signAndBroadcastWithFB): ' + err);
+    }
+  }
 }
 

src/integrations/fb_signer.ts

@@ -13,6 +13,7 @@ import { Service } from './service';
 import { utils } from 'ethers';
 import { ServiceProps } from '../types/service';
 import { Integration } from '../types/integrations';
+import { TransactionResponse } from 'fireblocks-sdk';
 
 export class EthService extends Service {
   constructor({ testnet }: ServiceProps) {
@@ -47,7 +48,7 @@ export class EthService extends Service {
   /**
    * Sign transaction with given integration
    * @param integration custody solution to sign with
-   * @param tx raw ada transaction
+   * @param tx ETH transaction
    * @param note note to identify the transaction in your custody solution
    */
   async sign(integration: Integration, tx: EthTx, note?: string): Promise<EthSignedTx> {
@@ -63,8 +64,13 @@ export class EthService extends Service {
       };
 
       const fbSigner = this.getFbSigner(integration);
+      const assetId = this.testnet ? 'ETH_TEST3' : 'ETH';
       const fbNote = note ? note : 'ETH tx from @kilnfi/sdk';
-      const signatures = await fbSigner.signWithFB(payload, this.testnet ? 'ETH_TEST3' : 'ETH', fbNote);
+      const signatures = await fbSigner.signWithFB(
+        payload,
+        assetId,
+        fbNote,
+      );
       const { data } = await api.post<EthSignedTx>(
         `/v1/eth/transaction/prepare`,
         {
@@ -79,6 +85,35 @@ export class EthService extends Service {
     }
   }
 
+  /**
+   * Sign transaction with given integration using Fireblocks contract call feature
+   * @param integration custody solution to sign with
+   * @param tx ETH transaction
+   * @param note note to identify the transaction in your custody solution
+   */
+  async signAndBroadcast(integration: Integration, tx: EthTx,  note?: string): Promise<TransactionResponse> {
+    if(!integration.fireblocksDestinationId) {
+      throw new Error('Fireblocks destination id is missing in integration');
+    }
+    try {
+      const payload = {
+        contractCallData: tx.data.contract_call_data,
+      };
+
+      const fbSigner = this.getFbSigner(integration);
+      const assetId = this.testnet ? 'ETH_TEST3' : 'ETH';
+      const fbNote = note ? note : 'ETH tx from @kilnfi/sdk';
+      return  await fbSigner.signAndBroadcastWithFB(
+        payload,
+        assetId,
+        tx,
+        integration.fireblocksDestinationId,
+        fbNote,
+      );
+    } catch (err: any) {
+      throw new Error(err);
+    }
+  }
 
   /**
    * Broadcast transaction to the network

src/services/eth.ts

@@ -60,6 +60,14 @@ export type EthTx = {
   data: {
     unsigned_tx_hash: string;
     unsigned_tx_serialized: string;
+    to: string;
+    contract_call_data: string;
+    amount_wei: string;
+    nonce: number;
+    gas_limit: number;
+    max_priority_fee_per_gas_wei: string;
+    max_fee_per_gas_wei: string;
+    chain_id: number;
   }
 };
 

src/types/eth.ts

@@ -6,6 +6,7 @@ export type FireblocksIntegration = {
   fireblocksSecretKey: string;
   vaultId: number;
   name?: string;
+  fireblocksDestinationId?: string
 };
 
 export type Integration = FireblocksIntegration;