From 8df61daa6c972ec602ddf4d8fa5a59ba038fc2ba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miguel=20Moruj=C3=A3o?= Date: Wed, 23 Jul 2025 14:29:48 +0100 Subject: [PATCH 1/4] Update README.md --- README.md | 95 ++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 91 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 34de6d29..521eb845 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,47 @@ # Edge Exchange Plugins +[![Version](https://img.shields.io/npm/v/edge-exchange-plugins.svg)](https://www.npmjs.com/package/edge-exchange-plugins) +[![License](https://img.shields.io/npm/l/edge-exchange-plugins.svg)](https://github.com/EdgeApp/edge-exchange-plugins/blob/master/LICENSE) +[![Build Status](https://img.shields.io/github/actions/workflow/status/EdgeApp/edge-exchange-plugins/ci.yml?branch=master)](https://github.com/EdgeApp/edge-exchange-plugins/actions) + This library exports a collection of exchange-rate & swap plugins for use with [`edge-core-js`](https://github.com/EdgeApp/edge-core-js). -Please see [index.js](./src/index.js) for the list of plugins in this repo. These are compatible with edge-core-js v0.19.37 or later. +Please see [index.ts](./src/index.ts) for the list of plugins in this repo. These are compatible with edge-core-js v0.19.37 or later. + +## Table of Contents + +- [Quick Start](#quick-start) +- [Installing](#installing) + - [Node.js](#nodejs) + - [Browser](#browser) + - [React Native](#react-native) +- [Available Plugins](#available-plugins) +- [Development](#development) +- [edge-react-gui Integration](#edge-react-gui) +- [Adding Your Exchange](#adding-your-exchange) + +## Quick Start + +```bash +# Install the package +yarn add edge-exchange-plugins + +# For Node.js projects +const { addEdgeCorePlugins, lockEdgeCorePlugins } = require('edge-core-js') +const plugins = require('edge-exchange-plugins') + +addEdgeCorePlugins(plugins) +lockEdgeCorePlugins() +``` ## Installing -Fist, add this library to your project: +First, add this library to your project: ```sh yarn add edge-exchange-plugins +# or +npm install edge-exchange-plugins ``` ### Node.js @@ -60,11 +92,64 @@ import { pluginUri } from 'edge-exchange-plugins' To debug this project, run `yarn start` to start a Webpack server, and then use `debugUri` instead of `pluginUri`. -## edge-react-gui +## Available Plugins + +This library includes the following exchange and swap plugins: + +### Centralized Exchanges +- **ChangeHero** - Centralized exchange service +- **ChangeNow** - Instant cryptocurrency exchange +- **Exolix** - Cross-chain exchange platform +- **Godex** - Anonymous cryptocurrency exchange +- **LetsExchange** - Multi-currency exchange service +- **SideShift** - Non-custodial exchange +- **Swapuz** - Cryptocurrency exchange platform + +### DeFi Protocols +- **0x Gasless** - Gasless trading on 0x protocol +- **Cosmos IBC** - Inter-blockchain communication swaps +- **Fantom Sonic Upgrade** - Fantom network upgrades +- **LiFi** - Cross-chain aggregation protocol +- **Rango** - Multi-chain DEX aggregator +- **Thorchain** - Cross-chain liquidity protocol +- **Maya Protocol** - Thorchain-based protocol +- **SwapKit** - Thorchain swap toolkit +- **SpookySwap** - Fantom DEX +- **TombSwap** - Fantom-based DEX +- **Velodrome** - Optimism DEX +- **Unizen** - Multi-chain DeFi platform + +### Other +- **Transfer** - Direct transfer functionality +- **XRP DEX** - XRP decentralized exchange information + +## Development + +To contribute to this project: + +```bash +# Clone the repository +git clone https://github.com/EdgeApp/edge-exchange-plugins.git +cd edge-exchange-plugins + +# Install dependencies +yarn install + +# Build the project +yarn prepare + +# Run tests +yarn test + +# Start development server +yarn start +``` + +## edge-react-gui Integration To enable in edge-react-gui please make sure that the appropriate truthy value (can be object) is included into `env.json`, and that the new `env.json` values are updated on the server building and delivering the app. Since `env.json` is gitignored, plugins may be enabled on your local dev environment but will not be enabled for `develop` or `master` (release) builds until the `env.json` on that build server is updated to include the new plugin. -# Adding Your Exchange +## Adding Your Exchange To test your exchange plugin, build the full application at [`edge-react-gui`](https://github.com/EdgeApp/edge-react-gui). Follow the README there for instructions on building and running the app. @@ -94,3 +179,5 @@ https://github.com/edx/edx-platform/wiki/How-to-Rebase-a-Pull-Request - Accompanying PR submitted to `edge-react-gui` that includes (but is not limited to) the following: - Small 64x64 pixel square logos with a white background - 600x210 pixel horizontal logo for your exchange, with **no** empty space around the logo (we will add this programatically within the app + + From a001d851c4f5065b5d5eefbec69a654900532530 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miguel=20Moruj=C3=A3o?= Date: Wed, 23 Jul 2025 14:36:31 +0100 Subject: [PATCH 2/4] Update README.md --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 521eb845..935a1c95 100644 --- a/README.md +++ b/README.md @@ -119,9 +119,7 @@ This library includes the following exchange and swap plugins: - **Velodrome** - Optimism DEX - **Unizen** - Multi-chain DeFi platform -### Other -- **Transfer** - Direct transfer functionality -- **XRP DEX** - XRP decentralized exchange information +### and more... ## Development From 70812d9ae04fae6bbd433686db7ef5212b140dac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miguel=20Moruj=C3=A3o?= Date: Wed, 23 Jul 2025 14:40:18 +0100 Subject: [PATCH 3/4] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 935a1c95..08317c3a 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,6 @@ [![Version](https://img.shields.io/npm/v/edge-exchange-plugins.svg)](https://www.npmjs.com/package/edge-exchange-plugins) [![License](https://img.shields.io/npm/l/edge-exchange-plugins.svg)](https://github.com/EdgeApp/edge-exchange-plugins/blob/master/LICENSE) -[![Build Status](https://img.shields.io/github/actions/workflow/status/EdgeApp/edge-exchange-plugins/ci.yml?branch=master)](https://github.com/EdgeApp/edge-exchange-plugins/actions) This library exports a collection of exchange-rate & swap plugins for use with [`edge-core-js`](https://github.com/EdgeApp/edge-core-js). From 86a18e9863d3c73a04fb80cb381655f2515f56d9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miguel=20Moruj=C3=A3o?= Date: Wed, 23 Jul 2025 14:41:17 +0100 Subject: [PATCH 4/4] Update README.md --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 08317c3a..8d7e17ea 100644 --- a/README.md +++ b/README.md @@ -176,5 +176,3 @@ https://github.com/edx/edx-platform/wiki/How-to-Rebase-a-Pull-Request - Accompanying PR submitted to `edge-react-gui` that includes (but is not limited to) the following: - Small 64x64 pixel square logos with a white background - 600x210 pixel horizontal logo for your exchange, with **no** empty space around the logo (we will add this programatically within the app - -