{"_id":"@doncesarts/tokenbound-contracts","name":"@doncesarts/tokenbound-contracts","dist-tags":{"alpha":"0.3.1-beta.0","latest":"0.3.1-beta.0"},"versions":{"0.3.1-beta.0":{"name":"@doncesarts/tokenbound-contracts","version":"0.3.1-beta.0","description":"Test TokenBound implementation","scripts":{"prepublishOnly":"../script/verify-package-json-in-sync.js"},"peerDependencies":{"@account-abstraction/contracts":"^0.6.0","@openzeppelin/contracts":"^4.9.3","erc6551":"^0.3.1"},"publishConfig":{"access":"public"},"_id":"@doncesarts/tokenbound-contracts@0.3.1-beta.0","gitHead":"479bf7cb1111f5cf9c071c8cf754aad0ffc583bc","_nodeVersion":"20.5.1","_npmVersion":"10.0.0","dist":{"integrity":"sha512-ADQ1LbANRFVeuA9YaYw6gbRRWzu49BQM4rzbMebmdVEy2SdKsZ3TpjL8ObcnX6kCDqRS6lG/IDs8tRoFzLs85A==","shasum":"340234a7e478c850ffc10907a7b6eb9902cbc08c","tarball":"https://registry.npmjs.org/@doncesarts/tokenbound-contracts/-/tokenbound-contracts-0.3.1-beta.0.tgz","fileCount":25,"unpackedSize":46531,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHgdXuvbwfFqULl0TgpJxxJkarkFJyqk/6W4DtJBqKe1AiEAqd3k4JP8Y02G3IUVrjxkNsRD+DaZVYOjEZCzfpj95+I="}]},"_npmUser":{"name":"doncesarts","email":"doncesarts@gmail.com"},"directories":{},"maintainers":[{"name":"doncesarts","email":"doncesarts@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/tokenbound-contracts_0.3.1-beta.0_1700347164787_0.942153669982208"},"_hasShrinkwrap":false}},"time":{"created":"2023-11-18T22:39:24.696Z","0.3.1-beta.0":"2023-11-18T22:39:24.990Z","modified":"2023-11-18T22:39:25.259Z"},"maintainers":[{"name":"doncesarts","email":"doncesarts@gmail.com"}],"description":"Test TokenBound implementation","readme":"# Tokenbound Account Contracts\n\nThis repository contains an opinionated [ERC-6551](https://eips.ethereum.org/EIPS/eip-6551) account implementation. The smart contracts are written in Solidity using the [Foundry](https://book.getfoundry.sh/) development framework.\n\n**This project is under active development and may undergo changes until ERC-6551 is finalized.** For the most recently deployed version of these contracts, see the [v0.3.1](https://github.com/tokenbound/contracts/releases/tag/v0.3.1) release. We recommend this version for any production usage.\n\n## Contracts\n\nThe `src/` directory contains the main contracts for the project:\n\n- `Account.sol`: This contract is the main ERC-6551 account implementation. It includes functionalities for executing a low-level call against an account if the caller is authorized to make calls, setting the implementation address for a given function call, granting a given caller execution permissions, locking the account until a certain timestamp, and more.\n\n- `AccountGuardian.sol`: This contract manages upgrade and cross-chain execution settings for accounts. It includes functionalities for setting trusted implementations and executors.\n\n- `AccountProxy.sol`: This contract is an ERC-1967 proxy which enables account upgradability. It includes functionalities for initializing and getting the implementation of the contract.\n\n## Using as a Dependency\n\n### Foundry\n\nIf you want to use `tokenbound/contracts` as a dependency in another project, you can add it using `forge install`:\n\n```sh\nforge install tokenbound=tokenbound/contracts\n```\n\nThis will add `tokenbound/contracts` as a git submodule in your project. For more information on managing dependencies, refer to the [Foundry dependencies guide](https://github.com/foundry-rs/book/blob/master/src/projects/dependencies.md).\n\n### Hardhat\n\n```sh\nnpm install @tokenbound/contracts\n```\n\nand use, for example, as\n\n```\nimport \"@tokenbound/contracts/AccountV3.sol\";\n```\n\n## Development Setup\n\nYou will need to have Foundry installed on your system. Please refer to the [Foundry installation guide](https://github.com/foundry-rs/book/blob/master/src/getting-started/installation.md) for detailed instructions.\n\nTo use this repository, first clone it:\n\n```sh\ngit clone https://github.com/tokenbound/contracts.git\ncd contracts\n```\n\nThen, install the dependencies:\n\n```sh\nforge install\n```\n\nThis will install the submodule dependencies that are in the project.\n\n## Running Tests\n\nTo run the tests, use the `forge test` command:\n\n```sh\nforge test\n```\n\nFor more information on writing and running tests, refer to the [Foundry testing guide](https://github.com/foundry-rs/book/blob/master/src/forge/writing-tests.md).\n\n## Contributing\n\nContributions are welcome and appreciated! Please make sure to run the tests before submitting a pull request.\n","readmeFilename":"README.md"}