@keplr-wallet/hooks-evm 0.13.15-rc.0

package/build/tx/types.d.ts

@@ -0,0 +1,102 @@
+import { AppCurrency, EvmGasSimulationOutcome, FeeCurrency, StdFee } from "@keplr-wallet/types";
+import { CoinPretty, Dec } from "@keplr-wallet/unit";
+import { NameService } from "./name-service";
+import { IModularChainInfoImpl } from "@keplr-wallet/stores";
+export interface ITxChainSetter {
+    chainId: string;
+    setChain(chainId: string): void;
+    modularChainInfo: IModularChainInfoImpl;
+}
+export interface UIProperties {
+    readonly error?: Error;
+    readonly warning?: Error;
+    readonly loadingState?: "loading" | "loading-block";
+}
+export type FeeType = "high" | "average" | "low";
+export type EVMFeeType = FeeType | "custom";
+export interface IGasConfig extends ITxChainSetter {
+    value: string;
+    setValue(value: string | number): void;
+    gas: number;
+    uiProperties: UIProperties;
+}
+export interface ISenderConfig extends ITxChainSetter {
+    value: string;
+    setValue(value: string): void;
+    sender: string;
+    uiProperties: UIProperties;
+}
+export interface IFeeConfig extends ITxChainSetter {
+    type: EVMFeeType;
+    setType(type: EVMFeeType): void;
+    maxFeePerGas: Dec | undefined;
+    maxPriorityFeePerGas: Dec | undefined;
+    gasPrice: Dec | undefined;
+    fee: CoinPretty | undefined;
+    maxFee: CoinPretty | undefined;
+    l1DataFee: Dec | undefined;
+    setL1DataFee(fee: Dec): void;
+    refreshEIP1559TxFees(): void;
+    customPriorityFee: string;
+    customPriorityFeeInput: string;
+    setCustomPriorityFee(fee: string): void;
+    isLegacyFeeMode: boolean;
+    customGasPrice: string;
+    customGasPriceInput: string;
+    setCustomGasPrice(value: string): void;
+    getEIP1559TxFees(feeType: EVMFeeType | "manual"): {
+        maxPriorityFeePerGas?: Dec;
+        maxFeePerGas?: Dec;
+        gasPrice?: Dec;
+    };
+    fees: CoinPretty[];
+    selectableFeeCurrencies: FeeCurrency[];
+    setFee(fee: {
+        type: EVMFeeType;
+        currency: FeeCurrency;
+    } | CoinPretty | CoinPretty[] | undefined): void;
+    getFeeTypePrettyForFeeCurrency(currency: FeeCurrency, feeType: EVMFeeType): CoinPretty;
+    toStdFee(): StdFee;
+    uiProperties: UIProperties;
+}
+export interface IRecipientConfig extends ITxChainSetter {
+    value: string;
+    setValue(value: string): void;
+    recipient: string;
+    uiProperties: UIProperties;
+}
+export interface IRecipientConfigWithNameServices extends IRecipientConfig {
+    preferredNameService: string | undefined;
+    setPreferredNameService(nameService: string | undefined): void;
+    getNameService(type: string): NameService | undefined;
+    getNameServices(): NameService[];
+    nameServiceResult: {
+        type: string;
+        address: string;
+        fullName: string;
+        domain: string;
+        suffix: string;
+    }[];
+}
+export interface IAmountConfig extends ITxChainSetter {
+    amount: CoinPretty[];
+    value: string;
+    setValue(value: string): void;
+    currency: AppCurrency;
+    setCurrency(currency: AppCurrency | undefined): void;
+    canUseCurrency(currency: AppCurrency): boolean;
+    fraction: number;
+    setFraction(fraction: number): void;
+    uiProperties: UIProperties;
+}
+export interface IGasSimulator {
+    enabled: boolean;
+    setEnabled(value: boolean): void;
+    isSimulating: boolean;
+    gasEstimated: number | undefined;
+    gasAdjustment: number;
+    gasAdjustmentValue: string;
+    setGasAdjustmentValue(gasAdjustment: string | number): void;
+    evmSimulationOutcome?: EvmGasSimulationOutcome;
+    uiProperties: UIProperties;
+}

