@zhoujun_aptos/octopus-ts-sdk-min 0.22.6 → 0.22.8

package/dist/common/index.d.ts

@@ -150,12 +150,46 @@ declare function keygen$3(schemeId?: number): DecryptionKey$1;
 declare function deriveEncryptionKey(dk: DecryptionKey$1): EncryptionKey$1;
 declare function encrypt$3(ek: EncryptionKey$1, msg: Uint8Array): Ciphertext$5;
 declare function encryptWithRandomness$2(ek: EncryptionKey$1, msg: Uint8Array, randomness: Uint8Array): Ciphertext$5;
-declare function decrypt$3(dk: DecryptionKey$1, ciphertext: Ciphertext$5): Uint8Array | undefined;
+declare function decrypt$2(dk: DecryptionKey$1, ciphertext: Ciphertext$5): Uint8Array | undefined;
 
 declare const index$5_SCHEME_SIMPLE_ELGAMAL_RISTRETTO255: typeof SCHEME_SIMPLE_ELGAMAL_RISTRETTO255;
 declare const index$5_deriveEncryptionKey: typeof deriveEncryptionKey;
 declare namespace index$5 {
-  export { Ciphertext$5 as Ciphertext, DecryptionKey$1 as DecryptionKey, EncryptionKey$1 as EncryptionKey, index$5_SCHEME_SIMPLE_ELGAMAL_RISTRETTO255 as SCHEME_SIMPLE_ELGAMAL_RISTRETTO255, decrypt$3 as decrypt, index$5_deriveEncryptionKey as deriveEncryptionKey, encrypt$3 as encrypt, encryptWithRandomness$2 as encryptWithRandomness, keygen$3 as keygen };
+  export { Ciphertext$5 as Ciphertext, DecryptionKey$1 as DecryptionKey, EncryptionKey$1 as EncryptionKey, index$5_SCHEME_SIMPLE_ELGAMAL_RISTRETTO255 as SCHEME_SIMPLE_ELGAMAL_RISTRETTO255, decrypt$2 as decrypt, index$5_deriveEncryptionKey as deriveEncryptionKey, encrypt$3 as encrypt, encryptWithRandomness$2 as encryptWithRandomness, keygen$3 as keygen };
+}
+
+declare class Result<T> {
+    isOk: boolean;
+    okValue?: T;
+    errValue?: any;
+    extra?: any;
+    private constructor();
+    static Ok<T>(args: {
+        value: T;
+        extra?: any;
+    }): Result<T>;
+    static Err<T>(args: {
+        error: any;
+        extra?: any;
+    }): Result<T>;
+    /**
+     * You write a closure that either returns a T or throws, and we wrap it to return a Result<T>.
+     * Your closure is also given an `extra` dictionary to record additional context.
+     */
+    static capture<T>({ task, recordsExecutionTimeMs }: {
+        task: (extra: Record<string, any>) => T;
+        recordsExecutionTimeMs: boolean;
+    }): Result<T>;
+    /**
+     * You write an async closure that either returns a T or throws, and we wrap it to return a Result<T>.
+     * Your closure is also given an `extra` dictionary to record additional context.
+     */
+    static captureAsync<T>({ task, recordsExecutionTimeMs }: {
+        task: (extra: Record<string, any>) => Promise<T>;
+        recordsExecutionTimeMs: boolean;
+    }): Promise<Result<T>>;
+    unwrapOrThrow(tothrow: any): T;
+    unwrapErrOrThrow(tothrow: any): any | undefined;
 }
 
 declare const SCHEME_OTP_HAMC_BONEH_FRANKLIN_BLS12381_SHORT_PK = 0;
@@ -208,8 +242,12 @@ declare function derivePublicKey(privateKey: MasterPrivateKey): MasterPublicKey;
 declare function encrypt$2(publicKey: MasterPublicKey, id: Uint8Array, plaintext: Uint8Array): Ciphertext$4;
 /** Do NOT use this, unless you are a maintainer. Use `encrypt` instead. */
 declare function encryptWithRandomness$1(publicKey: MasterPublicKey, id: Uint8Array, plaintext: Uint8Array, randomness: Uint8Array): Ciphertext$4;
+/** @deprecated Use tryExtract instead */
 declare function extract(privateKey: MasterPrivateKey, id: Uint8Array): IdentityPrivateKey;
