Merge pull request #37 from kilnfi/transaction-status

feat: add transactions statuses per protocol

Author: nooxx

examples/ada.ts

@@ -1,7 +1,8 @@
 import { Kiln } from "../src/kiln";
+
 const fs = require('fs');
 
-const apiSecretPath = fs.readFileSync(__dirname + '/fireblocks_secret.key', 'utf8');
+const apiSecret = fs.readFileSync(__dirname + '/fireblocks_secret.key', 'utf8');
 
 const f = async () => {
   try {
@@ -13,9 +14,9 @@ const f = async () => {
           name: 'vault1',
           provider: 'fireblocks',
           fireblocksApiKey: '53aee35e-04b7-9314-8f28-135a66c8af2c',
-          fireblocksSecretKeyPath: apiSecretPath,
-          vaultAccountId: '7'
-        }
+          fireblocksSecretKey: apiSecret,
+          vaultAccountId: '7',
+        },
       ],
     });
 
@@ -27,13 +28,14 @@ const f = async () => {
     //   'addr_test1qpy358g8glafrucevf0rjpmzx2k5esn5uvjh7dzuakpdhv4g2egyt3y3qw6jrguz0lmyhxygjdg2ytaf5z6ueaety7dsmpcee5',
     // );
 
-    const tx = await k.ada.craftUnstakeTx(
-      'addr_test1qpy358g8glafrucevf0rjpmzx2k5esn5uvjh7dzuakpdhv4g2egyt3y3qw6jrguz0lmyhxygjdg2ytaf5z6ueaety7dsmpcee5',
-    );
-    const txSigned = await k.ada.sign('vault1', tx);
-    const hash = await k.ada.broadcast(txSigned);
-    console.log(hash);
-  } catch (err){
+    // const tx = await k.ada.craftUnstakeTx(
+    //   'addr_test1qpy358g8glafrucevf0rjpmzx2k5esn5uvjh7dzuakpdhv4g2egyt3y3qw6jrguz0lmyhxygjdg2ytaf5z6ueaety7dsmpcee5',
+    // );
+    // const txSigned = await k.ada.sign('vault1', tx);
+    // const hash = await k.ada.broadcast(txSigned);
+    const status = await k.ada.getTxStatus('aad008eec08f606f763837144d18275203406bdada7fc2a429c656c15952dd9c');
+    console.log(status);
+  } catch (err) {
     console.log(err);
   }
 };

examples/atom.ts

@@ -19,20 +19,22 @@ const f = async () => {
   });
 
   try {
-    const tx = await k.atom.craftStakeTx(
-      '376acfff-e35d-4b7c-90da-c6acb8ea7197',
-      'cosmos19c9fdh488vqjclltwp68jm50ydwyh36jqeatev',
-      0.1,
-    );
+    // const tx = await k.atom.craftStakeTx(
+    //   '376acfff-e35d-4b7c-90da-c6acb8ea7197',
+    //   'cosmos19c9fdh488vqjclltwp68jm50ydwyh36jqeatev',
+    //   0.1,
+    // );
     // const tx = await k.atom.craftUnstakeTx(
     //   'cosmos19c9fdh488vqjclltwp68jm50ydwyh36jqeatev',
     //   'cosmosvaloper17hskshytlrepzhas628uk00jvvppg7yfj3wpqz',
     //   0.1
     // );
 
-    const signedTx = await k.atom.sign('vault1', tx);
-    const hash = await k.atom.broadcast(signedTx);
-    console.log(hash);
+    // const signedTx = await k.atom.sign('vault1', tx);
+    // const hash = await k.atom.broadcast(signedTx);
+    // console.log(hash);
+    const tx = await k.atom.getTxStatus('B0493A93397438DAD6D5641CBDE8CF43CC7424E6A322A2F5CD3C3B7DF02161E5');
+    console.log(tx);
   } catch (err){
     console.log(err);
   }

examples/eth.ts

