{"_id":"@elimu-ai/web3-sponsors","_rev":"2-bca6a363eefa06046159ae10ef05064e","name":"@elimu-ai/web3-sponsors","dist-tags":{"latest":"0.9.5"},"versions":{"0.9.4":{"name":"@elimu-ai/web3-sponsors","version":"0.9.4","keywords":["education","edtech","web3","ethereum","dao","sponsor","sponsorship"],"author":{"name":"Ξlimu DAO"},"license":"MIT","_id":"@elimu-ai/web3-sponsors@0.9.4","maintainers":[{"name":"nya-elimu","email":"info@elimu.ai"},{"name":"jo-elimu","email":"jo@elimu.ai"}],"homepage":"https://sponsors.elimu.ai","bugs":{"url":"https://github.com/elimu-ai/web3-sponsors/issues"},"dist":{"shasum":"4b6cadde6627dfc71acfd76b8b1d0fe3c09f6192","tarball":"https://registry.npmjs.org/@elimu-ai/web3-sponsors/-/web3-sponsors-0.9.4.tgz","fileCount":4,"integrity":"sha512-kS2gW9Qy49naG41oAAEw7vPHVQdh+5JO1UCB7rIu1sZtWMjUGIaYVpM5Qj9E3ZOxJtQ30Oqrx8LuLRnfx72O5w==","signatures":[{"sig":"MEUCIDrDju85eLKlbPRVNWw+6008H1IuaWahpAiCRrlGaAUcAiEAwyMHTpYDVF9MzpfcpSarT+Gho6TKBKTu+RUry+8wEXo=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":2994},"gitHead":"600c68c8b3ad40f4e9c77b8fdb42baebd5833cbb","_npmUser":{"name":"nya-elimu","email":"info@elimu.ai"},"repository":{"url":"git+https://github.com/elimu-ai/web3-sponsors.git","type":"git"},"_npmVersion":"11.6.2","description":"Interfaces for interacting with the Ξlimu DAO's education sponsorship program","directories":{},"_nodeVersion":"24.12.0","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/web3-sponsors_0.9.4_1766075705077_0.8655945164792218","host":"s3://npm-registry-packages-npm-production"}},"0.9.5":{"name":"@elimu-ai/web3-sponsors","version":"0.9.5","description":"Interfaces for interacting with the Ξlimu DAO's education sponsorship program","repository":{"type":"git","url":"git+https://github.com/elimu-ai/web3-sponsors.git"},"license":"MIT","author":{"name":"Ξlimu DAO"},"homepage":"https://sponsors.elimu.ai","keywords":["education","edtech","web3","ethereum","dao","sponsor","sponsorship"],"gitHead":"fde7a6c2c84ace942246c45fef4f8820e5ff0926","_id":"@elimu-ai/web3-sponsors@0.9.5","bugs":{"url":"https://github.com/elimu-ai/web3-sponsors/issues"},"_nodeVersion":"24.12.0","_npmVersion":"11.6.2","dist":{"integrity":"sha512-oVQ9w0JXxmmGXvwlJxNRhrBpeACPnjJZx9V/ui1qmZ/nBaIFAKPh889lpP9rsH4Dr0d/CupGaMy9hVCU6+v+ng==","shasum":"7223f849a74a5d1c67288ec72c899dab0402f553","tarball":"https://registry.npmjs.org/@elimu-ai/web3-sponsors/-/web3-sponsors-0.9.5.tgz","fileCount":4,"unpackedSize":3165,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIEmCd23iyZbcpervdjO5Vy4X/CAzOto+XLUukNQ+DXHZAiEAwqt8gJs8s4DGidAW94yj93LVSqojqUsnun8f2NeqdKs="}]},"_npmUser":{"name":"nya-elimu","email":"info@elimu.ai"},"directories":{},"maintainers":[{"name":"nya-elimu","email":"info@elimu.ai"},{"name":"jo-elimu","email":"jo@elimu.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/web3-sponsors_0.9.5_1766076655101_0.04786591395528661"},"_hasShrinkwrap":false}},"time":{"created":"2025-12-18T16:35:04.986Z","modified":"2025-12-18T16:50:55.489Z","0.9.4":"2025-12-18T16:35:05.224Z","0.9.5":"2025-12-18T16:50:55.257Z"},"bugs":{"url":"https://github.com/elimu-ai/web3-sponsors/issues"},"author":{"name":"Ξlimu DAO"},"license":"MIT","homepage":"https://sponsors.elimu.ai","keywords":["education","edtech","web3","ethereum","dao","sponsor","sponsorship"],"repository":{"type":"git","url":"git+https://github.com/elimu-ai/web3-sponsors.git"},"description":"Interfaces for interacting with the Ξlimu DAO's education sponsorship program","maintainers":[{"name":"nya-elimu","email":"info@elimu.ai"},{"name":"jo-elimu","email":"jo@elimu.ai"}],"readme":"# Web3 Sponsors 🫶🏽\r\n\r\nInterfaces for interacting with the Ξlimu DAO's education sponsorship program (https://sponsors.elimu.ai)\r\n\r\nIf you want to integrate your own smart contracts with Ξlimu DAO's education sponsorship program, install this library:\r\n\r\n```shell\r\nnpm install @elimu-ai/web3-sponsors\r\n```\r\n\r\n## Add Sponsorship 💜\r\n\r\nIf you want your smart contract to *add a new sponsorship* to our queue of sponsorships, start by importing its interface:\r\n\r\nThen, instantiate the smart contract(s) you want to interact with:\r\n\r\n```solidity\r\nimport { ISponsorshipQueue } from \"@elimu-ai/web3-sponsors/ISponsorshipQueue.sol\";\r\n\r\ncontract MyContract {\r\n    ISponsorshipQueue public immutable sponsorshipQueue;\r\n\r\n    constructor() {\r\n        sponsorshipQueue = ISponsorshipQueue(\"0x47071D164900986994e4cc75DB1AF0ee0D04C6df\");\r\n    }\r\n\r\n    function myFunction() {\r\n        sponsorshipQueue.addSponsorship();\r\n    }\r\n}\r\n```\r\n\r\nNext, add logic to your smart contract for checking if it holds enough ETH to pay for one sponsorship:\r\n\r\n```diff\r\nimport { ILanguages } from \"@elimu-ai/web3-sponsors/ISponsorshipQueue.sol\";\r\n\r\ncontract MyContract {\r\n    ISponsorshipQueue public immutable sponsorshipQueue;\r\n\r\n    constructor() {\r\n        sponsorshipQueue = ISponsorshipQueue(\"0x47071D164900986994e4cc75DB1AF0ee0D04C6df\");\r\n    }\r\n\r\n    function myFunction() {\r\n+        require(address(this).balance > sponsorshipQueue.estimatedCost(), \"Not enough ETH\");\r\n        sponsorshipQueue.addSponsorship();\r\n    }\r\n}\r\n```\r\n\r\nFor a sample implementation, see [`CommunityFund.sol`](https://github.com/elimu-ai/web3-sponsors/tree/main/backend/contracts/sample/CommunityFund.sol).\r\n\r\n> [!WARNING]\r\n> The `estimatedCost` parameter set in the SponsorshipQueue smart contract can be adjusted by the Ξlimu DAO, so make sure to implement your code in a way that can handle this.\r\n\r\n## Add Distribution 🛵💨\r\n\r\nComing soon...\r\n\r\n---\r\n\r\nThe mission of elimu.ai is to build innovative learning software that empowers out-of-school children to teach themselves basic reading📖, writing✍🏽 and math🔢 **within 6 months**.\r\n\r\nTo learn more about the Ξlimu DAO, see https://github.com/elimu-ai/web3-wiki\r\n","readmeFilename":"README.md"}