@harmoniclabs/use-cardano-wallet 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 MartinSchere
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,74 @@
+# use-cardano-wallet
+
+A simple react hook to connect your application to cardano wallets. This library does not take care of transaction building. For that, you should use something like [Lucid](https://github.com/Berry-Pool/lucid).
+
+> ℹ This library does not depend on `cardano-serialization-lib`, so you don't have to worry about big budle sizes!
+
+## Installation
+
+```
+npm i @asterium-dev/use-cardano-wallet
+```
+
+```
+yarn add @asterium-dev/use-cardano-wallet
+```
+
+## Basic usage
+
+```ts
+const {
+  connect,
+  isConnecting,
+  isConnected,
+  lovelaceBalance,
+  address,
+  network,
+  selectedWallet,
+  connectedWallet,
+  api,
+  disconnect,
+  isRefetchingBalance,
+  refetchBalance,
+} = useCardanoWallet();
+```
+
+## Example
+
+Check out the example in [this](./example/) folder
+
+---
+
+## API
+
+▸ **useCardanoWallet**(`options?`): ReturnVal
+
+### Parameters
+
+| Name      | Type                    | Default value    |
+| :-------- | :---------------------- | :--------------- |
+| `options` | UseCardanoWalletOptions | `defaultOptions` |
+
+### UseCardanoWalletOptions:
+
+| Name               | Type    | Description                                                                                                           |
+| :----------------- | :------ | :-------------------------------------------------------------------------------------------------------------------- |
+| `autoConnect?`     | boolean | Specify if the connector should automatically try to connect to previously connected wallets. Relies on localStorage. |
+| `localStorageKey?` | string  | Specify a local storage key to store the connected wallet name                                                        |
+
+### Returns object:
+
+| Name                  | Type              | Description                                                                      |
+| :-------------------- | :---------------- | :------------------------------------------------------------------------------- |
+| `address`             | null \| string    | bech32 representation of the wallet address                                      |
+| `api`                 | null \| WalletApi | The [CIP30](https://cips.cardano.org/cips/cip30/) object of the connected wallet |
+| `connect`             | Function          | Primary function to connect the desired wallet                                   |
+| `connectedWallet`     | null \| string    | The wallet that is currently connected.                                          |
+| `disconnect`          | Function          | Disconnects the current wallet                                                   |
+| `isConnected`         | boolean           | True if the wallet is connected                                                  |
+| `isConnecting`        | boolean           | Loading indicator for the wallet connection                                      |
+| `isRefetchingBalance` | boolean           | Loading indicator for balance refetch                                            |
+| `lovelaceBalance`     | null \| number    | Wallet balance, in lovelace (1 ADA = 1000000 lovelace)                           |
+| `network`             | null \| NetworkId | 0 if testnet, 1 if mainnet                                                       |
+| `refetchBalance`      | Function          | Refresh the wallet's balance                                                     |
+| `selectedWallet`      | null \| string    | The wallet that was selected to connect.                                         |

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+import { State } from './store';
+import { WalletName } from './typescript/cip30';
+export type UseCardanoWalletOptions = {
+    /**
+     * Specify if the connector should automatically try to connect
+     * to previously connected wallets. Relies on localStorage.
+     */
+    autoConnect?: boolean;
+    /**
+     * Specify a local storage key to store the connected wallet name
+     */
+    localStorageKey?: string;
+};
+type ReturnVal = Omit<State, 'connect' | 'getDetectedWallets'> & {
+    connect: (walletName: WalletName) => Promise<void>;
+};
+export declare const useCardanoWallet: ({ autoConnect, localStorageKey, }?: UseCardanoWalletOptions) => ReturnVal;
+export * from './typescript/cip30';

package/dist/index.js

@@ -0,0 +1,45 @@
+import { __assign, __awaiter, __generator, __rest } from "tslib";
+import { useEffect } from 'react';
+import { useStore } from './store';
+var defaultOptions = {
+    autoConnect: true,
+    localStorageKey: 'cardano-wallet-name',
+};
+export var useCardanoWallet = function (_a) {
+    var _b = _a === void 0 ? defaultOptions : _a, _c = _b.autoConnect, autoConnect = _c === void 0 ? true : _c, _d = _b.localStorageKey, localStorageKey = _d === void 0 ? 'cardano-wallet-name' : _d;
+    var _e = useStore(), connectWithStore = _e.connect, getDetectedWallets = _e.getDetectedWallets, storeDisconnect = _e.disconnect, rest = __rest(_e, ["connect", "getDetectedWallets", "disconnect"]);
+    useEffect(function () {
+        getDetectedWallets();
+    }, [getDetectedWallets]);
+    useEffect(function () {
+        // Check localStorage in case we are in SSR
+        if (autoConnect && typeof localStorage !== 'undefined') {
+            var connectedWalletName_1 = localStorage.getItem(localStorageKey);
+            if (!connectedWalletName_1) {
+                return;
+            }
+            // Setting timeout to let the wallet be injected and not get undefined
+            setTimeout(function () {
+                connectWithStore(connectedWalletName_1, localStorageKey);
+            }, 10);
+        }
+    }, [autoConnect, localStorageKey, connectWithStore]);
+    var connect = function (walletName) { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, connectWithStore(walletName, localStorageKey)];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); };
+    var disconnect = function () {
+        localStorage.removeItem(localStorageKey);
+        storeDisconnect();
+    };
+    return __assign({ connect: connect, disconnect: disconnect }, rest);
+};
+export * from './typescript/cip30';
+// export default useCardanoWallet;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC,OAAO,EAAE,QAAQ,EAA0B,MAAM,SAAS,CAAC;AAyB3D,IAAM,cAAc,GAA4B;IAC9C,WAAW,EAAE,IAAI;IACjB,eAAe,EAAE,qBAAqB;CACvC,CAAC;AAMF,MAAM,CAAC,IAAM,gBAAgB,GAAG,UAAC,EAGU;QAHV,qBAGJ,cAAc,KAAA,EAFzC,mBAAkB,EAAlB,WAAW,mBAAG,IAAI,KAAA,EAClB,uBAAuC,EAAvC,eAAe,mBAAG,qBAAqB,KAAA;IAEvC,IAAM,KAKF,QAAQ,EAAE,EAJH,gBAAgB,aAAA,EACzB,kBAAkB,wBAAA,EACN,eAAe,gBAAA,EACxB,IAAI,cAJH,+CAKL,CAAa,CAAC;IAEf,SAAS,CAAC;QACR,kBAAkB,EAAE,CAAC;IACvB,CAAC,EAAE,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAEzB,SAAS,CAAC;QACR,2CAA2C;QAC3C,IAAI,WAAW,IAAI,OAAO,YAAY,KAAK,WAAW,EAAE,CAAC;YACvD,IAAM,qBAAmB,GAAG,YAAY,CAAC,OAAO,CAC9C,eAAe,CACK,CAAC;YAEvB,IAAI,CAAC,qBAAmB,EAAE,CAAC;gBACzB,OAAO;YACT,CAAC;YAED,sEAAsE;YACtE,UAAU,CAAC;gBACT,gBAAgB,CAAC,qBAAmB,EAAE,eAAe,CAAC,CAAC;YACzD,CAAC,EAAE,EAAE,CAAC,CAAC;QACT,CAAC;IACH,CAAC,EAAE,CAAC,WAAW,EAAE,eAAe,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAErD,IAAM,OAAO,GAAG,UAAO,UAAsB;;;wBAC3C,qBAAM,gBAAgB,CAAC,UAAU,EAAE,eAAe,CAAC,EAAA;;oBAAnD,SAAmD,CAAC;;;;SACrD,CAAC;IACF,IAAM,UAAU,GAAG;QACjB,YAAY,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;QACzC,eAAe,EAAE,CAAC;IACpB,CAAC,CAAC;IAEF,kBAAS,OAAO,SAAA,EAAE,UAAU,YAAA,IAAK,IAAI,EAAG;AAC1C,CAAC,CAAC;AAEF,cAAc,oBAAoB,CAAC;AAEnC,mCAAmC"}

