3.4.6 • Published 9 months ago

@dynamic-labs/wallet-book v3.4.6

Weekly downloads
-
License
MIT
Repository
github
Last release
9 months ago

Wallet Book

Updating Wallet Book

Adding First Party Wallet

Simply add an entry to firstPartyWalletsData in packages/wallet-book/src/build/sources/firstParty/index.ts and Compile & Publish

For example:

  argentx: {
    brand: {
      alt: 'Argent Wallet',
      primaryColor: '#FF875B',
      spriteId: 'argentx',
    },
    desktop: {
      chromeId: 'dlcobpjiigpikoobohmabehhmhfoodbb',
      firefoxId: 'argent-x',
    },
    name: 'Argent X',
    injectedConfig: [
      {
        chain: 'EVM',
        extensionLocators:
      }
    ]
  },

Required fields:

  • brand
    • alt
    • primaryColor
    • spriteId - The id used in the iconic svg
    • name

Refer to WalletRecordsSchema for more schema options

Adding injected (browser extension) wallets

Similar to adding first party wallets, we add another key, injectedConfig to the wallet object.

...
injectedConfig: [
  {
    chain: 'EVM',
    extensionLocators: [
      { flag: 'isOkxWallet', value: true },
      { flag: 'isOkexWallet', value: true }
    ],
    windowLocations: ['okxwallet']
  }
],
name: 'OKX'

If you need to override any of the following functions: signMessage, getAddress, getSigner, isInstalledOnBrowser, etc...

  1. Create a file in the respective ethereum/src/injected/ or solana/src/injected/. The basic file should follow this form:
export class <NameOfConnector> extends InjectedWalletBase {
  override name = '<Name Here>';
  override walletConnectorFallback = true; // only specified on evm wallet connectors

  constructor(props: EthereumWalletConnectorOpts) {
    super(props);

    this.wallet = findWalletBookWallet(this.walletBook, this.key);
  }

  // override the methods you need below
  override async getAddress() {
    ...
  }
}
  1. Open fetchInjectedWalletConnectors.ts for the respective network package (etherem/solana/...) and add the new InjectedWalletBase class to injectedWalletOverrides and the key (normalized name) to the filterInjectedWalletKeyOverrides

Things to remember when adding a new wallet

  • IF the new wallet is also in wallletconnect.json: make sure that the key used in firstParty/index.ts is the same as the value from walletconnect.json as to inherit the properties from that wallet definition.
  • The value(s) in windowLocations map to window.<value from windowLocations>. i.e. okxwallet means window.okxwallet. The values can be a nested path that is dot delimited. If the wallet lives under window.ethereum or window.ethereum.providers, those window locations are imported by default.
  • For every extension locator you add for the new wallet, add the negation [{ flag: 'isOkxWallet', value: false }, ...] to the extensionLocators under the metamask key in firstParty.
  • If the new wallet is wallet connect enabled (exists in walletconnect.json), make sure to add: filterFromWalletConnect: true as a sibling to injectedConfig which will filter the wallet from the wallet connect connectors list and use wallet connect as fallback.

Checklist before submitting the PR:

: If this change adds a new file to the injected folder, add the wallet key to the walletBookFallbackList in packages/wallet-book/src/build/index.ts

: If the name is changing in walletbook, make sure that if there is no new file in the injected/ folder, you make sure at least the shortName normalizes down to the wallet key

myawesomenewwallet: {
  ...
  injectedConfig: { ... },
  shortName: 'My Awesome New Wallet', // maps down to the key if you lowercase and remove special characters and spaces
  name: 'Awesome Wallet' // this will be displayed in the wallet list and can be changed as long as the `shortName` normalizes to the key
}

NOTE:

Refer to injectedConfigSchema for the schema options

Updating Wallet Connect Data

Adding overrides to WalletConnect

  • modify packages/wallet-book/src/build/sources/walletConnectOverrides/index.ts
  • Compile & Publish

Compile & Publish

The compiled json is stored in packages/wallet-book/wallet-book.json. When the file is updated and merged to main it will be published to S3 automatically.

Simply, make any changes that you need and:

  • run npm run nuke - to clean any cache of the wallet-book logic
  • run npx nx compile wallet-book
  • commit wallet-book.json
  • Open PR with changes and merge
