@decentralizedauthority/nodewallet-react-sdk
TypeScript icon, indicating that this package has built-in type declarations

0.1.5 • Public • Published

Nodewallet React SDK

Provides straightforward, programmatic access to the NodeWallet extension in React projects using the NodeWallet SDK.

Usage

Add the NodeWallet React SDK to your project:

npm install --save @decentralizedauthority/nodewallet-react-sdk

Add NodeWalletProvider to the top level of your application:

import {
  NodeWalletProvider,
} from '@decentralizedauthority/nodewallet-react-sdk';

const AppContainer = () => {
  
  const nodeWalletOptions = {
    autoConnect: false,                // Optional. Auto connect on load. Defaults to false.
    connectTimeout: 10000,             // Optional. Timeout for connecting to the extension. Defaults to 10000ms.
    requestTimeout: 30000,             // Optional. Timeout for requests to the extension. Defaults to 30000ms.
    onConnectError: (err: Error) => {  // Optional. Called when there is an error on the initial connecting to the extension.
      console.error(err);
      alert('Unable to connect to the NodeWallet extension. Are you sure that you have it installed?');
    },
  };
  
  return (
    <NodeWalletProvider options={nodeWalletOptions}>
      <App />
    </NodeWalletProvider>
  );
};

Use the available hooks to interact with the NodeWallet extension:

import {
  ConnectButton,
  useNodeWallet,
  useNodeWalletConnect,
} from '@decentralizedauthority/nodewallet-react-sdk';

export const App = () => {

  const {
    connected,
    address,
    publicKey,
    chain,
    pocket, // Instance of PocketProvider from the NodeWallet SDK
  } = useNodeWallet();

  // provides a function to initiate a connection to NodeWallet
  // not needed if autoConnect is set to true or if using the
  // ConnectButton component
  // const connect = useNodeWalletConnect();
  
  return (
    <div>
      <h1>NodeWallet React SDK Demo</h1>
      {!connected ?
        <ConnectButton />
        :
        <div>
          <p>Address: {address}</p>
          <p>Public Key: {publicKey}</p>
          <p>Chain: {chain}</p>
        </div>
      }
    </div>
  );
};

ConnectButton Component

The NodeWallet React SDK provides a ConnectButton component that can be used to initiate a connection to NodeWallet as long as you have the NodeWalletProvider added to the top level of your application. It is customizable via props:

interface ConnectButtonProps {
  size?: 'sm'|'md'|'lg'
  buttonStyle?: React.CSSProperties
  buttonBackground?: string
  buttonHoverBackground?: string
  buttonOutlineColor?: string
  buttonOutlineHoverColor?: string
  buttonMinHeight?: number
  buttonBorderRadius?: number
  buttonProps?: React.DetailedHTMLProps<React.ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>
  logoContainerStyle?: React.CSSProperties
  logoSize?: number
  textContainerStyle?: React.CSSProperties
  textColor?: string
  textHoverColor?: string
  textSize?: number
  text?: string
}

There are three sizes available: sm, md, and lg. The default size is md. The buttonProps prop can be used to pass additional props to the underlying button element. The text prop can be used to customize the text displayed on the button. The default text is Connect to NodeWallet.

NodeWallet button sizes example

Readme

Keywords

none

Package Sidebar

Install

npm i @decentralizedauthority/nodewallet-react-sdk

Weekly Downloads

0

Version

0.1.5

License

none

Unpacked Size

16.3 kB

Total Files

6

Last publish

Collaborators

  • decentralizedauthority