package/dist/store/index.d.ts

@@ -0,0 +1,30 @@
+import { NetworkId, WalletApi, WalletName } from '../typescript/cip30';
+export interface WalletInfo {
+    name: WalletName;
+    icon?: string | undefined;
+    displayName: string;
+}
+export type State = {
+    isConnected: boolean;
+    isConnecting: boolean;
+    isRefetchingBalance: boolean;
+    detectedWallets: WalletInfo[];
+    address: null | string;
+    rewardAddress: null | string;
+    /**
+     * The wallet that was selected to connect.
+     */
+    selectedWallet: null | WalletInfo;
+    /**
+     * The wallet that is currently connected.
+     */
+    connectedWallet: null | WalletInfo;
+    lovelaceBalance: null | number;
+    api: null | WalletApi;
+    network: null | NetworkId;
+    connect: (walletName: WalletName, localStorageKey: string) => Promise<void>;
+    getDetectedWallets: () => void;
+    disconnect: () => void;
+    refetchBalance: () => Promise<void>;
+};
+export declare const useStore: import("zustand").UseBoundStore<import("zustand").StoreApi<State>>;

package/dist/store/index.js

@@ -0,0 +1,134 @@
+import { __assign, __awaiter, __generator } from "tslib";
+import produce from 'immer';
+import { create } from 'zustand';
+import { NetworkId, WalletName } from '../typescript/cip30';
+import { parseBalance, toWalletInfo } from '../utils';
+import { fromHex } from '@harmoniclabs/uint8array-utils';
+import { encodeBech32 } from '@harmoniclabs/crypto';
+var defaults = {
+    isConnecting: false,
+    isConnected: false,
+    detectedWallets: [],
+    address: null,
+    lovelaceBalance: null,
+    api: null,
+    selectedWallet: null,
+    connectedWallet: null,
+    network: null,
+    isRefetchingBalance: false,
+    rewardAddress: null,
+};
+export var useStore = create()(function (set, get) { return (__assign(__assign({}, defaults), { disconnect: function () {
+        set(function (prev) {
+            return __assign(__assign({}, defaults), { 
+                // Keep detected wallets
+                detectedWallets: prev.detectedWallets });
+        });
+    }, refetchBalance: function () { return __awaiter(void 0, void 0, void 0, function () {
+        var api, balance, lovelace;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    api = get().api;
+                    if (api === null)
+                        return [2 /*return*/];
+                    set(produce(function (draft) {
+                        draft.isRefetchingBalance = true;
+                    }));
+                    return [4 /*yield*/, api.getBalance()];
+                case 1:
+                    balance = _a.sent();
+                    lovelace = parseBalance(balance);
+                    set(produce(function (draft) {
+                        draft.isRefetchingBalance = false;
+                        draft.lovelaceBalance = lovelace;
+                    }));
+                    return [2 /*return*/];
+            }
+        });
+    }); }, getDetectedWallets: function () { return __awaiter(void 0, void 0, void 0, function () {
+        var ns;
+        return __generator(this, function (_a) {
+            if (typeof window === 'undefined' || !window.cardano) {
+                return [2 /*return*/];
+            }
+            ns = window.cardano;
+            set(produce(function (draft) {
+                draft.detectedWallets = Object.keys(ns)
+                    .filter(function (ns) { return Object.values(WalletName).includes(ns); })
+                    .map(function (n) { return toWalletInfo(n); });
+            }));
+            return [2 /*return*/];
+        });
+    }); }, connect: function (walletName, localStorageKey) { return __awaiter(void 0, void 0, void 0, function () {
+        var api_1, rawAddress, rewardAddress_1, buf, addressBytes_1, balance, decodedBalance_1, bechAddr_1, e_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    set(produce(function (draft) {
+                        draft.isConnecting = true;
+                        draft.selectedWallet = toWalletInfo(walletName);
+                    }));
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 10, , 11]);
+                    // Exit early if the Cardano dApp-Wallet Web Bridge (CIP 30) has not been injected
+                    // This can happen in a SSR scenario for example
+                    if (typeof window === 'undefined' || !window.cardano) {
+                        throw Error('window.cardano is undefined');
+                    }
+                    return [4 /*yield*/, window.cardano[walletName].enable()];
+                case 2:
+                    api_1 = _a.sent();
+                    return [4 /*yield*/, api_1.getChangeAddress()];
+                case 3:
+                    rawAddress = _a.sent();
+                    if (!!rawAddress) return [3 /*break*/, 5];
+                    return [4 /*yield*/, api_1.getUsedAddresses()];
+                case 4:
+                    rawAddress = (_a.sent())[0];
+                    _a.label = 5;
+                case 5:
+                    if (!!rawAddress) return [3 /*break*/, 7];
+                    return [4 /*yield*/, api_1.getUnusedAddresses()];
+                case 6:
+                    rawAddress = (_a.sent())[0];
+                    _a.label = 7;
+                case 7: return [4 /*yield*/, api_1.getRewardAddresses()];
+                case 8:
+                    rewardAddress_1 = (_a.sent())[0];
+                    if (rewardAddress_1) {
+                        buf = fromHex(rewardAddress_1);
+                        rewardAddress_1 = encodeBech32(buf[0] === NetworkId.MAINNET ? 'stake' : 'stake_test', buf.slice(1));
+                    }
+                    addressBytes_1 = fromHex(rawAddress);
+                    return [4 /*yield*/, api_1.getBalance()];
+                case 9:
+                    balance = _a.sent();
+                    decodedBalance_1 = parseBalance(balance);
+                    bechAddr_1 = encodeBech32(addressBytes_1[0] === NetworkId.MAINNET ? 'addr' : 'addr_test', addressBytes_1.slice(1));
+                    localStorage.setItem(localStorageKey, walletName);
+                    set(produce(function (draft) {
+                        draft.isConnecting = false;
+                        draft.isConnected = true;
+                        draft.api = api_1;
+                        draft.lovelaceBalance = decodedBalance_1;
+                        draft.rewardAddress = rewardAddress_1;
+                        draft.address = bechAddr_1;
+                        draft.network = addressBytes_1[0];
+                        draft.connectedWallet = toWalletInfo(walletName);
+                    }));
+                    return [3 /*break*/, 11];
+                case 10:
+                    e_1 = _a.sent();
+                    console.error(e_1);
+                    set(produce(function (draft) {
+                        draft.isConnecting = false;
+                        draft.selectedWallet = null;
+                    }));
+                    return [3 /*break*/, 11];
+                case 11: return [2 /*return*/];
+            }
+        });
+    }); } })); });
+//# sourceMappingURL=index.js.map

