@airgap/bitcoin 0.13.7-beta.22 → 0.13.7-beta.23

package/v1/protocol/BitcoinProtocol.d.ts

@@ -0,0 +1,68 @@
+import { Address, AirGapProtocol, AirGapTransaction, AirGapTransactionsWithCursor, Amount, Balance, ExtendedKeyPair, ExtendedPublicKey, ExtendedSecretKey, FeeDefaults, KeyPair, ProtocolMetadata, ProtocolUnitsMetadata, PublicKey, RecursivePartial, Secret, SecretKey, Signature, SignedTransaction, TransactionConfiguration, TransactionDetails, UnsignedTransaction } from '@airgap/module-kit';
+import { BitcoinJS } from '../types/bitcoinjs';
+import { BitcoinProtocolNetwork, BitcoinProtocolOptions, BitcoinStandardProtocolNetwork, BitcoinUnits } from '../types/protocol';
+import { BitcoinSignedTransaction, BitcoinTransactionCursor, BitcoinUnsignedTransaction } from '../types/transaction';
+export interface BitcoinProtocol<_SignedTransaction extends SignedTransaction = BitcoinSignedTransaction, _UnsignedTransaction extends UnsignedTransaction = BitcoinUnsignedTransaction> extends AirGapProtocol<{
+    AddressResult: Address;
+    ProtocolNetwork: BitcoinProtocolNetwork;
+    SignedTransaction: _SignedTransaction;
+    TransactionCursor: BitcoinTransactionCursor;
+    Units: BitcoinUnits;
+    FeeEstimation: FeeDefaults<BitcoinUnits>;
+    UnsignedTransaction: _UnsignedTransaction;
+}, 'Bip32', 'Crypto', 'FetchDataForAddress', 'FetchDataForMultipleAddresses'> {
+}
+export declare class BitcoinProtocolImpl implements BitcoinProtocol {
+    private readonly options;
+    private readonly cryptoClient;
+    readonly bitcoinJS: BitcoinJS;
+    constructor(options?: RecursivePartial<BitcoinProtocolOptions>, bitcoinJS?: any, bitcoinJSMessage?: any);
+    readonly units: ProtocolUnitsMetadata<BitcoinUnits>;
+    readonly feeDefaults: FeeDefaults<BitcoinUnits>;
+    readonly metadata: ProtocolMetadata<BitcoinUnits>;
+    getMetadata(): Promise<ProtocolMetadata<BitcoinUnits>>;
+    getAddressFromPublicKey(publicKey: PublicKey | ExtendedPublicKey): Promise<string>;
+    private getAddressFromNonExtendedPublicKey;
+    private getAddressFromExtendedPublicKey;
+    deriveFromExtendedPublicKey(extendedPublicKey: ExtendedPublicKey, visibilityIndex: number, addressIndex: number): Promise<PublicKey>;
+    getDetailsFromTransaction(transaction: BitcoinSignedTransaction | BitcoinUnsignedTransaction, _publicKey: PublicKey | ExtendedPublicKey): Promise<AirGapTransaction<BitcoinUnits>[]>;
+    private getDetailsFromSignedTransaction;
+    private getDetailsFromUnsignedTransaction;
+    verifyMessageWithPublicKey(message: string, signature: Signature, publicKey: ExtendedPublicKey | PublicKey): Promise<boolean>;
+    encryptAsymmetricWithPublicKey(payload: string, publicKey: ExtendedPublicKey | PublicKey): Promise<string>;
+    getKeyPairFromSecret(secret: Secret, derivationPath?: string): Promise<KeyPair>;
+    private getKeyPairFromHexSecret;
+    private getKeyPairFromMnemonic;
+    getExtendedKeyPairFromSecret(secret: Secret, derivationPath?: string): Promise<ExtendedKeyPair>;
+    private getExtendedKeyPairFromHexSecret;
+    private getExtendedKeyPairFromMnemonic;
+    signTransactionWithSecretKey(transaction: BitcoinUnsignedTransaction, secretKey: SecretKey | ExtendedSecretKey): Promise<BitcoinSignedTransaction>;
+    private signTransactionWithNonExtendedSecretKey;
+    private signTransactionWithExtendedSecretKey;
+    private createSignedTransaction;
+    signMessageWithKeyPair(message: string, keyPair: ExtendedKeyPair | KeyPair): Promise<Signature>;
+    decryptAsymmetricWithKeyPair(payload: string, keyPair: ExtendedKeyPair | KeyPair): Promise<string>;
+    encryptAESWithSecretKey(payload: string, secretKey: SecretKey | ExtendedSecretKey): Promise<string>;
+    decryptAESWithSecretKey(payload: string, secretKey: SecretKey | ExtendedSecretKey): Promise<string>;
+    getNetwork(): Promise<BitcoinProtocolNetwork>;
+    getTransactionsForPublicKey(publicKey: ExtendedPublicKey | PublicKey, limit: number, cursor?: BitcoinTransactionCursor): Promise<AirGapTransactionsWithCursor<BitcoinTransactionCursor, BitcoinUnits>>;
+    private getTransactionsForNonExtendedPublicKey;
+    private getTransactionsForExtendedPublicKey;
+    getTransactionsForAddress(address: string, limit: number, cursor?: BitcoinTransactionCursor): Promise<AirGapTransactionsWithCursor<BitcoinTransactionCursor, BitcoinUnits>>;
+    getTransactionsForAddresses(addresses: string[], limit: number, cursor?: BitcoinTransactionCursor): Promise<AirGapTransactionsWithCursor<BitcoinTransactionCursor, BitcoinUnits>>;
+    getBalanceOfPublicKey(publicKey: ExtendedPublicKey | PublicKey): Promise<Balance<BitcoinUnits>>;
+    private getBalanceOfNonExtendedPublicKey;
+    private getBalanceOfExtendedPublicKey;
+    getBalanceOfAddress(address: string): Promise<Balance<BitcoinUnits>>;
+    getBalanceOfAddresses(addresses: string[]): Promise<Balance<BitcoinUnits>>;
+    getTransactionMaxAmountWithPublicKey(publicKey: ExtendedPublicKey | PublicKey, to: string[], configuration?: TransactionConfiguration<BitcoinUnits>): Promise<Amount<BitcoinUnits>>;
+    getTransactionFeeWithPublicKey(publicKey: ExtendedPublicKey | PublicKey, details: TransactionDetails<BitcoinUnits>[]): Promise<FeeDefaults<BitcoinUnits>>;
+    prepareTransactionWithPublicKey(publicKey: ExtendedPublicKey | PublicKey, details: TransactionDetails<BitcoinUnits>[], configuration?: TransactionConfiguration<BitcoinUnits>): Promise<BitcoinUnsignedTransaction>;
+    private prepareTransactionWithNonExtendedPublicKey;
+    private prepareTransactionWithExtendedPublicKey;
+    broadcastTransaction(transaction: BitcoinSignedTransaction): Promise<string>;
+    protected convertExtendedPublicKey(extendedPublicKey: ExtendedPublicKey, targetFormat: ExtendedPublicKey['format']): ExtendedPublicKey;
+}
+export declare function createBitcoinProtocol(options?: RecursivePartial<BitcoinProtocolOptions>): BitcoinProtocol;
+export declare const BITCOIN_MAINNET_PROTOCOL_NETWORK: BitcoinStandardProtocolNetwork;
+export declare function createBitcoinProtocolOptions(network?: Partial<BitcoinProtocolNetwork>): BitcoinProtocolOptions;