@bitgo-beta/sdk-coin-hbar 1.0.2-beta.234 → 1.0.2-beta.2340

package/dist/src/hbar.d.ts

@@ -1,9 +1,9 @@
-/// <reference types="node" />
 /**
  * @prettier
  */
 import { CoinFamily, BaseCoin as StaticsBaseCoin } from '@bitgo-beta/statics';
-import { BaseCoin, BitGoBase, KeyPair, ParsedTransaction, ParseTransactionOptions, SignedTransaction, SignTransactionOptions, VerifyAddressOptions as BaseVerifyAddressOptions, VerifyTransactionOptions, TransactionFee, TransactionRecipient as Recipient, TransactionPrebuild as BaseTransactionPrebuild, TransactionExplanation, Memo, TokenEnablementConfig } from '@bitgo-beta/sdk-core';
+import { BaseCoin, BitGoBase, ExternalEd25519Signature, KeyPair, ParsedTransaction, ParseTransactionOptions, SignedTransaction, SignTransactionOptions, VerifyAddressOptions as BaseVerifyAddressOptions, VerifyTransactionOptions, TransactionFee, TransactionRecipient as Recipient, TransactionPrebuild as BaseTransactionPrebuild, TransactionExplanation, Memo, TokenEnablementConfig, BaseBroadcastTransactionOptions, BaseBroadcastTransactionResult, MultisigType, AuditDecryptedKeyParams } from '@bitgo-beta/sdk-core';
+import { Client, Transaction as HbarTransaction, AccountBalanceJson } from '@hashgraph/sdk';
 export interface HbarSignTransactionOptions extends SignTransactionOptions {
     txPrebuild: TransactionPrebuild;
     prv: string;
@@ -24,7 +24,7 @@ export interface ExplainTransactionOptions {
     halfSigned?: {
         txHex: string;
     };
-    feeInfo: TransactionFee;
+    feeInfo?: TransactionFee;
     memo?: {
         type: string;
         value: string;
@@ -37,6 +37,49 @@ export interface HbarVerifyTransactionOptions extends VerifyTransactionOptions {
 interface VerifyAddressOptions extends BaseVerifyAddressOptions {
     baseAddress: string;
 }
+export interface RecoveryOptions {
+    backupKey: string;
+    userKey: string;
+    rootAddress: string;
+    recoveryDestination: string;
+    bitgoKey?: string;
+    walletPassphrase?: string;
+    maxFee?: string;
+    nodeId?: string;
+    startTime?: string;
+    tokenId?: string;
+    /** Optional pre-made signature for the backup child, whose signature must be over the transaction body bytes (`bodyBytes`). */
+    externalBackupSignature?: ExternalEd25519Signature;
+}
+export interface RecoveryInfo {
+    id: string;
+    tx: string;
+    coin: string;
+    startTime: string;
+    nodeId: string;
+}
+export interface OfflineVaultTxInfo {
+    txHex: string;
+    userKey: string;
+    backupKey: string;
+    bitgoKey?: string;
+    address: string;
+    coin: string;
+    maxFee: string;
+    recipients: Recipient[];
+    amount: string;
+    startTime: string;
+    validDuration: string;
+    nodeId: string;
+    memo: string;
+    json?: any;
+}
+export interface BroadcastTransactionOptions extends BaseBroadcastTransactionOptions {
+    startTime?: string;
+}
+export interface BroadcastTransactionResult extends BaseBroadcastTransactionResult {
+    status?: string;
+}
 export declare class Hbar extends BaseCoin {
     protected readonly _staticsCoin: Readonly<StaticsBaseCoin>;
     constructor(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>);
@@ -55,13 +98,15 @@ export declare class Hbar extends BaseCoin {
      * @param address
      */
     isValidAddress(address: string): boolean;
-    /**
-     * Generate Hedera Hashgraph key pair
-     *
-     * @param seed
-     * @returns {Object} object with generated pub, prv
-     */
+    /** inheritdoc */
+    deriveKeyWithSeed(): {
+        derivationPath: string;
+        key: string;
+    };
+    /** inheritdoc */
     generateKeyPair(seed?: Buffer): KeyPair;
+    /** inheritdoc */
+    generateRootKeyPair(seed?: Buffer): KeyPair;
     parseTransaction(params: ParseTransactionOptions): Promise<ParsedTransaction>;
     /**
      * Check if address is valid, then make sure it matches the base address.
@@ -71,6 +116,23 @@ export declare class Hbar extends BaseCoin {
      * @param {String} params.baseAddress - the base address from the wallet
      */
     isWalletAddress(params: VerifyAddressOptions): Promise<boolean>;
+    /**
+     * Verify a token enablement transaction with strict validation
+     * @param txHex - The transaction hex to verify
+     * @param expectedToken - Object containing tokenId (preferred) or tokenName
+     * @param expectedAccountId - The expected account ID that will enable the token
+     * @throws Error if the transaction is not a valid token enablement transaction
+     */
+    verifyTokenEnablementTransaction(txHex: string, expectedToken: {
+        tokenId?: string;
+        tokenName?: string;
+    }, expectedAccountId: string): Promise<void>;
+    private validateTxStructureStrict;
+    private validateNoTransfers;
+    private validateAccountIdMatches;
+    private validateTokenEnablementTarget;
+    private validateTxHexAgainstExpected;
+    private validateAssociateInstructionOnly;
     verifyTransaction(params: HbarVerifyTransactionOptions): Promise<boolean>;
     /**
      * Assemble keychain and half-sign prebuilt transaction
@@ -78,7 +140,6 @@ export declare class Hbar extends BaseCoin {
      * @param params
      * @param params.txPrebuild {Object} prebuild object returned by platform
      * @param params.prv {String} user prv
-     * @param params.wallet.addressVersion {String} this is the version of the Algorand multisig address generation format
      * @returns Promise<SignedTransaction>
      */
     signTransaction(params: HbarSignTransactionOptions): Promise<SignedTransaction>;
@@ -98,7 +159,7 @@ export declare class Hbar extends BaseCoin {
      * 3) Send signed build - send our signed build to a public node
      * @param params
      */
-    recover(params: any): Promise<any>;
+    recover(params: RecoveryOptions): Promise<RecoveryInfo | OfflineVaultTxInfo>;
     /**
      * Explain a Hedera transaction from txHex
      * @param params
@@ -107,8 +168,33 @@ export declare class Hbar extends BaseCoin {
     isStellarSeed(seed: string): boolean;
     convertFromStellarSeed(seed: string): string | null;
     isValidPub(pub: string): boolean;
+    supportsDeriveKeyWithSeed(): boolean;
+    /** inherited doc */
+    getDefaultMultisigType(): MultisigType;
     getTokenEnablementConfig(): TokenEnablementConfig;
     private getBuilderFactory;
+    private getHbarClient;
+    /**
+     * Fetches the flattened set of ed25519 public keys controlling an account, via the Hedera mirror node.
+     * Returns raw (non-DER) lowercase hex keys for ed25519 keys (single key, key list or threshold key).
+     * Account keys of other types (e.g. ECDSA_secp256k1) are rejected, so recovery of such accounts
+     * fails closed with an explicit error rather than a misleading key mismatch.
+     * Uses the free mirror-node REST API because the SDK's AccountInfoQuery is a paid query,
+     * and recovery runs with an operator-less client that cannot pay.
+     */
+    getAccountKeys(accountId: string): Promise<string[]>;
+    /**
+     * Flattens a protobuf Key (single ed25519 / keyList / thresholdKey) into raw ed25519 hex keys
+     */
+    private static collectEd25519Keys;
+    getAccountBalance(accountId: string, client: Client): Promise<AccountBalanceJson>;
+    broadcastTransaction({ serializedSignedTransaction, startTime, }: BroadcastTransactionOptions): Promise<BroadcastTransactionResult>;
+    clientBroadcastTransaction(hbarTx: HbarTransaction): Promise<{
+        txId: string;
+        status: string;
+    }>;
+    /** @inheritDoc */
+    auditDecryptedKey({ prv, publicKey, multiSigType }: AuditDecryptedKeyParams): void;
 }
 export {};
 //# sourceMappingURL=hbar.d.ts.map

package/dist/src/hbar.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hbar.d.ts","sourceRoot":"","sources":["../../src/hbar.ts"],"names":[],"mappings":";AAAA;;GAEG;AACH,OAAO,EAAE,UAAU,EAAE,QAAQ,IAAI,eAAe,EAAS,MAAM,qBAAqB,CAAC;AACrF,OAAO,EACL,QAAQ,EACR,SAAS,EACT,OAAO,EAEP,iBAAiB,EACjB,uBAAuB,EACvB,iBAAiB,EACjB,sBAAsB,EACtB,oBAAoB,IAAI,wBAAwB,EAChD,wBAAwB,EACxB,cAAc,EACd,oBAAoB,IAAI,SAAS,EACjC,mBAAmB,IAAI,uBAAuB,EAC9C,sBAAsB,EACtB,IAAI,EACJ,qBAAqB,EACtB,MAAM,sBAAsB,CAAC;AAQ9B,MAAM,WAAW,0BAA2B,SAAQ,sBAAsB;IACxE,UAAU,EAAE,mBAAmB,CAAC;IAChC,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,MAAM;IACrB,UAAU,EAAE,SAAS,EAAE,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,mBAAoB,SAAQ,uBAAuB;IAClE,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,cAAc,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,yBAAyB;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE;QACX,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;IACF,OAAO,EAAE,cAAc,CAAC;IAExB,IAAI,CAAC,EAAE;QACL,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED,MAAM,WAAW,4BAA6B,SAAQ,wBAAwB;IAC5E,UAAU,EAAE,mBAAmB,CAAC;IAChC,IAAI,CAAC,EAAE,IAAI,CAAC;CACb;AAED,UAAU,oBAAqB,SAAQ,wBAAwB;IAC7D,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,qBAAa,IAAK,SAAQ,QAAQ;IAChC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;gBAE/C,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC;IAUrE,QAAQ;IAIR,SAAS,IAAI,UAAU;IAIvB,WAAW;IAIX,aAAa;IAIb,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC,GAAG,QAAQ;IAI1F;;;OAGG;IACH,wBAAwB,IAAI,OAAO;IAInC;;;OAGG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAQxC;;;;;OAKG;IACH,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO;IAcjC,gBAAgB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAInF;;;;;;OAMG;IACG,eAAe,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAK/D,iBAAiB,CAAC,MAAM,EAAE,4BAA4B,GAAG,OAAO,CAAC,OAAO,CAAC;IA8C/E;;;;;;;;OAQG;IACG,eAAe,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAiBrF;;;;;;OAMG;IACG,WAAW,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAM1E;;;;;;;OAOG;IACG,OAAO,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxC;;;OAGG;IACG,kBAAkB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAoF5F,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAIpC,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAiBnD,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIzB,wBAAwB,IAAI,qBAAqB;IAOxD,OAAO,CAAC,iBAAiB;CAG1B"}
+{"version":3,"file":"hbar.d.ts","sourceRoot":"","sources":["../../src/hbar.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,UAAU,EAAE,QAAQ,IAAI,eAAe,EAAS,MAAM,qBAAqB,CAAC;AACrF,OAAO,EACL,QAAQ,EACR,SAAS,EAGT,wBAAwB,EACxB,OAAO,EACP,iBAAiB,EACjB,uBAAuB,EAEvB,iBAAiB,EACjB,sBAAsB,EACtB,oBAAoB,IAAI,wBAAwB,EAChD,wBAAwB,EACxB,cAAc,EACd,oBAAoB,IAAI,SAAS,EACjC,mBAAmB,IAAI,uBAAuB,EAC9C,sBAAsB,EACtB,IAAI,EACJ,qBAAqB,EACrB,+BAA+B,EAC/B,8BAA8B,EAE9B,YAAY,EAEZ,uBAAuB,EAGxB,MAAM,sBAAsB,CAAC;AAQ9B,OAAO,EACL,MAAM,EACN,WAAW,IAAI,eAAe,EAE9B,kBAAkB,EAGnB,MAAM,gBAAgB,CAAC;AA4BxB,MAAM,WAAW,0BAA2B,SAAQ,sBAAsB;IACxE,UAAU,EAAE,mBAAmB,CAAC;IAChC,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,MAAM;IACrB,UAAU,EAAE,SAAS,EAAE,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,mBAAoB,SAAQ,uBAAuB;IAClE,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,cAAc,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,yBAAyB;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE;QACX,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;IACF,OAAO,CAAC,EAAE,cAAc,CAAC;IAEzB,IAAI,CAAC,EAAE;QACL,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED,MAAM,WAAW,4BAA6B,SAAQ,wBAAwB;IAC5E,UAAU,EAAE,mBAAmB,CAAC;IAChC,IAAI,CAAC,EAAE,IAAI,CAAC;CACb;AAED,UAAU,oBAAqB,SAAQ,wBAAwB;IAC7D,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,+HAA+H;IAC/H,uBAAuB,CAAC,EAAE,wBAAwB,CAAC;CACpD;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,SAAS,EAAE,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,GAAG,CAAC;CACZ;AAED,MAAM,WAAW,2BAA4B,SAAQ,+BAA+B;IAClF,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,0BAA2B,SAAQ,8BAA8B;IAChF,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,qBAAa,IAAK,SAAQ,QAAQ;IAChC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;gBAE/C,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC;IAUrE,QAAQ;IAIR,SAAS,IAAI,UAAU;IAIvB,WAAW;IAIX,aAAa;IAIb,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC,GAAG,QAAQ;IAI1F;;;OAGG;IACH,wBAAwB,IAAI,OAAO;IAInC;;;OAGG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAQxC,iBAAiB;IACjB,iBAAiB,IAAI;QAAE,cAAc,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE;IAI5D,iBAAiB;IACjB,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO;IAcvC,iBAAiB;IACjB,mBAAmB,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO;IASrC,gBAAgB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAInF;;;;;;OAMG;IACG,eAAe,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAKrE;;;;;;OAMG;IACG,gCAAgC,CACpC,KAAK,EAAE,MAAM,EACb,aAAa,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,EACvD,iBAAiB,EAAE,MAAM,GACxB,OAAO,CAAC,IAAI,CAAC;IA2BhB,OAAO,CAAC,yBAAyB;IAajC,OAAO,CAAC,mBAAmB;IAe3B,OAAO,CAAC,wBAAwB;IAwBhC,OAAO,CAAC,6BAA6B;IAoCrC,OAAO,CAAC,4BAA4B;IA8CpC,OAAO,CAAC,gCAAgC;IAoBlC,iBAAiB,CAAC,MAAM,EAAE,4BAA4B,GAAG,OAAO,CAAC,OAAO,CAAC;IAmE/E;;;;;;;OAOG;IACG,eAAe,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAiBrF;;;;;;OAMG;IACG,WAAW,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAM1E;;;;;;;OAOG;IACU,OAAO,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,GAAG,kBAAkB,CAAC;IAmLzF;;;OAGG;IACG,kBAAkB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAyF5F,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAIpC,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAiBnD,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIhC,yBAAyB,IAAI,OAAO;IAIpC,oBAAoB;IACpB,sBAAsB,IAAI,YAAY;IAI/B,wBAAwB,IAAI,qBAAqB;IAOxD,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,aAAa;IAKrB;;;;;;;OAOG;IACG,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IA2B1D;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAS3B,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAUjF,oBAAoB,CAAC,EACzB,2BAA2B,EAC3B,SAAS,GACV,EAAE,2BAA2B,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAiB9D,0BAA0B,CAAC,MAAM,EAAE,eAAe;;;;IAQxD,kBAAkB;IAClB,iBAAiB,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,YAAY,EAAE,EAAE,uBAAuB;CAiB5E"}