package/dist/store/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/store/index.ts"],"names":[],"mappings":";AAAA,OAAO,OAAO,MAAM,OAAO,CAAC;AAC5B,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC,OAAO,EAAE,SAAS,EAAa,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAuCpD,IAAM,QAAQ,GAAG;IACf,YAAY,EAAE,KAAK;IACnB,WAAW,EAAE,KAAK;IAClB,eAAe,EAAE,EAAE;IACnB,OAAO,EAAE,IAAI;IACb,eAAe,EAAE,IAAI;IACrB,GAAG,EAAE,IAAI;IACT,cAAc,EAAE,IAAI;IACpB,eAAe,EAAE,IAAI;IACrB,OAAO,EAAE,IAAI;IACb,mBAAmB,EAAE,KAAK;IAC1B,aAAa,EAAE,IAAI;CACpB,CAAC;AAEF,MAAM,CAAC,IAAM,QAAQ,GAAG,MAAM,EAAS,CAAC,UAAC,GAAG,EAAE,GAAG,IAAK,OAAA,uBACjD,QAAQ,KACX,UAAU,EAAE;QACV,GAAG,CAAC,UAAC,IAAW;YACd,6BACK,QAAQ;gBACX,wBAAwB;gBACxB,eAAe,EAAE,IAAI,CAAC,eAAe,IACrC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,EAED,cAAc,EAAE;;;;;oBACR,GAAG,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC;oBAEtB,IAAI,GAAG,KAAK,IAAI;wBAAE,sBAAO;oBAEzB,GAAG,CACD,OAAO,CAAC,UAAC,KAAY;wBACnB,KAAK,CAAC,mBAAmB,GAAG,IAAI,CAAC;oBACnC,CAAC,CAAC,CACH,CAAC;oBAEc,qBAAM,GAAG,CAAC,UAAU,EAAE,EAAA;;oBAAhC,OAAO,GAAG,SAAsB;oBAChC,QAAQ,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;oBAEvC,GAAG,CACD,OAAO,CAAC,UAAC,KAAY;wBACnB,KAAK,CAAC,mBAAmB,GAAG,KAAK,CAAC;wBAClC,KAAK,CAAC,eAAe,GAAG,QAAQ,CAAC;oBACnC,CAAC,CAAC,CACH,CAAC;;;;SACH,EAED,kBAAkB,EAAE;;;YAClB,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,CAAE,MAAc,CAAC,OAAO,EAAE,CAAC;gBAC9D,sBAAO;YACT,CAAC;YAEK,EAAE,GAAI,MAAc,CAAC,OAAO,CAAC;YAEnC,GAAG,CACD,OAAO,CAAC,UAAC,KAAY;gBACnB,KAAK,CAAC,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;qBACpC,MAAM,CAAC,UAAA,EAAE,IAAI,OAAA,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,EAAgB,CAAC,EAApD,CAAoD,CAAC;qBAClE,GAAG,CAAC,UAAA,CAAC,IAAI,OAAA,YAAY,CAAC,CAAe,CAAC,EAA7B,CAA6B,CAAC,CAAC;YAC7C,CAAC,CAAC,CACH,CAAC;;;SACH,EAED,OAAO,EAAE,UAAO,UAAsB,EAAE,eAAuB;;;;;oBAC7D,GAAG,CACD,OAAO,CAAC,UAAC,KAAY;wBACnB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;wBAC1B,KAAK,CAAC,cAAc,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC;oBAClD,CAAC,CAAC,CACH,CAAC;;;;oBAGA,kFAAkF;oBAClF,gDAAgD;oBAChD,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,CAAE,MAAc,CAAC,OAAO,EAAE,CAAC;wBAC9D,MAAM,KAAK,CAAC,6BAA6B,CAAC,CAAC;oBAC7C,CAAC;oBAEsB,qBAAO,MAAc,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE,EAAA;;oBAAnE,QAAiB,SAAkD;oBACxD,qBAAM,KAAG,CAAC,gBAAgB,EAAE,EAAA;;oBAAzC,UAAU,GAAG,SAA4B;yBACzC,CAAC,UAAU,EAAX,wBAAW;oBACE,qBAAM,KAAG,CAAC,gBAAgB,EAAE,EAAA;;oBAA1C,UAAU,GAAI,CAAA,SAA4B,CAAA,GAAhC,CAAiC;;;yBAE1C,CAAC,UAAU,EAAX,wBAAW;oBACE,qBAAM,KAAG,CAAC,kBAAkB,EAAE,EAAA;;oBAA5C,UAAU,GAAI,CAAA,SAA8B,CAAA,GAAlC,CAAmC;;wBAG1B,qBAAM,KAAG,CAAC,kBAAkB,EAAE,EAAA;;oBAA/C,kBAAiB,CAAA,SAA8B,CAAA,GAAlC;oBAElB,IAAI,eAAa,EAAE,CAAC;wBACZ,GAAG,GAAG,OAAO,CAAE,eAAa,CAAE,CAAC;wBACrC,eAAa,GAAG,YAAY,CAC1B,GAAG,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,EACrD,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CACb,CAAC;oBACJ,CAAC;oBAEK,iBAAe,OAAO,CAAE,UAAU,CAAE,CAAC;oBAC3B,qBAAM,KAAG,CAAC,UAAU,EAAE,EAAA;;oBAAhC,OAAO,GAAG,SAAsB;oBAEhC,mBAAiB,YAAY,CAAE,OAAO,CAAE,CAAC;oBAEzC,aAAW,YAAY,CAC3B,cAAY,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,EAC5D,cAAY,CAAC,KAAK,CAAE,CAAC,CAAE,CACxB,CAAC;oBAEF,YAAY,CAAC,OAAO,CAAE,eAAe,EAAE,UAAU,CAAE,CAAC;oBAEpD,GAAG,CACD,OAAO,CAAC,UAAC,KAAY;wBACnB,KAAK,CAAC,YAAY,GAAG,KAAK,CAAC;wBAC3B,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC;wBACzB,KAAK,CAAC,GAAG,GAAG,KAAG,CAAC;wBAChB,KAAK,CAAC,eAAe,GAAG,gBAAc,CAAC;wBACvC,KAAK,CAAC,aAAa,GAAG,eAAa,CAAC;wBACpC,KAAK,CAAC,OAAO,GAAG,UAAQ,CAAC;wBACzB,KAAK,CAAC,OAAO,GAAG,cAAY,CAAC,CAAC,CAAc,CAAC;wBAC7C,KAAK,CAAC,eAAe,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC;oBACnD,CAAC,CAAC,CACH,CAAC;;;;oBAEF,OAAO,CAAC,KAAK,CAAC,GAAC,CAAC,CAAC;oBACjB,GAAG,CACD,OAAO,CAAC,UAAC,KAAY;wBACnB,KAAK,CAAC,YAAY,GAAG,KAAK,CAAC;wBAC3B,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC;oBAC9B,CAAC,CAAC,CACH,CAAC;;;;;SAEL,IACD,EAtHoD,CAsHpD,CAAC,CAAC"}

