@bitgo-beta/sdk-coin-flrp 1.0.1-beta.7 → 1.0.1-beta.700

package/dist/src/flrp.d.ts

@@ -1,70 +1,115 @@
-import { BaseCoin, BitGoBase, VerifyAddressOptions, ParsedTransaction, ParseTransactionOptions, KeyPair, SignTransactionOptions, SignedTransaction, InitiateRecoveryOptions, SupplementGenerateWalletOptions, KeychainsTriplet, TransactionPrebuild, PresignTransactionOptions, FeeEstimateOptions, DeriveKeyWithSeedOptions, AuditKeyParams, PopulatedIntent, PrebuildTransactionWithIntentOptions, TokenTransferRecipientParams, BuildNftTransferDataOptions, BaseBroadcastTransactionOptions, BaseBroadcastTransactionResult, MPCAlgorithm, Wallet, IInscriptionBuilder, ExtraPrebuildParamsOptions, ValidMofNOptions, VerifyTransactionOptions, ITransactionExplanation, RecoverTokenTransaction, RecoverWalletTokenOptions, PrecreateBitGoOptions, IWallet } from '@bitgo-beta/sdk-core';
 import { BaseCoin as StaticsBaseCoin, CoinFamily } from '@bitgo-beta/statics';
-import { Hash } from 'crypto';
+import { AuditDecryptedKeyParams, BaseCoin, BitGoBase, KeyPair, MPCAlgorithm, MultisigType, ParsedTransaction, ParseTransactionOptions, SignedTransaction, VerifyAddressOptions, ITransactionRecipient, SignableTransaction } from '@bitgo-beta/sdk-core';
+import * as FlrpLib from './lib';
+import { CreatePairedWalletParams, CreatePairedWalletResponse, FlrpEntry, FlrpExplainTransactionOptions, FlrpSignTransactionOptions, FlrpTransactionParams, FlrpVerifyTransactionOptions } from './lib/iface';
 export declare class Flrp extends BaseCoin {
     protected readonly _staticsCoin: Readonly<StaticsBaseCoin>;
-    protected constructor(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>);
+    constructor(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>);
     static createInstance(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>): BaseCoin;
     getChain(): string;
     getFamily(): CoinFamily;
     getFullName(): string;
-    getBaseFactor(): number | string;
+    getBaseFactor(): string | number;
+    /** inherited doc */
+    getDefaultMultisigType(): MultisigType;
+    /** @inheritdoc */
     supportsTss(): boolean;
-    supportsMessageSigning(): boolean;
-    supportsSigningTypedData(): boolean;
-    supportsBlockTarget(): boolean;
-    supportsLightning(): boolean;
-    supportsBlsDkg(): boolean;
-    isEVM(): boolean;
-    generateKeyPair(): KeyPair;
-    generateRootKeyPair(): KeyPair;
-    keyIdsForSigning(): number[];
-    isValidPub(_pub: string): boolean;
-    isValidAddress(_address: string): boolean;
-    isValidMofNSetup(_params: ValidMofNOptions): boolean;
-    canonicalAddress(address: string): string;
-    checkRecipient(_recipient: {
-        address: string;
-        amount: string | number;
-    }): void;
-    verifyAddress(_params: VerifyAddressOptions): Promise<boolean>;
-    isWalletAddress(_params: VerifyAddressOptions): Promise<boolean>;
-    verifyTransaction(_params: VerifyTransactionOptions): Promise<boolean>;
-    signTransaction(_params: SignTransactionOptions): Promise<SignedTransaction>;
-    explainTransaction(_options: Record<string, unknown>): Promise<ITransactionExplanation<unknown, string | number> | undefined>;
-    parseTransaction(_params: ParseTransactionOptions): Promise<ParsedTransaction>;
-    presignTransaction(_params: PresignTransactionOptions): Promise<PresignTransactionOptions>;
-    postProcessPrebuild(prebuild: TransactionPrebuild): Promise<TransactionPrebuild>;
-    getExtraPrebuildParams(_buildParams: ExtraPrebuildParamsOptions): Promise<Record<string, unknown>>;
-    feeEstimate(_params: FeeEstimateOptions): Promise<unknown>;
-    broadcastTransaction(_params: BaseBroadcastTransactionOptions): Promise<BaseBroadcastTransactionResult>;
-    supplementGenerateWallet(_walletParams: SupplementGenerateWalletOptions, _keychains: KeychainsTriplet): Promise<Record<string, unknown>>;
-    newWalletObject(walletParams: unknown): IWallet;
-    preCreateBitGo(_params: PrecreateBitGoOptions): void;
-    initiateRecovery(_params: InitiateRecoveryOptions): never;
-    signMessage(_key: {
-        prv: string;
-    }, _message: string): Promise<Buffer>;
-    createKeySignatures(_prv: string, _backup: {
-        pub: string;
-    }, _bitgo: {
-        pub: string;
-    }): Promise<{
-        backup: string;
-        bitgo: string;
-    }>;
-    getSignablePayload(_serializedTx: string): Promise<Buffer>;
+    /** @inheritdoc */
     getMPCAlgorithm(): MPCAlgorithm;
-    recoverToken(_params: RecoverWalletTokenOptions): Promise<RecoverTokenTransaction>;
-    buildNftTransferData(_params: BuildNftTransferDataOptions): string | TokenTransferRecipientParams;
-    getInscriptionBuilder(_wallet: Wallet): IInscriptionBuilder;
-    getHashFunction(): Hash;
-    deriveKeyWithSeed(_params: DeriveKeyWithSeedOptions): {
-        key: string;
-        derivationPath: string;
-    };
-    setCoinSpecificFieldsInIntent(_intent: PopulatedIntent, _params: PrebuildTransactionWithIntentOptions): void;
-    assertIsValidKey(_params: AuditKeyParams): void;
-    auditDecryptedKey(): void;
+    verifyTransaction(params: FlrpVerifyTransactionOptions): Promise<boolean>;
+    /**
+     * Check if export txn is valid, based on expected tx params.
+     *
+     * @param {ITransactionRecipient[]} recipients expected recipients and info
+     * @param {FlrpLib.TransactionExplanation} explainedTx explained export transaction
+     */
+    validateExportTx(recipients: ITransactionRecipient[], explainedTx: FlrpLib.TransactionExplanation): void;
+    /**
+     * Check if import txn into P is valid, based on expected tx params.
+     *
+     * @param {FlrpEntry[]} explainedTxInputs tx inputs (unspents to be imported)
+     * @param {FlrpTransactionParams} txParams expected tx info to check against
+     */
+    validateImportTx(explainedTxInputs: FlrpEntry[], txParams: FlrpTransactionParams): void;
+    /**
+     * Validate AddPermissionlessDelegator transaction parameters.
+     * Validates both expected txParams and the parsed explainedTx for consistency.
+     *
+     * @param {FlrpTransactionParams} txParams - Expected transaction parameters
+     * @param {FlrpLib.TransactionExplanation} explainedTx - Parsed transaction explanation
+     */
+    validateDelegationTx(txParams: FlrpTransactionParams, explainedTx: FlrpLib.TransactionExplanation): void;
+    private getBuilder;
+    /**
+     * Check if address is valid, then make sure it matches the root address.
+     *
+     * @param params.address address to validate
+     * @param params.keychains public keys to generate the wallet
+     */
+    isWalletAddress(params: VerifyAddressOptions): Promise<boolean>;
+    /**
+     * Validate that two multisig address arrays have the same elements, order doesnt matter
+     * @param addressArray1
+     * @param addressArray2
+     * @returns true if address arrays have the same addresses
+     * @private
+     */
+    private adressesArraysMatch;
+    /**
+     * Generate Flrp key pair
+     *
+     * @param {Buffer} seed - Seed from which the new keypair should be generated, otherwise a random seed is used
+     * @returns {Object} object with generated pub and prv
+     */
+    generateKeyPair(seed?: Buffer): KeyPair;
+    /**
+     * Return boolean indicating whether input is valid public key for the coin
+     *
+     * @param {string} pub the prv to be checked
+     * @returns is it valid?
+     */
+    isValidPub(pub: string): boolean;
+    /**
+     * Return boolean indicating whether input is valid private key for the coin
+     *
+     * @param {string} prv the prv to be checked
+     * @returns is it valid?
+     */
+    isValidPrv(prv: string): boolean;
+    isValidAddress(address: string | string[]): boolean;
+    /**
+     * Get the raw bytes that need to be signed by the MPC ceremony.
+     * MPC.sign() internally SHA-256 hashes, so return raw unsigned tx bytes.
+     */
+    getSignablePayload(txHex: string): Promise<Buffer>;
+    /**
+     * Inject an MPC-produced signature into an unsigned transaction.
+     * @param txHex - Unsigned transaction hex
+     * @param signature - 65-byte ECDSA signature (r || s || recovery)
+     * @returns Signed transaction hex
+     */
+    addSignatureToTransaction(txHex: string, signature: Buffer): Promise<string>;
+    /**
+     * Signs Avaxp transaction
+     */
+    signTransaction(params: FlrpSignTransactionOptions): Promise<SignedTransaction>;
+    parseTransaction(params: ParseTransactionOptions): Promise<ParsedTransaction>;
+    /**
+     * Explain a Avaxp transaction from txHex
+     * @param params
+     * @param callback
+     */
+    explainTransaction(params: FlrpExplainTransactionOptions): Promise<FlrpLib.TransactionExplanation>;
+    recoverySignature(messageHash: Buffer, signature: Buffer): Buffer;
+    signMessage(key: KeyPair, message: string | Buffer): Promise<Buffer>;
+    /**
+     * Returns true when the signableHex for this transaction is already the
+     * final signing hash (SHA-256 for Avalanche atomic txs), and the MPC
+     * signing flow should use it directly without additional hashing.
+     */
+    isSignablePreHashed(unsignedTx: SignableTransaction): boolean;
+    /** @inheritDoc */
+    auditDecryptedKey(params: AuditDecryptedKeyParams): void;
+    createPairedWallet(params: CreatePairedWalletParams): Promise<CreatePairedWalletResponse>;
 }
 //# sourceMappingURL=flrp.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"flrp.d.ts","sourceRoot":"","sources":["../../src/flrp.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EACR,SAAS,EACT,oBAAoB,EACpB,iBAAiB,EACjB,uBAAuB,EACvB,OAAO,EACP,sBAAsB,EACtB,iBAAiB,EACjB,uBAAuB,EACvB,+BAA+B,EAC/B,gBAAgB,EAChB,mBAAmB,EACnB,yBAAyB,EACzB,kBAAkB,EAClB,wBAAwB,EACxB,cAAc,EACd,eAAe,EACf,oCAAoC,EACpC,4BAA4B,EAC5B,2BAA2B,EAC3B,+BAA+B,EAC/B,8BAA8B,EAC9B,YAAY,EACZ,MAAM,EACN,mBAAmB,EACnB,0BAA0B,EAC1B,gBAAgB,EAChB,wBAAwB,EACxB,uBAAuB,EACvB,uBAAuB,EACvB,yBAAyB,EACzB,qBAAqB,EACrB,OAAO,EACR,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,QAAQ,IAAI,eAAe,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC9E,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAG9B,qBAAa,IAAK,SAAQ,QAAQ;IAChC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;IAE3D,SAAS,aAAa,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC;IAQ/E,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC,GAAG,QAAQ;IAI1F,QAAQ,IAAI,MAAM;IAGlB,SAAS,IAAI,UAAU;IAGvB,WAAW,IAAI,MAAM;IAGrB,aAAa,IAAI,MAAM,GAAG,MAAM;IAMhC,WAAW,IAAI,OAAO;IAGtB,sBAAsB,IAAI,OAAO;IAGjC,wBAAwB,IAAI,OAAO;IAGnC,mBAAmB,IAAI,OAAO;IAG9B,iBAAiB,IAAI,OAAO;IAG5B,cAAc,IAAI,OAAO;IAGzB,KAAK,IAAI,OAAO;IAQhB,eAAe,IAAI,OAAO;IAW1B,mBAAmB,IAAI,OAAO;IAG9B,gBAAgB,IAAI,MAAM,EAAE;IAG5B,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAGjC,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAGzC,gBAAgB,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO;IAGpD,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAGzC,cAAc,CAAC,UAAU,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI;IAKxE,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAG9D,eAAe,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAGhE,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,OAAO,CAAC;IAKtE,eAAe,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI5E,kBAAkB,CACtB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,OAAO,CAAC,uBAAuB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC,GAAG,SAAS,CAAC;IAInE,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI9E,kBAAkB,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAI1F,mBAAmB,CAAC,QAAQ,EAAE,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAIhF,sBAAsB,CAAC,YAAY,EAAE,0BAA0B,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAIlG,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,OAAO,CAAC;IAI1D,oBAAoB,CAAC,OAAO,EAAE,+BAA+B,GAAG,OAAO,CAAC,8BAA8B,CAAC;IAMvG,wBAAwB,CAC5B,aAAa,EAAE,+BAA+B,EAC9C,UAAU,EAAE,gBAAgB,GAC3B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAGnC,eAAe,CAAC,YAAY,EAAE,OAAO,GAAG,OAAO;IAG/C,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,IAAI;IAGpD,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,KAAK;IAKnD,WAAW,CAAC,IAAI,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAGrE,mBAAmB,CACvB,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,EACxB,MAAM,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GACtB,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAGvC,kBAAkB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAGhE,eAAe,IAAI,YAAY;IAK/B,YAAY,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAGlF,oBAAoB,CAAC,OAAO,EAAE,2BAA2B,GAAG,MAAM,GAAG,4BAA4B;IAGjG,qBAAqB,CAAC,OAAO,EAAE,MAAM,GAAG,mBAAmB;IAK3D,eAAe,IAAI,IAAI;IAGvB,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,GAAG;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,MAAM,CAAA;KAAE;IAG7F,6BAA6B,CAAC,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,oCAAoC,GAAG,IAAI;IAG5G,gBAAgB,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI;IAG/C,iBAAiB,IAAI,IAAI;CAG1B"}
