@dhedge/trading-widget 3.0.3 → 3.1.0

package/README.md

@@ -112,7 +112,7 @@ UI configuration provider. Manages params to configure custom styling, component
 ##### params
 
 > | name                               | type                                                           | default value                | description                                                                                                                                        |
-> | ---------------------------------- | -------------------------------------------------------------- | ---------------------------- |----------------------------------------------------------------------------------------------------------------------------------------------------|
+> | ---------------------------------- | -------------------------------------------------------------- | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
 > | `isGeoBlocked`                     | `boolean`                                                      | `false`                      | Restricts depositing action button and conditionally renders GeoBlockAlert component                                                               |
 > | `isSanctioned`                     | `boolean`                                                      | `false`                      | Restricts depositing action button and conditionally renders SanctionedAlert component                                                             |
 > | `depositQuoteDiffWarningThreshold` | `number`                                                       | `1`                          | Deposit slippage absolute percent value warning threshold, Affects styling to warn user                                                            |
@@ -120,6 +120,7 @@ UI configuration provider. Manages params to configure custom styling, component
 > | `defaultWithdrawSlippage`          | `number`                                                       | `[0.1, 0.3, 0.5, 1, 1.5, 3]` | Initial withdraw slippage absolute percent. Further adjustments are available in panel settings                                                    |
 > | `defaultSwapTransactionSlippage`   | `number`                                                       | `0.3`                        | Default slippage (%) applied to swap transaction.                                                                                                  |
 > | `defaultNoSwapMinDepositAmountGap` | `number`                                                       | `0.1`                        | Default gap (%) for min received vault tokens during no swap deposits.                                                                             |
+> | `defaultNotificationDuration`      | `number`                                                       | `10000`                      | Notification duration in ms                                                                                                                        |
 > | `defaultLockTime`                  | `string`                                                       | `'24 hours'`                 | Formatted default deposit lock time to be displayed in panel (Long lockup period is used to bypass entry fee and can be managed in panel settings) |
 > | `customLockTime`                   | `string`                                                       | `'15 minutes'`               | Formatted custom deposit lock time alternative to be displayed in panel                                                                            |
 > | `stablePrecision`                  | `number`                                                       | `3`                          | Number of decimals to be displayed in stables (e.g USDC balance)                                                                                   |
@@ -498,6 +499,7 @@ path: `component.meta[name]`
 > | `selectToken`                    | string | Select Token                                                                                                                                                                          |             |
 > | `sendingOrderToWallet`           | string | Sending order to your wallet                                                                                                                                                          |             |
 > | `settingUpTx`                    | string | Setting up transaction                                                                                                                                                                |             |
+> | `miningTx`                       | string | Processing                                                                                                                                                                            |             |
 > | `updateSynthetixOracles`         | string | Updating Synthetix Oracles                                                                                                                                                            |             |
 > | `approveSpending`                | string | Approve {symbol} spending                                                                                                                                                             |             |
 > | `pay`                            | string | Pay                                                                                                                                                                                   |             |
@@ -510,7 +512,7 @@ path: `component.meta[name]`
 > | `withdrawAction`                 | string | Sell                                                                                                                                                                                  |             |
 > | `swapAction`                     | string | Swap                                                                                                                                                                                  |             |
 > | `unrollAction`                   | string | Unroll                                                                                                                                                                                |             |
-> | `unrollAndClaimAction`           | string | Unroll and Claim                                                                                                                                                                      |             |
+> | `unrollAndClaimAction`           | string | Claim                                                                                                                                                                                 |             |
 > | `claimAction`                    | string | Claim Without Swap                                                                                                                                                                    |             |
 > | `claimLabel`                     | string | Claim                                                                                                                                                                                 |             |
 > | `swapAndClaimTo`                 | string | Swap and claim assets to                                                                                                                                                              |             |