package/dist/typescript/cip30.d.ts

@@ -0,0 +1,176 @@
+export declare enum NetworkId {
+    TESTNET = 0,
+    MAINNET = 1
+}
+/**
+ * A hex-encoded string of the corresponding bytes.
+ */
+export type Bytes = string;
+/**
+ * A hex-encoded string representing CBOR either inside
+ * of the Shelley Multi-asset binary spec or, if not present there,
+ * from the CIP-0008 signing spec.
+ */
+export type Cbor = string;
+/**
+   *  Used to specify optional pagination for some API calls.
+  Limits results to {limit} each page, and uses a 0-indexing {page}
+  to refer to which of those pages of {limit} items each.
+   */
+export type Paginate = {
+    page: number;
+    limit: number;
+};
+/**
+ * DataSignature type as described in CIP-0030.
+ */
+type CoseSign1CborHex = string;
+type CoseKeyCborHex = string;
+export interface Cip30DataSignature {
+    key: CoseKeyCborHex;
+    signature: CoseSign1CborHex;
+}
+/**
+ * Returns the network id of the currently connected account.
+ * 0 is testnet and 1 is mainnet but other networks can possibly be returned by wallets.
+ * Those other network ID values are not governed by this document.
+ *
+ * This result will stay the same unless the connected account has changed.
+ *
+ * @throws ApiError
+ */
+export type GetNetworkId = () => Promise<NetworkId>;
+/**
+ * If `amount` is `undefined`, this shall return a list of all UTxOs (unspent transaction outputs)
+ * controlled by the wallet.
+ *
+ * If `amount` is not `undefined`, this request shall be limited to just the UTxOs that are required
+ * to reach the combined ADA/multi-asset value target specified in `amount`,
+ * and if this cannot be attained, `undefined` shall be returned.
+ *
+ * The results can be further paginated by `paginate` if it is not `undefined`.
+ *
+ * @throws ApiError
+ * @throws PaginateError
+ */
+export type GetUtxos = (amount?: Cbor, paginate?: Paginate) => Promise<Cbor[] | undefined>;
+/**
+ * @returns a list of one or more UTxOs (unspent transaction outputs) controlled by the wallet
+ * that are required to reach AT LEAST the combined ADA value target specified in amount
+ * AND the best suitable to be used as collateral inputs
+ * for transactions with plutus script inputs (pure ADA-only UTxOs).
+ * @throws ApiError
+ */
+export type GetCollateral = (params?: {
+    amount?: Cbor;
+}) => Promise<Cbor[] | null>;
+/**
+ * Returns the total balance available of the wallet.
+ *
+ * This is the same as summing the results of `api.getUtxos()`, but it is both useful to dApps
+ * and likely already maintained by the implementing wallet in a more efficient manner
+ * so it has been included in the API as well.
+ *
+ * @throws ApiError
+ */
+export type GetBalance = () => Promise<Cbor>;
+/**
+ * Returns a list of all used (included in some on-chain transaction) addresses controlled by the wallet.
+ *
+ * The results can be further paginated by `paginate` if it is not `undefined`.
+ *
+ * @throws ApiError
+ * @throws PaginateError
+ */
+export type GetUsedAddresses = (paginate?: Paginate) => Promise<Cbor[]>;
+/**
+ * Returns a list of unused addresses controlled by the wallet.
+ *
+ * @throws ApiError
+ */
+export type GetUnusedAddresses = () => Promise<Cbor[]>;
+/**
+ * Returns an address owned by the wallet that should be used as a change address to return
+ * leftover assets during transaction creation back to the connected wallet.
+ *
+ * This can be used as a generic receive address as well.
+ *
+ * @throws ApiError
+ */
+export type GetChangeAddress = () => Promise<Cbor>;
+/**
+ * Returns the reward addresses owned by the wallet. This can return multiple addresses e.g. CIP-0018.
+ *
+ * @throws ApiError
+ */
+export type GetRewardAddresses = () => Promise<Cbor[]>;
+/**
+ * Requests that a user sign the unsigned portions of the supplied transaction.
+ *
+ * The wallet should ask the user for permission, and if given,
+ * try to sign the supplied body and return a signed transaction.
+ *
+ * If `partialSign` is `true`, the wallet only tries to sign what it can.
+ *
+ * If `partialSign` is `false` and the wallet could not sign the entire transaction,
+ * `TxSignError` shall be returned with the `ProofGeneration` code.
+ *
+ * Likewise if the user declined in either case it shall return the `UserDeclined` code.
+ *
+ * Only the portions of the witness set that were signed as a result of this call are
+ * returned to encourage dApps to verify the contents returned by this endpoint while building the final transaction.
+ *
+ * @throws ApiError
+ * @throws TxSignError
+ */
+export type SignTx = (tx: Cbor, partialSign?: boolean) => Promise<Cbor>;
+/**
+ * This endpoint utilizes the CIP-0008 signing spec for standardization/safety reasons.
+ *
+ * It allows the dApp to request the user to sign data conforming to said spec.
+ *
+ * The user's consent should be requested and the details of `sig_structure` shown to them in an informative way.
+ *
+ * Please refer to the CIP-0008 spec for details on how to construct the sig structure.
+ *
+ * @throws ApiError
+ * @throws DataSignError
+ */
+export type SignData = (addr: string, payload: Bytes) => Promise<Cip30DataSignature>;
+/**
+ * As wallets should already have this ability, we allow dApps to request that a transaction be sent through it.
+ *
+ * If the wallet accepts the transaction and tries to send it, it shall return the transaction id for the dApp to track.
+ *
+ * The wallet is free to return the `TxSendError` with code `Refused` if they do not wish to send it,
+ * or `Failure` if there was an error in sending it (e.g. preliminary checks failed on signatures).
+ *
+ * @throws ApiError
+ * @throws TxSendError
+ */
+export type SubmitTx = (tx: Cbor) => Promise<string>;
+export declare enum WalletName {
+    NAMI = "nami",
+    ETERNL = "eternl",
+    FLINT = "flint",
+    BEGIN = "begin",
+    GERO = "gero",
+    TYPHON = "typhoncip30",
+    LACE = "lace",
+    VESPR = "vespr"
+}
+export interface WalletApi {
+    getNetworkId: GetNetworkId;
+    getUtxos: GetUtxos;
+    getBalance: GetBalance;
+    getCollateral: GetCollateral;
+    getUsedAddresses: GetUsedAddresses;
+    getUnusedAddresses: GetUnusedAddresses;
+    getChangeAddress: GetChangeAddress;
+    getRewardAddresses: GetRewardAddresses;
+    signTx: SignTx;
+    signData: SignData;
+    submitTx: SubmitTx;
+}
+export type WalletMethod = keyof WalletApi;
+export {};