-declare function decrypt$2(identityKey: IdentityPrivateKey, ciphertext: Ciphertext$4): Uint8Array | undefined;
+declare function tryExtract$1(privateKey: MasterPrivateKey, id: Uint8Array): Result<IdentityPrivateKey>;
+/** @deprecated Use tryDecrypt instead */
+declare function decrypt$1(identityKey: IdentityPrivateKey, ciphertext: Ciphertext$4): Uint8Array | undefined;
+declare function tryDecrypt$2(identityKey: IdentityPrivateKey, ciphertext: Ciphertext$4): Result<Uint8Array>;
 
 type index$4_IdentityPrivateKey = IdentityPrivateKey;
 declare const index$4_IdentityPrivateKey: typeof IdentityPrivateKey;
@@ -221,7 +259,7 @@ declare const index$4_SCHEME_OTP_HAMC_BONEH_FRANKLIN_BLS12381_SHORT_PK: typeof S
 declare const index$4_derivePublicKey: typeof derivePublicKey;
 declare const index$4_extract: typeof extract;
 declare namespace index$4 {
-  export { Ciphertext$4 as Ciphertext, index$4_IdentityPrivateKey as IdentityPrivateKey, index$4_MasterPrivateKey as MasterPrivateKey, index$4_MasterPublicKey as MasterPublicKey, index$4_SCHEME_OTP_HAMC_BONEH_FRANKLIN_BLS12381_SHORT_PK as SCHEME_OTP_HAMC_BONEH_FRANKLIN_BLS12381_SHORT_PK, decrypt$2 as decrypt, index$4_derivePublicKey as derivePublicKey, encrypt$2 as encrypt, encryptWithRandomness$1 as encryptWithRandomness, index$4_extract as extract, keygen$2 as keygen };
+  export { Ciphertext$4 as Ciphertext, index$4_IdentityPrivateKey as IdentityPrivateKey, index$4_MasterPrivateKey as MasterPrivateKey, index$4_MasterPublicKey as MasterPublicKey, index$4_SCHEME_OTP_HAMC_BONEH_FRANKLIN_BLS12381_SHORT_PK as SCHEME_OTP_HAMC_BONEH_FRANKLIN_BLS12381_SHORT_PK, decrypt$1 as decrypt, index$4_derivePublicKey as derivePublicKey, encrypt$2 as encrypt, encryptWithRandomness$1 as encryptWithRandomness, index$4_extract as extract, keygen$2 as keygen, tryDecrypt$2 as tryDecrypt, tryExtract$1 as tryExtract };
 }
 
 declare class SchnorrRistretto255SigningKey {
@@ -325,14 +363,17 @@ declare class Ciphertext$3 {
 declare function keygen(scheme?: number): Key;
 declare function encrypt$1(key: Key, plaintext: Uint8Array): Ciphertext$3;
 declare function encryptWithRandomness(key: Key, plaintext: Uint8Array, randomness: Uint8Array): Ciphertext$3;
-declare function decrypt$1(key: Key, ciphertext: Ciphertext$3): Uint8Array | undefined;
+/** @deprecated Use tryDecrypt instead */
+declare function decrypt(key: Key, ciphertext: Ciphertext$3): Uint8Array | undefined;
+declare function tryDecrypt$1(key: Key, ciphertext: Ciphertext$3): Result<Uint8Array>;
 
 type index$2_Key = Key;
 declare const index$2_Key: typeof Key;
+declare const index$2_decrypt: typeof decrypt;
 declare const index$2_encryptWithRandomness: typeof encryptWithRandomness;
 declare const index$2_keygen: typeof keygen;
 declare namespace index$2 {
-  export { Ciphertext$3 as Ciphertext, index$2_Key as Key, decrypt$1 as decrypt, encrypt$1 as encrypt, index$2_encryptWithRandomness as encryptWithRandomness, index$2_keygen as keygen };
+  export { Ciphertext$3 as Ciphertext, index$2_Key as Key, index$2_decrypt as decrypt, encrypt$1 as encrypt, index$2_encryptWithRandomness as encryptWithRandomness, index$2_keygen as keygen, tryDecrypt$1 as tryDecrypt };
 }
 
 declare class WorkerConfig {
@@ -352,7 +393,9 @@ declare class WorkerConfig {
     toPrettyJson(): string;
 }
 declare function view(aptos: Aptos, worker: AccountAddress): Promise<WorkerConfig>;
+/** @deprecated Use getAsync instead */
 declare function get(workerEndpoint: string): Promise<WorkerConfig>;
+declare function getAsync(workerEndpoint: string): Promise<Result<WorkerConfig>>;
 declare function randWorker(): {
     addr: AccountAddress;
     config: WorkerConfig;
@@ -364,10 +407,11 @@ declare function randWorker(): {
 type worker_config_WorkerConfig = WorkerConfig;
 declare const worker_config_WorkerConfig: typeof WorkerConfig;
 declare const worker_config_get: typeof get;
+declare const worker_config_getAsync: typeof getAsync;
 declare const worker_config_randWorker: typeof randWorker;
 declare const worker_config_view: typeof view;
 declare namespace worker_config {
-  export { worker_config_WorkerConfig as WorkerConfig, worker_config_get as get, worker_config_randWorker as randWorker, worker_config_view as view };
+  export { worker_config_WorkerConfig as WorkerConfig, worker_config_get as get, worker_config_getAsync as getAsync, worker_config_randWorker as randWorker, worker_config_view as view };
 }
 
 /**
@@ -800,7 +844,7 @@ declare class EncryptionKey {
     });
     static fetch({ committee }: {
         committee: Committee;
-    }): Promise<EncryptionKey>;
+    }): Promise<Result<EncryptionKey>>;
 }
 declare class DecryptionKey {
     ibeDecryptionKeys: (IdentityPrivateKey | null)[];
@@ -810,7 +854,8 @@ declare class DecryptionKey {
         contractId: ContractID;
         domain: Uint8Array;
         proof: ProofOfPermission;
-    }): Promise<DecryptionKey>;
+    }): Promise<Result<DecryptionKey>>;
+    private static fetchDecKeyShare;
 }
 declare class Ciphertext {
     aesCiph: Ciphertext$3;
@@ -879,17 +924,17 @@ declare function encrypt({ committee, encryptionKey, contractId, domain, plainte
     fullDecryptionDomain: FullDecryptionDomain;
     ciphertext: Ciphertext;
 };
-declare function decrypt({ decryptionKey, ciphertext }: {
+declare function tryDecrypt({ decryptionKey, ciphertext }: {
     decryptionKey: DecryptionKey;
     ciphertext: Ciphertext;
-}): Uint8Array | undefined;
-declare function verifyAndExtract({ ibeMsk, committee, contractId, domain, proof }: {
+}): Result<Uint8Array>;
+declare function tryExtract({ ibeMsk, committee, contractId, domain, proof }: {
     ibeMsk: MasterPrivateKey;
     committee: Committee;
     contractId: ContractID;
     domain: Uint8Array;
     proof: ProofOfPermission;
-}): Promise<IdentityPrivateKey>;
+}): Promise<Result<IdentityPrivateKey>>;
 
 type index_Ciphertext = Ciphertext;
 declare const index_Ciphertext: typeof Ciphertext;
@@ -905,11 +950,11 @@ type index_FullDecryptionDomain = FullDecryptionDomain;
 declare const index_FullDecryptionDomain: typeof FullDecryptionDomain;
 type index_ProofOfPermission = ProofOfPermission;
 declare const index_ProofOfPermission: typeof ProofOfPermission;
-declare const index_decrypt: typeof decrypt;
 declare const index_encrypt: typeof encrypt;
-declare const index_verifyAndExtract: typeof verifyAndExtract;
+declare const index_tryDecrypt: typeof tryDecrypt;
+declare const index_tryExtract: typeof tryExtract;
 declare namespace index {
-  export { index_Ciphertext as Ciphertext, index_Committee as Committee, index_ContractID as ContractID, index_DecryptionKey as DecryptionKey, index_EncryptionKey as EncryptionKey, index_FullDecryptionDomain as FullDecryptionDomain, index_ProofOfPermission as ProofOfPermission, index_decrypt as decrypt, index_encrypt as encrypt, index_verifyAndExtract as verifyAndExtract };
+  export { index_Ciphertext as Ciphertext, index_Committee as Committee, index_ContractID as ContractID, index_DecryptionKey as DecryptionKey, index_EncryptionKey as EncryptionKey, index_FullDecryptionDomain as FullDecryptionDomain, index_ProofOfPermission as ProofOfPermission, index_encrypt as encrypt, index_tryDecrypt as tryDecrypt, index_tryExtract as tryExtract };
 }
 
 declare const CONTRACT_ADDRESS_HEX: string;
@@ -963,4 +1008,4 @@ declare class WorkerTask {
     };
 }
 
-export { elgamal as ElGamal, index$5 as Enc, group as Group, index$4 as IBE, index$3 as Sig, silent_setup_encryption as SilentSetupEncryption, index$1 as SilentSetupEncryptionXChain, index$2 as Sym, index as ThresholdIbe, utils as Utils, worker_config as WorkerConfig, WorkerTask };
+export { elgamal as ElGamal, index$5 as Enc, group as Group, index$4 as IBE, Result, index$3 as Sig, silent_setup_encryption as SilentSetupEncryption, index$1 as SilentSetupEncryptionXChain, index$2 as Sym, index as ThresholdIbe, utils as Utils, worker_config as WorkerConfig, WorkerTask };