@multiplechain/bitcoin 0.1.18 → 0.4.0

package/README.md

@@ -1 +1,7 @@
-Preparing
+# MultipleChain standard for JavaScript
+
+## Introduction
+
+MultipleChain aims for easy access by simplifying the complex structure of many blockchains. For example, each blockchain network has a different structure for transfer initiation or transaction data. You may need to learn new things from scratch for each blockchain network. This is necessary if you want to go into detail. But if you just want to get to the basics. MultipleChain will make your work much easier. In many different programming languages.
+
+#### 📚 [Documentation](https://multiplechain.gitbook.io/multiplechain-docs)

package/dist/assets/Coin.d.ts

@@ -0,0 +1,38 @@
+import { CoinInterface, TransferAmount, WalletAddress } from '@multiplechain/types';
+import { TransactionSigner } from '../services/TransactionSigner.ts';
+import { Provider } from '../services/Provider.ts';
+
+export declare class Coin implements CoinInterface<TransactionSigner> {
+    /**
+     * Blockchain network provider
+     */
+    provider: Provider;
+    /**
+     * @param {Provider} provider network provider
+     */
+    constructor(provider?: Provider);
+    /**
+     * @returns {string} Coin name
+     */
+    getName(): string;
+    /**
+     * @returns {string} Coin symbol
+     */
+    getSymbol(): string;
+    /**
+     * @returns {number} Decimal value of the coin
+     */
+    getDecimals(): number;
+    /**
+     * @param {WalletAddress} owner Wallet address
+     * @returns {Promise<number>} Wallet balance as currency of COIN
+     */
+    getBalance(owner: WalletAddress): Promise<number>;
+    /**
+     * @param {WalletAddress} sender Sender wallet address
+     * @param {WalletAddress} receiver Receiver wallet address
+     * @param {TransferAmount} amount Amount of assets that will be transferred
+     * @returns {Promise<TransactionSigner>} Transaction signer
+     */
+    transfer(sender: WalletAddress, receiver: WalletAddress, amount: TransferAmount): Promise<TransactionSigner>;
+}

package/dist/assets/index.d.ts

@@ -0,0 +1 @@
+export * from './Coin.ts';

package/dist/browser/Wallet.d.ts

@@ -0,0 +1,81 @@
+import { TransactionSigner } from '../services/TransactionSigner.ts';
+import { Provider } from '../services/Provider.ts';
+import { WalletInterface, WalletAdapterInterface, WalletPlatformEnum, UnknownConfig, ConnectConfig, WalletAddress, SignedMessage, TransactionId } from '@multiplechain/types';
+
+export interface BitcoinWalletAdapter {
+    getAddress: () => Promise<string>;
+    signMessage: (message: string) => Promise<string>;
+    sendBitcoin: (to: string, amount: number) => Promise<string>;
+    on: (event: string, callback: (data: any) => void) => void;
+}
+type WalletAdapter = WalletAdapterInterface<Provider, BitcoinWalletAdapter>;
+export declare class Wallet implements WalletInterface<Provider, BitcoinWalletAdapter, TransactionSigner> {
+    adapter: WalletAdapter;
+    walletProvider: BitcoinWalletAdapter;
+    networkProvider: Provider;
+    /**
+     * @param {WalletAdapter} adapter
+     * @param {Provider} provider
+     */
+    constructor(adapter: WalletAdapter, provider?: Provider);
+    /**
+     * @returns {string}
+     */
+    getId(): string;
+    /**
+     * @returns {string}
+     */
+    getName(): string;
+    /**
+     * @returns {string}
+     */
+    getIcon(): string;
+    /**
+     * @returns {WalletPlatformEnum[]}
+     */
+    getPlatforms(): WalletPlatformEnum[];
+    /**
+     * @returns {string}
+     */
+    getDownloadLink(): string | undefined;
+    /**
+     * @param {string} url
+     * @param {UnknownConfig} config
+     * @returns {string}
+     */
+    createDeepLink(url: string, config?: UnknownConfig): string | null;
+    /**
+     * @param {ConnectConfig} config
+     * @returns {Promise<WalletAddress>}
+     */
+    connect(config?: ConnectConfig): Promise<WalletAddress>;
+    /**
+     * @returns {boolean}
+     */
+    isDetected(): Promise<boolean>;
+    /**
+     * @returns {boolean}
+     */
+    isConnected(): Promise<boolean>;
+    /**
+     * @returns {Promise<WalletAddress>}
+     */
+    getAddress(): Promise<WalletAddress>;
+    /**
+     * @param {string} message
+     * @returns {Promise<SignedMessage>}
+     */
+    signMessage(message: string): Promise<SignedMessage>;
+    /**
+     * @param {TransactionSigner} transactionSigner
+     * @returns {Promise<TransactionId>}
+     */
+    sendTransaction(transactionSigner: TransactionSigner): Promise<TransactionId>;
+    /**
+     * @param {string} eventName
+     * @param {Function} callback
+     * @returns {void}
+     */
+    on(eventName: string, callback: (...args: any[]) => void): void;
+}
+export {};