package/dist/typescript/cip30.js

@@ -0,0 +1,17 @@
+export var NetworkId;
+(function (NetworkId) {
+    NetworkId[NetworkId["TESTNET"] = 0] = "TESTNET";
+    NetworkId[NetworkId["MAINNET"] = 1] = "MAINNET";
+})(NetworkId || (NetworkId = {}));
+export var WalletName;
+(function (WalletName) {
+    WalletName["NAMI"] = "nami";
+    WalletName["ETERNL"] = "eternl";
+    WalletName["FLINT"] = "flint";
+    WalletName["BEGIN"] = "begin";
+    WalletName["GERO"] = "gero";
+    WalletName["TYPHON"] = "typhoncip30";
+    WalletName["LACE"] = "lace";
+    WalletName["VESPR"] = "vespr";
+})(WalletName || (WalletName = {}));
+//# sourceMappingURL=cip30.js.map

package/dist/typescript/cip30.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cip30.js","sourceRoot":"","sources":["../../src/typescript/cip30.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,+CAAW,CAAA;IACX,+CAAW,CAAA;AACb,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAuKD,MAAM,CAAN,IAAY,UASX;AATD,WAAY,UAAU;IACpB,2BAAa,CAAA;IACb,+BAAiB,CAAA;IACjB,6BAAe,CAAA;IACf,6BAAe,CAAA;IACf,2BAAa,CAAA;IACb,oCAAsB,CAAA;IACtB,2BAAa,CAAA;IACb,6BAAe,CAAA;AACjB,CAAC,EATW,UAAU,KAAV,UAAU,QASrB"}

package/dist/utils.d.ts

@@ -0,0 +1,4 @@
+import { WalletName } from './typescript/cip30';
+import { WalletInfo } from './store';
+export declare function parseBalance(balance: string): number;
+export declare function toWalletInfo(walletName: WalletName): WalletInfo;

package/dist/utils.js

@@ -0,0 +1,21 @@
+import { walletPrettyNames } from './wallets';
+import { Cbor, CborNegInt, CborUInt } from '@harmoniclabs/cbor';
+export function parseBalance(balance) {
+    var cbor = Cbor.parse(balance);
+    if (cbor instanceof CborNegInt
+        || cbor instanceof CborUInt)
+        return Number(cbor.num);
+    return 0;
+}
+;
+export function toWalletInfo(walletName) {
+    var _a, _b, _c;
+    var ns = (_a = globalThis === null || globalThis === void 0 ? void 0 : globalThis.cardano) !== null && _a !== void 0 ? _a : {};
+    return {
+        name: walletName,
+        displayName: (_b = walletPrettyNames[walletName]) !== null && _b !== void 0 ? _b : walletName,
+        icon: (_c = ns[walletName]) === null || _c === void 0 ? void 0 : _c.icon,
+    };
+}
+;
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAEhE,MAAM,UAAU,YAAY,CAAE,OAAe;IAE3C,IAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAE,OAAO,CAAE,CAAC;IACnC,IACE,IAAI,YAAY,UAAU;WACvB,IAAI,YAAY,QAAQ;QAC3B,OAAO,MAAM,CAAE,IAAI,CAAC,GAAG,CAAE,CAAC;IAC5B,OAAO,CAAC,CAAC;AACX,CAAC;AAAA,CAAC;AAEF,MAAM,UAAU,YAAY,CAAC,UAAsB;;IAEjD,IAAM,EAAE,GAAG,MAAC,UAAkB,aAAlB,UAAU,uBAAV,UAAU,CAAU,OAAO,mCAAI,EAAE,CAAC;IAE9C,OAAO;QACL,IAAI,EAAE,UAAU;QAChB,WAAW,EAAE,MAAA,iBAAiB,CAAC,UAAU,CAAC,mCAAI,UAAU;QACxD,IAAI,EAAE,MAAA,EAAE,CAAC,UAAU,CAAC,0CAAE,IAAI;KAC3B,CAAC;AACJ,CAAC;AAAA,CAAC"}

