@omnisat/lasereyes 0.0.2

package/README.md

@@ -0,0 +1,102 @@
+# @omnisat/lasereyes
+![Laser Eyes](http://localhost:3001/lasereyes.png)
+
+
+# Laser Eyes
+## React Hooks for Bitcoin
+
+Laser Eyes is a collection of React Hooks containing everything you need to start working with Bitcoin.
+Laser Eyes makes it easy to "Connect" interface with Bitcoin, Inscriptions, balance information, interact with BRC-20s, and more.
+
+### Install
+
+```yarn add @omnisat/lasereyes```
+
+### Usage Overview
+```javascript
+
+import { LaserEyesProvider, createConfig } from '@omnisat/lasereyes'
+
+const config = createConfig({
+ ...
+})
+ 
+function App() {
+  return (
+    <LaserEyesProvider config={config}>
+      <Profile />
+    </LaserEyesProvider>
+  )
+}
+```
+
+# Usage
+## how to
+
+The following hooks support typed inference:
+
+### Read Methods
+
+connect
+```lasereyes.connect()```
+
+Get addresses of current account
+```lasereyes.requestAccounts()```
+
+Returns testnet or mainnet
+```lasereyes.getNetwork()```
+
+Get public key of account
+```lasereyes.getPublicKey()```
+
+Get Balance of current account
+```lasereyes.getBalance()```
+
+Get All inscriptions
+```lasereyes.getInscriptions()```
+
+Get All Tokens
+```lasereyes.getAllBRC20Tokens()```
+
+
+### Write Methods
+
+Send Bitcoin
+```lasereyes.sendBTC(toPK, btc_in_sats, ...)```
+
+Pay & Inscribe
+```lasereyes.pay_inscribe(...)````
+
+Transferable: The amount has been inscribed into one or more TRANSFER inscriptions (can be transferred immediately).
+Available: The amount that is available as a part of a balance (including both minted and received) but not transferable yet.
+To spend an available amount, you must first inscribe a certain amount into a TRANSFER inscription.
+
+The transfer Amount can be calculated by the sum of the chosen amounts of TRANSFER inscriptions.
+If you don’t have enough transferable inscriptions, you will need to inscribe them first.
+
+Once a number of TRANSFER inscriptions are chosen, proceed to send them by asserting an address
+
+sign the tx to send.
+
+Deploy a Inscription
+```lasereyes.deploy(...)```
+
+Mint a deployed Inscription
+```lasereyes.mint(...)```
+
+Sign a message
+```lasereyes.signMessage(...)```
+
+Sign a single PSBT
+```lasereyes.signPsbt(...)```
+
+Sign an array of PSBT
+```lasereyes.signPsbts(...)```
+
+### Events
+
+`networkChanged`
+Testnet, mainnet
+
+`accountsChanged`
+user changes account pub keys

package/dist/index.d.ts

@@ -0,0 +1,111 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+
+declare const OYL = "oyl";
+declare const UNISAT = "unisat";
+declare const XVERSE = "xverse";
+declare const PHANTOM = "phantom";
+declare const LEATHER = "leather";
+declare const XVERSE_NETWORK: 'Mainnet' | 'Testnet';
+declare const UNISAT_MAINNET = "livenet";
+declare const UNISAT_TESTNET = "testnet";
+declare const XVERSE_MAINNET = "Mainnet";
+declare const XVERSE_TESTNET = "Testnet";
+declare const LEATHER_MAINNET = "mainnet";
+declare const LEATHER_TESTNET = "testnet";
+declare const MAINNET = "mainnet";
+declare const TESTNET = "testnet";
+declare const getXverseNetwork: (network: string) => "Mainnet" | "Testnet";
+declare const getLeatherNetwork: (network: string) => "testnet" | "mainnet";
+declare const getUnisatNetwork: (network: string) => "livenet" | "testnet";
+declare const getNetworkForUnisat: (network: string) => "testnet" | "mainnet";
+declare const getNetworkForXverse: (network: string) => "testnet" | "mainnet";
+declare const getNetworkForLeather: (network: string) => "testnet" | "mainnet";
+declare const P2TR = "p2tr";
+declare const P2PKH = "p2pkh";
+declare const P2WPKH = "p2wpkh";
+declare const P2WSH = "p2wsh";
+declare const P2SH = "p2sh";
+declare const WALLETS: {
+    oyl: {
+        name: string;
+        icon: string;
+        site: string;
+        disabled: boolean;
+    };
+    unisat: {
+        name: string;
+        icon: string;
+        site: string;
+        disabled: boolean;
+    };
+    xverse: {
+        name: string;
+        icon: string;
+        site: string;
+        config: () => void;
+        disabled: boolean;
+    };
+    leather: {
+        name: string;
+        icon: string;
+        site: string;
+        config: () => void;
+        disabled: boolean;
+    };
+};
+
+type LaserEyesContextType = {
+    hasOyl: boolean;
+    hasUnisat: boolean;
+    hasLeather: boolean;
+    hasXverse: boolean;
+    connected: boolean;
+    isConnecting: boolean;
+    publicKey: string;
+    address: string;
+    paymentAddress: string;
+    paymentPublicKey: string;
+    balance: {
+        confirmed: number;
+        unconfirmed: number;
+        total: number;
+    };
+    network: string;
+    library: any;
+    provider: any;
+    accounts: string[];
+    connect: (walletName: typeof OYL | typeof UNISAT | typeof XVERSE | typeof LEATHER) => Promise<void>;
+    disconnect: () => void;
+    requestAccounts: () => Promise<string[]>;
+    getNetwork: () => Promise<string | undefined>;
+    switchNetwork: (network: 'mainnet' | 'testnet') => Promise<string | undefined>;
+    getPublicKey: () => Promise<string>;
+    getBalance: () => Promise<string>;
+    getInscriptions: () => Promise<any>;
+    getAllBRC20Tokens: () => Promise<any>;
+    sendBTC: (to: string, amount: number) => Promise<string>;
+    payInscribe: () => Promise<void>;
+    deploy: () => Promise<void>;
+    mint: () => Promise<void>;
+    signMessage: (message: string) => Promise<string>;
+    signPsbt: (tx: string, finalize?: boolean, broadcast?: boolean) => Promise<string | {
+        signedPsbtHex: string;
+        signedPsbtBase64: string;
+    } | undefined>;
+    pushPsbt: (tx: string) => Promise<string | undefined>;
+};
+type Config = {
+    network: string;
+    provider: string;
+    chainId: number;
+};
+
+declare const createConfig: (config: Config) => Config;
+
+declare const useLaserEyes: () => LaserEyesContextType;
+declare const LaserEyesProvider: ({ children }: {
+    children: ReactNode;
+}) => react_jsx_runtime.JSX.Element;
+
+export { LEATHER, LEATHER_MAINNET, LEATHER_TESTNET, LaserEyesProvider, MAINNET, OYL, P2PKH, P2SH, P2TR, P2WPKH, P2WSH, PHANTOM, TESTNET, UNISAT, UNISAT_MAINNET, UNISAT_TESTNET, WALLETS, XVERSE, XVERSE_MAINNET, XVERSE_NETWORK, XVERSE_TESTNET, createConfig, getLeatherNetwork, getNetworkForLeather, getNetworkForUnisat, getNetworkForXverse, getUnisatNetwork, getXverseNetwork, useLaserEyes };