# phan-wallet-mock

**Repository Path**: mirrors_thlorenz/phan-wallet-mock

## Basic Information

- **Project Name**: phan-wallet-mock
- **Description**: 🪙 Mock version of Phantom Wallet. ONLY USE FOR TESTING!!!
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-11-10
- **Last Updated**: 2026-05-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# phan-wallet-mock [![Build and Test](https://github.com/thlorenz/phan-wallet-mock/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/thlorenz/phan-wallet-mock/actions/workflows/build-and-test.yml)

Mock version of Phantom Wallet. **ONLY USE FOR TESTING!!!**

```ts
export async function setupWithPayer(
  payer = Keypair.generate(),
  net = LOCALNET
): Promise<{ payer: Keypair; wallet: PhantomWalletMock }> {
  const wallet = PhantomWalletMock.create(net, payer, 'confirmed')

  // NOTE: no user approval needed
  await wallet.connect()
  const signature = await wallet.connection.requestAirdrop(
    payer.publicKey,
    LAMPORTS_PER_SOL * 5
  )
  // NOTE: no user approval needed here either
  await wallet.connection.confirmTransaction(signature)

  return { payer, wallet }
}

const { wallet, payer } = await setupWithPayer()

// NOTE: this only works when no actual Phantom extension is present as then `window.solana`
// cannot be overwritten
window.solana = wallet
```

![assets/cypress.png](assets/cypress.png)

## API

[API documentation](https://thlorenz.github.io/phan-wallet-mock/docs/index.html)

## How it Works

Unlike with real wallets `phan-wallet-mock` requires the user to provide a full `Keypair` which
it uses under the hood to sign transactions and messages.

To do that it never requires the user's approval like the original does in order to ease
testing.

**THEREFORE MAKE SURE TO ONLY USE THIS WHILE RUNNING TESTS WITH FRESHLY GENERATED KEYPAIRS!!!**

## Apps using phan-wallet-mock

- [example app based on phantom wallet
  sandbox](https://github.com/thlorenz/phan-wallet-mock-react-example)

## LICENSE

MIT