package/build/tx/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/build/tx/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/tx/types.ts"],"names":[],"mappings":""}

package/build/tx/validate.d.ts

@@ -0,0 +1,11 @@
+import { IAmountConfig, IFeeConfig, IGasConfig, IGasSimulator, IRecipientConfig, ISenderConfig } from "./types";
+export declare const useTxConfigsValidate: (configs: {
+    amountConfig?: IAmountConfig;
+    senderConfig?: ISenderConfig;
+    recipientConfig?: IRecipientConfig;
+    gasConfig?: IGasConfig;
+    feeConfig?: IFeeConfig;
+    gasSimulator?: IGasSimulator;
+}) => {
+    interactionBlocked: boolean;
+};

package/build/tx/validate.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useTxConfigsValidate = void 0;
+// CONTRACT: Use with `observer`
+const useTxConfigsValidate = (configs) => {
+    const interactionBlocked = (() => {
+        var _a, _b, _c, _d, _e, _f;
+        const amountConfigUIProperties = (_a = configs.amountConfig) === null || _a === void 0 ? void 0 : _a.uiProperties;
+        const senderConfigUIProperties = (_b = configs.senderConfig) === null || _b === void 0 ? void 0 : _b.uiProperties;
+        const recipientConfigUIProperties = (_c = configs.recipientConfig) === null || _c === void 0 ? void 0 : _c.uiProperties;
+        const gasConfigUIProperties = (_d = configs.gasConfig) === null || _d === void 0 ? void 0 : _d.uiProperties;
+        const feeConfigUIProperties = (_e = configs.feeConfig) === null || _e === void 0 ? void 0 : _e.uiProperties;
+        const gasSimulatorUIProperties = (_f = configs.gasSimulator) === null || _f === void 0 ? void 0 : _f.uiProperties;
+        if ((amountConfigUIProperties === null || amountConfigUIProperties === void 0 ? void 0 : amountConfigUIProperties.error) ||
+            (senderConfigUIProperties === null || senderConfigUIProperties === void 0 ? void 0 : senderConfigUIProperties.error) ||
+            (recipientConfigUIProperties === null || recipientConfigUIProperties === void 0 ? void 0 : recipientConfigUIProperties.error) ||
+            (gasConfigUIProperties === null || gasConfigUIProperties === void 0 ? void 0 : gasConfigUIProperties.error) ||
+            (feeConfigUIProperties === null || feeConfigUIProperties === void 0 ? void 0 : feeConfigUIProperties.error) ||
+            (gasSimulatorUIProperties === null || gasSimulatorUIProperties === void 0 ? void 0 : gasSimulatorUIProperties.error)) {
+            return true;
+        }
+        if ((amountConfigUIProperties === null || amountConfigUIProperties === void 0 ? void 0 : amountConfigUIProperties.loadingState) === "loading-block" ||
+            (senderConfigUIProperties === null || senderConfigUIProperties === void 0 ? void 0 : senderConfigUIProperties.loadingState) === "loading-block" ||
+            (recipientConfigUIProperties === null || recipientConfigUIProperties === void 0 ? void 0 : recipientConfigUIProperties.loadingState) === "loading-block" ||
+            (gasConfigUIProperties === null || gasConfigUIProperties === void 0 ? void 0 : gasConfigUIProperties.loadingState) === "loading-block" ||
+            (feeConfigUIProperties === null || feeConfigUIProperties === void 0 ? void 0 : feeConfigUIProperties.loadingState) === "loading-block" ||
+            (gasSimulatorUIProperties === null || gasSimulatorUIProperties === void 0 ? void 0 : gasSimulatorUIProperties.loadingState) === "loading-block") {
+            return true;
+        }
+        return false;
+    })();
+    return {
+        interactionBlocked,
+    };
+};
+exports.useTxConfigsValidate = useTxConfigsValidate;
+//# sourceMappingURL=validate.js.map

