# @rndlabs/safe-apps-provider

> A provider wrapper of Safe Apps SDK

Latest version **0.1.15** (published 2023-07-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @rndlabs/safe-apps-provider
pnpm add @rndlabs/safe-apps-provider
yarn add @rndlabs/safe-apps-provider
bun add @rndlabs/safe-apps-provider
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.1.15 |
| Published | 2023-07-22 |
| First published | 2023-07-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 65 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 330 |
| Author | Safe |
| Maintainers | mfw78 |

## Links

- npm: https://www.npmjs.com/package/@rndlabs/safe-apps-provider
- Repository: https://github.com/safe-global/safe-apps-sdk
- Homepage: https://github.com/safe-global/safe-apps-sdk#readme
- Issues: https://github.com/safe-global/safe-apps-sdk/issues
- npm.io page: https://npm.io/package/@rndlabs/safe-apps-provider

## Dependencies (2)

- [events](https://npm.io/package/events.md) ^3.3.0
- [@rndlabs/safe-apps-sdk](https://npm.io/package/@rndlabs/safe-apps-sdk.md) ^0.1.13

## Recent versions

- 0.1.15 (latest) — 2023-07-22
- 0.1.14 — 2023-07-22
- 0.1.13 — 2023-07-21
- 0.1.12 — 2023-07-21
- 0.1.11 — 2023-07-21
- 0.1.10 — 2023-07-21
- 0.1.9 — 2023-07-21
- 0.1.8 — 2023-07-21
- 0.1.7 — 2023-07-21
- 0.1.6 — 2023-07-21
- 0.1.5 — 2023-07-21
- 0.1.4 — 2023-07-21
- 0.1.3 — 2023-07-21
- 0.1.2 — 2023-07-21
- 0.1.1 — 2023-07-21
- … 1 more at https://npm.io/package/@rndlabs/safe-apps-provider/versions

## README

# Safe Apps Provider

[![npm](https://img.shields.io/npm/v/@safe-global/safe-apps-provider)](https://www.npmjs.com/package/@safe-global/safe-apps-provider)

This is a provider that follows common standards (e.g. [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193)) and can be used with various Web3 libraries (e.g. web3.js or Ethers)

### How to use

- Add npm package

```bash
yarn add @safe-global/safe-apps-provider

npm i @safe-global/safe-apps-provider
```

### SafeAppProvider

The provider can be used with the [safe-apps-react-sdk](https://github.com/safe-global/safe-apps-sdk/tree/main/packages/safe-apps-react-sdk) and common web3 libraries.

#### With Ethers.js

- [Ethers.js](https://docs.ethers.io/v5/api/providers/other/#Web3Provider)

```js
import React, { useMemo } from 'react';
import { ethers } from 'ethers';
import { useSafeAppsSDK } from '@safe-global/safe-apps-react-sdk';
import { SafeAppProvider } from '@safe-global/safe-apps-provider';

const App = () => {
  const { sdk, safe } = useSafeAppsSDK();
  const web3Provider = useMemo(() => new ethers.providers.Web3Provider(new SafeAppProvider(safe, sdk)), [sdk, safe]);

  // use provider with contracts

  return;
};

export default App;
```

#### With web3.js

- [web3.js](https://web3js.readthedocs.io/en/v1.5.2/web3.html)

```js
import React, { useMemo } from 'react';
import Web3 from 'web3';
import { useSafeAppsSDK } from '@safe-global/safe-apps-react-sdk';
import { SafeAppProvider } from '@safe-global/safe-apps-provider';

const App = () => {
  const { sdk, safe } = useSafeAppsSDK();
  const web3Provider = useMemo(() => new Web3(new SafeAppProvider(safe, sdk)), [sdk, safe]);

  // use provider with contracts

  return;
};

export default App;
```

### A note on gas limit
The ethereum transaction gas limit passed to the safe-apps-provider will be treated as safeTxGas, which is an equivalent of the ethereum transaction gas limit in the Safe context. To learn more about the safe transaction gas, read here:  
https://github.com/safe-global/safe-contracts/blob/c36bcab46578a442862d043e12a83fec41143dec/docs/safe_tx_gas.md  

If you don't want to pass a calculation and leave it to the Safe, pass 0 as the gas limit.

### More scenarios

For the SDK overview documentation, please refer to the [safe-apps-sdk](https://github.com/safe-global/safe-apps-sdk/) documentation

---
_Source: https://npm.io/package/@rndlabs/safe-apps-provider · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
