https://github.com/TalismanSociety/talisman
Multi-Chain Made Easy with Talisman Wallet. An ultra-secure Ethereum and Polkadot wallet for both beginners and pros.
https://github.com/TalismanSociety/talisman
blockchain ethereum monorepo polkadot wallet
Last synced: 4 months ago
JSON representation
Multi-Chain Made Easy with Talisman Wallet. An ultra-secure Ethereum and Polkadot wallet for both beginners and pros.
- Host: GitHub
- URL: https://github.com/TalismanSociety/talisman
- Owner: TalismanSociety
- License: gpl-3.0
- Created: 2022-05-18T03:40:03.000Z (over 3 years ago)
- Default Branch: dev
- Last Pushed: 2025-07-28T09:00:34.000Z (4 months ago)
- Last Synced: 2025-07-28T09:04:09.265Z (4 months ago)
- Topics: blockchain, ethereum, monorepo, polkadot, wallet
- Language: TypeScript
- Homepage: https://talisman.xyz/download
- Size: 33.2 MB
- Stars: 69
- Watchers: 8
- Forks: 46
- Open Issues: 70
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- jimsghstars - TalismanSociety/talisman - Multi-Chain Made Easy with Talisman Wallet. An ultra-secure Ethereum and Polkadot wallet for both beginners and pros. (TypeScript)
README
# Talisman Wallet
[](https://talisman.xyz)
[](https://discord.gg/talisman)
[](https://chromewebstore.google.com/detail/talisman-ethereum-and-pol/fijngjgcjhjmmpcmkeiomlglpeiijkld)
[](https://chromewebstore.google.com/detail/talisman-ethereum-and-pol/fijngjgcjhjmmpcmkeiomlglpeiijkld)
[](https://addons.mozilla.org/en-US/firefox/addon/talisman-wallet-extension)
**Multi-Chain Made Easy** with Talisman Wallet.
An ultra-secure Ethereum and Polkadot wallet for both beginners and pros.
## What's inside?
This repo contains the source code for Talisman Wallet.
If you want to use Talisman, you can [install it for your browser by following this link](https://talisman.xyz/download).
If you would like to build Talisman from source, please continue reading:
## System requirements
If you haven't already, you will first need to install **[Node.js](https://nodejs.org/en/download)** on your system.
This repo uses **[corepack](https://github.com/nodejs/corepack)** and **[pnpm](https://pnpm.io)** to manage dependencies.
Corepack is [distributed by default with all recent Node.js versions](https://nodejs.org/api/corepack.html).
**Pnpm** is a fast, _disk space efficient_ javascript package manager.
**Corepack** lets you use **pnpm** without having to install a specific version of it.
Once you have installed **Node.js**, run `corepack enable` to turn it on, then follow the [Getting started](#getting-started-wallet-extension-development) instructions to continue.
## Getting started (wallet extension development)
1. Install **Node.js** and enable **corepack**, as per the [System Requirements](#system-requirements) section.
1. Clone the repo.
`git clone git@github.com:TalismanSociety/talisman.git`
1. Change to the repo directory.
`cd talisman`
1. Install dependencies and generate the english translation files (these are loaded by i18next during development).
`pnpm install`
1. Start the dev server, waiting for it to generate the `dist` directory.
`pnpm dev:extension`
1. Open Chrome and navigate to `chrome://extensions`.
1. Turn on the `Developer mode` toggle on the top right of the page.
1. Click `Load unpacked` on the top left of the page and select the `apps/extension/dist/chrome` directory.
1. Change some code!
## Apps and packages
- `apps/extension`: the non-custodial Talisman Wallet browser extension
- `packages/eslint-config`: shared `eslint` configurations
- `packages/tsconfig`: shared `tsconfig.json`s used throughout the monorepo
- `packages/util`: library containing shared non-react code. It is not meant to be npm published.
All our apps and packages are 100% [TypeScript](https://www.typescriptlang.org/).
## Writing and running tests
- Testing is carried out with Jest.
- Tests can be written in `*.spec.ts` files, inside a `__tests__` folder.
- Follow the pattern in `apps/extension/src/core/handlers/Extension.spec.ts` or `apps/extension/src/core/domains/signing/__tests__/requestsStore.spec.ts`
- Tests are run with `pnpm test`
## i18n (wallet extension development)
We use i18next in the wallet to make it available in a bunch of languages.
When building UI features, please follow the following spec to ensure they're translatable:
1. Import the `useTranslation` hook into your React components:
```tsx
import { useTranslation } from "react-i18next"
```
1. Use the hook in your component to get access to the `t` function:
```tsx
const { t } = useTranslation()
```
1. Wrap any user-visible language in your component with the `t` function:
```tsx
return (
{t("Account Assets")}
{t("Account has {{assetCount}} assets", { assetCount: assets.length })}
)
```
1. If you want to include any react components in your translation, you will need to use the `Trans` component:
```tsx
import { useTranslation, Trans } from "react-i18next"
const { t } = useTranslation()
return (
,
Tooltip: (
{t(
"Only use this address for receiving assets on the {{name}} network.",
{
name: chain.name,
}
)}
),
}}
)
```
1. If you see one of the following errors in your console:
```
locales/en/common.json:1
Failed to load resource: net::ERR_FILE_NOT_FOUND
```
```
i18next::translator: missingKey en common
```
Then update the english translation files with this command:
```sh
pnpm chore:update-translations
```
### Scripts
- `chore:update-translations` : finds all of the i18n strings in the codebase and adds them to the english translations files which i18next loads in development builds of the wallet
- `dev` : builds and watches all packages/apps with hot reloading
- `dev:extension` : when working on extension only, for better color output
- `build`: builds the wallet in `packages/apps/extension/dist/chrome` folder, without sentry keys
- `build:firefox`: builds the wallet in `packages/apps/extension/dist/firefox` folder, without sentry keys
- `build:extension:prod` builds the Talisman browser extension (requires sentry settings, Talisman team only)
- `build:extension:canary` : builds the Talisman browser extension test version, with different ID and icon than prod
### Build the wallet browser extension using Docker
```bash
# builds with docker, outputs in dist folder at the root of the monorepo
rm -rf dist && DOCKER_BUILDKIT=1 docker build --output type=local,dest=./dist .
```
### Update packages
```bash
# Make changes, and then run:
pnpm changeset
# Select the packages which have been modified and write a commit message
```
## Security disclosures
If you find a security issue or exploit, please email us at **security@talisman.xyz**. Please _DO NOT_ create an issue or PR in this repo for security issues.