4.0.0-alpha.25

9 months ago

4.0.0-alpha.17

9 months ago

4.0.0-alpha.16

9 months ago

4.0.0-alpha.19

9 months ago

4.0.0-alpha.18

9 months ago

4.0.0-alpha.20

9 months ago

4.0.0-alpha.24

9 months ago

4.0.0-alpha.23

9 months ago

4.0.0-alpha.22

9 months ago

4.0.0-alpha.21

9 months ago

3.4.6

9 months ago

3.4.5

9 months ago

4.0.0-alpha.15

9 months ago

3.4.4

9 months ago

3.4.3

9 months ago

4.0.0-alpha.14

10 months ago

4.0.0-alpha.13

10 months ago

4.0.0-alpha.12

10 months ago

3.4.0

10 months ago

3.4.2

10 months ago

3.4.1

10 months ago

4.0.0-alpha.11

10 months ago

4.0.0-alpha.10

10 months ago

2.4.0

12 months ago

3.2.0

10 months ago

2.3.0

1 year ago

2.3.2

1 year ago

2.3.1

1 year ago

2.3.4

1 year ago

2.3.3

1 year ago

2.3.6

1 year ago

2.3.5

1 year ago

3.1.3

10 months ago

3.1.2

10 months ago

3.1.1

10 months ago

3.1.0

10 months ago

3.1.4

10 months ago

1.4.13

1 year ago

1.4.12

1 year ago

1.4.15

1 year ago

1.4.14

1 year ago

1.4.17

1 year ago

1.4.16

1 year ago

1.4.19

11 months ago

1.4.18

12 months ago

0.0.0-exp20240810.0

12 months ago

2.2.1

1 year ago

2.2.0

1 year ago

2.2.3

1 year ago

2.2.2

1 year ago

2.2.5

1 year ago

2.2.4

1 year ago

2.2.7

1 year ago

2.2.6

1 year ago

3.0.3

11 months ago

3.0.2

11 months ago

3.0.1

11 months ago

2.3.8

12 months ago

2.3.7

1 year ago

2.3.9

12 months ago

3.0.0

11 months ago

2.1.0-alpha.32

1 year ago

2.1.0-alpha.31

1 year ago

2.1.0-alpha.30

1 year ago

2.1.2

1 year ago

2.1.1

1 year ago

2.1.4

1 year ago

2.1.3

1 year ago

2.1.5

1 year ago

2.1.0

1 year ago

2.2.9

1 year ago

2.2.8

1 year ago

3.0.0-alpha.7

1 year ago

3.0.0-alpha.6

1 year ago

3.0.0-alpha.9

1 year ago

3.0.0-alpha.8

1 year ago

3.0.0-alpha.1

1 year ago

3.0.0-alpha.0

1 year ago

3.0.0-alpha.3

1 year ago

3.0.0-alpha.2

1 year ago

3.0.0-alpha.5

1 year ago

3.0.0-alpha.4

1 year ago

0.0.0-exp20240809.0

12 months ago

0.0.0-exp20240808.1

12 months ago

0.0.0-exp20240808.0

12 months ago

2.6.1

11 months ago

2.6.0

11 months ago

2.6.3

11 months ago

2.6.2

11 months ago

2.2.10

1 year ago

2.2.0-alpha.5

1 year ago

2.5.0

11 months ago

2.5.2

11 months ago

2.5.1

11 months ago

2.5.3

11 months ago

2.2.0-alpha.0

1 year ago

2.2.0-alpha.4

1 year ago

2.2.0-alpha.3

1 year ago

2.2.0-alpha.2

1 year ago

2.2.0-alpha.1

1 year ago

3.3.0

10 months ago

2.3.10

12 months ago

4.0.0-alpha.9

10 months ago

4.0.0-alpha.7

10 months ago

4.0.0-alpha.8

10 months ago

4.0.0-alpha.5

10 months ago

4.0.0-alpha.6

10 months ago

3.0.0-alpha.58

11 months ago

3.0.0-alpha.57

11 months ago

3.0.0-alpha.59

11 months ago

4.0.0-alpha.3

10 months ago

