{"id":22066773,"url":"https://github.com/gift-stack/web3-plugin-ipfs-registry","last_synced_at":"2026-05-09T17:40:53.516Z","repository":{"id":207065440,"uuid":"718343679","full_name":"Gift-Stack/web3-plugin-ipfs-registry","owner":"Gift-Stack","description":"Web3.js Plugin that have two main functions for uploading a provided local file to IPFS, then store the CID in a smart contract, and another function for listing all stored CIDs of given ethereum address.","archived":false,"fork":false,"pushed_at":"2023-11-14T18:33:55.000Z","size":162,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-01T04:13:30.434Z","etag":null,"topics":["chainsafe","ipfs","web3js"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/web3-plugin-ipfs-registry","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Gift-Stack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2023-11-13T22:16:55.000Z","updated_at":"2023-11-15T15:18:18.000Z","dependencies_parsed_at":"2024-11-30T19:39:19.168Z","dependency_job_id":null,"html_url":"https://github.com/Gift-Stack/web3-plugin-ipfs-registry","commit_stats":null,"previous_names":["gift-stack/web3-plugin-ipfs-registry"],"tags_count":0,"template":false,"template_full_name":"web3/web3.js-plugin-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gift-Stack%2Fweb3-plugin-ipfs-registry","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gift-Stack%2Fweb3-plugin-ipfs-registry/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gift-Stack%2Fweb3-plugin-ipfs-registry/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gift-Stack%2Fweb3-plugin-ipfs-registry/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Gift-Stack","download_url":"https://codeload.github.com/Gift-Stack/web3-plugin-ipfs-registry/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245147144,"owners_count":20568442,"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":["chainsafe","ipfs","web3js"],"created_at":"2024-11-30T19:29:00.978Z","updated_at":"2026-05-09T17:40:48.482Z","avatar_url":"https://github.com/Gift-Stack.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"web3-plugin-ipfs-registry\n===========\n\nThis is a plugin for uploading files into ipfs, and registering them in a smart contract, built with web3.js v4 plugin.\n\nHow to use\n------------\nTL;DR: The `usage.ts` file has it implemented already!! 🚀\n\n1. Instantiate  `web3`\n```javascript\nconst provider = new HttpProvider(\n  \"https://ethereum-sepolia.publicnode.com\",\n);\n// const provider = new HttpProvider(\"HTTP://127.0.0.1:7545\"); // Provider for Ganache environment\nconst web3 = new Web3(provider);\n```\nHere are a list of supported RPCs:\n```javascript\n[\"https://ethereum-sepolia.publicnode.com\", \"https://endpoints.omniatech.io/v1/eth/sepolia/public\", \"https://rpc.sepolia.org\", \"https://sepolia.gateway.tenderly.co\"]\n```\nThere are more rpcs [here](https://chainlist.org/chain/11155111)\n\n2. Register plugin for use\n```javascript\nweb3.registerPlugin(new IPFSRegistryPlugin());\n```\n\n3. Call the upload function\n```javascript\nexport const _upload = async (): Promise\u003cUploadReturnData\u003e =\u003e {\n  return await web3.ipfsRegistry.upload(\"src/usage.ts\");\n};\n```\n\n4. Fetch uploaded CIDs\n```javascript\nexport const getCids = async (): Promise\u003cvoid\u003e =\u003e {\n  await web3.ipfsRegistry.listCids(\n    \"0x8B90d90F2867D52878483B42bcA591F9Efe2931b\",\n  );\n};\n\n```\n\n5. Run test (This runs the E2E test on both node and browser environment)\n```sql\nyarn run test:all\n```\n\n7. Run build.\n```sql\nyarn run build\n```\n\nContributing\n------------\n\nPull requests are welcome. For major changes, please open an issue first\nto discuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\n\nLicense\n-------\n\n[MIT](https://choosealicense.com/licenses/mit/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgift-stack%2Fweb3-plugin-ipfs-registry","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgift-stack%2Fweb3-plugin-ipfs-registry","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgift-stack%2Fweb3-plugin-ipfs-registry/lists"}