{"id":18244998,"url":"https://github.com/edgeapp/edge-exchange-plugins","last_synced_at":"2025-04-06T07:12:52.213Z","repository":{"id":37792679,"uuid":"97538010","full_name":"EdgeApp/edge-exchange-plugins","owner":"EdgeApp","description":"Exchange-rate sources for the Edge Core","archived":false,"fork":false,"pushed_at":"2025-03-01T02:19:06.000Z","size":2859,"stargazers_count":10,"open_issues_count":18,"forks_count":36,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-03-30T03:09:28.318Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://edge.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/EdgeApp.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-07-18T01:24:02.000Z","updated_at":"2025-03-01T02:19:07.000Z","dependencies_parsed_at":"2023-10-27T21:30:56.537Z","dependency_job_id":"487216a5-eea1-4292-958e-675957216a02","html_url":"https://github.com/EdgeApp/edge-exchange-plugins","commit_stats":{"total_commits":576,"total_committers":30,"mean_commits":19.2,"dds":0.5920138888888888,"last_synced_commit":"103a7369675fdfbb56c7bdd327f81aad8f3d296f"},"previous_names":[],"tags_count":204,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EdgeApp%2Fedge-exchange-plugins","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EdgeApp%2Fedge-exchange-plugins/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EdgeApp%2Fedge-exchange-plugins/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EdgeApp%2Fedge-exchange-plugins/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/EdgeApp","download_url":"https://codeload.github.com/EdgeApp/edge-exchange-plugins/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247445671,"owners_count":20939958,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T09:18:33.382Z","updated_at":"2025-04-06T07:12:52.197Z","avatar_url":"https://github.com/EdgeApp.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Edge Exchange Plugins\n\nThis library exports a collection of exchange-rate \u0026 swap plugins for use with [`edge-core-js`](https://github.com/EdgeApp/edge-core-js).\n\nPlease 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.\n\n## Installing\n\nFist, add this library to your project:\n\n```sh\nyarn add edge-exchange-plugins\n```\n\n### Node.js\n\nFor Node.js, you should call `addEdgeCorePlugins` to register these plugins with edge-core-js:\n\n```js\nconst { addEdgeCorePlugins, lockEdgeCorePlugins } = require('edge-core-js')\nconst plugins = require('edge-exchange-plugins')\n\naddEdgeCorePlugins(plugins)\n\n// Once you are done adding plugins, call this:\nlockEdgeCorePlugins()\n```\n\nYou can also add plugins individually if you want to be more picky:\n\n```js\naddEdgeCorePlugins({\n  thorchain: plugins.thorchain\n})\n```\n\n### Browser\n\nThe bundle located in `dist/edge-exchange-plugins.js` will automatically register itself with edge-core-js. Just serve the entire `dist` directory along with your app, and then load the script:\n\n```html\n\u003cscript src='https://example.com/app/dist/edge-exchange-plugins.js'\u003e\n```\n\nIf you want to debug this project, run `yarn start` to start a Webpack server,\nand then adjust your script URL to http://localhost:8083/edge-exchange-plugins.js.\n\n### React Native\n\nThis package will automatically install itself using React Native autolinking. To integrate the plugins with edge-core-js, add its URI to the context component:\n\n```jsx\nimport { pluginUri } from 'edge-exchange-plugins'\n\n\u003cMakeEdgeContext\n  pluginUris={[pluginUri]}\n  // Plus other props as required...\n/\u003e\n```\n\nTo debug this project, run `yarn start` to start a Webpack server, and then use `debugUri` instead of `pluginUri`.\n\n## edge-react-gui\n\nTo 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.\n\n# Adding Your Exchange\n\nTo 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.\n\nClone this repo as a peer in the same directory as `edge-react-gui`. Then run\n\n```sh\nyarn\nyarn prepare\n```\n\nFrom within the `edge-react-gui`\n\n```sh\nyarn updot edge-exchange-plugins\nyarn prepare\nyarn prepare.ios # For iPhone development\n```\n\nMake appropriate changes to `edge-react-gui` to include your plugin. Search `edge-react-gui` for the string `changelly` and make similar changes for your plugin.\nYou can then rebuild the `edge-react-gui` app and run and test the plugin. To do a swap with your plugin, go to Settings \u003e Exchange Settings, then disable all other exchanges but yours. Then tap the bottom right `Exchange` button and try to do a swap. You'll of course need funds in your Edge account.\n\nPlease be aware that when considering merging pull requests for additional exchanges we require the following:\n\n- Accompanying PR submitted to `edge-reports` that fetches transaction data to your exchange that is credited to Edge users\n- Rebase of your branch upon this repo's `master` branch. For more info:\nhttps://github.com/edx/edx-platform/wiki/How-to-Rebase-a-Pull-Request\n- Accompanying PR submitted to `edge-react-gui` that includes (but is not limited to) the following:\n    - Small 64x64 pixel square logos with a white background\n    - 600x210 pixel horizontal logo for your exchange, with **no** empty space around the logo (we will add this programatically within the app\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedgeapp%2Fedge-exchange-plugins","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fedgeapp%2Fedge-exchange-plugins","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedgeapp%2Fedge-exchange-plugins/lists"}