3.0.0-alpha.50

11 months ago

4.0.0-alpha.4

10 months ago

4.0.0-alpha.1

11 months ago

3.0.0-alpha.52

11 months ago

4.0.0-alpha.2

11 months ago

3.0.0-alpha.51

11 months ago

3.0.0-alpha.54

11 months ago

4.0.0-alpha.0

11 months ago

3.0.0-alpha.53

11 months ago

3.0.0-alpha.56

11 months ago

3.0.0-alpha.55

11 months ago

3.0.0-alpha.68

11 months ago

3.0.0-alpha.61

11 months ago

3.0.0-alpha.60

11 months ago

3.0.0-alpha.63

11 months ago

3.0.0-alpha.62

11 months ago

3.0.0-alpha.65

11 months ago

3.0.0-alpha.64

11 months ago

3.0.0-alpha.67

11 months ago

3.0.0-alpha.66

11 months ago

2.1.2-alpha.1

1 year ago

2.1.2-alpha.0

1 year ago

2.3.1-alpha.0

1 year ago

0.0.0-exp20240827.1

11 months ago

3.0.0-alpha.14

1 year ago

3.0.0-alpha.13

1 year ago

3.0.0-alpha.16

1 year ago

3.0.0-alpha.15

1 year ago

3.0.0-alpha.18

1 year ago

3.0.0-alpha.17

1 year ago

3.0.0-alpha.19

1 year ago

3.0.0-alpha.10

1 year ago

3.0.0-alpha.12

1 year ago

3.0.0-alpha.11

1 year ago

3.0.0-alpha.25

1 year ago

3.0.0-alpha.24

1 year ago

3.0.0-alpha.27

1 year ago

3.0.0-alpha.26

1 year ago

3.0.0-alpha.29

1 year ago

3.0.0-alpha.28

1 year ago

3.0.0-alpha.21

1 year ago

3.0.0-alpha.20

1 year ago

3.0.0-alpha.23

1 year ago

3.0.0-alpha.22

1 year ago

3.0.0-alpha.36

12 months ago

3.0.0-alpha.35

12 months ago

3.0.0-alpha.38

12 months ago

3.0.0-alpha.37

12 months ago

3.0.0-alpha.39

12 months ago

3.0.0-alpha.30

1 year ago

3.0.0-alpha.32

12 months ago

3.0.0-alpha.31

1 year ago

3.0.0-alpha.34

12 months ago

3.0.0-alpha.33

12 months ago

3.0.0-alpha.47

11 months ago

3.0.0-alpha.46

12 months ago

3.0.0-alpha.49

11 months ago

3.0.0-alpha.48

11 months ago

3.0.0-alpha.41

12 months ago

3.0.0-alpha.40

12 months ago

3.0.0-alpha.43

12 months ago

3.0.0-alpha.42

12 months ago

3.0.0-alpha.45

12 months ago

3.0.0-alpha.44

12 months ago

2.0.8

1 year ago

2.1.0-alpha.21

1 year ago

2.1.0-alpha.23

1 year ago

2.1.0-alpha.22

1 year ago

2.1.0-alpha.29

1 year ago

2.1.0-alpha.28

1 year ago

2.1.0-alpha.25

1 year ago

2.1.0-alpha.24

1 year ago

2.1.0-alpha.27

1 year ago

2.1.0-alpha.26

1 year ago

2.1.0-alpha.20

1 year ago

2.1.0-alpha.19

1 year ago

2.1.0-alpha.18

1 year ago

2.1.0-alpha.17

1 year ago

2.1.0-alpha.16

1 year ago

2.0.7

1 year ago

2.1.0-alpha.15

1 year ago

2.1.0-alpha.14

1 year ago

2.1.0-alpha.12

1 year ago

2.1.0-alpha.11

1 year ago

2.1.0-alpha.13

1 year ago

2.0.6

1 year ago

2.1.0-alpha.10

1 year ago

2.1.0-alpha.9

1 year ago

1.4.11

1 year ago

2.0.5

1 year ago

2.1.0-alpha.8

1 year ago

2.1.0-alpha.7

1 year ago

2.0.4

1 year ago

2.1.0-alpha.6

1 year ago

