{"_id":"@0xmetropolis/metro-sdk","_rev":"6-c40d899bcc45a19dfbef63b15a0a7c06","name":"@0xmetropolis/metro-sdk","dist-tags":{"latest":"3.8.2"},"versions":{"3.8.2":{"name":"@0xmetropolis/metro-sdk","version":"3.8.2","author":"","license":"ISC","_id":"@0xmetropolis/metro-sdk@3.8.2","maintainers":[{"name":"john-sterlacci","email":"john@sonar-labs.com"}],"homepage":"https://github.com/0xmetropolis/metro-sdk#readme","bugs":{"url":"https://github.com/0xmetropolis/metro-sdk/issues"},"dist":{"shasum":"22e07dc76efcfa9ef7048885c307ca27d8973dc1","tarball":"https://registry.npmjs.org/@0xmetropolis/metro-sdk/-/metro-sdk-3.8.2.tgz","fileCount":78,"integrity":"sha512-BeP+W6AVEXp4IwIzWBEBPLa8k4fjujKSo9oXZQyAiUUX5L4Fdm15dfLiKm/MugHArnRNjznyZInKF6Q32F1zYw==","signatures":[{"sig":"MEUCIQDq9BbbLRh2K+68YiOftQ70Nn/YZocDjzbcPJXIWn4hdAIgVa76nLr/glqyKyEzEpZhbLm+ZXFEpYcsh7NwkzaRXqI=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":777538,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkGz20ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrKfg/9HogIBnZ/5jqHrM/AzsQiWAm0/NVJ0Fr9ehy96AbNK1ooQTsR\r\nBczx8eupfEwKOZ/6J8BpeMVFHMlKkmA3q1iQwj9voCdOIYYooAg8IEzfZ4/P\r\nZJVkLlql4ejE/wRYN6yHl5vdAOd64XZMtWCMuvVs5CVjRpJtpwtJa5pIVjlL\r\nNH7yrFoaZQDfW3ZjsfUGRCaqFLms550Dlc9UBkqcIWvR6zR2Rp0c/o7CbaEn\r\neiRnSDGFCiv1VTqccCpKtcUmE7LA4L26iTGTcEcfIE2Xtc/Pfz88waHp7I7k\r\nCDh5CjZ5/wXitG3fN1j1yNMpR3NDYLUBtD01AOuwBUOeS6jW9lfddpXpde+r\r\nTF96q6ok4y4U6MCC3jvcSzddpIp8fdVqFem2M06prJyXYcKtN/vdD0R+x1yG\r\nwlgKFmZZVfqmEKQi2YDatH9s6rA57bjpTUJOrdhxJWhx1ZdhqVeRhrqS8aME\r\n4P1oVUqWYdycQsEyQ8TbanYoWZBBwRa43nO/egtQlF0YJ4Ncmcut9tMhSHRx\r\nSgif27doyZbd272ociaYTu4YLZqk96INu7kiiWSWpRtj/0lnllBc4juwJGk8\r\n8n9M7gx7Z5hc43yLjEbolTzngkDazTQXmOht3gmr+928IM+HeBkLqkPOfh/1\r\na9RSRngSbwMIH9Yk/IkoNMbpr8ApM7TbpHw=\r\n=BqB3\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","types":"./dist/index.d.ts","gitHead":"3424e66ecf185489f25a0813eb9884a796313666","scripts":{"docs":"typedoc src","lint":"cod-scripts lint","test":"jest","format":"cod-scripts format","compile":"tsc --build .","prepare":"husky install"},"_npmUser":{"name":"john-sterlacci","email":"john@sonar-labs.com"},"repository":{"url":"git+https://github.com/0xmetropolis/metro-sdk.git","type":"git"},"_npmVersion":"8.15.0","description":"## Getting Started","directories":{"test":"test"},"_nodeVersion":"18.7.0","dependencies":{"axios":"^0.25.0","ethers":"^5.5.4","typescript":"^4.6.4","@ensdomains/ensjs":"^2.0.1","@0xsequence/multicall":"^0.40.5","@orcaprotocol/contracts":"^5.11.0","@safe-global/safe-core-sdk":"^3.2.2","@gnosis.pm/safe-deployments":"^1.10.0","@safe-global/safe-ethers-lib":"^1.8.0"},"eslintConfig":{"rules":{"react/react-in-jsx-scope":"off","react/require-default-props":"off"},"extends":["./node_modules/cod-scripts/eslint.js"]},"_hasShrinkwrap":false,"devDependencies":{"jest":"^27.4.7","husky":"^7.0.0","ts-node":"^10.7.0","typedoc":"^0.22.15","babel-jest":"^27.4.6","@babel/core":"^7.16.12","@types/jest":"^27.4.0","cod-scripts":"^10.0.0","@babel/preset-env":"^7.16.11","@babel/preset-typescript":"^7.16.7"},"_npmOperationalInternal":{"tmp":"tmp/metro-sdk_3.8.2_1679506868198_0.040347976923480244","host":"s3://npm-registry-packages"}}},"time":{"created":"2023-03-22T17:41:08.126Z","modified":"2025-05-01T21:04:50.055Z","3.8.2":"2023-03-22T17:41:08.520Z"},"bugs":{"url":"https://github.com/0xmetropolis/metro-sdk/issues"},"license":"ISC","homepage":"https://github.com/0xmetropolis/metro-sdk#readme","repository":{"url":"git+https://github.com/0xmetropolis/metro-sdk.git","type":"git"},"description":"## Getting Started","maintainers":[{"email":"john@sonar-labs.com","name":"john-sterlacci"},{"email":"kevinweaver2@gmail.com","name":"kevinweaver"},{"email":"marco@sonar-labs.com","name":"quizford"},{"email":"tony@metal.build","name":"tony-metal"}],"readme":"# metro-sdk\n\n## Getting Started\n\nInitialize the SDK with the init function on startup:\n\n```js\nimport { init } from '@0xmetropolis/metro-sdk';\n\n// Any ethers provider works.\n// 1 for mainnet, 5 for goerli.\n// Make sure that the provider is instantiated before the SDK\ninit({ provider: ethers.getDefaultProvider(), network: 1 });\n```\n\nOnce you init the SDK, you can call `getPod()`, `getUserPods()`, or `getAdminPods()` anywhere to\nfetch Pod objects.\n\n```js\nimport { getPod, getUserPods, getAdminPods } from '@0xmetropolis/metro-sdk';\n\nconst podFromEnsName = await getPod('mypod.pod.xyz');\n// ENS names also work for the below.\nconst podFromAddress = await getPod('0x123...456');\nconst podFromId = await getPod(1);\n\n// Returns null\nconst notAPod = await getPod('not a pod');\n\n// Fetches all Pods that a user is a member of\nconst userPods = await getUserPods(userAddress);\n\n// Fetches all Pods that a user is an admin of\nconst adminPods = await getAdminPods(adminAddress);\n```\n\n### Types\n\nTypes can be imported as such:\n\n```js\nimport { Pod, Proposal } from '@0xmetropolis/metro-sdk';\n```\n\n### Additional Documentation\n\nAdditional documentation can be found [here](https://0xmetropolis.github.io/metro-sdk/)\n\n## Test Scripts\n\nThere are have some test scripts to test approve/reject proposals and super proposals. They can be\nexecuted by duplicating the `env-examples.json` with private keys in `env.json`, and executing the\ntransactions with `npx ts-node ./scripts/reject-superproposal.ts`.\n","readmeFilename":"README.md"}