Base Account SDK

Base Account SDK allows apps to connect to Base Account

1. Base Account
   • Docs

Installing Base Account SDK

1. Check available versions:

     # yarn
     yarn info @base-org/account versions
   
     # npm
     npm view @base-org/account versions
   

2. Install latest version:

   # yarn
   yarn add @base-org/account
   
   # npm
   npm install @base-org/account
   

3. Check installed version:

   # yarn
   yarn list @base-org/account
   
   # npm
   npm list @base-org/account
   

Upgrading Base Account SDK

1. Compare the installed version with the latest:

   # yarn
   yarn outdated @base-org/account
   
   # npm
   npm outdated @base-org/account
   

2. Update to latest:

   # yarn
   yarn upgrade @base-org/account --latest
   
   # npm
   npm update @base-org/account
   

Basic Usage

1. Initialize Base Account SDK

   const sdk = createBaseAccountSDK({
     appName: 'SDK Playground',
   });
   

2. Make Base Account Provider

   const provider = sdk.getProvider();
   

3. Request accounts to initialize a connection to wallet

   const addresses = provider.request({
     method: 'eth_requestAccounts',
   });
   

4. Make more requests

   provider.request('personal_sign', [
     `0x${Buffer.from('test message', 'utf8').toString('hex')}`,
     addresses[0],
   ]);
   

5. Handle provider events

   provider.on('connect', (info) => {
     setConnect(info);
   });
   
   provider.on('disconnect', (error) => {
     setDisconnect({ code: error.code, message: error.message });
   });
   
   provider.on('accountsChanged', (accounts) => {
     setAccountsChanged(accounts);
   });
   
   provider.on('chainChanged', (chainId) => {
     setChainChanged(chainId);
   });
   
   provider.on('message', (message) => {
     setMessage(message);
   });
   

Developing locally and running the test app

• The Base Account SDK test app can be viewed here https://base.github.io/account-sdk/.

• To run it locally follow these steps:

  1. Fork this repo and clone it
  2. From the root dir run yarn install
  3. From the root dir run yarn dev