1.4.10

1 year ago

2.1.0-alpha.5

1 year ago

2.1.0-alpha.4

1 year ago

2.1.0-alpha.3

1 year ago

2.0.3

1 year ago

1.4.9

1 year ago

1.4.8

1 year ago

2.0.2

1 year ago

2.0.1

1 year ago

2.1.0-alpha.2

1 year ago

2.1.0-alpha.1

1 year ago

2.0.0-alpha.32

1 year ago

2.0.0

1 year ago

2.1.0-alpha.0

1 year ago

1.4.7

1 year ago

2.0.0-alpha.31

1 year ago

2.0.0-alpha.30

1 year ago

1.4.6

1 year ago

2.0.0-alpha.29

1 year ago

2.0.0-alpha.28

1 year ago

2.0.0-alpha.27

1 year ago

2.0.0-alpha.26

1 year ago

1.4.5

1 year ago

1.4.4

1 year ago

2.0.0-alpha.25

1 year ago

2.0.0-alpha.24

1 year ago

2.0.0-alpha.23

1 year ago

1.4.3

1 year ago

2.0.0-alpha.22

1 year ago

1.4.2

1 year ago

1.4.1

1 year ago

1.4.0

1 year ago

2.0.0-alpha.21

1 year ago

2.0.0-alpha.19

1 year ago

2.0.0-alpha.20

1 year ago

2.0.0-alpha.18

1 year ago

2.0.0-alpha.17

1 year ago

2.0.0-alpha.16

1 year ago

2.0.0-alpha.15

1 year ago

2.0.0-alpha.14

1 year ago

2.0.0-alpha.13

1 year ago

2.0.0-alpha.11

1 year ago

2.0.0-alpha.12

1 year ago

2.0.0-alpha.10

1 year ago

1.3.1

1 year ago

2.0.0-alpha.9

1 year ago

1.2.1

1 year ago

2.0.0-alpha.7

1 year ago

2.0.0-alpha.8

1 year ago

1.3.0

1 year ago

1.2.0

1 year ago

1.1.5

1 year ago

2.0.0-alpha.6

1 year ago

2.0.0-alpha.4

1 year ago

2.0.0-alpha.5

1 year ago

1.1.4

1 year ago

1.1.3

1 year ago

2.0.0-alpha.3

1 year ago

1.1.2

1 year ago

2.0.0-alpha.0

1 year ago

2.0.0-alpha.1

1 year ago

2.0.0-alpha.2

1 year ago

1.1.1

1 year ago

1.2.0-alpha.1

1 year ago

1.2.0-alpha.0

1 year ago

1.1.0-alpha.26

1 year ago

1.1.0

1 year ago

1.1.0-alpha.25

1 year ago

1.1.0-alpha.19

1 year ago

1.1.0-alpha.22

1 year ago

1.1.0-alpha.21

1 year ago

1.1.0-alpha.20

1 year ago

1.1.0-alpha.24

1 year ago

1.1.0-alpha.23

1 year ago

1.0.9

1 year ago

1.1.0-alpha.15

2 years ago

1.1.0-alpha.18

2 years ago

1.1.0-alpha.17

2 years ago

1.1.0-alpha.16

2 years ago

1.0.8

2 years ago

1.0.7

2 years ago

1.1.0-alpha.14

2 years ago

1.1.0-alpha.13

2 years ago

1.1.0-phantom.0

2 years ago

1.1.0-alpha.12

2 years ago

1.0.6

2 years ago

1.1.0-alpha.11

2 years ago

1.0.5

2 years ago

1.1.0-alpha.10

2 years ago

1.0.4

2 years ago

1.1.0-alpha.9

2 years ago

1.1.0-alpha.8

2 years ago

1.0.3

2 years ago

1.1.0-alpha.7

2 years ago

1.1.0-alpha.6

2 years ago

1.1.0-alpha.5

2 years ago

1.1.0-alpha.4

2 years ago

1.1.0-alpha.3

2 years ago

1.0.2

2 years ago

0.19.7

2 years ago

1.1.0-alpha.2

2 years ago

1.1.0-alpha.1

2 years ago

1.1.0-alpha.0

2 years ago

1.0.1

2 years ago