package/dist/wallets.d.ts

@@ -0,0 +1,2 @@
+import { WalletName } from './typescript/cip30';
+export declare const walletPrettyNames: Record<WalletName, string>;

package/dist/wallets.js

@@ -0,0 +1,11 @@
+export var walletPrettyNames = {
+    begin: 'Begin',
+    eternl: 'Eternl',
+    flint: 'Flint',
+    gero: 'Gero',
+    lace: 'Lace',
+    nami: 'Nami',
+    typhoncip30: 'Typhon',
+    vespr: 'Vespr',
+};
+//# sourceMappingURL=wallets.js.map

package/dist/wallets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wallets.js","sourceRoot":"","sources":["../src/wallets.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,IAAM,iBAAiB,GAA+B;IAC3D,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,WAAW,EAAE,QAAQ;IACrB,KAAK,EAAE,OAAO;CACf,CAAC"}

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@harmoniclabs/use-cardano-wallet",
+  "author": "Harmonic Labs",
+  "version": "0.0.1",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "src",
+    "!src/test"
+  ],
+  "engines": {
+    "node": ">=10"
+  },
+  "scripts": {
+    "start": "tsdx watch",
+    "build": "tsc --project tsconfig.json",
+    "test": "tsdx test --passWithNoTests",
+    "lint": "tsdx lint",
+    "prepare": "npm run build",
+    "size": "size-limit",
+    "analyze": "size-limit --why"
+  },
+  "peerDependencies": {
+    "react": ">=16"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "tsdx lint"
+    }
+  },
+  "prettier": {
+    "printWidth": 80,
+    "semi": true,
+    "singleQuote": true,
+    "trailingComma": "es5"
+  },
+  "size-limit": [
+    {
+      "path": "dist/index.js",
+      "limit": "10 KB"
+    }
+  ],
+  "devDependencies": {
+    "@size-limit/preset-small-lib": "^12.0.0",
+    "@types/react": "^18.0.17",
+    "@types/react-dom": "^18.0.6",
+    "husky": "^8.0.1",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "size-limit": "^8.0.1",
+    "tsdx": "^2.0.0",
+    "tslib": "^2.4.0",
+    "typedoc-plugin-markdown": "^3.13.4",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "@harmoniclabs/cbor": "^2.0.1",
+    "@harmoniclabs/crypto": "^0.3.0",
+    "@harmoniclabs/uint8array-utils": "^1.0.4",
+    "immer": "^9.0.15",
+    "zustand": "^4.0.0"
+  }
+}

package/src/index.ts

@@ -0,0 +1,83 @@
+import { useEffect } from 'react';
+
+import { useStore, WalletInfo as _, State } from './store';
+import { WalletName } from './typescript/cip30';
+
+export type UseCardanoWalletOptions = {
+  /**
+   * Specify if the connector should automatically try to connect
+   * to previously connected wallets. Relies on localStorage.
+   */
+  autoConnect?: boolean;
+
+  /**
+   * Specify a local storage key to store the connected wallet name
+   */
+  localStorageKey?: string;
+
+  /**
+   * If specified, it will call `api.getUtxos()` using the specified
+   * interval (in milliseconds). When `utxos` is referenced from the
+   * hook, it will return the prefetched array.
+   *
+   * This is useful for saving on load times when building transactions.
+   */
+  // prefetchUtxosInterval?: number | null;
+};
+
+const defaultOptions: UseCardanoWalletOptions = {
+  autoConnect: true,
+  localStorageKey: 'cardano-wallet-name',
+};
+
+type ReturnVal = Omit<State, 'connect' | 'getDetectedWallets'> & {
+  connect: (walletName: WalletName) => Promise<void>;
+};
+
+export const useCardanoWallet = ({
+  autoConnect = true,
+  localStorageKey = 'cardano-wallet-name',
+}: UseCardanoWalletOptions = defaultOptions): ReturnVal => {
+  const {
+    connect: connectWithStore,
+    getDetectedWallets,
+    disconnect: storeDisconnect,
+    ...rest
+  } = useStore();
+
+  useEffect(() => {
+    getDetectedWallets();
+  }, [getDetectedWallets]);
+
+  useEffect(() => {
+    // Check localStorage in case we are in SSR
+    if (autoConnect && typeof localStorage !== 'undefined') {
+      const connectedWalletName = localStorage.getItem(
+        localStorageKey
+      ) as WalletName | null;
+
+      if (!connectedWalletName) {
+        return;
+      }
+
+      // Setting timeout to let the wallet be injected and not get undefined
+      setTimeout(() => {
+        connectWithStore(connectedWalletName, localStorageKey);
+      }, 10);
+    }
+  }, [autoConnect, localStorageKey, connectWithStore]);
+
+  const connect = async (walletName: WalletName) => {
+    await connectWithStore(walletName, localStorageKey);
+  };
+  const disconnect = () => {
+    localStorage.removeItem(localStorageKey);
+    storeDisconnect();
+  };
+
+  return { connect, disconnect, ...rest };
+};
+
+export * from './typescript/cip30';
+
+// export default useCardanoWallet;

package/src/store/index.ts