+{"version":3,"file":"flrp.d.ts","sourceRoot":"","sources":["../../src/flrp.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,IAAI,eAAe,EAAE,UAAU,EAAuB,MAAM,qBAAqB,CAAC;AACnG,OAAO,EACL,uBAAuB,EACvB,QAAQ,EACR,SAAS,EACT,OAAO,EACP,YAAY,EACZ,YAAY,EAEZ,iBAAiB,EACjB,uBAAuB,EACvB,iBAAiB,EACjB,oBAAoB,EAEpB,qBAAqB,EAOrB,mBAAmB,EAEpB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,OAAO,MAAM,OAAO,CAAC;AACjC,OAAO,EACL,wBAAwB,EACxB,0BAA0B,EAC1B,SAAS,EACT,6BAA6B,EAC7B,0BAA0B,EAC1B,qBAAqB,EACrB,4BAA4B,EAC7B,MAAM,aAAa,CAAC;AAKrB,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,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC,GAAG,QAAQ;IAI1F,QAAQ,IAAI,MAAM;IAGlB,SAAS,IAAI,UAAU;IAGvB,WAAW,IAAI,MAAM;IAGrB,aAAa,IAAI,MAAM,GAAG,MAAM;IAIhC,oBAAoB;IACpB,sBAAsB,IAAI,YAAY;IAItC,kBAAkB;IAClB,WAAW,IAAI,OAAO;IAItB,kBAAkB;IAClB,eAAe,IAAI,YAAY;IAIzB,iBAAiB,CAAC,MAAM,EAAE,4BAA4B,GAAG,OAAO,CAAC,OAAO,CAAC;IAqE/E;;;;;OAKG;IACH,gBAAgB,CAAC,UAAU,EAAE,qBAAqB,EAAE,EAAE,WAAW,EAAE,OAAO,CAAC,sBAAsB,GAAG,IAAI;IAqBxG;;;;;OAKG;IACH,gBAAgB,CAAC,iBAAiB,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,qBAAqB,GAAG,IAAI;IAgBvF;;;;;;OAMG;IACH,oBAAoB,CAAC,QAAQ,EAAE,qBAAqB,EAAE,WAAW,EAAE,OAAO,CAAC,sBAAsB,GAAG,IAAI;IAuCxG,OAAO,CAAC,UAAU;IAIlB;;;;;OAKG;IACG,eAAe,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAuCrE;;;;;;OAMG;IACH,OAAO,CAAC,mBAAmB;IAI3B;;;;;OAKG;IACH,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO;IAcvC;;;;;OAKG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAShC;;;;;OAKG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAShC,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO;IAanD;;;OAGG;IACG,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAMxD;;;;;OAKG;IACG,yBAAyB,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAOlF;;OAEG;IACG,eAAe,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAkB/E,gBAAgB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAInF;;;;OAIG;IACG,kBAAkB,CAAC,MAAM,EAAE,6BAA6B,GAAG,OAAO,CAAC,OAAO,CAAC,sBAAsB,CAAC;IAcxG,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM;IAI3D,WAAW,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAW1E;;;;OAIG;IACH,mBAAmB,CAAC,UAAU,EAAE,mBAAmB,GAAG,OAAO;IAI7D,kBAAkB;IAClB,iBAAiB,CAAC,MAAM,EAAE,uBAAuB,GAAG,IAAI;IAIlD,kBAAkB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,0BAA0B,CAAC;CAOhG"}