0.19.6

2 years ago

0.18.100-viem.31

2 years ago

1.0.0

2 years ago

1.0.0-alpha.10

2 years ago

1.0.0-alpha.12

2 years ago

1.0.0-alpha.11

2 years ago

1.0.0-alpha.14

2 years ago

1.0.0-alpha.13

2 years ago

1.0.0-alpha.9

2 years ago

1.0.0-alpha.8

2 years ago

0.19.5

2 years ago

1.0.0-alpha.7

2 years ago

0.19.0-alpha.20

2 years ago

0.19.0-alpha.23

2 years ago

0.19.0-alpha.24

2 years ago

0.19.0-alpha.21

2 years ago

0.19.0-alpha.22

2 years ago

0.19.0-alpha.27

2 years ago

0.19.0-alpha.28

2 years ago

0.19.0-alpha.25

2 years ago

0.19.0-alpha.26

2 years ago

0.17.18

2 years ago

0.17.17

2 years ago

0.17.19

2 years ago

0.17.21

2 years ago

0.17.20

2 years ago

0.17.23

2 years ago

0.17.22

2 years ago

0.17.25

2 years ago

0.17.100-viem.4

2 years ago

0.17.24

2 years ago

0.17.100-viem.3

2 years ago

0.17.27

2 years ago

0.17.100-viem.2

2 years ago

0.17.26

2 years ago

0.18.9

2 years ago

0.17.100-viem.8

2 years ago

0.17.100-viem.7

2 years ago

0.17.100-viem.6

2 years ago

0.17.100-viem.5

2 years ago

0.17.100-viem.9

2 years ago

0.18.1

2 years ago

0.18.2

2 years ago

0.18.4

2 years ago

0.18.5

2 years ago

0.18.6

2 years ago

0.18.7

2 years ago

0.18.8

2 years ago

0.18.0-beta.32

2 years ago

0.17.29

2 years ago

0.18.0-beta.31

2 years ago

0.17.28

2 years ago

0.18.0-beta.30

2 years ago

0.18.0

2 years ago

0.17.32

2 years ago

0.17.31

2 years ago

0.17.34

2 years ago

0.17.33

2 years ago

0.17.30

2 years ago

0.18.0-beta.29

2 years ago

0.18.0-beta.28

2 years ago

0.18.100-viem.1

2 years ago

0.18.100-viem.0

2 years ago

0.18.100-viem.3

2 years ago

0.18.100-viem.2

2 years ago

0.18.100-viem.5

2 years ago

0.18.100-viem.4

2 years ago

0.18.100-viem.7

2 years ago

0.18.100-viem.6

2 years ago

0.18.100-viem.9

2 years ago

0.18.100-viem.8

2 years ago

0.18.0-RC.8

2 years ago

0.18.0-RC.9

2 years ago

1.0.0-alpha.6

2 years ago

1.0.0-alpha.5

2 years ago

1.0.0-alpha.4

2 years ago

1.0.0-alpha.3

2 years ago

1.0.0-alpha.1

2 years ago

1.0.0-alpha.0

2 years ago

0.18.0-RC.10

2 years ago

0.18.0-RC.11

2 years ago

0.18.0-RC.16

2 years ago

0.18.0-RC.17

2 years ago

0.18.0-RC.18

2 years ago

0.18.0-RC.19

2 years ago

0.18.0-RC.12

2 years ago

0.18.0-RC.13

2 years ago

0.18.0-RC.14

2 years ago

0.18.0-RC.15

2 years ago

0.18.0-RC.20

2 years ago

0.18.0-RC.21

2 years ago

0.18.0-RC.22

2 years ago

0.18.0-RC.27

2 years ago

0.18.0-RC.23

2 years ago

0.18.0-RC.24

2 years ago

0.18.0-RC.25

2 years ago

0.18.0-RC.26

2 years ago

0.18.11

2 years ago

0.18.100-viem.10

2 years ago

0.18.10

2 years ago

0.18.13

2 years ago

0.18.100-viem.12

2 years ago

0.18.12

2 years ago

0.18.100-viem.11

2 years ago

0.18.15

2 years ago

0.18.14

2 years ago

0.18.17

2 years ago

