@airgap/substrate 0.13.7-beta.11

package/protocol/SubstrateProtocol.d.ts

@@ -0,0 +1,88 @@
+import { ICoinProtocol, ICoinSubProtocol } from '@airgap/coinlib-core';
+import { AirGapTransactionStatus, IAirGapTransaction } from '@airgap/coinlib-core/interfaces/IAirGapTransaction';
+import { CurrencyUnit, FeeDefaults } from '@airgap/coinlib-core/protocols/ICoinProtocol';
+import { NonExtendedProtocol } from '@airgap/coinlib-core/protocols/NonExtendedProtocol';
+import { ProtocolSymbols } from '@airgap/coinlib-core/utils/ProtocolSymbols';
+import { SignedSubstrateTransaction } from '../types/signed-transaction-substrate';
+import { RawSubstrateTransaction } from '../types/transaction-substrate';
+import { UnsignedSubstrateTransaction } from '../types/unsigned-transaction-substrate';
+import { SubstrateTransactionType } from './common/data/transaction/SubstrateTransaction';
+import { SubstrateAccountId, SubstrateCompatAddressType } from './compat/SubstrateCompatAddress';
+import { SubstrateCryptoClient } from './SubstrateCryptoClient';
+import { SubstrateNetwork } from './SubstrateNetwork';
+import { SubstrateProtocolOptions } from './SubstrateProtocolOptions';
+import { SubstrateAddressCursor, SubstrateAddressResult, SubstrateTransactionCursor, SubstrateTransactionResult } from './SubstrateTypes';
+export declare abstract class SubstrateProtocol<Network extends SubstrateNetwork> extends NonExtendedProtocol implements ICoinProtocol {
+    readonly options: SubstrateProtocolOptions<Network>;
+    abstract symbol: string;
+    abstract name: string;
+    abstract marketSymbol: string;
+    abstract feeSymbol: string;
+    abstract decimals: number;
+    abstract feeDecimals: number;
+    abstract identifier: ProtocolSymbols;
+    abstract feeDefaults: FeeDefaults;
+    abstract units: CurrencyUnit[];
+    abstract standardDerivationPath: string;
+    supportsHD: boolean;
+    addressIsCaseSensitive: boolean;
+    addressValidationPattern: string;
+    addressPlaceholder: string;
+    readonly cryptoClient: SubstrateCryptoClient;
+    constructor(options: SubstrateProtocolOptions<Network>);
+    getSymbol(): Promise<string>;
+    getName(): Promise<string>;
+    getMarketSymbol(): Promise<string>;
+    getFeeSymbol(): Promise<string>;
+    getDecimals(): Promise<number>;
+    getFeeDecimals(): Promise<number>;
+    getIdentifier(): Promise<ProtocolSymbols>;
+    getFeeDefaults(): Promise<FeeDefaults>;
+    getUnits(): Promise<CurrencyUnit[]>;
+    getStandardDerivationPath(): Promise<string>;
+    getSupportsHD(): Promise<boolean>;
+    getAddressIsCaseSensitive(): Promise<boolean>;
+    getAddressValidationPattern(): Promise<string>;
+    getAddressPlaceholder(): Promise<string>;
+    getOptions(): Promise<SubstrateProtocolOptions<Network>>;
+    getBlockExplorerLinkForAddress(address: string): Promise<string>;
+    getBlockExplorerLinkForTxId(txId: string): Promise<string>;
+    getPublicKeyFromMnemonic(mnemonic: string, derivationPath: string, password?: string): Promise<string>;
+    getPrivateKeyFromMnemonic(mnemonic: string, derivationPath: string, password?: string): Promise<string>;
+    getPublicKeyFromHexSecret(secret: string, derivationPath: string): Promise<string>;
+    getPrivateKeyFromHexSecret(secret: string, derivationPath: string): Promise<string>;
+    getAddressFromPublicKey(publicKey: string, cursor?: SubstrateAddressCursor): Promise<SubstrateAddressResult>;
+    getAddressesFromPublicKey(publicKey: string, cursor?: SubstrateAddressCursor): Promise<SubstrateAddressResult[]>;
+    getTransactionsFromPublicKey(publicKey: string, limit: number, cursor?: SubstrateTransactionCursor): Promise<SubstrateTransactionResult>;
+    getTransactionsFromAddresses(addresses: string[], limit: number, cursor?: SubstrateTransactionCursor): Promise<SubstrateTransactionResult>;
+    signWithPrivateKey(privateKey: string, rawTransaction: RawSubstrateTransaction): Promise<string>;
+    getTransactionDetails(transaction: UnsignedSubstrateTransaction): Promise<IAirGapTransaction[]>;
+    getTransactionDetailsFromSigned(transaction: SignedSubstrateTransaction): Promise<IAirGapTransaction[]>;
+    getBalanceOfAddresses(addresses: string[]): Promise<string>;
+    getAvailableBalanceOfAddresses(addresses: string[]): Promise<string>;
+    getBalanceOfPublicKey(publicKey: string): Promise<string>;
+    getBalanceOfPublicKeyForSubProtocols(publicKey: string, subProtocols: ICoinSubProtocol[]): Promise<string[]>;
+    estimateMaxTransactionValueFromPublicKey(publicKey: string, _recipients: string[], fee?: string, data?: {
+        excludeExistentialDeposit?: boolean;
+    }): Promise<string>;
+    estimateFeeDefaultsFromPublicKey(publicKey: string, recipients: string[], values: string[], data?: any): Promise<FeeDefaults>;
+    prepareTransactionFromPublicKey(publicKey: string, recipients: string[], values: string[], fee: string, data?: {
+        excludeExistentialDeposit?: boolean;
+    }): Promise<RawSubstrateTransaction>;
+    broadcastTransaction(encoded: string): Promise<string>;
+    getFutureRequiredTransactions(accountId: SubstrateAccountId<SubstrateCompatAddressType[Network]>, intention: 'check' | 'transfer' | 'delegate'): Promise<[SubstrateTransactionType, any][]>;
+    private getTransactionDetailsFromEncoded;
+    signMessage(message: string, keypair: {
+        publicKey: string;
+        privateKey: string;
+    }): Promise<string>;
+    verifyMessage(message: string, signature: string, publicKey: string): Promise<boolean>;
+    encryptAsymmetric(message: string, publicKey: string): Promise<string>;
+    decryptAsymmetric(message: string, keypair: {
+        publicKey: string;
+        privateKey: string;
+    }): Promise<string>;
+    encryptAES(message: string, privateKey: string): Promise<string>;
+    decryptAES(message: string, privateKey: string): Promise<string>;
+    getTransactionStatuses(transactionHashes: string[]): Promise<AirGapTransactionStatus[]>;
+}