@@ -0,0 +1,178 @@
+import produce from 'immer';
+import { create } from 'zustand';
+
+import { NetworkId, WalletApi, WalletName } from '../typescript/cip30';
+import { parseBalance, toWalletInfo } from '../utils';
+import { fromHex } from '@harmoniclabs/uint8array-utils';
+import { encodeBech32 } from '@harmoniclabs/crypto';
+
+export interface WalletInfo {
+  name: WalletName;
+  icon?: string | undefined;
+  displayName: string;
+}
+
+export type State = {
+  isConnected: boolean;
+  isConnecting: boolean;
+  isRefetchingBalance: boolean;
+
+  detectedWallets: WalletInfo[];
+
+  address: null | string;
+
+  rewardAddress: null | string;
+
+  /**
+   * The wallet that was selected to connect.
+   */
+  selectedWallet: null | WalletInfo;
+
+  /**
+   * The wallet that is currently connected.
+   */
+  connectedWallet: null | WalletInfo;
+
+  lovelaceBalance: null | number;
+  api: null | WalletApi;
+  network: null | NetworkId;
+
+  connect: (walletName: WalletName, localStorageKey: string) => Promise<void>;
+  getDetectedWallets: () => void;
+  disconnect: () => void;
+  refetchBalance: () => Promise<void>;
+};
+
+const defaults = {
+  isConnecting: false,
+  isConnected: false,
+  detectedWallets: [],
+  address: null,
+  lovelaceBalance: null,
+  api: null,
+  selectedWallet: null,
+  connectedWallet: null,
+  network: null,
+  isRefetchingBalance: false,
+  rewardAddress: null,
+};
+
+export const useStore = create<State>()((set, get) => ({
+  ...defaults,
+  disconnect: () => {
+    set((prev: State) => {
+      return {
+        ...defaults,
+        // Keep detected wallets
+        detectedWallets: prev.detectedWallets,
+      };
+    });
+  },
+
+  refetchBalance: async () => {
+    const api = get().api;
+
+    if (api === null) return;
+
+    set(
+      produce((draft: State) => {
+        draft.isRefetchingBalance = true;
+      })
+    );
+
+    const balance = await api.getBalance();
+    const lovelace = parseBalance(balance);
+
+    set(
+      produce((draft: State) => {
+        draft.isRefetchingBalance = false;
+        draft.lovelaceBalance = lovelace;
+      })
+    );
+  },
+
+  getDetectedWallets: async () => {
+    if (typeof window === 'undefined' || !(window as any).cardano) {
+      return;
+    }
+
+    const ns = (window as any).cardano;
+
+    set(
+      produce((draft: State) => {
+        draft.detectedWallets = Object.keys(ns)
+          .filter(ns => Object.values(WalletName).includes(ns as WalletName))
+          .map(n => toWalletInfo(n as WalletName));
+      })
+    );
+  },
+
+  connect: async (walletName: WalletName, localStorageKey: string) => {
+    set(
+      produce((draft: State) => {
+        draft.isConnecting = true;
+        draft.selectedWallet = toWalletInfo(walletName);
+      })
+    );
+
+    try {
+      // Exit early if the Cardano dApp-Wallet Web Bridge (CIP 30) has not been injected
+      // This can happen in a SSR scenario for example
+      if (typeof window === 'undefined' || !(window as any).cardano) {
+        throw Error('window.cardano is undefined');
+      }
+
+      const api: WalletApi = await (window as any).cardano[walletName].enable();
+      let rawAddress = await api.getChangeAddress();
+      if (!rawAddress) {
+        [rawAddress] = await api.getUsedAddresses();
+      }
+      if (!rawAddress) {
+        [rawAddress] = await api.getUnusedAddresses();
+      }
+
+      let [rewardAddress] = await api.getRewardAddresses();
+
+      if (rewardAddress) {
+        const buf = fromHex( rewardAddress );
+        rewardAddress = encodeBech32(
+          buf[0] === NetworkId.MAINNET ? 'stake' : 'stake_test',
+          buf.slice(1)
+        );
+      }
+
+      const addressBytes = fromHex( rawAddress );
+      const balance = await api.getBalance();
+
+      const decodedBalance = parseBalance( balance );
+
+      const bechAddr = encodeBech32(
+        addressBytes[0] === NetworkId.MAINNET ? 'addr' : 'addr_test',
+        addressBytes.slice( 1 )
+      );
+
+      localStorage.setItem( localStorageKey, walletName );
+
+      set(
+        produce((draft: State) => {
+          draft.isConnecting = false;
+          draft.isConnected = true;
+          draft.api = api;
+          draft.lovelaceBalance = decodedBalance;
+          draft.rewardAddress = rewardAddress;
+          draft.address = bechAddr;
+          draft.network = addressBytes[0] as NetworkId;
+          draft.connectedWallet = toWalletInfo(walletName);
+        })
+      );
+    } catch (e) {
+      console.error(e);
+      set(
+        produce((draft: State) => {
+          draft.isConnecting = false;
+          draft.selectedWallet = null;
+        })
+      );
+    }
+  },
+}));

package/src/typescript/cip30.ts

