@ledgerhq/coin-aptos 2.5.1 → 2.5.2-nightly.0

package/src/network/client.ts

@@ -1,5 +1,4 @@
 import { ApolloClient, InMemoryCache } from "@apollo/client";
-
 import {
   type AccountData,
   Aptos,
@@ -9,6 +8,7 @@ import {
   type InputEntryFunctionData,
   type InputGenerateTransactionOptions,
   MimeType,
+  MoveStructId,
   type RawTransaction,
   type SimpleTransaction,
   type TransactionResponse,
@@ -30,7 +30,12 @@ import {
   ESTIMATE_GAS_MUL,
   TOKEN_TYPE,
 } from "../constants";
-import type { AptosBalance, AptosTransaction, TransactionOptions } from "../types";
+import type {
+  AptosBalance,
+  AptosTransaction,
+  StakePoolResource,
+  TransactionOptions,
+} from "../types";
 import { GetAccountTransactionsData, GetAccountTransactionsDataGt } from "./graphql/queries";
 import type {
   GetAccountTransactionsDataQuery,
@@ -59,7 +64,8 @@ const getIndexerEndpoint = (currencyId: string) =>
 export class AptosAPI {
   private readonly aptosConfig: AptosConfig;
   private readonly aptosClient: Aptos;
-  private readonly apolloClient: ApolloClient<object>;
+
+  readonly apolloClient: ApolloClient<object>;
 
   constructor(currencyIdOrSettings: AptosSettings | string) {
     if (typeof currencyIdOrSettings === "string") {
@@ -211,7 +217,9 @@ export class AptosAPI {
     const simulation = await this.simulateTransaction(publicKeyEd, tx);
     const completedTx = simulation[0];
 
-    const gasLimit = new BigNumber(completedTx.gas_used).multipliedBy(ESTIMATE_GAS_MUL);
+    const gasLimit = new BigNumber(completedTx.gas_used)
+      .multipliedBy(ESTIMATE_GAS_MUL)
+      .integerValue();
     const gasPrice = new BigNumber(completedTx.gas_unit_price);
 
     const expectedGas = gasPrice.multipliedBy(gasLimit);
@@ -226,6 +234,38 @@ export class AptosAPI {
     };
   }
 
+  async getNextUnlockTime(stakingPoolAddress: string): Promise<string | undefined> {
+    const resourceType: MoveStructId = "0x1::stake::StakePool";
+    try {
+      const resource = await this.aptosClient.getAccountResource<StakePoolResource>({
+        accountAddress: stakingPoolAddress,
+        resourceType,
+      });
+      return resource.locked_until_secs;
+    } catch (error) {
+      log("error", "Failed to fetch StakePool resource:", { error });
+    }
+  }
+
+  async getDelegatorBalanceInPool(
+    poolAddress: string,
+    delegatorAddress: string,
+  ): Promise<Array<string>> {
+    try {
+      // Query the delegator balance in the pool
+      return await this.aptosClient.view<[string]>({
+        payload: {
+          function: "0x1::delegation_pool::get_stake",
+          typeArguments: [],
+          functionArguments: [poolAddress, delegatorAddress],
+        },
+      });
+    } catch (error) {
+      log("error", "Failed to fetch delegation_pool::get_stake", { error });
+      return ["0", "0", "0"];
+    }
+  }
+
   async listOperations(
     rawAddress: string,
     pagination: Pagination,

package/src/network/graphql/queries.ts

@@ -1,4 +1,3 @@
-// We need to target CJS for the CJS build of the lib
 import { gql } from "@apollo/client";
 
 export const GetDelegatedStakingActivities = gql`
@@ -16,6 +15,7 @@ export const GetDelegatedStakingActivities = gql`
     }
   }
 `;
+
 export const GetAccountTransactionsData = gql`
   query GetAccountTransactionsData($address: String, $limit: Int) {
     account_transactions(
@@ -28,6 +28,7 @@ export const GetAccountTransactionsData = gql`
     }
   }
 `;
+
 export const GetAccountTransactionsDataGt = gql`
   query GetAccountTransactionsDataGt($address: String, $limit: Int, $gt: bigint) {
     account_transactions(
@@ -40,6 +41,7 @@ export const GetAccountTransactionsDataGt = gql`
     }
   }
 `;
+
 export const GetAccountTransactionsDataLt = gql`
   query GetAccountTransactionsDataLt($address: String, $limit: Int, $lt: bigint) {
     account_transactions(
@@ -52,3 +54,46 @@ export const GetAccountTransactionsDataLt = gql`
     }
   }
 `;
+
+export const GetNumActiveDelegatorPerPoolData = gql`
+  query GetNumActiveDelegatorPerPoolData {
+    num_active_delegator_per_pool {
+      num_active_delegator
+      pool_address
+    }
+    delegated_staking_pools {
+      staking_pool_address
+      current_staking_pool {
+        operator_address
+        operator_aptos_name(where: { is_active: { _eq: true } }) {
+          domain
+          is_primary
+        }
+      }
+    }
+  }
+`;
+
+export const GetCurrentDelegatorBalancesData = gql`
+  query GetCurrentDelegatorBalances {
+    current_delegator_balances(
+      distinct_on: pool_address
+      order_by: { current_pool_balance: { total_coins: desc }, pool_address: asc }
+    ) {
+      current_pool_balance {
+        total_coins
+        operator_commission_percentage
+        staking_pool_address
+        total_shares
+      }
+      shares
+      delegator_address
+      staking_pool_metadata {
+        operator_aptos_name {
+          domain_with_suffix
+          is_active
+        }
+      }
+    }
+  }
+`;

package/src/network/graphql/types.ts

@@ -21,9 +21,7 @@ export type GetAccountTransactionsDataQueryVariables = Exact<{
 }>;
 
 export type GetAccountTransactionsDataQuery = {
-  __typename?: "query_root";
   account_transactions: Array<{
-    __typename?: "account_transactions";
     transaction_version: number;
   }>;
 };
@@ -35,9 +33,7 @@ export type GetAccountTransactionsDataGtQueryVariables = Exact<{
 }>;
 
 export type GetAccountTransactionsDataGtQuery = {
-  __typename?: "query_root";
   account_transactions: Array<{
-    __typename?: "account_transactions";
     transaction_version: number;
   }>;
 };
@@ -49,9 +45,7 @@ export type GetAccountTransactionsDataLtQueryVariables = Exact<{
 }>;
 
 export type GetAccountTransactionsDataLtQuery = {
-  __typename?: "query_root";
   account_transactions: Array<{
-    __typename?: "account_transactions";
     transaction_version: number;
   }>;
 };
@@ -83,3 +77,66 @@ export type StakeDetails = {
   canWithdrawPendingInactive: boolean;
   poolAddress: string;
 };
+
+export type GetNumActiveDelegatorPerPoolQuery = {
+  num_active_delegator_per_pool: Array<{
+    pool_address: string;
+    num_active_delegator: number;
+  }>;
+  delegated_staking_pools: Array<{
+    staking_pool_address: string;
+    current_staking_pool: {
+      operator_address: string;
+      operator_aptos_name: Array<{
+        domain: string;
+        is_primary: boolean;
+      }>;
+    };
+  }>;
+};
+
+export type GetCurrentDelegatorBalancesQuery = {
+  current_delegator_balances: Array<{
+    current_pool_balance: {
+      total_coins: string;
+      operator_commission_percentage: string;
+      staking_pool_address: string;
+      total_shares: string;
+    };
+    shares: string;
+    delegator_address: string;
+    staking_pool_metadata: {
+      operator_aptos_name: {
+        domain_with_suffix: string;
+        is_active: boolean;
+      };
+    };
+  }>;
+};
+
+export interface DelegationPoolAddress {
+  staking_pool_address: string;
+}
+
+interface CurrentPoolBalance {
+  total_coins: string;
+  operator_commission_percentage: string;
+  staking_pool_address: string;
+  total_shares: string;
+}
+
+interface StakingPoolMetadata {
+  operator_aptos_name: OperatorAptosName;
+}
+
+interface OperatorAptosName {
+  domain_with_suffix: string;
+  is_active: boolean;
+}
+
+export interface CurrentDelegatorBalance {
+  shares: string;
+  delegator_address: string;
+  current_pool_balance: CurrentPoolBalance;
+  staking_pool_metadata: StakingPoolMetadata;
+}

package/src/network/index.ts

@@ -11,6 +11,7 @@ import { Account } from "@ledgerhq/types-live";
 import { AptosSigner } from "../types";
 import { sha3_256 as sha3Hash } from "@noble/hashes/sha3";
 import { combineSignedTransaction } from "../logic/combine";
+
 export * from "./client";
 
 export async function signTransaction(

package/src/network/validators.ts

@@ -0,0 +1,48 @@
+import BigNumber from "bignumber.js";
+import { AptosAPI } from "../network";
+import { GetCurrentDelegatorBalancesData } from "./graphql/queries";
+import { CurrentDelegatorBalance, GetCurrentDelegatorBalancesQuery } from "./graphql/types";
+import { AptosValidator } from "../types";
+import { isTestnet } from "../logic/isTestnet";
+import { APTOS_EXPLORER_ACCOUNT_URL } from "../constants";
+import { formatUnlockTime } from "../logic/staking";
+
+export async function getValidators(currencyId: string): Promise<AptosValidator[]> {
+  const api = new AptosAPI(currencyId);
+  const query = GetCurrentDelegatorBalancesData;
+  const queryResponse = await api.apolloClient.query<GetCurrentDelegatorBalancesQuery, object>({
+    query: query,
+    fetchPolicy: "network-only",
+  });
+
+  const stakingData: CurrentDelegatorBalance[] = queryResponse.data.current_delegator_balances;
+
+  const list: AptosValidator[] = await Promise.all(
+    stakingData.map(async pool => {
+      const aptosName = pool.staking_pool_metadata.operator_aptos_name;
+      const naming =
+        Array.isArray(aptosName) && aptosName.length > 0 && aptosName[0].domain_with_suffix
+          ? aptosName[0].domain_with_suffix
+          : pool.current_pool_balance.staking_pool_address;
+
+      const url = `${APTOS_EXPLORER_ACCOUNT_URL}/${pool.current_pool_balance.staking_pool_address}?network=${isTestnet(currencyId) ? "testnet" : "mainnet"}`;
+
+      const unblockdata = await api.getNextUnlockTime(
+        pool.current_pool_balance.staking_pool_address,
+      );
+      const nextUnlockTime = unblockdata ? formatUnlockTime(unblockdata) : undefined; //`${30}d ${20}h ${30}m`;
+
+      return {
+        commission: BigNumber(pool.current_pool_balance.operator_commission_percentage).div(100),
+        activeStake: BigNumber(pool.current_pool_balance.total_coins),
+        address: pool.current_pool_balance.staking_pool_address,
+        name: naming,
+        shares: pool.current_pool_balance.total_shares,
+        wwwUrl: url,
+        nextUnlockTime: nextUnlockTime,
+      };
+    }),
+  );
+
+  return list.sort((a, b) => b.activeStake.toNumber() - a.activeStake.toNumber());
+}

package/src/preload-data.ts

@@ -0,0 +1,43 @@
+import { CryptoCurrency } from "@ledgerhq/types-cryptoassets";
+import { BehaviorSubject, Observable } from "rxjs";
+import { AptosPreloadData } from "./types";
+
+const initialData: AptosPreloadData = {
+  validatorsWithMeta: [],
+  validators: [],
+};
+
+const dataByCurrency = new Map<string, AptosPreloadData>([
+  ["aptos", initialData],
+  ["aptos_testnet", initialData],
+]);
+
+const dataUpdatesByCurrency = new Map([
+  ["aptos", new BehaviorSubject<AptosPreloadData>(initialData)],
+  ["aptos_testnet", new BehaviorSubject<AptosPreloadData>(initialData)],
+]);
+
+export function setAptosPreloadData(data: AptosPreloadData, currency: CryptoCurrency): void {
+  dataByCurrency.set(currency.id, data ?? initialData);
+  const subject = dataUpdatesByCurrency.get(currency.id);
+  if (subject === undefined) {
+    throw new Error(`unsupported currency ${currency.id}`);
+  }
+  subject.next(data);
+}
+
+export function getAptosPreloadData(currency: CryptoCurrency): Observable<AptosPreloadData> {
+  const subject = dataUpdatesByCurrency.get(currency.id);
+  if (subject === undefined) {
+    throw new Error(`unsupported currency ${currency.id}`);
+  }
+  return subject.asObservable();
+}
+
+export function getCurrentAptosPreloadData(currency: CryptoCurrency): AptosPreloadData {
+  const data = dataByCurrency.get(currency.id);
+  if (data === undefined) {
+    throw new Error(`unsupported currency ${currency.id}`);
+  }
+  return data;
+}

package/src/preload.ts

@@ -0,0 +1,23 @@
+import { CryptoCurrency } from "@ledgerhq/types-cryptoassets";
+import { setAptosPreloadData } from "./preload-data";
+import { AptosPreloadData, AptosValidator } from "./types";
+import { getValidators } from "./network/validators";
+
+export const PRELOAD_MAX_AGE = 15 * 60 * 1000; // 15min
+
+export async function preloadWithValidators(currency: CryptoCurrency): Promise<AptosPreloadData> {
+  const validators: AptosValidator[] = await getValidators(currency.id);
+
+  const data: AptosPreloadData = {
+    validatorsWithMeta: [],
+    validators,
+  };
+
+  setAptosPreloadData(data, currency);
+
+  return data;
+}
+
+export function hydrate(data: AptosPreloadData, currency: CryptoCurrency): void {
+  setAptosPreloadData(data, currency);
+}

package/src/test/bridgeDatasetTest.ts

@@ -2,6 +2,7 @@ import { CurrenciesData, DatasetTest } from "@ledgerhq/types-live";
 import { Transaction } from "../types";
 
 const aptos: CurrenciesData<Transaction> = {
+  FIXME_ignorePreloadFields: ["validators"],
   scanAccounts: [
     {
       name: "aptos seed 1",

package/src/types/index.ts

@@ -1,6 +1,7 @@
 import type { UserTransactionResponse } from "@aptos-labs/ts-sdk";
 import type {
   Account,
+  AccountRaw,
   Operation,
   TransactionCommon,
   TransactionCommonRaw,
@@ -8,6 +9,7 @@ import type {
   TransactionStatusCommonRaw,
 } from "@ledgerhq/types-live";
 import type { BigNumber } from "bignumber.js";
+
 export * from "./signer";
 export * from "./bridge";
 
@@ -18,9 +20,15 @@ export type AptosTransaction = UserTransactionResponse & {
   };
 };
 
-export type AptosOperation = Operation;
+export type AptosOperation = Operation<AptosOperationExtra>;
+
+export type AptosOperationRaw = Operation<AptosOperationExtraRaw>;
+
+export type AptosAccount = Account & { aptosResources: AptosResources };
 
-export type AptosAccount = Account;
+export type AptosAccountRaw = AccountRaw & {
+  aptosResources: AptosResourcesRaw;
+};
 
 export type TransactionStatus = TransactionStatusCommon;
 
@@ -43,19 +51,14 @@ export type AptosAddress = {
   path: string;
 };
 
-export interface TransactionOptions {
-  maxGasAmount: string;
-  gasUnitPrice: string;
-}
-
 export type TransactionErrors = {
   maxGasAmount?: string;
   gasUnitPrice?: string;
 };
 
 export type Transaction = TransactionCommon & {
-  mode: string;
   family: "aptos";
+  mode: string;
   fees?: BigNumber | null;
   options: TransactionOptions;
   errors?: TransactionErrors;
@@ -87,6 +90,101 @@ export type AptosMoveResource = {
   [key: string]: AptosMoveResourceData;
 };
 
+export type AptosOperationExtra = {
+  stake?: ExtraStakeInfo;
+};
+
+export type ExtraStakeInfo = {
+  address: string;
+  amount: BigNumber;
+};
+
+export type AptosOperationExtraRaw = {
+  stake?: ExtraStakeInfoRaw;
+};
+
+export type ExtraStakeInfoRaw = {
+  address: string;
+  amount: string;
+};
+
+export type AptosResources = {
+  activeBalance: BigNumber;
+  inactiveBalance: BigNumber;
+  pendingInactiveBalance: BigNumber;
+  stakingPositions: AptosStakingPosition[];
+};
+
+export type AptosResourcesRaw = {
+  activeBalance: string;
+  pendingInactiveBalance: string;
+  inactiveBalance: string;
+  stakingPositions: {
+    active: string;
+    pendingInactive: string;
+    inactive: string;
+    validatorId: string;
+  }[];
+};
+
+export type AptosStakingPosition = {
+  active: BigNumber;
+  inactive: BigNumber;
+  pendingInactive: BigNumber;
+  validatorId: string;
+};
+
+export type AptosMappedStakingPosition = AptosStakingPosition & {
+  formattedAmount: string;
+  formattedPending: string;
+  formattedAvailable: string;
+  rank: number;
+  validator: AptosValidator | null | undefined;
+};
+
+export type AptosValidator = {
+  activeStake: BigNumber;
+  commission: BigNumber;
+  address: string;
+  name?: string | undefined;
+  shares: string;
+  avatarUrl?: string | undefined;
+  wwwUrl?: string | undefined;
+  nextUnlockTime?: string | undefined;
+};
+
+export type AptosValidatorRaw = {
+  active_stake?: number | null;
+  commission?: number | null;
+  addr?: string | null;
+  name?: string | null;
+  shares: string;
+  avatar_url?: string | null;
+  www_url?: string | null;
+  nextUnlockTime?: string | undefined;
+};
+
+export type AptosValidatorWithMeta = {
+  validator: AptosValidator;
+  meta: {
+    name?: string;
+    img?: string;
+  };
+};
+
+export type AptosPreloadData = {
+  validatorsWithMeta: AptosValidatorWithMeta[];
+  validators: AptosValidator[];
+};
+
+export interface TransactionOptions {
+  maxGasAmount: string;
+  gasUnitPrice: string;
+}
+
+export interface StakePoolResource {
+  locked_until_secs: string;
+}
 export type AptosBalance = {
   contractAddress: string;
   amount: BigNumber;