{"id":21660134,"url":"https://github.com/parallel-finance/parallel-js","last_synced_at":"2025-07-17T23:30:53.851Z","repository":{"id":36958282,"uuid":"372706157","full_name":"parallel-finance/parallel-js","owner":"parallel-finance","description":"This library provides necessary types and JSON-RPC information for user to access Parallel Finance backend","archived":false,"fork":false,"pushed_at":"2023-10-17T07:46:29.000Z","size":5116,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-11-13T21:05:14.785Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/parallel-finance.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2021-06-01T05:00:31.000Z","updated_at":"2024-04-21T11:45:42.000Z","dependencies_parsed_at":"2023-01-17T08:31:02.995Z","dependency_job_id":"57e5da53-bb9b-4780-9449-14719e60eef0","html_url":"https://github.com/parallel-finance/parallel-js","commit_stats":{"total_commits":95,"total_committers":13,"mean_commits":"7.3076923076923075","dds":0.6947368421052631,"last_synced_commit":"3888b61593f685eedbd2ebe4ecd5768a9111b544"},"previous_names":[],"tags_count":49,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/parallel-finance%2Fparallel-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/parallel-finance%2Fparallel-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/parallel-finance%2Fparallel-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/parallel-finance%2Fparallel-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/parallel-finance","download_url":"https://codeload.github.com/parallel-finance/parallel-js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226165759,"owners_count":17583855,"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-25T09:32:18.103Z","updated_at":"2024-11-25T09:34:18.666Z","avatar_url":"https://github.com/parallel-finance.png","language":"TypeScript","readme":"# parallel-js\n\nThis library provides necessary types and JSON-RPC information for user to access Parallel Finance backend by using [polkadot.js](https://github.com/polkadot-js/api).\n\n## Usage\n1. Add this repo as dependencies\n\n```bash\nyarn add @parallel-finance/api\n\n```\n\n2. Import the `ApiPromise` from this package\n```typescript\nimport { ApiPromise, options, WsProvider, Keyring } from \"@parallel-finance/api\" \n\nconst main = async () =\u003e {\n  const api = await ApiPromise.create(options({\n    provider: new WsProvider()\n  }))\n\n  const keyring = new Keyring({ type: \"sr25519\" });\n  const signer = keyring.addFromUri(\"//Alice\")\n\n  await api.tx.system.remark(\"hello\").signAndSend(signer);\n  \n  const [route, amount] = await api.rpc.router.getBestRoute(\"10000000\", 100, 1, true);\n}\n\n```\n\n## Maintenance\n\n- [api](./packages/api)\n  - Contains necessary options to create a polkadot.js API instance\n- [types](./packages/types)\n  - Polkadot.js types  for Parallel Fanance\n- [types-definitions](./packages/types-definitions)\n  - Polkadot.js type definitions for Parallel Fanance\n\n## Update metadata\nStart a local node service on ws://localhost:9948\n```\nyarn\nENDPOINT=ws://localhost:9948 yarn update-metadata\n```\n\n## Build\n```\nyarn\nyarn generate:defs\nyarn generate:meta\nyarn build\n```\n\n## Bump Version\n```\n# For patch update(eg: 0.0.1 -\u003e 0.0.2)\nyarn bump patch\n# For minor update(eg: 0.1.0 -\u003e 0.2.0)\nyarn bump minor\n# For major update(eg: 1.0.0 -\u003e 2.0.0)\nyarn bump major\n\n```\n\n## Open Source Credits\n\nWe would like to thank the following projects.\n\n-   [polkadot-js/api](https://github.com/polkadot-js/api)\n-   [open-web3.js](https://github.com/open-web3-stack/open-web3.js)\n-   [acala.js](https://github.com/AcalaNetwork/acala.js)\n","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fparallel-finance%2Fparallel-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fparallel-finance%2Fparallel-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fparallel-finance%2Fparallel-js/lists"}