@@ -0,0 +1,206 @@
+export enum NetworkId {
+  TESTNET = 0,
+  MAINNET = 1,
+}
+/**
+ * A hex-encoded string of the corresponding bytes.
+ */
+export type Bytes = string;
+
+/**
+ * A hex-encoded string representing CBOR either inside
+ * of the Shelley Multi-asset binary spec or, if not present there,
+ * from the CIP-0008 signing spec.
+ */
+export type Cbor = string;
+
+/**
+   *  Used to specify optional pagination for some API calls.
+  Limits results to {limit} each page, and uses a 0-indexing {page}
+  to refer to which of those pages of {limit} items each.
+   */
+export type Paginate = { page: number; limit: number };
+
+/**
+ * DataSignature type as described in CIP-0030.
+ */
+
+type CoseSign1CborHex = string;
+type CoseKeyCborHex = string;
+
+export interface Cip30DataSignature {
+  key: CoseKeyCborHex;
+  signature: CoseSign1CborHex;
+}
+
+/**
+ * Returns the network id of the currently connected account.
+ * 0 is testnet and 1 is mainnet but other networks can possibly be returned by wallets.
+ * Those other network ID values are not governed by this document.
+ *
+ * This result will stay the same unless the connected account has changed.
+ *
+ * @throws ApiError
+ */
+export type GetNetworkId = () => Promise<NetworkId>;
+/**
+ * If `amount` is `undefined`, this shall return a list of all UTxOs (unspent transaction outputs)
+ * controlled by the wallet.
+ *
+ * If `amount` is not `undefined`, this request shall be limited to just the UTxOs that are required
+ * to reach the combined ADA/multi-asset value target specified in `amount`,
+ * and if this cannot be attained, `undefined` shall be returned.
+ *
+ * The results can be further paginated by `paginate` if it is not `undefined`.
+ *
+ * @throws ApiError
+ * @throws PaginateError
+ */
+export type GetUtxos = (
+  amount?: Cbor,
+  paginate?: Paginate
+) => Promise<Cbor[] | undefined>;
+
+/**
+ * @returns a list of one or more UTxOs (unspent transaction outputs) controlled by the wallet
+ * that are required to reach AT LEAST the combined ADA value target specified in amount
+ * AND the best suitable to be used as collateral inputs
+ * for transactions with plutus script inputs (pure ADA-only UTxOs).
+ * @throws ApiError
+ */
+export type GetCollateral = (params?: {
+  amount?: Cbor;
+}) => Promise<Cbor[] | null>;
+
+/**
+ * Returns the total balance available of the wallet.
+ *
+ * This is the same as summing the results of `api.getUtxos()`, but it is both useful to dApps
+ * and likely already maintained by the implementing wallet in a more efficient manner
+ * so it has been included in the API as well.
+ *
+ * @throws ApiError
+ */
+export type GetBalance = () => Promise<Cbor>;
+
+/**
+ * Returns a list of all used (included in some on-chain transaction) addresses controlled by the wallet.
+ *
+ * The results can be further paginated by `paginate` if it is not `undefined`.
+ *
+ * @throws ApiError
+ * @throws PaginateError
+ */
+export type GetUsedAddresses = (paginate?: Paginate) => Promise<Cbor[]>;
+
+/**
+ * Returns a list of unused addresses controlled by the wallet.
+ *
+ * @throws ApiError
+ */
+export type GetUnusedAddresses = () => Promise<Cbor[]>;
+
+/**
+ * Returns an address owned by the wallet that should be used as a change address to return
+ * leftover assets during transaction creation back to the connected wallet.
+ *
+ * This can be used as a generic receive address as well.
+ *
+ * @throws ApiError
+ */
+export type GetChangeAddress = () => Promise<Cbor>;
+
+/**
+ * Returns the reward addresses owned by the wallet. This can return multiple addresses e.g. CIP-0018.
+ *
+ * @throws ApiError
+ */
+export type GetRewardAddresses = () => Promise<Cbor[]>;
+
+/**
+ * Requests that a user sign the unsigned portions of the supplied transaction.
+ *
+ * The wallet should ask the user for permission, and if given,
+ * try to sign the supplied body and return a signed transaction.
+ *
+ * If `partialSign` is `true`, the wallet only tries to sign what it can.
+ *
+ * If `partialSign` is `false` and the wallet could not sign the entire transaction,
+ * `TxSignError` shall be returned with the `ProofGeneration` code.
+ *
+ * Likewise if the user declined in either case it shall return the `UserDeclined` code.
+ *
+ * Only the portions of the witness set that were signed as a result of this call are
+ * returned to encourage dApps to verify the contents returned by this endpoint while building the final transaction.
+ *
+ * @throws ApiError
+ * @throws TxSignError
+ */
+export type SignTx = (tx: Cbor, partialSign?: boolean) => Promise<Cbor>;
+
+/**
+ * This endpoint utilizes the CIP-0008 signing spec for standardization/safety reasons.
+ *
+ * It allows the dApp to request the user to sign data conforming to said spec.
+ *
+ * The user's consent should be requested and the details of `sig_structure` shown to them in an informative way.
+ *
+ * Please refer to the CIP-0008 spec for details on how to construct the sig structure.
+ *
+ * @throws ApiError
+ * @throws DataSignError
+ */
+export type SignData = (
+  addr: string,
+  payload: Bytes
+) => Promise<Cip30DataSignature>;
+
+/**
+ * As wallets should already have this ability, we allow dApps to request that a transaction be sent through it.
+ *
+ * If the wallet accepts the transaction and tries to send it, it shall return the transaction id for the dApp to track.
+ *
+ * The wallet is free to return the `TxSendError` with code `Refused` if they do not wish to send it,
+ * or `Failure` if there was an error in sending it (e.g. preliminary checks failed on signatures).
+ *
+ * @throws ApiError
+ * @throws TxSendError
+ */
+export type SubmitTx = (tx: Cbor) => Promise<string>;
+
+export enum WalletName {
+  NAMI = 'nami',
+  ETERNL = 'eternl',
+  FLINT = 'flint',
+  BEGIN = 'begin',
+  GERO = 'gero',
+  TYPHON = 'typhoncip30',
+  LACE = 'lace',
+  VESPR = 'vespr',
+}
+
+export interface WalletApi {
+  getNetworkId: GetNetworkId;
+
+  getUtxos: GetUtxos;
+
+  getBalance: GetBalance;
+
+  getCollateral: GetCollateral;
+
+  getUsedAddresses: GetUsedAddresses;
+
+  getUnusedAddresses: GetUnusedAddresses;
+
+  getChangeAddress: GetChangeAddress;
+
+  getRewardAddresses: GetRewardAddresses;
+
+  signTx: SignTx;
+
+  signData: SignData;
+
+  submitTx: SubmitTx;
+}
+
+export type WalletMethod = keyof WalletApi;

package/src/utils.ts

@@ -0,0 +1,25 @@
+import { WalletName } from './typescript/cip30';
+import { WalletInfo } from './store';
+import { walletPrettyNames } from './wallets';
+import { Cbor, CborNegInt, CborUInt } from '@harmoniclabs/cbor';
+
+export function parseBalance( balance: string): number
+{
+  const cbor = Cbor.parse( balance );
+  if(
+    cbor instanceof CborNegInt
+    || cbor instanceof CborUInt
+  ) return Number( cbor.num );
+  return 0;
+};
+
+export function toWalletInfo(walletName: WalletName): WalletInfo
+{
+  const ns = (globalThis as any)?.cardano ?? {};
+
+  return {
+    name: walletName,
+    displayName: walletPrettyNames[walletName] ?? walletName,
+    icon: ns[walletName]?.icon,
+  };
+};

package/src/wallets.ts

@@ -0,0 +1,12 @@
+import { WalletName } from './typescript/cip30';
+
+export const walletPrettyNames: Record<WalletName, string> = {
+  begin: 'Begin',
+  eternl: 'Eternl',
+  flint: 'Flint',
+  gero: 'Gero',
+  lace: 'Lace',
+  nami: 'Nami',
+  typhoncip30: 'Typhon',
+  vespr: 'Vespr',
+};