0.18.16

2 years ago

0.19.0

2 years ago

0.19.1

2 years ago

0.19.2

2 years ago

0.19.3

2 years ago

0.19.4

2 years ago

0.18.19

2 years ago

0.18.100-viem.18

2 years ago

0.18.18

2 years ago

0.18.100-viem.17

2 years ago

0.18.100-viem.19

2 years ago

0.18.100-viem.14

2 years ago

0.18.100-viem.13

2 years ago

0.18.100-viem.16

2 years ago

0.18.100-viem.15

2 years ago

0.18.22

2 years ago

0.18.21

2 years ago

0.18.24

2 years ago

0.18.23

2 years ago

0.18.26

2 years ago

0.18.25

2 years ago

0.18.28

2 years ago

0.18.27

2 years ago

0.18.20

2 years ago

0.19.0-alpha.8

2 years ago

0.19.0-alpha.7

2 years ago

0.19.0-alpha.6

2 years ago

0.19.0-alpha.5

2 years ago

0.19.0-alpha.9

2 years ago

0.18.29

2 years ago

0.18.100-viem.30

2 years ago

0.19.0-alpha.0

2 years ago

0.19.0-alpha.4

2 years ago

0.19.0-alpha.3

2 years ago

0.19.0-alpha.2

2 years ago

0.18.30

2 years ago

0.19.0-alpha.1

2 years ago

0.18.100-viem.21

2 years ago

0.18.100-viem.20

2 years ago

0.18.100-viem.23

2 years ago

0.18.100-viem.22

2 years ago

0.19.0-alpha.12

2 years ago

0.19.0-alpha.13

2 years ago

0.19.0-alpha.10

2 years ago

0.19.0-alpha.11

2 years ago

0.18.100-viem.29

2 years ago

0.19.0-alpha.16

2 years ago

0.18.100-viem.28

2 years ago

0.19.0-alpha.17

2 years ago

0.19.0-alpha.14

2 years ago

0.19.0-alpha.15

2 years ago

0.18.100-viem.25

2 years ago

0.18.100-viem.24

2 years ago

0.19.0-alpha.18

2 years ago

0.18.100-viem.27

2 years ago

0.19.0-alpha.19

2 years ago

0.18.100-viem.26

2 years ago

0.17.14

2 years ago

0.17.13

2 years ago

0.17.16

2 years ago

0.17.15

2 years ago

0.17.100-viem.1

2 years ago

0.17.12

2 years ago

0.17.11

2 years ago

0.18.0-RC.7

2 years ago

0.17.10

2 years ago

0.17.9

2 years ago

0.18.0-RC.6

2 years ago

0.17.8

2 years ago

0.18.0-RC.5

2 years ago

0.18.0-RC.4

2 years ago

0.18.0-RC.3

2 years ago

0.17.7

2 years ago

0.18.0-RC.2

2 years ago

0.17.6

2 years ago

0.17.5

2 years ago

0.17.4

2 years ago

0.17.3

2 years ago

0.18.0-RC.1

2 years ago

0.17.2

2 years ago

0.18.0-RC.0

2 years ago

0.17.1

2 years ago

0.17.0

2 years ago

0.0.20

2 years ago

0.17.0-RC.33

2 years ago

0.17.0-RC.32

2 years ago

0.17.0-RC.31

2 years ago

0.17.0-RC.30

2 years ago

0.17.0-RC.29

2 years ago

0.17.0-RC.28

2 years ago

0.17.0-RC.27

2 years ago

0.17.0-RC.26

2 years ago

0.17.0-RC.25

2 years ago

0.17.0-RC.24

2 years ago

0.0.19

2 years ago

0.0.18

2 years ago

0.0.17

2 years ago

0.0.16

2 years ago

0.0.15

2 years ago

0.0.14

2 years ago

0.0.13

2 years ago

0.0.12

2 years ago

0.0.11

2 years ago

0.0.10

2 years ago

0.0.9

2 years ago

0.0.8

2 years ago

0.0.7

2 years ago

0.0.6

2 years ago

0.0.5

2 years ago

0.0.4

2 years ago

0.0.3

2 years ago

0.0.2

2 years ago

0.0.1

2 years ago