@@ -518,13 +520,40 @@ path: `component.meta[name]`
 > | `initWithdrawTooltip`            | string | Unroll prepares assets for single asset withdrawal                                                                                                                                    |             |
 > | `completeWithdrawDescription`    | string | Claim                                                                                                                                                                                 |             |
 > | `completeWithdrawTooltip`        | string | This final step swaps all assets to a single asset and sends it to your wallet                                                                                                        |             |
-> | `unrollAndClaimDescription`      | string | Unroll {vaultSymbol} tokens and claim {assetSymbol}                                                                                                                                   |             |
+> | `unrollAndClaimDescription`      | string | Claim                                                                                                                                                                                 |             |
 > | `total`                          | string | Total:                                                                                                                                                                                |             |
 > | `showAll`                        | string | Show All                                                                                                                                                                              |             |
 > | `hide`                           | string | Hide                                                                                                                                                                                  |             |
+> | `refreshSwapQuoteTooltip`        | string | Refresh swap quote                                                                                                                                                                    |             |
 
 ###### Source: `packages/trading-widget/src/trading-widget/providers/translation-provider/translation-provider.tsx`
 
 ###### Default values: `packages/trading-widget/src/trading-widget/providers/translation-provider/translation-provider.defaults.ts`
 
 </details>
+
+## Local Development
+
+Follow the steps below to set up the project for local development:
+
+1. **Install Dependencies**:
+   Use `pnpm` to install all required dependencies:
+
+   ```bash
+   pnpm install
+   ```
+
+2. **Update Alchemy API Key**: Replace the placeholder Alchemy API key in the file:
+
+   ```bash
+    packages/trading-widget/src/core-kit/providers/wagmi-provider.tsx
+   ```
+
+3. **Implement** getSwapData in:
+   ```bash
+   packages/trading-widget/src/core-kit/providers/wagmi-provider.tsx
+   ```
+4. **Run Storybook**
+   ```bash
+   pnpm storybook
+   ```

package/core-kit/const/contracts/base.d.ts

@@ -3,3 +3,4 @@ export declare const SYNTHETIX_V3_CORE_ADDRESS_BASE = "0x32C222A9A159782aFD7529c
 export declare const EASY_SWAPPER_V2_ADDRESS_BASE = "0xf067575Eb60c7587C11e867907AA7284833704d1";
 export declare const FLATCOIN_POINTS_MODULE_ADDRESS_BASE = "0x59525b9b23adc475ef91d98dae06b568ba574ce5";
 export declare const FLATMONEY_EARLY_DEPOSITOR_VAULT_ADDRESS_BASE = "0xa907504d7a4c415b4e6e1d0866d96afe8202f0e5";
+export declare const FLATMONEY_DHT_STAKING_VAULT_ADDRESS_BASE = "0x1849324228d852a67eb7443e42d967e480ffe95d";

package/core-kit/const/default-data.d.ts

@@ -24,3 +24,5 @@ export declare const GAS_LIMIT_BUFFER_COEFF = 1.25;
 export declare const MANAGER_FEE_DENOMINATOR = 10000;
 export declare const DEFAULT_PROMISE_TIMEOUT_MS = 13000;
 export declare const DEFAULT_VISIBLE_ASSETS_LIMIT = 3;
+export declare const SWAP_QUOTE_REFRESH_INTERVAL_MS = 20000;
+export declare const DEFAULT_NOTIFICATION_DURATION_MS = 10000;

package/core-kit/const/error.d.ts

@@ -2,3 +2,9 @@ export declare const GAS_ESTIMATION_ERROR = "Gas estimate error occurred";
 export declare const DEFAULT_ERROR_MESSAGE = "See console logs to report error details.";
 export declare const DEFAULT_SIMULATION_ERROR = "Missing simulation params";
 export declare const SIMULATION_TIMEOUT_ERROR = "Simulation timeout";
+export declare const DEPOSIT_SWAP_DATA_ERROR = "swap_data_deposit_error";
+export declare const WITHDRAW_SWAP_DATA_ERROR = "swap_data_withdraw_error";
+export declare const TRANSACTION_ERRORS: Record<string, {
+    title: string;
+    hint?: string;
+}>;

package/core-kit/const/logger.d.ts

