# @solflare-wallet/sdk

> ## Example

Latest version **1.4.2** (published 2024-01-25) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @solflare-wallet/sdk
pnpm add @solflare-wallet/sdk
yarn add @solflare-wallet/sdk
bun add @solflare-wallet/sdk
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.4.2 |
| Published | 2024-01-25 |
| First published | 2021-12-28 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 166.8 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 10 |
| Author | Solflare Developers |
| Maintainers | anbud, sljuka, veloja, skakac, vidor, vsakos, turshija |

## Links

- npm: https://www.npmjs.com/package/@solflare-wallet/sdk
- Repository: https://github.com/solflare-wallet/solflare-sdk
- Homepage: https://github.com/solflare-wallet/solflare-sdk#readme
- Issues: https://github.com/solflare-wallet/solflare-sdk/issues
- npm.io page: https://npm.io/package/@solflare-wallet/sdk

## Dependencies (3)

- [bs58](https://npm.io/package/bs58.md) ^5.0.0
- [uuid](https://npm.io/package/uuid.md) ^9.0.0
- [eventemitter3](https://npm.io/package/eventemitter3.md) ^5.0.1

## Recent versions

- 1.4.2 (latest) — 2024-01-25
- 1.4.2-rc1 (next) — 2024-01-24
- 1.3.0-mm.2 (mm) — 2023-07-20
- 1.4.1 — 2023-11-10
- 1.4.0 — 2023-11-10
- 1.3.2 — 2023-10-06
- 1.3.1 — 2023-09-08
- 1.3.0-mm.1 — 2023-07-18
- 1.3.0 — 2023-07-06
- 1.3.0-beta.2 — 2023-07-06
- 1.3.0-beta.1 — 2023-06-11
- 1.2.1 — 2023-03-15
- 1.2.0-react.1 — 2023-02-24
- 1.2.0-react — 2023-02-09
- 1.2.0 — 2022-12-30
- … 16 more at https://npm.io/package/@solflare-wallet/sdk/versions

## README

# @solflare-wallet/sdk

## Example

```javascript
import Solflare from '@solflare-wallet/sdk';
import { Transaction } from '@solana/web3.js';

const wallet = new Solflare();

wallet.on('connect', () => console.log('connected', wallet.publicKey.toString()));
wallet.on('disconnect', () => console.log('disconnected'));

try {
  await wallet.connect();

  const signature = await wallet.signAndSendTransaction(new Transaction());

  const transaction = await wallet.signTransaction(new Transaction());

  const transactions = await wallet.signAllTransactions([ new Transaction(), new Transaction() ]);

  const encoder = new TextEncoder();
  const messageBytes = encoder.encode('Test message');
  const messageSignature = await wallet.signMessage(messageBytes, 'utf8');

  await wallet.disconnect();
} catch (err) {
  console.log(err);
}
```

## API

```javascript
class Solflare extends EventEmitter {
  publicKey: PublicKey | null;
  isConnected: boolean;
  connected: boolean; // for SOL Wallet Adapter compatibility
  autoApprove: boolean; // for SOL Wallet Adapter compatibility

  constructor(config: { network?: string });

  connect(): Promise<void>;
  disconnect(): Promise<void>;

  signAndSendTransaction(transaction: TransactionOrVersionedTransaction, options: SendOptions | undefined): Promise<string>;
  signTransaction(transaction: TransactionOrVersionedTransaction): Promise<TransactionOrVersionedTransaction>;
  signAllTransactions(transactions: TransactionOrVersionedTransaction[]): Promise<TransactionOrVersionedTransaction[]>;
  signMessage(data: Uint8Array, display: 'hex' | 'utf8' = 'utf8'): Promise<Uint8Array>;
  sign(data: Uint8Array, display: 'hex' | 'utf8' = 'utf8'): Promise<Uint8Array>; // for SOL Wallet Adapter compatibility
}
```

---
_Source: https://npm.io/package/@solflare-wallet/sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._