{"id":24892918,"url":"https://github.com/b4s36t4/pyth-plugin","last_synced_at":"2025-03-27T13:49:51.969Z","repository":{"id":232993260,"uuid":"705750847","full_name":"b4s36t4/pyth-plugin","owner":"b4s36t4","description":"A web3.js plugin to interact with pyth.network oracle. ","archived":false,"fork":false,"pushed_at":"2023-10-16T16:11:45.000Z","size":170,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-01T18:17:48.902Z","etag":null,"topics":["chainlink","chainlink-hackathon","chainlink-price-feeds","oracles","web3js"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/b4s36t4.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}},"created_at":"2023-10-16T16:11:29.000Z","updated_at":"2023-10-16T16:29:24.000Z","dependencies_parsed_at":"2024-04-12T22:02:25.736Z","dependency_job_id":"17488fe4-e922-404a-bd0c-05749c2f0075","html_url":"https://github.com/b4s36t4/pyth-plugin","commit_stats":null,"previous_names":["b4s36t4/pyth-plugin"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/b4s36t4%2Fpyth-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/b4s36t4%2Fpyth-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/b4s36t4%2Fpyth-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/b4s36t4%2Fpyth-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/b4s36t4","download_url":"https://codeload.github.com/b4s36t4/pyth-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245858872,"owners_count":20684057,"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":["chainlink","chainlink-hackathon","chainlink-price-feeds","oracles","web3js"],"created_at":"2025-02-01T18:17:53.960Z","updated_at":"2025-03-27T13:49:51.940Z","avatar_url":"https://github.com/b4s36t4.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Web3.js Pyth Network Plugin\n\nThis is a [web3.js](https://github.com/web3/web3.js) `4.x` plugin for interacting with _Pyth Network_ Ethereum contracts.\n\n## Prerequisites\n\n- :gear: [NodeJS](https://nodejs.org/)\n- :toolbox: [Yarn](https://yarnpkg.com/)\n\n## Installation\n\n```bash\nyarn add web3.js-pythnet-plugin\n```\n\n## Using this plugin\n\n### Installing Version `4.x` of `web3`\n\nWhen adding the `web3` package to your project, make sure to use version `4.x`:\n\n- `npm i -S web3@4.0.3`\n- `yarn add web3@4.0.3`\n\n\u003e **_NOTE_**  \n\u003e If 4.x was already released, you are good to just use `web3` without appending anything to it.\n\nTo verify you have the correct `web3` version installed, after adding the package to your project (the above commands), look at the versions listed in your project's `package.json` under the `dependencies` section, it should contain version 4.x similar to:\n\n```json\n\"dependencies\": {\n\t\"web3\": \"4.0.3\"\n}\n```\n\n### Registering the Plugin with a web3.js Instance\n\nAfter importing `PythNetworkPlugin` from `web3.js-pythnet-plugin` and `Web3` from `web3`, register an instance of `PythNetworkPlugin` with an instance of `Web3` like so:\n\n```typescript\nimport { PythNetworkPlugin } from '@chainsafe/web3-plugin-chainlink';\nimport { Web3 } from 'web3';\n\nconst web3 = new Web3('YOUR_PROVIDER_URL');\nconst plugin = new PythNetworkPlugin({ type: 'stable', contract: 'Arbitrum' });\n\nweb3.registerPlugin(plugin);\n```\n\nMore information about registering web3.js plugins can be found [here](https://docs.web3js.org/docs/guides/web3_plugin_guide/plugin_users#registering-the-plugin).\n\n### Plugin Methods\n\n\u003e [!WARNING]\n\u003e Not fully documented\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fb4s36t4%2Fpyth-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fb4s36t4%2Fpyth-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fb4s36t4%2Fpyth-plugin/lists"}