Skip to content

Commit

Permalink
new: LxLy.js implementation
Browse files Browse the repository at this point in the history
  • Loading branch information
nitinmittal23 committed Feb 9, 2024
0 parents commit 83fb8da
Show file tree
Hide file tree
Showing 123 changed files with 45,416 additions and 0 deletions.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report---.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: "Bug report \U0001F41E"
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

#### Hint

* You can write what you are expecting and what is currently happening
* You can includes steps to reproduce
* Add screenshot
* Create an issue reproducible public repo and share with us
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
contact_links:
- name: Ask Question 🙋
url: https://github.com/0xpolygon/lxly.js/discussions/categories/q-a
about: Have any doubt ? Ask your question
- name: Show & Tell ⚡
url: https://github.com/0xpolygon/lxly.js/discussions/categories/show-and-tell
about: Show everyone what you have made. This will motivate other users & us.
- name: Ideas
url: https://github.com/0xpolygon/lxly.js/discussions/categories/ideas
about: Have some idea, let's discuss.
- name: General - anything
url: https://github.com/0xpolygon/lxly.js/discussions/categories/general
about: Share anything with us. It might be an article, news or anything which is beneficial for community.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request---.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: "Feature request \U0001F680"
about: Suggest a feature for this project
title: ''
labels: ''
assignees: ''

---

## Summary

Brief explanation of the feature.

### Basic example

Include a basic example or links here.

### Motivation

Why are we doing this? What use cases does it support? What is the expected outcome?
26 changes: 26 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: CI

on:
push:
branches: [main]
pull_request:
branches: [main]

jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [10.x, 12.x, 14.x]
steps:
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- name: Install dependencies
run: npm ci
- name: Check lint
run: npm run lint
- name: Build
run: npm run deploy
18 changes: 18 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
node_modules
lib
.DS_Store
*.log
dump.rdb

test-blockchain/geth
test-blockchain/history
test-blockchain/data/**
!test-blockchain/data/.gitkeep
*.env
bundle.js
dist

*.tgz
config.json
.nuxt
docs
6 changes: 6 additions & 0 deletions .lintstagedrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"**/*.+(js|jsx|css|less|scss|ts|tsx|md)": [
"prettier --write",
"git add"
]
}
11 changes: 11 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
node_modules
lib
*.tgz
src
build_helper
test
*.env
examples
webpack
docs
test
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v11.1.0
3 changes: 3 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules
build
dist
10 changes: 10 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"printWidth": 120,
"proseWrap": "preserve",
"semi": false,
"singleQuote": true,
"useTabs": false,
"tabWidth": 2,
"arrowParens": "avoid",
"trailingComma": "es5"
}
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Contributing to lxly.js

1. [Clone](https://help.github.com/articles/cloning-a-repository/) this repository to your local machine.
2. Checkout new branch to start development `git checkout -b <branch-name>`.

_Branch naming convention:_
- Feature - `feat_custom_token`
- Release/Build - `release_2.1` or `v2.1`
- Fix/Bug - `fix_unknown_token` or `fixes` (if more than one)

_Note: No strict convention while naming branch, but try to keep it meaningful for your team members to understand._

3. Add files to be committed and then commit changes to your local machine `git commit -m <commit-message>`

_Commit message convention:_
- Feature - `feat: integrate token balances`
- Release/Build - `chore: release v2.1` or `chore: bump version to 2.1`
- Fix/Bug - `fix: token balances` or `fix: token list, transfers` (if more than one)

_Note: Keep commit message meaningful for your team members to understand while reviewing merge/pull request._

6. Push changes to remote repository `git push origin <branch-name>`

7. Create a merge/pull request against `master` branch.

_Note: Don't push changes to `master` branch directly. Write proper description of the changes while creating merge/pull request_
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Polygon Labs

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
88 changes: 88 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# LxLy SDK

[![GitHub version](https://badge.fury.io/gh/0xpolygon%2Flxly.js.svg)](https://badge.fury.io/gh/0xpolygon%2Flxly.js)
![Build Status](https://github.com/0xpolygon/lxly.js/workflows/CI/badge.svg?branch=master)
[![npm version](https://badge.fury.io/js/%400xpolygon%2Flxlyjs.svg)](https://badge.fury.io/js/%400xpolygon%2Flxlyjs)
![GitHub](https://img.shields.io/github/license/0xpolygon/lxly.js)
[![TEST](https://github.com/0xpolygon/lxly.js/actions/workflows/test.yml/badge.svg)](https://github.com/0xpolygon/lxly.js/actions/workflows/test.yml)

This repository contains the `lxlyjs` client library. `lxlyjs` makes it easy for developers, who may not be deeply familiar with smart contract development, to interact with the various components of Polygon LxLy Aggregator bridge.

This library will help developers to move assets between Ethereum chain and Polygon CDK chains.

## Support

Our [Discord](https://discord.gg/0xPolygonDevs) is the best way to reach us ✨.

## Contributors

You are very welcome to contribute, please see contributing guidelines - [[Contribute](CONTRIBUTING.md)].

Thank you to all the people who already contributed to lxly.js!

<a href="https://github.com/0xpolygon/lxly.js/graphs/contributors">
<img src="https://contrib.rocks/image?repo=0xpolygon/lxly.js" />
</a>

Made with [contributors-img](https://contrib.rocks).

## Development

**Setup**

```bash
npm ci
```

**How to debug**

Write your code inside file `test/debug.js` and run below code

```bash
npm run debug
```

Above command will build the source code & install the built version into test folder, which will be used by `debug.js`.

**Lint**

```bash
# To check lint errors
npm run lint

# To fix most common lint errors
# Note that it might not fix all errors, some need manual intervention
npm run lint:fix
```

**Build code**

```bash
npm run build
```

**Run test**

```bash
npm run test
```

**Generate distribution files**

```bash
npm run deploy
```

**NPM publish**

Before running publish script, make sure you have updated version properly.

Note that `prepublishOnly` script will be automatically called while publishing. It will check lint, clean dist/lib folders and build fresh distribution files before it executes `npm publish`.

```bash
npm publish
```

### License

MIT
17 changes: 17 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Polygon Technology Security Information

## Link to vulnerability disclosure details (Bug Bounty).
- Websites and Applications: https://hackerone.com/polygon-technology
- Smart Contracts: https://immunefi.com/bounty/polygon

## Languages that our team speaks and understands.
Preferred-Languages: en

## Security-related job openings at Polygon.
https://polygon.technology/careers

## Polygon security contact details.
[email protected]

## The URL for accessing the security.txt file.
Canonical: https://polygon.technology/security.txt
5 changes: 5 additions & 0 deletions build_helper/npm.export.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
if (process.env.NODE_ENV === 'production') {
module.exports = require('./lxly.node.min.js')
} else {
module.exports = require('./lxly.node.js')
}
Loading

0 comments on commit 83fb8da

Please sign in to comment.