@wallfree-dev/bitcoin 0.13.42

package/v1/protocol/BitcoinProtocol.d.ts

@@ -0,0 +1,84 @@
+import { Address, AirGapProtocol, AirGapTransaction, AirGapTransactionsWithCursor, Amount, Balance, CryptoDerivative, ExtendedKeyPair, ExtendedPublicKey, ExtendedSecretKey, FeeDefaults, KeyPair, ProtocolMetadata, ProtocolUnitsMetadata, PublicKey, RecursivePartial, SecretKey, Signature, SignedTransaction, TransactionFullConfiguration, TransactionDetails, UnsignedTransaction, TransactionSimpleConfiguration } from '@wallfree-dev/module-kit';
+import { BitcoinJS } from '../types/bitcoinjs';
+import { BitcoinCryptoConfiguration } from '../types/crypto';
+import { BitcoinProtocolNetwork, BitcoinProtocolOptions, BitcoinStandardProtocolNetwork, BitcoinUnits } from '../types/protocol';
+import { BitcoinSignedTransaction, BitcoinTransactionCursor, BitcoinUnsignedTransaction } from '../types/transaction';
+import { ExtendedPublicKeyEncoding, ExtendedSecretKeyEncoding } from '../utils/key';
+export interface BitcoinProtocol<_SignedTransaction extends SignedTransaction = BitcoinSignedTransaction, _UnsignedTransaction extends UnsignedTransaction = BitcoinUnsignedTransaction> extends AirGapProtocol<{
+    AddressResult: Address;
+    ProtocolNetwork: BitcoinProtocolNetwork;
+    CryptoConfiguration: BitcoinCryptoConfiguration;
+    SignedTransaction: _SignedTransaction;
+    TransactionCursor: BitcoinTransactionCursor;
+    Units: BitcoinUnits;
+    FeeEstimation: FeeDefaults<BitcoinUnits>;
+    UnsignedTransaction: _UnsignedTransaction;
+}, 'Bip32', 'Crypto', 'FetchDataForAddress', 'FetchDataForMultipleAddresses'> {
+    _isBitcoinProtocol: true;
+}
+export interface BitcoinKeyConfiguration {
+    xpriv: {
+        type: ExtendedSecretKeyEncoding;
+    };
+    xpub: {
+        type: ExtendedPublicKeyEncoding;
+    };
+}
+export declare class BitcoinProtocolImpl implements BitcoinProtocol {
+    readonly _isBitcoinProtocol: true;
+    private readonly options;
+    private readonly keyConfiguration;
+    private readonly cryptoClient;
+    readonly bitcoinJS: BitcoinJS;
+    constructor(options?: RecursivePartial<BitcoinProtocolOptions>, keyConfiguration?: BitcoinKeyConfiguration, 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>;
+    private readonly cryptoConfiguration;
+    getCryptoConfiguration(): Promise<BitcoinCryptoConfiguration>;
+    getKeyPairFromDerivative(derivative: CryptoDerivative): Promise<KeyPair>;
+    getExtendedKeyPairFromDerivative(derivative: CryptoDerivative): Promise<ExtendedKeyPair>;
+    deriveFromExtendedSecretKey(extendedSecretKey: ExtendedSecretKey, visibilityIndex: number, addressIndex: number): Promise<SecretKey>;
+    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?: TransactionFullConfiguration<BitcoinUnits>): Promise<Amount<BitcoinUnits>>;
+    getTransactionFeeWithPublicKey(_publicKey: ExtendedPublicKey | PublicKey, _details: TransactionDetails<BitcoinUnits>[], _configuration?: TransactionSimpleConfiguration): Promise<FeeDefaults<BitcoinUnits>>;
+    prepareTransactionWithPublicKey(publicKey: ExtendedPublicKey | PublicKey, details: TransactionDetails<BitcoinUnits>[], configuration?: TransactionFullConfiguration<BitcoinUnits>): Promise<BitcoinUnsignedTransaction>;
+    private prepareTransactionWithNonExtendedPublicKey;
+    private prepareTransactionWithExtendedPublicKey;
+    broadcastTransaction(transaction: BitcoinSignedTransaction): Promise<string>;
+    private convertExtendedSecretKey;
+    private convertExtendedPublicKey;
+    private convertCryptoDerivative;
+    private derivativeToBip32Node;
+}
+export declare function createBitcoinProtocol(options?: RecursivePartial<BitcoinProtocolOptions>): BitcoinProtocol;
+export declare const BITCOIN_MAINNET_PROTOCOL_NETWORK: BitcoinStandardProtocolNetwork;
+export declare function createBitcoinProtocolOptions(network?: Partial<BitcoinProtocolNetwork>): BitcoinProtocolOptions;