Merge pull request #503 from enkryptcom/devop/add-jupiter-swap

[WIP] Add Jupiter Swap

packages/extension/src/providers/bitcoin/libs/api.ts

@@ -10,6 +10,7 @@ import { toBN } from "web3-utils";
 import { getAddress as getBitcoinAddress } from "../types/bitcoin-network";
 import { filterOutOrdinals } from "./filter-ordinals";
 
+/** Bitcoin API wrapper */
 class API implements ProviderAPIInterface {
   node: string;
   networkInfo: BitcoinNetworkInfo;

packages/extension/src/providers/ethereum/libs/api.ts

@@ -6,6 +6,7 @@ import { numberToHex, toBN } from "web3-utils";
 import { ERC20TokenInfo } from "../types";
 import erc20 from "./abi/erc20";
 
+/** Ethereum API wrapper */
 class API implements ProviderAPIInterface {
   node: string;
   web3: Web3Eth;

packages/extension/src/providers/ethereum/libs/transaction/index.ts

@@ -21,6 +21,7 @@ import { FeeMarketEIP1559Transaction, LegacyTransaction } from "@ethereumjs/tx";
 import { OPTIMISM_PRICE_ORACLE, OPTIMISM_PRICE_ORACLE_ABI } from "./op-data";
 import { bufferToHex } from "@enkryptcom/utils";
 
+/** Represents an EVM transaction */
 class Transaction {
   tx: EthereumTransaction;
   web3: Web3Eth;
@@ -72,6 +73,10 @@ class Transaction {
       maxFeePerGas,
     };
   };
+
+  /**
+   * Gathers the last bits of data required to serialize a transaction eg gas price, nonce, etc
+   */
   async finalizeTransaction(options: TransactionOptions): Promise<{
     transaction:
       | FinalizedFeeMarketEthereumTransaction
@@ -94,8 +99,10 @@ class Transaction {
         isFeeMarketNetwork: false,
         feeHistory: {} as FeeHistoryResult,
       }));
+    // Gets the number of transactions that they will have sent by the next pending block
     const nonce = await this.web3.getTransactionCount(this.tx.from, "pending");
     if (!isFeeMarketNetwork) {
+      // Legacy transaction
       const gasPrice = await this.web3.getGasPrice();
       const gasLimit =
         this.tx.gasLimit ||
@@ -122,6 +129,7 @@ class Transaction {
         gasLimit: legacyTx.gasLimit,
       };
     } else {
+      // Fee market transaction (post EIP1559)
       const baseFeePerGas =
         feeHistory.baseFeePerGas[feeHistory.baseFeePerGas.length - 2]; // -2 since -1 is the pending block
       const formattedFeeHistory = formatFeeHistory(feeHistory);
@@ -164,6 +172,13 @@ class Transaction {
       };
     }
   }
+
+  /**
+   * Create a sendable transaction
+   *
+   * Gathers last live bits of data required to send the transaction then
+   * creates a sendable transaction from it
+   */
   async getFinalizedTransaction(
     options: TransactionOptions
   ): Promise<LegacyTransaction | FeeMarketEIP1559Transaction> {
@@ -192,10 +207,12 @@ class Transaction {
       );
     }
   }
+
   async getMessageToSign(options: TransactionOptions): Promise<Uint8Array> {
     const tx = await this.getFinalizedTransaction(options);
     return tx.getHashedMessageToSign();
   }
