feat: add icp staking flow

Ticket: SC-1970

Author: Gautam2305

modules/sdk-coin-icp/src/lib/icpAgent.ts

@@ -1,7 +1,19 @@
 import { Principal } from '@dfinity/principal';
 import { HttpAgent, replica, AgentCanister } from 'ic0';
 import utils from './utils';
-import { ACCOUNT_BALANCE_CALL, LEDGER_CANISTER_ID, ICRC1_FEE_KEY, METADATA_CALL, DEFAULT_SUBACCOUNT } from './iface';
+import {
+  ACCOUNT_BALANCE_CALL,
+  LEDGER_CANISTER_ID,
+  GOVERNANCE_CANISTER_ID,
+  ICRC1_FEE_KEY,
+  METADATA_CALL,
+  DEFAULT_SUBACCOUNT,
+  NeuronInfo,
+  ProposalInfo,
+  ClaimNeuronParams,
+  SetFolloweesParams,
+  DissolveDelayParams,
+} from './iface';
 import BigNumber from 'bignumber.js';
 
 export class IcpAgent {
@@ -38,6 +50,17 @@ export class IcpAgent {
     return ic(Principal.fromUint8Array(LEDGER_CANISTER_ID).toText());
   }
 
+  /**
+   * Retrieves an instance of the governance canister agent.
+   *
+   * @returns {AgentCanister} An agent interface for interacting with the governance canister.
+   */
+  private getGovernanceCanister(): AgentCanister {
+    const agent = this.createAgent();
+    const ic = replica(agent, { local: true });
+    return ic(Principal.fromUint8Array(GOVERNANCE_CANISTER_ID).toText());
+  }
+
   /**
    * Fetches the account balance for a given principal ID.
    * @param principalId - The principal ID of the account.
@@ -87,4 +110,92 @@ export class IcpAgent {
       throw new Error(`Error fetching transaction fee: ${errorMessage}`);
     }
   }
+
+  /**
+   * Claims or refreshes a neuron from an account.
+   *
+   * @param {ClaimNeuronParams} params - Parameters for claiming the neuron
+   * @returns {Promise<bigint>} The neuron ID of the claimed neuron
+   * @throws {Error} If the neuron cannot be claimed
+   */
+  public async claimNeuron(params: ClaimNeuronParams): Promise<bigint> {
+    try {
+      const governance = this.getGovernanceCanister();
+      const result = await governance.call('claim_or_refresh_neuron_from_account', params);
+      return BigInt(result.neuron_id);
+    } catch (error) {
+      const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+      throw new Error(`Error claiming neuron: ${errorMessage}`);
+    }
+  }
+
+  /**
+   * Retrieves detailed information about a neuron.
+   *
+   * @param {bigint} neuronId - The ID of the neuron to query
+   * @returns {Promise<NeuronInfo>} Detailed information about the neuron
+   * @throws {Error} If the neuron information cannot be retrieved
+   */
+  public async getNeuronInfo(neuronId: bigint): Promise<NeuronInfo> {
+    try {
+      const governance = this.getGovernanceCanister();
+      const result = await governance.call('get_neuron_info', { neuron_id: neuronId });
+      return result;
+    } catch (error) {
+      const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+      throw new Error(`Error getting neuron info for ${neuronId}: ${errorMessage}`);
+    }
+  }
+
+  /**
+   * Sets the followees for a neuron on a specific topic.
+   *
+   * @param {SetFolloweesParams} params - Parameters for setting followees
+   * @returns {Promise<void>}
+   * @throws {Error} If the followees cannot be set
+   */
+  public async setFollowees(params: SetFolloweesParams): Promise<void> {
+    try {
+      const governance = this.getGovernanceCanister();
+      await governance.call('set_followees', params);
+    } catch (error) {
+      const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+      throw new Error(`Error setting followees for neuron ${params.neuronId}: ${errorMessage}`);
+    }
+  }
+
+  /**
+   * Sets the dissolve delay for a neuron.
+   *
+   * @param {DissolveDelayParams} params - Parameters for setting dissolve delay
+   * @returns {Promise<void>}
+   * @throws {Error} If the dissolve delay cannot be set
+   */
+  public async setDissolveDelay(params: DissolveDelayParams): Promise<void> {
+    try {
+      const governance = this.getGovernanceCanister();
+      await governance.call('set_dissolve_delay', params);
+    } catch (error) {
+      const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+      throw new Error(`Error setting dissolve delay for neuron ${params.neuronId}: ${errorMessage}`);
+    }
+  }
+
+  /**
+   * Retrieves information about a specific proposal.
+   *
+   * @param {bigint} proposalId - The ID of the proposal to query
+   * @returns {Promise<ProposalInfo>} Information about the proposal
+   * @throws {Error} If the proposal information cannot be retrieved
+   */
+  public async getProposal(proposalId: bigint): Promise<ProposalInfo> {
+    try {
+      const governance = this.getGovernanceCanister();
+      const result = await governance.call('get_proposal_info', { proposal_id: proposalId });
+      return result;
+    } catch (error) {
+      const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+      throw new Error(`Error getting proposal info for ${proposalId}: ${errorMessage}`);
+    }
+  }
 }