package/dist/browser/adapters/Leather.d.ts

@@ -0,0 +1,16 @@
+import { Provider } from '../../services/Provider.ts';
+import { BitcoinWalletAdapter } from '../Wallet.ts';
+import { WalletAdapterInterface } from '@multiplechain/types';
+
+declare global {
+    interface Window {
+        btc: {
+            listen?: (event: string, callback: (data: any) => void) => void;
+        };
+        LeatherProvider: {
+            request: (method: string, params: any) => Promise<any>;
+        };
+    }
+}
+declare const Leather: WalletAdapterInterface<Provider, BitcoinWalletAdapter>;
+export default Leather;

package/dist/browser/adapters/UniSat.d.ts

@@ -0,0 +1,19 @@
+import { WalletAdapterInterface } from '@multiplechain/types';
+import { Provider } from '../../services/Provider.ts';
+import { BitcoinWalletAdapter } from '../Wallet.ts';
+
+declare global {
+    interface Window {
+        unisat: {
+            _isConnected: boolean;
+            getAccounts: () => Promise<string[]>;
+            requestAccounts: () => Promise<void>;
+            signMessage: (message: string) => Promise<string>;
+            switchNetwork: (network: string) => Promise<void>;
+            on: (event: string, callback: (data: any) => void) => void;
+            sendBitcoin: (to: string, amount: number) => Promise<string>;
+        };
+    }
+}
+declare const UniSat: WalletAdapterInterface<Provider, BitcoinWalletAdapter>;
+export default UniSat;

package/dist/browser/adapters/Xverse.d.ts

@@ -0,0 +1,6 @@
+import { Provider } from '../../services/Provider.ts';
+import { WalletAdapterInterface } from '@multiplechain/types';
+import { BitcoinWalletAdapter } from '../Wallet.ts';
+
+declare const Xverse: WalletAdapterInterface<Provider, BitcoinWalletAdapter>;
+export default Xverse;

package/dist/browser/adapters/icons.d.ts

@@ -0,0 +1,6 @@
+declare const _default: {
+    UniSat: string;
+    Xverse: string;
+    Leather: string;
+};
+export default _default;

package/dist/browser/adapters/index.d.ts

@@ -0,0 +1,3 @@
+export { default as UniSat } from './UniSat.ts';
+export { default as Xverse } from './Xverse.ts';
+export { default as Leather } from './Leather.ts';

package/dist/browser/index.d.ts

@@ -0,0 +1,11 @@
+import { WalletAdapterListType, RegisterWalletAdapterType } from '@multiplechain/types';
+import { Wallet, BitcoinWalletAdapter } from './Wallet.ts';
+import { Provider } from 'sats-connect';
+
+import * as adapterList from './adapters/index.ts';
+export * from '../index.ts';
+export declare const browser: {
+    Wallet: typeof Wallet;
+    registerAdapter: RegisterWalletAdapterType<Provider, BitcoinWalletAdapter>;
+    adapters: WalletAdapterListType<Provider, BitcoinWalletAdapter> & typeof adapterList;
+};