@arcium-hq/client 0.8.3 → 0.8.5

package/build/index.d.ts

@@ -456,7 +456,7 @@ type Arcium = {
     "address": "Arcj82pX7HxYKLR92qvgZUAd7vGS1k4hQvAFcPATFdEQ";
     "metadata": {
         "name": "arcium";
-        "version": "0.8.3";
+        "version": "0.8.5";
         "spec": "0.1.0";
         "description": "The Arcium program";
     };
@@ -5113,6 +5113,85 @@ type Arcium = {
                 }
             ];
         },
+        {
+            "name": "initRecoveryPeerAccount";
+            "discriminator": [
+                116,
+                29,
+                20,
+                126,
+                177,
+                149,
+                50,
+                147
+            ];
+            "accounts": [
+                {
+                    "name": "signer";
+                    "writable": true;
+                    "signer": true;
+                },
+                {
+                    "name": "recoveryPeerAccount";
+                    "writable": true;
+                    "pda": {
+                        "seeds": [
+                            {
+                                "kind": "const";
+                                "value": [
+                                    82,
+                                    101,
+                                    99,
+                                    111,
+                                    118,
+                                    101,
+                                    114,
+                                    121,
+                                    80,
+                                    101,
+                                    101,
+                                    114,
+                                    65,
+                                    99,
+                                    99,
+                                    111,
+                                    117,
+                                    110,
+                                    116
+                                ];
+                            },
+                            {
+                                "kind": "arg";
+                                "path": "peerOffset";
+                            }
+                        ];
+                    };
+                },
+                {
+                    "name": "systemProgram";
+                    "address": "11111111111111111111111111111111";
+                }
+            ];
+            "args": [
+                {
+                    "name": "peerOffset";
+                    "type": "u32";
+                },
+                {
+                    "name": "authority";
+                    "type": "pubkey";
+                },
+                {
+                    "name": "x25519Pubkey";
+                    "type": {
+                        "array": [
+                            "u8",
+                            32
+                        ];
+                    };
+                }
+            ];
+        },
         {
             "name": "joinCluster";
             "discriminator": [
@@ -7485,29 +7564,41 @@ type Arcium = {
             ];
             "accounts": [
                 {
-                    "name": "nodeSigner";
+                    "name": "signer";
                     "writable": true;
                     "signer": true;
                 },
                 {
-                    "name": "node";
+                    "name": "recoveryPeerAccount";
                     "pda": {
                         "seeds": [
                             {
                                 "kind": "const";
                                 "value": [
-                                    65,
+                                    82,
+                                    101,
+                                    99,
+                                    111,
+                                    118,
+                                    101,
                                     114,
-                                    120,
-                                    78,
+                                    121,
+                                    80,
+                                    101,
+                                    101,
+                                    114,
+                                    65,
+                                    99,
+                                    99,
                                     111,
-                                    100,
-                                    101
+                                    117,
+                                    110,
+                                    116
                                 ];
                             },
                             {
                                 "kind": "arg";
-                                "path": "nodeOffset";
+                                "path": "peerOffset";
                             }
                         ];
                     };
@@ -7632,7 +7723,7 @@ type Arcium = {
                     "type": "pubkey";
                 },
                 {
-                    "name": "nodeOffset";
+                    "name": "peerOffset";
                     "type": "u32";
                 },
                 {
@@ -8156,6 +8247,19 @@ type Arcium = {
                 183
             ];
         },
+        {
+            "name": "recoveryPeerAccount";
+            "discriminator": [
+                126,
+                243,
+                17,
+                238,
+                223,
+                222,
+                130,
+                120
+            ];
+        },
         {
             "name": "smallExecPool";
             "discriminator": [
@@ -9127,7 +9231,7 @@ type Arcium = {
                     {
                         "name": "x25519Pubkey";
                         "docs": [
-                            "X25519 public key for usage when being a key recovery peer. MUST BE AT byte index 8 - 40"
+                            "X25519 public key. MUST BE AT byte index 8 - 40"
                         ];
                         "type": {
                             "array": [
@@ -10734,7 +10838,7 @@ type Arcium = {
                     {
                         "name": "ip";
                         "docs": [
-                            "[Ipv4Addr], represented by it's 4 octects"
+                            "`Ipv4Addr`, represented by its 4 octets"
                         ];
                         "type": {
                             "array": [
@@ -11149,6 +11253,38 @@ type Arcium = {
                 ];
             };
         },
+        {
+            "name": "recoveryPeerAccount";
+            "serialization": "bytemuck";
+            "repr": {
+                "kind": "c";
+            };
+            "type": {
+                "kind": "struct";
+                "fields": [
+                    {
+                        "name": "authority";
+                        "type": "pubkey";
+                    },
+                    {
+                        "name": "x25519Pubkey";
+                        "docs": [
+                            "DO NOT PUT ANYTHING ELSE BEFORE THE X25519_PUBKEY FIELD, IT'S EXPECTED TO BE AT OFFSET 40."
+                        ];
+                        "type": {
+                            "array": [
+                                "u8",
+                                32
+                            ];
+                        };
+                    },
+                    {
+                        "name": "bump";
+                        "type": "u8";
+                    }
+                ];
+            };
+        },
         {
             "name": "setUnset";
             "docs": [
@@ -11696,17 +11832,17 @@ interface MempoolPriorityFeeStats {
  */
 declare function getMempoolPriorityFeeStats(arciumProgram: anchor.Program<Arcium>, mempoolAddress: PublicKey): Promise<MempoolPriorityFeeStats>;
 /**
- * Fetches and extracts the MXE x25519 public key from the MXE account.
+ * Fetches and extracts the MXE X25519 public key from the MXE account.
  * @param provider - The Anchor provider to use for fetching accounts.
  * @param mxeProgramId - The public key of the MXE program.
- * @returns The MXE's x25519 public key as a Uint8Array, or null if not set.
+ * @returns The MXE's X25519 public key as a Uint8Array, or null if not set.
  */
 declare function getMXEPublicKey(provider: AnchorProvider, mxeProgramId: anchor.web3.PublicKey): Promise<Uint8Array | null>;
 /**
- * Fetches and extracts the MXE arcis ed25519 verifying key from the MXE account.
+ * Fetches and extracts the MXE arcis Ed25519 verifying key from the MXE account.
  * @param provider - The Anchor provider to use for fetching accounts.
  * @param mxeProgramId - The public key of the MXE program.
- * @returns The MXE's arcis ed25519 verifying key as a Uint8Array, or null if not set.
+ * @returns The MXE's arcis Ed25519 verifying key as a Uint8Array, or null if not set.
  */
 declare function getMXEArcisEd25519VerifyingKey(provider: AnchorProvider, mxeProgramId: anchor.web3.PublicKey): Promise<Uint8Array | null>;
 /**
@@ -11731,7 +11867,7 @@ declare function getCircuitState(circuitSource: CircuitSource): CircuitState;
  * @param chunkSize - The number of upload transactions to send in parallel (default: 500).
  * @returns An array of transaction signatures for all upload and finalize transactions.
  */
-declare function uploadCircuit(provider: AnchorProvider, circuitName: string, mxeProgramId: anchor.web3.PublicKey, rawCircuit: Uint8Array, logging?: boolean, chunkSize?: number): Promise<string[]>;
+declare function uploadCircuit(provider: AnchorProvider, circuitName: string, mxeProgramId: anchor.web3.PublicKey, rawCircuit: Uint8Array, logging?: boolean, chunkSize?: number, confirmOptions?: ConfirmOptions): Promise<string[]>;
 declare function queueKeyRecoveryInit(provider: AnchorProvider, clusterOffset: number, mxeProgramId: anchor.web3.PublicKey, confirmOptions?: ConfirmOptions): Promise<string[]>;
 /**
  * Builds a transaction to finalize a computation definition.
@@ -11765,7 +11901,7 @@ declare function getArciumProgram(provider: AnchorProvider): Program<Arcium>;
  * @param mxeProgramId - The public key of the MXE program to recover.
  * @returns The transaction signature.
  */
-declare function recoverMxe(provider: AnchorProvider, mxeProgramId: anchor.web3.PublicKey): Promise<string>;
+declare function recoverMxe(provider: AnchorProvider, mxeProgramId: anchor.web3.PublicKey, confirmOptions?: ConfirmOptions): Promise<string>;
 /**
  * Initializes key recovery execution by creating the MxeRecoveryAccount and
  * registering the key_recovery_final computation definition on the backup MXE.
@@ -11775,20 +11911,20 @@ declare function recoverMxe(provider: AnchorProvider, mxeProgramId: anchor.web3.
  * @param backupMxeProgramId - The public key of the backup MXE program that will take over.
  * @returns The transaction signature from part2.
  */
-declare function initKeyRecoveryExecution(provider: AnchorProvider, originalMxeProgramId: anchor.web3.PublicKey, backupMxeProgramId: anchor.web3.PublicKey): Promise<string>;
+declare function initKeyRecoveryExecution(provider: AnchorProvider, originalMxeProgramId: anchor.web3.PublicKey, backupMxeProgramId: anchor.web3.PublicKey, confirmOptions?: ConfirmOptions): Promise<string>;
 /**
  * Submits a re-encrypted key recovery share from a recovery peer.
- * Recovery peers must decrypt shares using their X25519 private key and re-encrypt
+ * Recovery peers must decrypt shares using their x25519 private key and re-encrypt
  * them for the backup MXE before submission.
  * @param provider - The Anchor provider to use for transactions.
  * @param originalMxeProgramId - The public key of the original MXE program being recovered.
  * @param backupMxeProgramId - The public key of the backup MXE program.
- * @param nodeOffset - The ARX node offset of the recovery peer.
+ * @param peerOffset - The offset of the recovery peer.
  * @param peerIndex - The index of this peer in the recovery peers list.
  * @param share - The re-encrypted share: 5 field elements of 32 bytes each (160 bytes total).
  * @returns The transaction signature.
  */
-declare function submitKeyRecoveryShare(provider: AnchorProvider, originalMxeProgramId: anchor.web3.PublicKey, backupMxeProgramId: anchor.web3.PublicKey, nodeOffset: number, peerIndex: number, share: number[][] | Uint8Array[]): Promise<string>;
+declare function submitKeyRecoveryShare(provider: AnchorProvider, originalMxeProgramId: anchor.web3.PublicKey, backupMxeProgramId: anchor.web3.PublicKey, peerOffset: number, peerIndex: number, share: number[][] | Uint8Array[], confirmOptions?: ConfirmOptions): Promise<string>;
 /**
  * Finalizes key recovery execution after the submission threshold is met.
  * This queues the key_recovery_finalize MPC computation on the backup cluster.
@@ -11799,7 +11935,7 @@ declare function submitKeyRecoveryShare(provider: AnchorProvider, originalMxePro
  * @param keyRecoveryFinalizeOffset - The computation offset for the key_recovery_finalize computation.
  * @returns The transaction signature.
  */
-declare function finalizeKeyRecoveryExecution(provider: AnchorProvider, originalMxeProgramId: anchor.web3.PublicKey, backupMxeProgramId: anchor.web3.PublicKey, clusterOffset: number, keyRecoveryFinalizeOffset: anchor.BN): Promise<string>;
+declare function finalizeKeyRecoveryExecution(provider: AnchorProvider, originalMxeProgramId: anchor.web3.PublicKey, backupMxeProgramId: anchor.web3.PublicKey, clusterOffset: number, keyRecoveryFinalizeOffset: anchor.BN, confirmOptions?: ConfirmOptions): Promise<string>;
 /**
  * Initializes an MXE (part 1). Due to Solana's 10KB per-instruction allocation limit,
  * this only partially allocates recovery_cluster_acc.
@@ -11808,7 +11944,7 @@ declare function finalizeKeyRecoveryExecution(provider: AnchorProvider, original
  * @param mxeProgramId - The public key to use as the MXE program ID.
  * @returns The transaction signature.
  */
-declare function initMxePart1(provider: AnchorProvider, mxeProgramId: anchor.web3.PublicKey): Promise<string>;
+declare function initMxePart1(provider: AnchorProvider, mxeProgramId: anchor.web3.PublicKey, confirmOptions?: ConfirmOptions): Promise<string>;
 /**
  * Finishes MXE initialization (part 2).
  * Reallocates recovery_cluster_acc to full size, initializes recovery_peers,
@@ -11822,7 +11958,7 @@ declare function initMxePart1(provider: AnchorProvider, mxeProgramId: anchor.web
  * @param mxeAuthority - Optional authority for the MXE (defaults to provider.publicKey).
  * @returns The transaction signature.
  */
-declare function initMxePart2(provider: AnchorProvider, clusterOffset: number, mxeProgramId: anchor.web3.PublicKey, recoveryPeers: number[], keygenOffset: anchor.BN, keyRecoveryInitOffset: anchor.BN, lutOffset: anchor.BN, mxeAuthority?: anchor.web3.PublicKey): Promise<string>;
+declare function initMxePart2(provider: AnchorProvider, clusterOffset: number, mxeProgramId: anchor.web3.PublicKey, recoveryPeers: number[], keygenOffset: anchor.BN, keyRecoveryInitOffset: anchor.BN, lutOffset: anchor.BN, mxeAuthority?: anchor.web3.PublicKey, confirmOptions?: ConfirmOptions): Promise<string>;
 
 /**
  * Structure representing the local Arcium environment variables required for local development or testing.
@@ -11839,19 +11975,23 @@ type ArciumLocalEnv = {
 declare function getArciumEnv(): ArciumLocalEnv;
 
 /**
- * Represents possible error messages that can occur during computation processing or transaction handling.
- */
-type ComputationErrorType = `Transaction ${string} not found` | 'Transaction inner instructions not found' | `Transaction failed with error: ${string}` | 'No log messages found' | 'No queue computation instruction found' | `Invalid computation offset: ${string}` | 'Computation not found in executing pool, might have already executed' | `Error fetching transactions: ${string}` | `Instruction at index ${number} not found` | 'Account keys or program ID index not found' | `No Program ID found for instruction at index ${number}` | 'Max retries reached while searching for transaction';
-/**
- * Waits for the finalization of a computation by listening for the finalizeComputationEvent.
- * Resolves with the transaction signature once the computation is finalized.
- * @param provider - The Anchor provider to use for event listening.
- * @param computationOffset - The offset of the computation to wait for.
- * @param mxeProgramId - The public key of the MXE program.
- * @param commitment - (Optional) The desired finality/commitment level (default: 'confirmed').
- * @returns The transaction signature of the finalization event.
+ * Waits for a computation to finalize by polling the computation account
+ * status via HTTP RPC. Does not use WebSocket subscriptions.
+ *
+ * Polls every 500ms (same as Agave's send_and_confirm_transaction_with_config).
+ * Returns the most recent transaction signature on the computation account
+ * once finalization is detected.
+ *
+ * @param provider - The Anchor provider.
+ * @param computationOffset - The computation offset to wait for.
+ * @param mxeProgramId - The MXE program public key.
+ * @param commitment - Commitment level for RPC calls (default: 'confirmed').
+ * @param timeoutMs - Maximum wait time in milliseconds (default: 120000).
+ * @returns The transaction signature from the finalization.
+ * @throws Error if the MXE account has no cluster assigned.
+ * @throws Error if the computation does not finalize within timeoutMs.
  */
-declare function awaitComputationFinalization(provider: AnchorProvider, computationOffset: BN, mxeProgramId: PublicKey, commitment?: Finality): Promise<string>;
+declare function awaitComputationFinalization(provider: AnchorProvider, computationOffset: BN, mxeProgramId: PublicKey, commitment?: Finality, timeoutMs?: number): Promise<string>;
 
 /**
  * Returns the public key of the deployed Arcium program on Solana.
@@ -11941,4 +12081,4 @@ declare function getRawCircuitAccAddress(compDefPubkey: PublicKey, rawCircuitInd
 declare function getLookupTableAddress(mxeProgramId: PublicKey, lutOffset: anchor.BN): PublicKey;
 
 export { ARCIUM_ADDR, ARCIUM_IDL, Aes128Cipher, Aes192Cipher, Aes256Cipher, ArcisModule, ArcisType, ArcisValueField, CSplRescueCipher, CURVE25519_BASE_FIELD, CURVE25519_SCALAR_FIELD, CURVE25519_SCALAR_FIELD_MODULUS, IntegerInfo, Matrix, RescueCipher, RescueDesc, RescuePrimeHash, arcisEd25519, awaitComputationFinalization, buildFinalizeCompDefTx, createPacker, deserializeLE, finalizeKeyRecoveryExecution, generateRandomFieldElem, getArciumAccountBaseSeed, getArciumEnv, getArciumProgram, getArciumProgramId, getArxNodeAccAddress, getCircuitState, getClockAccAddress, getClusterAccAddress, getCompDefAccAddress, getCompDefAccOffset, getComputationAccAddress, getComputationsInMempool, getExecutingPoolAccAddress, getExecutingPoolAccInfo, getFeePoolAccAddress, getLookupTableAddress, getMXEAccAddress, getMXEArcisEd25519VerifyingKey, getMXEPublicKey, getMempoolAccAddress, getMempoolAccInfo, getMempoolPriorityFeeStats, getMxeRecoveryAccAddress, getRawCircuitAccAddress, getRecoveryClusterAccAddress, initKeyRecoveryExecution, initMxePart1, initMxePart2, isNullRef, positiveModulo, queueKeyRecoveryInit, randMatrix, recoverMxe, serializeLE, sha256, submitKeyRecoveryShare, toVec, uploadCircuit };
-export type { Arcium as ArciumIdlType, ArciumLocalEnv, CircuitSource, CircuitState, ComputationErrorType, ComputationReference, ExecutingPoolAccount, FieldInfo, FpField, MempoolAccount, MempoolPriorityFeeStats, Packer };
+export type { Arcium as ArciumIdlType, ArciumLocalEnv, CircuitSource, CircuitState, ComputationReference, ExecutingPoolAccount, FieldInfo, FpField, MempoolAccount, MempoolPriorityFeeStats, Packer };