@cardano-foundation/cardano-connect-with-wallet-core

Cardano Connect with Wallet Core

This repository aims to provide framework-independent helper and wrapper functions for seamless interaction between Cardano decentralized applications (dApps) and wallets (CIP 8 and CIP 30). If you are looking for React.js components please move on to this repository.

Have fun building on Cardano! 🏗🎉

🚀 Getting Started

npm i @cardano-foundation/cardano-connect-with-wallet-core

import { Wallet } from '@cardano-foundation/cardano-connect-with-wallet-core';

The Wallet class conatins static helper to simplify the dApp development. Please tale a look into the React hook useCardano to see an example of how you can utilize Wallet in your project.

Wallet.isConnecting: Observable<boolean>;
Wallet.lastConnectedWallet: Observable<string>;
Wallet.isConnected: Observable<boolean>;
Wallet.enabledObserver: Observable<boolean>;
Wallet.isConnectingObserver: Observable<boolean>;
Wallet.enabledWalletObserver: Observable<string | null>;
Wallet.stakeAddressObserver: Observable<string | null>;
Wallet.installedWalletExtensionsObserver: Observable<string[]>;
Wallet.usedAddressesObserver: Observable<string[]>;
Wallet.unusedAddressesObserver: Observable<string[]>;
Wallet.accountBalanceObserver: Observable<number>;
Wallet.meerkatAddressObserver: Observable<string>;
Wallet.injectWalletListener: InjectWalletListener;

Wallet.disconnect(): void;
Wallet.clearLocalStorage(): void;

Wallet.startInjectWalletListener(): void;
Wallet.stopInjectWalletListener(): void;
Wallet.checkEnabled(network: NetworkType): Promise<void>;
Wallet.connectToWallet(walletName: string, networkType: NetworkType, retries?: number, retryIntervalInMs?: number): Promise<void>;

Wallet.connect(walletName: string, network: NetworkType, onConnect?: () => void | undefined, onError?: (code: Error) => void): Promise<void>;

Wallet.getInstalledWalletExtensions(supportedWallets?: Array<string>): Array<string>;

Wallet.getRewardAddresses(): Promise<any>;
Wallet.signMessage(message: string, onSignMessage?: (signature: string, key: string | undefined) => void, onSignError?: (error: Error) => void, limitNetwork?: NetworkType): Promise<void>;

💪 Contributing

Please have a look at our contributing infos to become familiar with our guidelines.