Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Sync main #358

Merged
merged 10 commits into from
Nov 29, 2023
Merged

Sync main #358

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
c931219
chore(deps-dev): bump semver from 5.7.1 to 5.7.2 (#345)
dependabot[bot] Nov 10, 2023
ab83f08
refactor!: remove supportsInterface
fhildeb Nov 23, 2023
b882379
feat: add more schemas available to parse via `getSchema` (#351)
CJ42 Nov 23, 2023
7791977
refactor: improve code for tuple checks (#353)
CJ42 Nov 23, 2023
a6fe7c8
feat: add `encode/decodeValueType` as public callable methods (#325)
CJ42 Nov 24, 2023
3a6be55
feat: allow to encode LSP2 Array length only (#326)
CJ42 Nov 24, 2023
417a4e8
feat: add support to encode / decode any `uint8` to `uint256` types (…
CJ42 Nov 27, 2023
ba92903
feat: add support for multi types in mappings (#357)
Hugoo Nov 27, 2023
3b48b0e
Revert "refactor!: remove supportsInterface" (#359)
Hugoo Nov 29, 2023
0f95928
docs: update README and docs (#360)
Hugoo Nov 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
# erc725.js · [![GitHub license](https://img.shields.io/badge/license-Apache-blue.svg)](./LICENSE) [![npm version](https://img.shields.io/npm/v/@erc725/erc725.js.svg?style=flat)](https://www.npmjs.com/package/@erc725/erc725.js)

<p align="center">
<h2 align="center"><strong>@erc725/erc725.js</strong></h2>
<p align="center">Allows for interfacing with <a href="https://github.com/lukso-network/LIPs/blob/master/LSPs/LSP-2-ERC725YJSONSchema.md">ERC725Y</a> compliant contracts on an EVM blockchain.</p>
<h1 align="center"><strong>@erc725/erc725.js</strong></h1>
<p align="center">Allows for interacting with <a href="https://github.com/lukso-network/LIPs/blob/master/LSPs/LSP-2-ERC725YJSONSchema.md">ERC725Y</a> compliant contracts on an EVM blockchain.</p>
</p>

<p align="center">
<a href="https://www.npmjs.com/package/@erc725/erc725.js">
<img alt="NPM version" src="https://img.shields.io/npm/v/@erc725/erc725.js.svg?style=flat" />
</a>
<a href="https://github.com/ERC725Alliance/erc725.js/actions">
<img alt="Tests Passing" src="https://github.com/ERC725Alliance/erc725.js/actions/workflows/lint-test-build.yml/badge.svg" />
</a>
</p>

<p align="center">
<a href="https://codecov.io/gh/ERC725Alliance/erc725.js">
<img src="https://codecov.io/gh/ERC725Alliance/erc725.js/branch/main/graph/badge.svg" />
</a>
Expand All @@ -19,13 +23,10 @@
<img alt="GitHub pull requests" src="https://img.shields.io/github/issues-pr/ERC725Alliance/erc725.js?color=0088ff" />
</a>
</p>
<p align="center">For more information see <a href="https://docs.lukso.tech/tools/erc725js/getting-started">Documentation</a>.</p>
<p align="center">For more information see the <a href="https://docs.lukso.tech/tools/erc725js/getting-started">Documentation</a>.</p>

## Installation

| :warning: | _This package is currently in early stages of development,<br/> use for testing or experimentation purposes only._ |
| :-------: | :----------------------------------------------------------------------------------------------------------------- |

```shell script
npm install @erc725/erc725.js
```
Expand All @@ -38,11 +39,12 @@ import ERC725 from '@erc725/erc725.js';

If you install it on the backend side, you may need to also install [`isomorphic-fetch`](https://www.npmjs.com/package/isomorphic-fetch).

## Usage
## Instantiation

You need to initialise it with a [schema](https://docs.lukso.tech/tools/erc725js/schemas), a contract address and an RPC URL.

```js
import { ERC725 } from '@erc725/erc725.js';
import Web3 from 'web3';

// Part of LSP3-Profile Schema
// https://github.com/lukso-network/LIPs/blob/master/LSPs/LSP-3-Profile-Metadata.md
Expand Down Expand Up @@ -166,10 +168,12 @@ await myErc725.fetchData();
*/
```

For more information 👉 [check the docs](https://docs.lukso.tech/tools/erc725js/classes/ERC725).

## Contributing

Please check [CONTRIBUTING](./CONTRIBUTING.md).

### License
## License

erc725.js is [Apache 2.0 licensed](./LICENSE).
Loading
Loading