{"_id":"@0xsambtc/protocol-kit","name":"@0xsambtc/protocol-kit","dist-tags":{"latest":"4.0.3"},"versions":{"4.0.3":{"name":"@0xsambtc/protocol-kit","version":"4.0.3","description":"SDK that facilitates the interaction with Safe Smart Accounts","main":"dist/src/index.js","types":"dist/src/index.d.ts","keywords":["Ethereum","Wallet","Safe","Smart Account","SDK"],"scripts":{"safe-deployments":"ts-node scripts/checkSafeDeployments.ts","test":"mocha -r ts-node/register -r tsconfig-paths/register tests/unit/**/*.ts","test:hardhat:web3:v1.0.0":"export TEST_NETWORK=hardhat && export ETH_LIB=web3 && export SAFE_VERSION=1.0.0 && hardhat deploy && nyc hardhat test","test:hardhat:web3:v1.1.1":"export TEST_NETWORK=hardhat && export ETH_LIB=web3 && export SAFE_VERSION=1.1.1 && hardhat deploy && nyc hardhat test","test:hardhat:web3:v1.2.0":"export TEST_NETWORK=hardhat && export ETH_LIB=web3 && export SAFE_VERSION=1.2.0 && hardhat deploy && nyc hardhat test","test:hardhat:web3:v1.3.0":"export TEST_NETWORK=hardhat && export ETH_LIB=web3 && export SAFE_VERSION=1.3.0 && hardhat deploy && nyc hardhat test","test:hardhat:web3:v1.4.1":"export TEST_NETWORK=hardhat && export ETH_LIB=web3 && export SAFE_VERSION=1.4.1 && hardhat deploy && nyc hardhat test","test:hardhat:ethers:v1.0.0":"export TEST_NETWORK=hardhat && export ETH_LIB=ethers && export SAFE_VERSION=1.0.0 && hardhat deploy && nyc hardhat test","test:hardhat:ethers:v1.1.1":"export TEST_NETWORK=hardhat && export ETH_LIB=ethers && export SAFE_VERSION=1.1.1 && hardhat deploy && nyc hardhat test","test:hardhat:ethers:v1.2.0":"export TEST_NETWORK=hardhat && export ETH_LIB=ethers && export SAFE_VERSION=1.2.0 && hardhat deploy && nyc hardhat test","test:hardhat:ethers:v1.3.0":"export TEST_NETWORK=hardhat && export ETH_LIB=ethers && export SAFE_VERSION=1.3.0 && hardhat deploy && nyc hardhat test","test:hardhat:ethers:v1.4.1":"export TEST_NETWORK=hardhat && export ETH_LIB=ethers && export SAFE_VERSION=1.4.1 && hardhat deploy && nyc hardhat test","test:hardhat:viem:v1.0.0":"export TEST_NETWORK=hardhat && export ETH_LIB=viem && export SAFE_VERSION=1.0.0 && hardhat deploy && nyc hardhat test","test:hardhat:viem:v1.1.1":"export TEST_NETWORK=hardhat && export ETH_LIB=viem && export SAFE_VERSION=1.1.1 && hardhat deploy && nyc hardhat test","test:hardhat:viem:v1.2.0":"export TEST_NETWORK=hardhat && export ETH_LIB=viem && export SAFE_VERSION=1.2.0 && hardhat deploy && nyc hardhat test","test:hardhat:viem:v1.3.0":"export TEST_NETWORK=hardhat && export ETH_LIB=viem && export SAFE_VERSION=1.3.0 && hardhat deploy && nyc hardhat test","test:hardhat:viem:v1.4.1":"export TEST_NETWORK=hardhat && export ETH_LIB=viem && export SAFE_VERSION=1.4.1 && hardhat deploy && nyc hardhat test","coverage":"nyc report --reporter=lcov","format:check":"prettier --check \"*/**/*.{js,json,md,ts}\"","format":"prettier --write \"*/**/*.{js,json,md,ts}\"","unbuild":"rimraf dist artifacts deployments cache .nyc_output *.tsbuildinfo","build":"yarn unbuild && hardhat compile && yarn safe-deployments && tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json"},"repository":{"type":"git","url":"git+https://github.com/0xsambtc/safe-core-sdk.git"},"author":{"name":"Safe","url":"https://safe.global"},"license":"MIT","bugs":{"url":"https://github.com/0xsambtc/safe-core-sdk/issues"},"homepage":"https://github.com/0xsambtc/safe-core-sdk#readme","devDependencies":{"@gnosis.pm/safe-contracts-v1.3.0":"npm:@gnosis.pm/safe-contracts@1.3.0","@nomicfoundation/hardhat-ethers":"^3.0.6","@openzeppelin/contracts":"^2.5.1","@safe-global/safe-contracts-v1.4.1":"npm:@safe-global/safe-contracts@1.4.1","@types/chai":"^4.3.16","@types/chai-as-promised":"^7.1.8","@types/mocha":"^10.0.6","@types/semver":"^7.5.8","@types/yargs":"^17.0.32","chai":"^4.3.10","chai-as-promised":"^7.1.1","dotenv":"^16.4.5","hardhat":"^2.19.3","hardhat-deploy":"^0.11.45","hardhat-deploy-ethers":"^0.4.2","mocha":"^10.2.0","nyc":"^15.1.0","tsconfig-paths":"^4.2.0","viem":"^2.15.1","web3":"^4.7.0","yargs":"^17.7.2"},"dependencies":{"@noble/hashes":"^1.3.3","@safe-global/safe-core-sdk-types":"^5.0.3","@safe-global/safe-deployments":"^1.37.1","abitype":"^1.0.2","ethereumjs-util":"^7.1.5","ethers":"^6.13.1","semver":"^7.6.2"},"_id":"@0xsambtc/protocol-kit@4.0.3","gitHead":"3d46beb20ae8eaffd167e8b7f3dc70da668673b3","_nodeVersion":"18.18.2","_npmVersion":"9.8.1","dist":{"integrity":"sha512-fJyvtmlb/qseuzDopE4/y0eZP6BqxcOe0P9KleqRd1XZZsxxmdZOJgNgj9MlwndGomovY7HMfwey3qBoE5biPA==","shasum":"eb286d4718485c962e3272e2276fac6ebfe59b8d","tarball":"https://registry.npmjs.org/@0xsambtc/protocol-kit/-/protocol-kit-4.0.3.tgz","fileCount":220,"unpackedSize":794998,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHiOJPuX0yxjCWkZIVP4sI5c7a/REymnjh8akGA08LDYAiEAmma+MlETgPOyLWKAII1yQtLzRcUJdwG5R5S6I3auMTA="}]},"_npmUser":{"name":"0xsambtc","email":"0xsambtc@gmail.com"},"directories":{},"maintainers":[{"name":"0xsambtc","email":"0xsambtc@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/protocol-kit_4.0.3_1721360814645_0.7647403013810443"},"_hasShrinkwrap":false}},"time":{"created":"2024-07-19T03:46:54.548Z","4.0.3":"2024-07-19T03:46:54.852Z","modified":"2024-07-19T03:46:55.099Z"},"maintainers":[{"name":"0xsambtc","email":"0xsambtc@gmail.com"}],"description":"SDK that facilitates the interaction with Safe Smart Accounts","homepage":"https://github.com/0xsambtc/safe-core-sdk#readme","keywords":["Ethereum","Wallet","Safe","Smart Account","SDK"],"repository":{"type":"git","url":"git+https://github.com/0xsambtc/safe-core-sdk.git"},"author":{"name":"Safe","url":"https://safe.global"},"bugs":{"url":"https://github.com/0xsambtc/safe-core-sdk/issues"},"license":"MIT","readme":"# Protocol Kit\n\n[![npm Version](https://badge.fury.io/js/%40safe-global%2Fprotocol-kit.svg)](https://badge.fury.io/js/%40safe-global%2Fprotocol-kit)\n[![GitHub Release](https://img.shields.io/github/release/safe-global/safe-core-sdk.svg?style=flat)](https://github.com/safe-global/safe-core-sdk/releases)\n[![GitHub](https://img.shields.io/github/license/safe-global/safe-core-sdk)](https://github.com/safe-global/safe-core-sdk/blob/main/LICENSE.md)\n\nSoftware development kit that facilitates the interaction with [Safe Smart Accounts](https://github.com/safe-global/safe-smart-account) using a TypeScript interface. This Kit can be used to create new Safe accounts, update the configuration of existing Safes, create and execute transactions, among other features.\n\n## Table of contents\n\n- [Documentation](#documentation)\n- [Installation](#installation)\n- [Quick Start](#quick-start)\n- [Need Help or Have Questions?](#need-help-or-have-questions)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Documentation\n\nHead to the [Protocol Kit docs](https://docs.safe.global/sdk/protocol-kit) to learn more about how to use this SDK.\n\n## Installation\n\nInstall the package with yarn or npm:\n\n```bash\nyarn add @safe-global/protocol-kit\nnpm install @safe-global/protocol-kit\n```\n\n## Quick Start\n\n- `provider`: You can set an EIP-1193 compatible provider or an HTTP/WebSocket RPC URL.\n- `signer`: This is an optional parameter. It should be the provider's address you want to use or a private key. If not set, it will try to fetch a connected account from the provider.\n\nLoading an already deployed Safe, using the `safeAddress` property:\n\n```js\nimport Safe from '@safe-global/protocol-kit'\n\nconst protocolKit = await Safe.init({\n  provider,\n  signer,\n  safeAddress\n})\n```\n\nInitialization of an undeployed Safe using the `predictedSafe` property. Because Safes are deployed in a deterministic way, passing a `predictedSafe` will allow to initialize the SDK with the Safe configuration and use it to some extent before it's deployed:\n\n```js\nimport Safe, { PredictedSafeProps } from '@safe-global/protocol-kit'\n\nconst predictedSafe: PredictedSafeProps = {\n  safeAccountConfig,\n  safeDeploymentConfig\n}\n\nconst protocolKit = await Safe.init({\n  provider,\n  signer,\n  predictedSafe\n})\n```\n\n## Need Help or Have Questions?\n\nIf you have any doubts, questions, or need assistance, feel free to reach out! [Here you will find how to get support.](https://github.com/safe-global/safe-core-sdk/tree/main/SUPPORT.md)\n\n## Contributing\n\nPlease read our [contribution guidelines](https://github.com/safe-global/safe-core-sdk/tree/main/CONTRIBUTING.md) before submitting any changes. We appreciate your help! 🙌\n\n## License\n\nThis library is [released under MIT](https://github.com/safe-global/safe-core-sdk/blob/main/LICENSE.md).\n","readmeFilename":"README.md"}