@puzzlehq/sdk-core/README.md

Your portal to privacy

# Let's puzzle!

The Puzzle SDK provides [React hooks](https://react.dev/reference/react) that enable interaction between a privacy dApp and the Puzzle Wallet.

### Downloading the wallet

You can download the wallet on the [chrome store](https://chromewebstore.google.com/detail/puzzle-wallet/fdchdcpieegfofnofhgdombfckhbcokj), or on [the app store](https://apps.apple.com/us/app/puzzle-aleo-wallet/id6450268321).

### Downloading the sdk

You can download the SDK using any of the following commands:

```sh
npm i @puzzlehq/sdk
```

```sh
pnpm add @puzzlehq/sdk
```

```sh
yarn add @puzzlehq/sdk
```

### Test the wallet out

Visit our devtools site at [dev.puzzle.online](https://dev.puzzle.online) to:

- Deploy an aleo program
- Execute an Aleo program
- Sign a message
- Decrypt a ciphertext
- View your records
- View your events
- Create/import a shared state

### Clone a sample repo

We've built a few sample repos for your choice of a nice starting point:

- [simple calculator](https://github.com/puzzlehq/aleo-starter.git)
- [build a token](https://github.com/puzzlehq/build-a-token.git)
- [where's alex](https://github.com/puzzlehq/coinflip.git)

You can clone the repo using the following command:

```sh
# clone the aleo-starter repo
git clone https://github.com/puzzlehq/build-a-token.git
```

## Work in progress

The Puzzle SDK and Aleo are in early development.
The Puzzle SDK is open source. If you find something that's not working, [open an issue on Github](https://github.com/puzzlehq/puzzle-sdk/issues/new/choose) or let us know on [Discord](https://discord.com/invite/puzzlearcade).