package/build/tx/validate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.js","sourceRoot":"","sources":["../../src/tx/validate.ts"],"names":[],"mappings":";;;AASA,gCAAgC;AACzB,MAAM,oBAAoB,GAAG,CAAC,OAOpC,EAAE,EAAE;IACH,MAAM,kBAAkB,GAAG,CAAC,GAAG,EAAE;;QAC/B,MAAM,wBAAwB,GAAG,MAAA,OAAO,CAAC,YAAY,0CAAE,YAAY,CAAC;QACpE,MAAM,wBAAwB,GAAG,MAAA,OAAO,CAAC,YAAY,0CAAE,YAAY,CAAC;QACpE,MAAM,2BAA2B,GAAG,MAAA,OAAO,CAAC,eAAe,0CAAE,YAAY,CAAC;QAC1E,MAAM,qBAAqB,GAAG,MAAA,OAAO,CAAC,SAAS,0CAAE,YAAY,CAAC;QAC9D,MAAM,qBAAqB,GAAG,MAAA,OAAO,CAAC,SAAS,0CAAE,YAAY,CAAC;QAC9D,MAAM,wBAAwB,GAAG,MAAA,OAAO,CAAC,YAAY,0CAAE,YAAY,CAAC;QAEpE,IACE,CAAA,wBAAwB,aAAxB,wBAAwB,uBAAxB,wBAAwB,CAAE,KAAK;aAC/B,wBAAwB,aAAxB,wBAAwB,uBAAxB,wBAAwB,CAAE,KAAK,CAAA;aAC/B,2BAA2B,aAA3B,2BAA2B,uBAA3B,2BAA2B,CAAE,KAAK,CAAA;aAClC,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,CAAE,KAAK,CAAA;aAC5B,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,CAAE,KAAK,CAAA;aAC5B,wBAAwB,aAAxB,wBAAwB,uBAAxB,wBAAwB,CAAE,KAAK,CAAA,EAC/B;YACA,OAAO,IAAI,CAAC;SACb;QAED,IACE,CAAA,wBAAwB,aAAxB,wBAAwB,uBAAxB,wBAAwB,CAAE,YAAY,MAAK,eAAe;YAC1D,CAAA,wBAAwB,aAAxB,wBAAwB,uBAAxB,wBAAwB,CAAE,YAAY,MAAK,eAAe;YAC1D,CAAA,2BAA2B,aAA3B,2BAA2B,uBAA3B,2BAA2B,CAAE,YAAY,MAAK,eAAe;YAC7D,CAAA,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,CAAE,YAAY,MAAK,eAAe;YACvD,CAAA,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,CAAE,YAAY,MAAK,eAAe;YACvD,CAAA,wBAAwB,aAAxB,wBAAwB,uBAAxB,wBAAwB,CAAE,YAAY,MAAK,eAAe,EAC1D;YACA,OAAO,IAAI,CAAC;SACb;QAED,OAAO,KAAK,CAAC;IACf,CAAC,CAAC,EAAE,CAAC;IAEL,OAAO;QACL,kBAAkB;KACnB,CAAC;AACJ,CAAC,CAAC;AA5CW,QAAA,oBAAoB,wBA4C/B"}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@keplr-wallet/hooks-evm",
+  "version": "0.13.15-rc.0",
+  "main": "build/index.js",
+  "author": "chainapsis",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/chainapsis/keplr-wallet.git"
+  },
+  "scripts": {
+    "clean": "rm -rf node_modules; rm -rf build",
+    "build": "npx tsc",
+    "dev": "npx tsc -w",
+    "test": "npx jest --passWithNoTests",
+    "lint-test": "npx eslint \"src/**/*\" && npx prettier --check \"src/**/*\"",
+    "lint-fix": "npx eslint --fix \"src/**/*\" && npx prettier --write \"src/**/*\"",
+    "typecheck": "npx tsc -p tsconfig.check.json"
+  },
+  "dependencies": {
+    "@ethersproject/address": "^5.7.0",
+    "@ethersproject/providers": "^5.7.0",
+    "@keplr-wallet/common": "0.13.15-rc.0",
+    "@keplr-wallet/cosmos": "0.13.15-rc.0",
+    "@keplr-wallet/simple-fetch": "0.13.15-rc.0",
+    "@keplr-wallet/stores": "0.13.15-rc.0",
+    "@keplr-wallet/stores-eth": "0.13.15-rc.0",
+    "@keplr-wallet/types": "0.13.15-rc.0",
+    "@keplr-wallet/unit": "0.13.15-rc.0",
+    "buffer": "^6.0.3"
+  },
+  "peerDependencies": {
+    "mobx": "^6",
+    "mobx-utils": "^6",
+    "react": "^16.8.0 || ^17 || ^18"
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from "./tx";

package/src/tx/amount.ts

@@ -0,0 +1,273 @@
+import {
+  IAmountConfig,
+  IFeeConfig,
+  ISenderConfig,
+  UIProperties,
+} from "./types";
+import { TxChainSetter } from "./chain";
+import { ChainGetter } from "@keplr-wallet/stores";
+import { action, computed, makeObservable, observable } from "mobx";
+import { AppCurrency } from "@keplr-wallet/types";
+import {
+  EmptyAmountError,
+  InsufficientAmountError,
+  InvalidNumberAmountError,
+  NegativeAmountError,
+  ZeroAmountError,
+} from "./errors";
+import { CoinPretty, Dec, DecUtils } from "@keplr-wallet/unit";
+import { useState } from "react";
+import { QueriesStore } from "./internal";
+
+export class AmountConfig extends TxChainSetter implements IAmountConfig {
+  @observable.ref
+  protected _currency?: AppCurrency = undefined;
+
+  @observable
+  protected _value: string = "";
+
+  @observable
+  protected _fraction: number = 0;
+
+  @observable.ref
+  protected _feeConfig: IFeeConfig | undefined = undefined;
+
+  constructor(
+    chainGetter: ChainGetter,
+    protected readonly queriesStore: QueriesStore,
+    initialChainId: string,
+    protected readonly senderConfig: ISenderConfig
+  ) {
+    super(chainGetter, initialChainId);
+
+    makeObservable(this);
+  }
+
+  get feeConfig(): IFeeConfig | undefined {
+    return this._feeConfig;
+  }
+
+  @action
+  setFeeConfig(feeConfig: IFeeConfig | undefined) {
+    this._feeConfig = feeConfig;
+  }
+
+  @computed
+  get value(): string {
+    if (this.fraction > 0) {
+      let result = this.queriesStore
+        .get(this.chainId)
+        .queryBalances.getQueryEthereumHexAddress(this.senderConfig.sender)
+        .getBalance(this.currency)?.balance;
+      if (!result) {
+        return "0";
+      }
+      if (this.feeConfig && this.feeConfig.maxFee) {
+        if (
+          this.currency.coinMinimalDenom ===
+          this.feeConfig.maxFee.currency.coinMinimalDenom
+        ) {
+          result = result.sub(this.feeConfig.maxFee);
+        }
+      }
+      if (result.toDec().lte(new Dec(0))) {
+        return "0";
+      }
+
+      return result
+        .mul(new Dec(this.fraction))
+        .trim(true)
+        .locale(false)
+        .hideDenom(true)
+        .toString();
+    }
+
+    return this._value;
+  }
+
+  @action
+  setValue(value: string): void {
+    if (value.startsWith(".")) {
+      value = "0" + value;
+    }
+
+    this._value = value;
+
+    this.setFraction(0);
+  }
+
+  @computed
+  get amount(): CoinPretty[] {
+    let amount: Dec;
+    try {
+      if (this.value.trim() === "") {
+        amount = new Dec(0);
+      } else {
+        amount = new Dec(this.value);
+      }
+    } catch {
+      amount = new Dec(0);
+    }
+
+    try {
+      return [
+        new CoinPretty(
+          this.currency,
+          amount
+            .mul(DecUtils.getTenExponentN(this.currency.coinDecimals))
+            .truncate()
+        ),
+      ];
+    } catch {
+      return [new CoinPretty(this.currency, new Dec(0))];
+    }
+  }
+
+  @computed
+  get currency(): AppCurrency {
+    const u = this.modularChainInfo.unwrapped;
+    if (u.type !== "evm" && u.type !== "ethermint") {
+      throw new Error("Chain is not an EVM compatible chain");
+    }
+
+    if (this._currency) {
+      const allCurrencies: AppCurrency[] = [
+        u.evm.nativeCurrency,
+        ...(u.evm.tokens ?? []),
+      ];
+      const find = allCurrencies.find(
+        (cur) => cur.coinMinimalDenom === this._currency!.coinMinimalDenom
+      );
+      if (find) {
+        return find;
+      }
+    }
+
+    return u.evm.nativeCurrency;
+  }
+
+  @action
+  setCurrency(currency: AppCurrency | undefined) {
+    if (currency?.coinMinimalDenom !== this._currency?.coinMinimalDenom) {
+      this._value = "";
+      this.setFraction(0);
+    }
+
+    this._currency = currency;
+  }
+
+  get fraction(): number {
+    return this._fraction;
+  }
+
+  @action
+  setFraction(fraction: number): void {
+    this._fraction = fraction;
+  }
+
+  canUseCurrency(currency: AppCurrency): boolean {
+    const u = this.modularChainInfo.unwrapped;
+    if (u.type !== "evm" && u.type !== "ethermint") {
+      return false;
+    }
+
+    const allCurrencies: AppCurrency[] = [
+      u.evm.nativeCurrency,
+      ...(u.evm.tokens ?? []),
+    ];
+
+    return (
+      allCurrencies.find(
+        (cur) => cur.coinMinimalDenom === currency.coinMinimalDenom
+      ) != null
+    );
+  }
+
+  @computed
+  get uiProperties(): UIProperties {
+    if (!this.currency) {
+      return {
+        error: new Error("Currency to send not set"),
+      };
+    }
+
+    if (this.value.trim() === "") {
+      return {
+        error: new EmptyAmountError("Amount is empty"),
+      };
+    }
+
+    try {
+      const dec = new Dec(this.value);
+      if (dec.equals(new Dec(0))) {
+        return {
+          error: new ZeroAmountError("Amount is zero"),
+        };
+      }
+      if (dec.lt(new Dec(0))) {
+        return {
+          error: new NegativeAmountError("Enter a positive number"),
+        };
+      }
+
+      new CoinPretty(
+        this.currency,
+        dec.mul(DecUtils.getTenExponentN(this.currency.coinDecimals)).truncate()
+      );
+    } catch {
+      return {
+        error: new InvalidNumberAmountError("Enter a valid number"),
+      };
+    }
+
+    for (const amount of this.amount) {
+      const bal = this.queriesStore
+        .get(this.chainId)
+        .queryBalances.getQueryEthereumHexAddress(this.senderConfig.sender)
+        .getBalance(amount.currency);
+
+      if (!bal) {
+        return {
+          warning: new Error(
+            `Can't parse the balance for ${amount.currency.coinMinimalDenom}`
+          ),
+        };
+      }
+
+      if (bal.error) {
+        return {
+          warning: new Error("Failed to fetch balance"),
+        };
+      }
+
+      if (!bal.response) {
+        return {
+          loadingState: "loading-block",
+        };
+      }
+
+      if (bal.balance.toDec().lt(amount.toDec())) {
+        return {
+          error: new InsufficientAmountError("Insufficient balance"),
+          loadingState: bal.isFetching ? "loading" : undefined,
+        };
+      }
+    }
+
+    return {};
+  }
+}
+
+export const useAmountConfig = (
+  chainGetter: ChainGetter,
+  queriesStore: QueriesStore,
+  chainId: string,
+  senderConfig: ISenderConfig
+) => {
+  const [txConfig] = useState(
+    () => new AmountConfig(chainGetter, queriesStore, chainId, senderConfig)
+  );
+  txConfig.setChain(chainId);
+
+  return txConfig;
+};

package/src/tx/chain.ts

@@ -0,0 +1,31 @@
+import { action, computed, makeObservable, observable } from "mobx";
+import { ChainGetter, IModularChainInfoImpl } from "@keplr-wallet/stores";
+import { ITxChainSetter } from "./types";
+
+export class TxChainSetter implements ITxChainSetter {
+  @observable
+  protected _chainId: string;
+
+  constructor(
+    protected readonly chainGetter: ChainGetter,
+    initialChainId: string
+  ) {
+    this._chainId = initialChainId;
+
+    makeObservable(this);
+  }
+
+  @computed
+  get modularChainInfo(): IModularChainInfoImpl {
+    return this.chainGetter.getModularChain(this.chainId);
+  }
+
+  get chainId(): string {
+    return this._chainId;
+  }
+
+  @action
+  setChain(chainId: string) {
+    this._chainId = chainId;
+  }
+}

package/src/tx/errors.ts

@@ -0,0 +1,79 @@
+export class EmptyAddressError extends Error {
+  constructor(m: string) {
+    super(m);
+    // Set the prototype explicitly.
+    Object.setPrototypeOf(this, EmptyAddressError.prototype);
+  }
+}
+
+export class InvalidHexError extends Error {
+  constructor(m: string) {
+    super(m);
+    // Set the prototype explicitly.
+    Object.setPrototypeOf(this, InvalidHexError.prototype);
+  }
+}
+
+export class EmptyAmountError extends Error {
+  constructor(m: string) {
+    super(m);
+    // Set the prototype explicitly.
+    Object.setPrototypeOf(this, EmptyAmountError.prototype);
+  }
+}
+
+export class InvalidNumberAmountError extends Error {
+  constructor(m: string) {
+    super(m);
+    // Set the prototype explicitly.
+    Object.setPrototypeOf(this, InvalidNumberAmountError.prototype);
+  }
+}
+
+export class ZeroAmountError extends Error {
+  constructor(m: string) {
+    super(m);
+    // Set the prototype explicitly.
+    Object.setPrototypeOf(this, ZeroAmountError.prototype);
+  }
+}
+
+export class NegativeAmountError extends Error {
+  constructor(m: string) {
+    super(m);
+    // Set the prototype explicitly.
+    Object.setPrototypeOf(this, NegativeAmountError.prototype);
+  }
+}
+
+export class InsufficientAmountError extends Error {
+  constructor(m: string) {
+    super(m);
+    // Set the prototype explicitly.
+    Object.setPrototypeOf(this, InsufficientAmountError.prototype);
+  }
+}
+
+export class InsufficientFeeError extends Error {
+  constructor(m: string) {
+    super(m);
+    // Set the prototype explicitly.
+    Object.setPrototypeOf(this, InsufficientFeeError.prototype);
+  }
+}
+
+export class ENSIsFetchingError extends Error {
+  constructor(m: string) {
+    super(m);
+    // Set the prototype explicitly.
+    Object.setPrototypeOf(this, ENSIsFetchingError.prototype);
+  }
+}
+
+export class ENSFailedToFetchError extends Error {
+  constructor(m: string) {
+    super(m);
+    // Set the prototype explicitly.
+    Object.setPrototypeOf(this, ENSFailedToFetchError.prototype);
+  }
+}