{"_id":"@algorandfoundation/xgov-clients","_rev":"6-034ac5082a633377b9d87da6b5f8913a","name":"@algorandfoundation/xgov-clients","dist-tags":{"latest":"3.0.1"},"versions":{"3.0.0":{"name":"@algorandfoundation/xgov-clients","version":"3.0.0","author":{"name":"Algorand Foundation"},"license":"AGPL-3.0-or-later","_id":"@algorandfoundation/xgov-clients@3.0.0","maintainers":[{"name":"bruno.martins.algorand.foundation","email":"bruno.martins@algorand.foundation"},{"name":"dev_algorand.foundation","email":"dev+npm@algorand.foundation"},{"name":"shane-at-algo","email":"shane.mcgovern@algorand.foundation"},{"name":"hmd2v","email":"yared@679labs.com"},{"name":"joe-p","email":"joepolny@gmail.com"},{"name":"bitd13co","email":"bit@d13.co"}],"dist":{"shasum":"0e2688d1683fcec4d88728274e0d4d1f0745760c","tarball":"https://registry.npmjs.org/@algorandfoundation/xgov-clients/-/xgov-clients-3.0.0.tgz","fileCount":7,"integrity":"sha512-XNpheFKCxczFCVKCito59GayKDC9f0YlQBV+ohsJvbFxBG1zjPyAewwG/NmAmKG+uNXIwbp3q7rrr18su0KL3w==","signatures":[{"sig":"MEQCIF7UbFoyh1sWQ6nkXAWMzV+OzrNTw4GLbYbnCI3iXzIUAiA2QcJ/Nacobt90LBUwct1SsDtPbREGSq4U524tCJ+hrQ==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":929298},"type":"module","exports":{"./proposal":{"types":"./dist/ProposalClient.d.ts","default":"./dist/ProposalClient.js"},"./registry":{"types":"./dist/XGovRegistryClient.d.ts","default":"./dist/XGovRegistryClient.js"}},"gitHead":"e6172ab42ffedfc8470504ab109f39e60278a808","scripts":{"test":"echo \"Error: no test specified\" && exit 0","build":"npm run generate && tsc","generate":"npm run generate:proposal && npm run generate:registry","prepublishOnly":"npm run build","generate:proposal":"npx @algorandfoundation/algokit-client-generator generate -o src/ProposalClient.ts -a contract/smart_contracts/artifacts/proposal/Proposal.arc56.json","generate:registry":"npx @algorandfoundation/algokit-client-generator generate -o src/XGovRegistryClient.ts -a contract/smart_contracts/artifacts/xgov_registry/XGovRegistry.arc56.json"},"_npmUser":{"name":"bitd13co","email":"bit@d13.co"},"_npmVersion":"10.9.2","description":"xGov Beta Smart Contract Clients","directories":{},"_nodeVersion":"22.17.0","_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.5.4","@types/node":"^22.10.1","@algorandfoundation/algokit-client-generator":"^6.0.0"},"peerDependencies":{"algosdk":"^3.4.0","@algorandfoundation/algokit-utils":"^9.1.2"},"_npmOperationalInternal":{"tmp":"tmp/xgov-clients_3.0.0_1756394105004_0.7673077541836455","host":"s3://npm-registry-packages-npm-production"}},"3.0.1":{"name":"@algorandfoundation/xgov-clients","version":"3.0.1","author":{"name":"Algorand Foundation"},"license":"AGPL-3.0-or-later","_id":"@algorandfoundation/xgov-clients@3.0.1","maintainers":[{"name":"bruno.martins.algorand.foundation","email":"bruno.martins@algorand.foundation"},{"name":"dev_algorand.foundation","email":"dev+npm@algorand.foundation"},{"name":"shane-at-algo","email":"shane.mcgovern@algorand.foundation"},{"name":"hmd2v","email":"yared@679labs.com"},{"name":"joe-p","email":"joepolny@gmail.com"},{"name":"bitd13co","email":"bit@d13.co"}],"dist":{"shasum":"87119b4d8ba5b36c394cdf2d3471683e1f429f9e","tarball":"https://registry.npmjs.org/@algorandfoundation/xgov-clients/-/xgov-clients-3.0.1.tgz","fileCount":7,"integrity":"sha512-s/L40sVpzeVtZqbsqR3NY3qLchg4UCR8mqdxFfXy4sL6iAkvoibpdz2NrIBAglHLyD4m8H4JI3Hj1oHf7FySAQ==","signatures":[{"sig":"MEUCIQDxieM5mnvhF8cCgNdBtdLUeA/TMf35vJ7Ufo9moQbyJwIgCbwkBM6KbGa4iO4SFTdlSBQjEU8wdEUWXqmN6dRAPA0=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":929812},"type":"module","exports":{"./proposal":{"types":"./dist/ProposalClient.d.ts","default":"./dist/ProposalClient.js"},"./registry":{"types":"./dist/XGovRegistryClient.d.ts","default":"./dist/XGovRegistryClient.js"}},"gitHead":"e6172ab42ffedfc8470504ab109f39e60278a808","scripts":{"test":"echo \"Error: no test specified\" && exit 0","build":"npm run generate && tsc","generate":"npm run generate:proposal && npm run generate:registry","prepublishOnly":"npm run build","generate:proposal":"npx @algorandfoundation/algokit-client-generator generate -o src/ProposalClient.ts -a contract/smart_contracts/artifacts/proposal/Proposal.arc56.json","generate:registry":"npx @algorandfoundation/algokit-client-generator generate -o src/XGovRegistryClient.ts -a contract/smart_contracts/artifacts/xgov_registry/XGovRegistry.arc56.json"},"_npmUser":{"name":"bitd13co","email":"bit@d13.co"},"_npmVersion":"10.9.2","description":"xGov Beta Smart Contract Clients","directories":{},"_nodeVersion":"22.17.0","_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.5.4","@types/node":"^22.10.1","@algorandfoundation/algokit-client-generator":"^6.0.0"},"peerDependencies":{"algosdk":"^3.4.0","@algorandfoundation/algokit-utils":"^9.1.2"},"_npmOperationalInternal":{"tmp":"tmp/xgov-clients_3.0.1_1756394726472_0.9278885123959391","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2025-08-28T15:15:04.912Z","modified":"2026-04-08T12:47:22.206Z","3.0.0":"2025-08-28T15:15:05.254Z","3.0.1":"2025-08-28T15:25:26.670Z"},"author":{"name":"Algorand Foundation"},"license":"AGPL-3.0-or-later","description":"xGov Beta Smart Contract Clients","maintainers":[{"email":"bruno.martins@algorand.foundation","name":"bruno.martins.algorand.foundation"},{"email":"dev+npm@algorand.foundation","name":"dev_algorand.foundation"},{"email":"shane.mcgovern@algorand.foundation","name":"shane-at-algo"},{"email":"joepolny@gmail.com","name":"joe-p"},{"email":"bit@d13.co","name":"bitd13co"},{"email":"kyle.breeding@algorand.foundation","name":"krby"}],"readme":"# @algorandfoundation/xgov\n\nThis is an npm package that provides a set of tools to interact with the xGov smart contracts. \nThe workflow is automated and dispatched from the [xgov-beta-sc](https://github.com/algorandfoundation/xgov-beta-sc) repository.\nThe workflow can also be triggered manually.\n\n\nThe package has two modules it exports, `Proposal` and `XGovRegistry`.\nBoth are typed clients generated from the smart contract's ARC-32 ABI definition.\nThis repository simply handles the generation and packaging of the artifacts.\n\n## Installation\n\n```bash\nnpm install algorandfoundation/xgov-beta-ts --save\n```\n\n## Usage\n\n### Proposal\n\n```typescript\nimport { ProposalClient } from '@algorandfoundation/xgov/proposal';\n```\n\n### Registry\n\n```typescript\nimport { XGovRegistryClient } from '@algorandfoundation/xgov/registry';\n```\n\n## Contributing\n\n> Ensure you have Node.js and Algokit installed on your machine.\n\n\nClone the project\n\n```bash\ngit clone git@github.com:algorandfoundation/xgov-beta-ts.git\n```\n\nEnsure submodule is up to date\n```bash\ngit submodule update --init --recursive\n```\n\nInstall dependencies\n\n```bash\nnpm install\n```\n\nBuild the project\n\n```bash\nnpm run build\n```\n","readmeFilename":"README.md"}