+
   async getGasCosts(): Promise<GasCosts> {
     const { gasLimit, gasPrice, baseFeePerGas, formattedFeeHistory } =
       await this.finalizeTransaction({

packages/extension/src/providers/ethereum/ui/libs/signer.ts

@@ -1,15 +1,19 @@
 import { InternalMethods, InternalOnMessageResponse } from "@/types/messenger";
-import { FeeMarketEIP1559Transaction } from "@ethereumjs/tx";
+import { FeeMarketEIP1559Transaction, LegacyTransaction } from "@ethereumjs/tx";
 import { SignerTransactionOptions, SignerMessageOptions } from "../types";
 import HWwallet from "@enkryptcom/hw-wallets";
 import { HWwalletType } from "@enkryptcom/types";
 import { fromRpcSig, hashPersonalMessage } from "@ethereumjs/util";
 import { getCustomError } from "@/libs/error";
 import { bufferToHex } from "@enkryptcom/utils";
 import sendUsingInternalMessengers from "@/libs/messenger/internal-messenger";
+
+/**
+ * Sign a transaction
+ */
 const TransactionSigner = (
   options: SignerTransactionOptions
-): Promise<FeeMarketEIP1559Transaction> => {
+): Promise<LegacyTransaction | FeeMarketEIP1559Transaction> => {
   const { account, network, payload } = options;
   if (account.isHardware) {
     const hwwallets = new HWwallet();
@@ -26,7 +30,7 @@ const TransactionSigner = (
       })
       .then((rpcsig: string) => {
         const rpcSig = fromRpcSig(rpcsig);
-        const signedTx = (payload as FeeMarketEIP1559Transaction).addSignature(
+        const signedTx = payload.addSignature(
           BigInt(rpcSig.v),
           rpcSig.r,
           rpcSig.s,
@@ -49,7 +53,7 @@ const TransactionSigner = (
         return Promise.reject(res);
       } else {
         const rpcSig = fromRpcSig(JSON.parse(res.result as string) || "0x");
-        const signedTx = (payload as FeeMarketEIP1559Transaction).addSignature(
+        const signedTx = payload.addSignature(
           rpcSig.v,
           rpcSig.r,
           rpcSig.s,
@@ -61,6 +65,9 @@ const TransactionSigner = (
   }
 };
 
+/**
+ * Sign a message
+ */
 const MessageSigner = (
   options: SignerMessageOptions
 ): Promise<InternalOnMessageResponse> => {

packages/extension/src/providers/kadena/libs/api.ts

@@ -13,6 +13,7 @@ import {
 import { toBase } from "@enkryptcom/utils";
 import DomainState from "@/libs/domain-state";
 
+/** Kadena API wrapper */
 class API implements ProviderAPIInterface {
   decimals: number;
   node: string;

packages/extension/src/providers/polkadot/libs/api.ts

@@ -4,6 +4,8 @@ import { PolkadotAPIOptions } from "../types";
 import { AccountInfoWithRefCount } from "@polkadot/types/interfaces";
 import { NetworkEndpoints } from "./activity-handlers/providers/subscan/configs";
 import { SubscanExtrinsicInfo } from "@/types/activity";
+
+/** Polkadot Substrate API wrapper */
 class API implements ProviderAPIInterface {
   node: string;
   decimals: number;

packages/extension/src/providers/solana/libs/api.ts

@@ -6,6 +6,7 @@ import { hexToBuffer, numberToHex } from "@enkryptcom/utils";
 import cacheFetch from "@/libs/cache-fetch";
 import { SPLTokenInfo } from "../types/sol-token";
 
+/** Solana API wrapper */
 class API implements ProviderAPIInterface {
   node: string;
   web3: Connection;

packages/extension/src/providers/solana/libs/wallet-standard/wallet.ts

@@ -252,6 +252,7 @@ export class EnkryptWallet implements Wallet {
   #signMessage: SolanaSignMessageMethod = async (...inputs) => {
     if (!this.#accounts?.length) throw new Error("not connected");
     const outputs: SolanaSignMessageOutput[] = [];
+
     if (inputs.length === 1) {
       const { message, account } = inputs[0]!;
       let isValidAccount = false;

packages/extension/src/types/base-network.ts

@@ -42,6 +42,19 @@ export interface BaseNetworkOptions {
   customTokens?: boolean;
 }
 
+/**
+ * The main representation of a network in the Enkrypt extension.
+ *
+ * Instantiated from a mostly static network config.
+ *
+ * Provides some common properties of networks used throughout UI elements and functionality in the app.
+ *
+ * Intended to be subclassed by different network types; for example EVMNetwork, SolanaNetwork, PolkadotNetwork etc.
+ *
+ * Has an `api` function (property) which returns a `ProviderAPIInterface` with some basic methods to interract with the network
+ * for balances, transaction statuses, etc. The implementing class of `ProviderAPIInterface` is typically one-to-one with the
+ * the network type. For example EVM networks have their own API (which wraps node JSON RPC). Solana networks have a different API.
+ */
 export abstract class BaseNetwork {
   public name: NetworkNames;
   public name_long: string;

packages/extension/src/types/provider.ts

@@ -119,6 +119,12 @@ export abstract class BackgroundProviderInterface extends EventEmitter {
   abstract sendNotification(notif: string): Promise<void>;
 }
 
+/**
+ * Wraps basic network functionality to provide common features like balances and transaction statuses.
+ *
+ * Each network type will typically have its own implementing class. For example, for EVM networks the implementing
+ * class need just wrap JSON RPC calls.
+ */
 export abstract class ProviderAPIInterface {
   abstract node: string;
   // eslint-disable-next-line @typescript-eslint/no-unused-vars, @typescript-eslint/no-empty-function