@gnosis.pm/safe-apps-react-sdk

Safe Apps React SDK

This SDK should provide a simple way to write a React.js Safe app

How to use

• Add npm package

yarn add @gnosis.pm/safe-apps-react-sdk

npm i @gnosis.pm/safe-apps-react-sdk

• Add SafeProvider Safe provider accepts loader and options props

// ... other imports
import SafeProvider from '@gnosis.pm/safe-apps-react-sdk';

ReactDOM.render(
  <React.StrictMode>
    <SafeProvider>
      <App /> // Your app
    </SafeProvider>
  </React.StrictMode>,
  document.getElementById('root'),
);

• Use Safe Apps SDK Hook

// ... other imports
import { useSafeAppsSDK } from '@gnosis.pm/safe-apps-react-sdk';

const App = () => {
  const { sdk, connected, safe } = useSafeAppsSDK();
  return <div>{safe.safeAddress}</div>;
};

Usages

Send transactions

import { BaseTransaction } from '@gnosis.pm/safe-apps-sdk'

const txs: BaseTransaction[] = [
  {
    to: '0x31415629...',
    value: '0',
    data: '0xbaddad',
  },
  //...
];
// Returns a hash to identify the Safe transaction
const safeTxHash: string = await sdk.txs.send({ txs });

Load Safe transaction information

const safeTx: SafeTransaction = await sdk.txs.getBySafeTxHash(safeTxHash);

More scenarios

For all available sdk methods, please refer to the safe-apps-sdk documentation