https://github.com/coral-xyz/backpack

🎒 Next level crypto wallet
https://github.com/coral-xyz/backpack

Last synced: about 1 month ago
JSON representation

🎒 Next level crypto wallet

• Host: GitHub
• URL: https://github.com/coral-xyz/backpack
• Owner: coral-xyz
• License: gpl-3.0
• Created: 2022-02-24T14:35:47.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-04-05T05:33:57.000Z (3 months ago)
• Last Synced: 2024-04-20T11:20:20.467Z (2 months ago)
• Language: TypeScript
• Homepage: https://backpack.app
• Size: 216 MB
• Stars: 1,186
• Watchers: 47
• Forks: 721
• Open Issues: 479
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Lists

• awesome-solana - Coral-xyz's Backpack - xyz/backpack.svg?style=social) Cross chain wallet for Solana and Ethereum, it's specialty is its app store, which allows dApps to be bought as xNFTs (executable NFTs) which can then be run inside your wallet (Wallets / Indexers)
• awesome-wallet - Backpack Wallet - xyz/backpack?style=flat-square)  - 🎒 Next level crypto wallet. Backpack is a self-custody crypto wallet for Solana and Ethereum. (TypeScript / Flutter SDK / Libraries)
• awesome-xnft - Backpack
• stars - coral-xyz/backpack - 🎒 Next level crypto wallet (TypeScript)

README

        


  

  
Backpack


  


    A home for your xNFTs

  


  


    

    

    

  



### Note

- Backpack is in active development, so all APIs are subject to change.

- This code is unaudited. Use at your own risk.

- I repeat. This is not ready for production.

# Table of contents:

- [Table of contents:](#table-of-contents)

  - [Installing the Latest Release](#installing-the-latest-release)

  - [Developing Locally](#developing-locally)

    - [Pull the code](#pull-the-code)

    - [Temporary preliminary steps](#temporary-preliminary-steps)

      - [Enable self-signed local SSL certs](#enable-self-signed-local-ssl-certs)

      - [Environment variables](#environment-variables)

    - [Install dependencies](#install-dependencies)

    - [Build all packages for production](#build-all-packages-for-production)

    - [Start everything inside `./packages` for development](#start-everything-inside-packages-for-development)

      - [Troubleshooting](#troubleshooting)

    - [Install the development version of the extension](#install-the-development-version-of-the-extension)

      - [Not seeing the dev folder?](#not-seeing-the-dev-folder)

    - [Optionally install the built extension](#optionally-install-the-built-extension)

  - [License](#license)

## Installing the Latest Release

If you'd like to install the latest dev release, grab the latest **build.zip** [here](https://github.com/coral-xyz/backpack/releases)

and add it to your local chrome profile, using developer mode. See the video below.

## Developing Locally

https://user-images.githubusercontent.com/101902546/173857300-fc139113-0af5-46fc-baad-236a2ebf63f1.m4p

### Pull the code

```bash

git clone [email protected]:coral-xyz/backpack.git

cd backpack

```

### Temporary preliminary steps

#### Enable self-signed local SSL certs

Go to chrome://flags/#allow-insecure-localhost and enable the toggle, then restart chrome. Note: Please don't enable this if you don't know what you're doing. It will leave you vulnerable to exploits if left on. It is recommended to undo this step when you are done developing.

#### Environment variables

### Install dependencies

```bash

yarn install

```

You can also optionally rename `.env.example` to `.env` and set your own variables.

### Build all packages for production

```bash

yarn build

```

### Start everything inside `./packages` for development

```bash

yarn start

```

Note: In a fresh repo, you should run `yarn build` before `yarn start`.

#### Troubleshooting

_If you run into issues with builds try running `yarn clean` and then start again._

  Seeing `WebSocket connection to 'wss://localhost:9997/ws' failed` error messages in your console?

You need to install a SSL certificate for localhost as the one provided by [webpack-dev-server is considered invalid](https://github.com/webpack/webpack-dev-server/issues/2957). This step is optional as `react-refresh` will still function without it, but it's a good idea to try and fix this error because otherwise your browser will be making a lot of failed requests and `webpack-dev-server` might not be functioning to its full capabilities.

A relatively simple way of doing this is using [mkcert](https://github.com/FiloSottile/mkcert)

Instructions for how to install a trusted self-signed cert on macOS -

```

cd packages/app-extension

brew install mkcert

mkcert localhost

mkcert -install

```

Now the next time you run `yarn start` the errors should no longer appear.

### Install the development version of the extension

Go to chrome://extensions, enable developer mode (top right) and drag the `packages/app-extension/dev` dir into the window. This version will have (Dev) in the title and supports live-reloading.

#### Not seeing the dev folder?

- Do you have a stale node process running? Try to kill it all: `killall -9 node` and start over

- Try running `yarn start` from within `packages/app-extension` while running `yarn start` from root. This should work.

### Optionally install the built extension

If you want to try the production build of the extension, run `yarn build` and drag the `packages/app-extension/build` dir into chrome://extensions as above. This version won't have hot-reloading and local plugins won't be visible unless you also run `yarn start`

## License

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion by you shall be licensed at the discretion of the repository maintainers without any additional terms or conditions.