@@ -1,11 +1,16 @@
 export declare const TRADING_PANEL_LOG_EVENT: {
     INVEST_INPUT_FOCUS: string;
     APPROVED_TOKEN: string;
+    UPDATE_ORACLES: string;
     DEPOSIT: string;
+    MULTI_ASSET_WITHDRAW: string;
+    SINGLE_ASSET_WITHDRAW: string;
+    SINGLE_ASSET_WITHDRAW_AND_CLAIM: string;
+    CLAIM: string;
+    SWAP: string;
     WITHDRAWAL: string;
     TRADING_SETTINGS_OPENED: string;
     INFINITE_ALLOWANCE_CHANGE: string;
-    MULTI_ASSET_WITHDRAWAL_CHANGE: string;
 };
 /**
  * Limits: Up to 50 custom event parameters per project;
@@ -18,10 +23,6 @@ export declare const TRADING_LOG_EVENT_PARAM: {
         NAME: string;
         TYPE: string;
     };
-    IS_MULTI_ASSET: {
-        NAME: string;
-        TYPE: string;
-    };
     SYMBOL: {
         NAME: string;
         TYPE: string;

package/core-kit/hooks/pool/index.d.ts

@@ -12,4 +12,4 @@ export { useSynthetixV3AssetBalance } from './synthetixV3/use-synthetix-v3-asset
 export { useTotalFundValueMutable } from './synthetixV3/use-total-funds-value-mutable';
 export { useInvalidatePoolContractData } from './use-invalidate-pool-contract-data';
 export { usePoolsDynamic } from './multicall';
-export { useFmedVestedPoints } from './use-fmed-vested-points';
+export { useVaultVestedPoints } from './use-vault-vested-points';

package/core-kit/hooks/pool/{use-fmed-vested-points.d.ts → use-vault-vested-points.d.ts}

@@ -1,7 +1,9 @@
+import type { Address } from 'core-kit/types';
 interface UseFmedVestedPointsProps {
     enabled?: boolean;
+    address: Address;
 }
-export declare const useFmedVestedPoints: ({ enabled, }?: UseFmedVestedPointsProps | undefined) => import("wagmi").UseReadContractsReturnType<{
+export declare const useVaultVestedPoints: ({ enabled, address, }: UseFmedVestedPointsProps) => import("wagmi").UseReadContractsReturnType<{
     address: `0x${string}`;
     chainId: 8453;
     abi: readonly [{

package/core-kit/utils/flat-money.d.ts

@@ -1,4 +1,4 @@
 import type { Address } from 'viem';
-export declare const isFlatMoneyEarlyDepositorAddress: (address: Address) => boolean;
+export declare const isFmpAirdropVaultAddress: (address: Address) => boolean;
 export declare const isFlatMoneyLeveragedRethAsset: (address: Address) => boolean;
 export declare const getFlatMonetUnitSymbol: (chainId: number) => string;

package/core-kit/utils/index.d.ts

@@ -9,3 +9,4 @@ export * from './formatter';
 export * from './synthetix';
 export * from './ua';
 export * from './flat-money';
+export * from './logger';

package/core-kit/utils/logger.d.ts

@@ -0,0 +1,17 @@
+import type { TradingPanelActionsState, TransactionAction } from 'core-kit/types';
+import type { Address } from 'core-kit/types/web3.types';
+/**
+ * Transforms an Ethereum address to ensure it's treated as a string in Firebase Analytics.
+ * Adds a prefix to avoid scientific notation or numeric interpretation.
+ *
+ * @param {string} ethereumAddress - The Ethereum address to transform.
+ * @returns {string} - The transformed Ethereum address.
+ */
+export declare const transformAddressForAnalytics: (ethereumAddress: Address) => string;
+export declare const logTransactionByActionType: ({ action, log, symbol, vaultAddress, chainId, }: {
+    action: TransactionAction;
+    symbol: string;
+    log: TradingPanelActionsState['onLog'];
+    chainId: number;
+    vaultAddress: Address;
+}) => void;