# @dcl/l2-utils

> A collection of helpers to make it easier to build a Decentraland scene using the SDK.

Latest version **1.0.4** (published 2021-01-12) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @dcl/l2-utils
pnpm add @dcl/l2-utils
yarn add @dcl/l2-utils
bun add @dcl/l2-utils
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2021-01-12 |
| First published | 2020-09-15 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 36.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 17 |
| Author | Decentraland |
| Maintainers | decentralandbot |

## Links

- npm: https://www.npmjs.com/package/@dcl/l2-utils
- Repository: https://github.com/decentraland/decentraland-l2-utils
- Homepage: https://github.com/decentraland/decentraland-l2-utils#readme
- Issues: https://github.com/decentraland/decentraland-l2-utils/issues
- npm.io page: https://npm.io/package/@dcl/l2-utils

## Dependencies (3)

- [eth-connect](https://npm.io/package/eth-connect.md) ^5.0.0
- [decentraland-ecs](https://npm.io/package/decentraland-ecs.md) ^6.6.3
- [decentraland-ecs-utils](https://npm.io/package/decentraland-ecs-utils.md) ^1.4.5

## Recent versions

- 1.0.4 (latest) — 2021-01-12
- 1.0.3 — 2020-11-18
- 1.0.2 — 2020-09-26
- 1.0.1 — 2020-09-15
- 1.0.0 — 2020-09-15

## README

# decentraland-l2-utils

This library includes a number of helpful pre-built tools that help you deal with common requirements that involve and interacting with data on the second layer blockchain.

- [ERC20](#ERC20)
	- [Get balance](#get-balance)
	- [Deposit MANA](#deposit-MANA)
	- [Send MANA](#send-MANA)
	- [Withdraw MANA](#withdraw-MANA)

## Using the L2 library

To use any of the helpers provided by the utils library

1. Install it as an `npm` package. Run this command in your scene's project folder:

```
npm i @dcl/l2-utils@latest
```

2. Import the library into the scene's script. Add this line at the start of your `game.ts` file, or any other TypeScript files that require it:

```ts
import * as layerTwo from '../node_modules/@dcl/l2-utils/index'

```

If you'll only be using part of this library in your scene, we recommend instead only importing the specific relevant subfolder/s. For example:

```ts
import * as matic from '../node_modules/@dcl/l2-utils/matic/index'
```

3. In your TypeScript file, write `layerTwo.` and let the suggestions of your IDE show the available helpers.

## MANA Operations

As MANA is Decentraland's main currency, this library provies tools to make it especially easy to use in a scene.

### Get balance of an address

To make players in your scene send MANA to a specific address, use the `sendMana()` function. This function requires the following arguments:

- `address`: What ethereum address to send the MANA to

```ts
matic.balance(`0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee`)
```

For example, your scene can have a button that requests players to make a MANA payment to the scene cretor's personal wallet. The button opens a door, but only once a transaction is sent to pay the fee.

```ts
import * as matic from '../node_modules/@dcl/l2-utils/matic/index'

(...)

let myWallet = `0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee`

button.addComponent(new OnPointerDown(async e => {
	const balance = await matic.balance(myWallet)
	if(balance > 10) {
		// open door
	}
))
```

### Send MANA to an address

To make players in your scene send MANA to a specific address, use the `sendMana()` function. This function requires the following arguments:

- `toAddress`: What ethereum address to send the MANA to
- `amount`: How many MANA tokens to send

```ts
matic.sendMana(`0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee`, 100)
```

For example, your scene can have a button that requests players to make a MANA payment to the scene cretor's personal wallet. The button opens a door, but only once a transaction is sent to pay the fee.

```ts
import * as matic from '../node_modules/@dcl/l2-utils/matic/index'

(...)

let myWallet = `0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee`

button.addComponent(new OnPointerDown(async e => {
	await matic.sendMana(myWallet, 100).then(
		// open door
	)
  }
))
```

In this scenario, when players click on the button, they are prompted by Metamask to accept the transaction.
Once that transaction is confirmed on the Matic network, the door opens.

---
_Source: https://npm.io/package/@dcl/l2-utils · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._