@@ -7,8 +7,7 @@ const apiSecret = fs.readFileSync(__dirname + '/fireblocks_secret.key', 'utf8');
 const f = async () => {
   const k = new Kiln({
     testnet: true,
-    // apiToken: 'kiln_dTkxUTFRdHBMZm9vNFFycFhDSTZCdlJsbjJZang5VnY6ejJoV3FCSTlyZlBtM2ZIM0RFRVVaM3NwTkZReHJXTDZWZUxJMWtWWlVrb3VNYUVzcE9Lakt4ZVplOG9vd1oyVw',
-    apiToken: 'kiln_V1JKOW55SkZMOFZvMzBJYmw0aGQ3bkM3UFpIM2IzeXA6YkN6VG9BZW56OWQtUVlGRjNqRW10c1E3R0w2YkRKdjAxQW1Cem5ONnF4Sm1WLUx6STNoRWE2XzdXSVZIc2s0Ug',
+    apiToken: 'kiln_dTkxUTFRdHBMZm9vNFFycFhDSTZCdlJsbjJZang5VnY6ZjF1SUw4d3R1ZDRxYUdreEwtV2sxcjdmbVFJYlhuMWFGUVduRjBkVFJscFdCaUc5bkV2WmpyTU9xb19pSjlsWg',
     integrations: [
       {
         name: 'vault1',
@@ -26,13 +25,16 @@ const f = async () => {
       '0x9cE658155A6f05FE4aef83b7Fa8F431D5e8CcB55',
       32,
     );
-    console.log(tx);
     const txSigned = await k.eth.sign('vault1', tx);
-    const receipt = await k.eth.broadcast(txSigned);
-    console.log(receipt);
-
-    const rewards = await k.eth.getStakesRewards(['0xb15c8670d36abe47f03acaa3ba901ac433973048d43df4d2086de4c422ea4d3d0a6b63702d253c15712d3c85997f0071', 'a262bbe9197b0fe7ced73f8af4b13813e0e03a42d62bd223e96b31c8ba379d6c56835c6729647139963f3fade95f52f6']);
-    console.log(rewards);
+    const hash = await k.eth.broadcast(txSigned);
+    //
+    // const rewards = await k.eth.getStakesRewards(['0xb15c8670d36abe47f03acaa3ba901ac433973048d43df4d2086de4c422ea4d3d0a6b63702d253c15712d3c85997f0071', 'a262bbe9197b0fe7ced73f8af4b13813e0e03a42d62bd223e96b31c8ba379d6c56835c6729647139963f3fade95f52f6']);
+    // console.log(rewards);
+    if(hash){
+      console.log(hash);
+      const status = await k.eth.getTxStatus(hash);
+      console.log(status);
+    }
   } catch (err) {
     console.log(err);
   }

examples/near.ts

@@ -26,15 +26,17 @@ const f = async () => {
     //   10
     // );
 
-    const tx = await k.near.craftUnstakeTx(
-      '373c6f8e84c6822a9f87035f65cccf899eef3fcdee61077041a93e1805bab24e',
-      'kiln.pool.f863973.m0',
-      5,
-    );
-
-    const signedTx = await k.near.sign('vault1', tx);
-    const hash = await k.near.broadcast(signedTx);
-    console.log(hash);
+    // const tx = await k.near.craftUnstakeTx(
+    //   '373c6f8e84c6822a9f87035f65cccf899eef3fcdee61077041a93e1805bab24e',
+    //   'kiln.pool.f863973.m0',
+    //   5,
+    // );
+    //
+    // const signedTx = await k.near.sign('vault1', tx);
+    // const hash = await k.near.broadcast(signedTx);
+    // console.log(hash);
+    const tx = await k.near.getTxStatus('7iRYHAtrerLh7VaL3N4CTPN7LDJvqXYk6Y1oNXzWk2VY');
+    console.log(tx);
   } catch (err) {
     console.log(err);
   }

examples/sol.ts

@@ -39,8 +39,10 @@ const f = async () => {
     // const hash = await k.sol.broadcast(signedTx);
     // console.log(hash);
 
-    const accounts = await k.sol.getAccountsRewards(['771254de-ac5a-4911-afdf-1d5b7e802dc9']);
-    console.log(accounts);
+    // const accounts = await k.sol.getAccountsRewards(['771254de-ac5a-4911-afdf-1d5b7e802dc9']);
+    // console.log(accounts);
+    const tx = await k.sol.getTxStatus('26GZcovnvTGvf5fXFysbtJkNob5r4K9v4H8ZU9tSm8oF5hgUuUm231cabS8LCiC1cqQMFiRkNRNEgqtiVwpr2Bek');
+    console.log(tx);
   } catch (err){
     console.log(err);
   }

src/errors/integrations.ts

@@ -17,4 +17,11 @@ export class BroadcastError extends Error {
     super(message);
     this.name = 'BroadcastError';
   }
+}
+
+export class GetTxStatusError extends Error {
+  constructor(message: string) {
+    super(message);
+    this.name = 'GetTxStatusError';
+  }
 }

src/kiln.ts

@@ -36,6 +36,6 @@ export class Kiln {
     this.sol = new SolService({ testnet, integrations, rpc: rpcs?.solana, });
     this.atom = new AtomService({ testnet, integrations, rpc: rpcs?.atom, });
     this.ada = new AdaService({ testnet, integrations });
-    this.near = new NearService({ testnet, integrations });
+    this.near = new NearService({ testnet, integrations, rpc: rpcs?.near });
   }
 }

src/services/ada.ts

@@ -28,18 +28,30 @@ import {
   Withdrawals,
 } from '@emurgo/cardano-serialization-lib-nodejs';
 import { Service } from "./service";
-import { AdaStakeOptions, InternalAdaConfig, UTXO } from "../types/ada";
+import {
+  AdaStakeOptions,
+  AdaTxStatus,
+  InternalAdaConfig,
+  UTXO,
+} from "../types/ada";
 import {
   BlockFrostAPI,
   BlockfrostServerError,
 } from "@blockfrost/blockfrost-js";
-import { InvalidIntegration, InvalidSignature } from "../errors/integrations";
+import {
+  BroadcastError,
+  GetTxStatusError,
+  InvalidIntegration,
+  InvalidSignature,
+} from "../errors/integrations";
 import { ADDRESSES } from "../globals";
 import {
   CouldNotFetchSlot,
   CouldNotFetchStakeAddress,
-  CouldNotHashStakeKey, NoRewardAddressFound,
-  NoStakeAddressFound, NotEnoughFunds,
+  CouldNotHashStakeKey,
+  NoRewardAddressFound,
+  NoStakeAddressFound,
+  NotEnoughFunds,
 } from "../errors/ada";
 
 const CARDANO_PARAMS = {
@@ -460,14 +472,34 @@ export class AdaService extends Service {
   async broadcast(transaction: Transaction): Promise<string | undefined> {
     try {
       return await this.client.txSubmit(transaction.to_bytes());
-    } catch (error) {
+    } catch (error: any) {
       // submit could fail if the transactions is rejected by cardano node
       if (error instanceof BlockfrostServerError && error.status_code === 400) {
         console.log(error.stack, error.error);
       } else {
-        // rethrow other errors
-        throw error;
+        throw new BroadcastError(error);
       }
     }
   }
+
+  /**
+   * Get transaction status
+   * @param transactionHash
+   */
+  async getTxStatus(transactionHash: string): Promise<AdaTxStatus> {
+    try {
+      const receipt = await this.client.txs(transactionHash);
+      const block = await this.client.blocks(receipt.block);
+
+      // Confirmed transactions after 15 confirmations
+      const status = block.confirmations > 15 ? 'success' : 'pending_confirmation';
+
+      return {
+        status: status,
+        txReceipt: receipt,
+      };
+    } catch (error: any) {
+      throw new GetTxStatusError(error);
+    }
+  }
 }

src/services/atom.ts

@@ -1,14 +1,23 @@
-import { BroadcastError, InvalidIntegration } from "../errors/integrations";
+import {
+  BroadcastError,
+  GetTxStatusError,
+  InvalidIntegration,
+} from "../errors/integrations";
 import { Service } from "./service";
 import {
-  coin,
+  coin, IndexedTx,
   MsgDelegateEncodeObject,
   MsgUndelegateEncodeObject,
   SigningStargateClient,
   StargateClient,
   StdFee,
 } from "@cosmjs/stargate";
-import { AtomStakeOptions, AtomTx, InternalAtomConfig } from "../types/atom";
+import {
+  AtomStakeOptions,
+  AtomTx,
+  AtomTxStatus,
+  InternalAtomConfig,
+} from "../types/atom";
 import { CouldNotFetchDelegation, InvalidStakeAmount } from "../errors/atom";
 import { TxRaw } from "cosmjs-types/cosmos/tx/v1beta1/tx";
 import { Coin, OfflineSigner } from "@cosmjs/proto-signing";
@@ -168,6 +177,23 @@ export class AtomService extends Service {
     }
   }
 
+  /**
+   * Get transaction status
+   * @param transactionHash: hash of transaction
+   */
+  async getTxStatus(transactionHash: string): Promise<AtomTxStatus | null> {
+    try {
+      const client = await this.getClient();
+      const tx = await client.getTx(transactionHash);
+      return tx ? {
+        status: tx.code === 0 ? 'success' : 'error',
+        txReceipt: tx
+      } : null;
+    } catch (e: any) {
+      throw new GetTxStatusError(e);
+    }
+  }
+
   /**
    * Get correct signer given integration. (only support fireblocks provider for now)
    * @param integration

src/services/eth.ts

@@ -8,12 +8,12 @@ import {
   EthereumStakeOptions,
   EthereumTx,
   EthNetworkStats,
-  EthStakes,
+  EthStakes, EthTxStatus,
   InternalEthereumConfig,
   ValidationKeyDepositData,
 } from '../types/eth';
 import {
-  BroadcastError,
+  BroadcastError, GetTxStatusError,
   InvalidIntegration,
   InvalidSignature,
 } from "../errors/integrations";
@@ -95,19 +95,16 @@ export class EthService extends Service {
         );
 
       const data = batchDepositFunction.encodeABI();
-      const gasPrice = await batchDepositFunction.estimateGas({
-        from: walletAddress,
-        value: this.web3.utils.toWei(amountEth.toString(), 'ether'),
-      });
+      const gasWei = 100000 + nbKeysNeeded * 80000;
       const common = new Common({ chain: this.testnet ? Chain.Goerli : Chain.Mainnet });
       const nonce = await this.web3.eth.getTransactionCount(walletAddress);
       return Transaction.fromTxData({
         nonce: nonce,
         data: data,
-        to: this.testnet ? ADDRESSES.eth.testnet.depositContract : ADDRESSES.eth.mainnet.depositContract,
-        value: this.web3.utils.numberToHex(this.web3.utils.toWei(amountEth.toString(), 'ether')),
-        gasPrice: this.web3.utils.numberToHex(gasPrice),
-        gasLimit: this.web3.utils.numberToHex(100000),
+        to: walletAddress,
+        value: this.web3.utils.numberToHex(0),
+        gasPrice: this.web3.utils.numberToHex(gasWei),
+        gasLimit: this.web3.utils.numberToHex(gasWei),
       }, { common });
     } catch (err: any) {
       throw new Error(err);
@@ -174,6 +171,23 @@ export class EthService extends Service {
     }
   }
 
+  /**
+   * Get transaction status
+   * @param transactionHash: transaction hash
+   */
+  async getTxStatus(transactionHash: string): Promise<EthTxStatus> {
+    try {
+      const receipt = await this.web3.eth.getTransactionReceipt(transactionHash);
+      const status = receipt ? receipt.status ? 'success' : 'error' : 'pending_confirmation';
+      return {
+        status: status,
+        txReceipt: receipt,
+      };
+    } catch (e: any) {
+      throw new GetTxStatusError(e);
+    }
+  }
+
   /**
    * Retrieve stakes of given kiln accounts
    * @param accountIds: account ids of which you wish to retrieve rewards