modules/sdk-coin-icp/src/lib/iface.ts

@@ -2,10 +2,12 @@ import {
   TransactionExplanation as BaseTransactionExplanation,
   TransactionType as BitGoTransactionType,
 } from '@bitgo/sdk-core';
+import { Principal } from '@dfinity/principal';
 
 export const MAX_INGRESS_TTL = 5 * 60 * 1000_000_000; // 5 minutes in nanoseconds
 export const PERMITTED_DRIFT = 60 * 1000_000_000; // 60 seconds in nanoseconds
-export const LEDGER_CANISTER_ID = new Uint8Array([0, 0, 0, 0, 0, 0, 0, 2, 1, 1]); // Uint8Array value for "00000000000000020101" and the string value is "ryjl3-tyaaa-aaaaa-aaaba-cai"
+export const LEDGER_CANISTER_ID = new Uint8Array([0, 0, 0, 0, 0, 0, 0, 2, 1, 1]); // ryjl3-tyaaa-aaaaa-aaaba-cai
+export const GOVERNANCE_CANISTER_ID = new Uint8Array([0, 0, 0, 0, 0, 0, 0, 0, 0, 1]); // rrkah-fqaaa-aaaaa-aaaaq-cai
 export const ROOT_PATH = 'm/0';
 export const ACCOUNT_BALANCE_CALL = 'icrc1_balance_of';
 export const PUBLIC_NODE_REQUEST_ENDPOINT = '/api/v3/canister/';
@@ -39,6 +41,25 @@ export enum Network {
   ID = '00000000000000020101', // ICP does not have different network IDs for mainnet and testnet
 }
 
+export enum Topic {
+  Unspecified = 0,
+  Governance = 1,
+  SnsAndCommunityFund = 2,
+  NetworkEconomics = 3,
+  Node = 4,
+  ParticipantManagement = 5,
+  SubnetManagement = 6,
+  NetworkCanisterManagement = 7,
+  KYC = 8,
+  NodeProviderRewards = 9,
+}
+
+export enum Vote {
+  Unspecified = 0,
+  Yes = 1,
+  No = 2,
+}
+
 export interface IcpTransactionData {
   senderAddress: string;
   receiverAddress: string;
@@ -194,6 +215,37 @@ export interface RecoveryTransaction {
   tx: string;
 }
 
+export enum HotkeyPermission {
+  VOTE = 'VOTE',
+  FOLLOW = 'FOLLOW',
+  DISSOLVE = 'DISSOLVE',
+  CONFIGURE = 'CONFIGURE',
+}
+
+export interface HotkeyStatus {
+  principal: Principal;
+  permissions: HotkeyPermission[];
+  addedAt: number;
+  lastUsed?: number;
+}
+
+export interface FullNeuron {
+  controller: Principal;
+  hotKeys: Principal[];
+  hotkeyDetails?: HotkeyStatus[];
+  dissolveDelaySeconds: number;
+  votingPower: bigint;
+  state: string;
+}
+
+export interface NeuronInfo {
+  neuronId: bigint;
+  fullNeuron?: FullNeuron;
+  dissolveDelaySeconds: number;
+  votingPower: bigint;
+  state: string;
+}
+
 export interface UnsignedSweepRecoveryTransaction {
   txHex: string;
   coin: string;
@@ -211,3 +263,46 @@ export interface TransactionHexParams {
   transactionHex: string;
   signableHex?: string;
 }
+
+export interface NeuronInfo {
+  neuronId: bigint;
+  controller: Principal;
+  dissolveDelaySeconds: number;
+  votingPower: bigint;
+  followees: Record<Topic, bigint[]>;
+  recentBallots: Ballot[];
+  createdTimestamp: number;
+  state: string;
+  stakedAmount: bigint;
+}
+
+export interface Ballot {
+  proposalId: bigint;
+  vote: Vote;
+}
+
+export interface ProposalInfo {
+  proposalId: bigint;
+  title: string;
+  topic: Topic;
+  status: string;
+  summary: string;
+  proposer: Principal;
+  created: number;
+}
+
+export interface ClaimNeuronParams {
+  controller: Principal;
+  memo: bigint;
+}
+
+export interface SetFolloweesParams {
+  neuronId: bigint;
+  topic: Topic;
+  followees: bigint[];
+}
+
+export interface DissolveDelayParams {
+  neuronId: bigint;
+  dissolveDelaySeconds: number;
+}