{"_id":"@buildwithsygma/sygma-x-solidity","name":"@buildwithsygma/sygma-x-solidity","dist-tags":{"latest":"2.4.2"},"versions":{"2.4.2":{"name":"@buildwithsygma/sygma-x-solidity","version":"2.4.2","main":"index.js","author":{"name":"Sygma"},"license":"BUSL-1.1","scripts":{"compile":"npx hardhat compile","coverage":"npx hardhat coverage","deploy":"npx hardhat deploy --network","lint:typescript":"eslint 'test/**/*.ts' 'scripts/**/*.ts'","lint:typescript:fix":"prettier --config .prettierrc.json --write 'scripts/**/*.ts' 'test/**/*.ts' 'hardhat.config.ts'","lint:solidity":"npx solhint 'src/contracts/**/*.sol'","lint:solidity:fix":"prettier --write --plugin=prettier-plugin-solidity 'src/contracts/**/*.sol'","lint:all":"yarn run lint:typescript && yarn run lint:solidity","lint:all:fix":"yarn run lint:typescript:fix && yarn run lint:solidity:fix","test":"REPORT_GAS=true npx hardhat test"},"devDependencies":{"@chainsafe/eslint-config":"^2.1.1","@metamask/eth-sig-util":"^7.0.0","@nomicfoundation/hardhat-chai-matchers":"^2.0.2","@nomicfoundation/hardhat-ethers":"^3.0.4","@nomicfoundation/hardhat-network-helpers":"^1.0.9","@nomicfoundation/hardhat-toolbox":"^3.0.0","@nomicfoundation/hardhat-verify":"^1.0.0","@openzeppelin/contracts":"4.9.3","@rushstack/eslint-patch":"^1.5.1","@typechain/ethers-v6":"^0.5.0","@typechain/hardhat":"^8.0.0","@types/chai":"^4.2.0","@types/mocha":">=9.1.0","@types/node":">=16.0.0","@typescript-eslint/eslint-plugin":"^7.3.1","@typescript-eslint/parser":"^7.3.1","chai":"^4.2.0","chain":"^0.4.0","eslint":"^8.57.0","eslint-config-prettier":"^9.0.0","eslint-plugin-prettier":"^5.0.1","ethers":"^6.7.1","hardhat-deploy":"^0.11.45","hardhat-gas-reporter":"^1.0.8","hardhat-preprocessor":"^0.1.5","prettier":"^3.0.3","prettier-plugin-solidity":"^1.1.3","sinon":"^16.0.0","solhint":"^3.6.2","solidity-coverage":"^0.8.0","ts-node":">=8.0.0","tslint-config-prettier":"^1.18.0","typescript":"5.3.3","dotenv":"^16.4.1"},"dependencies":{"hardhat":"^2.17.4","typechain":"^8.1.0"},"_id":"@buildwithsygma/sygma-x-solidity@2.4.2","gitHead":"5e3de66026e8efdcf7ed9c6226bec23aa0cb1992","description":"<p align=\"center\"><a href=\"https://buildwithsygma.com\"><img width=\"250\" title=\"Sygma solidity\" src='assets/full-logo.png'/></a></p>","_nodeVersion":"20.11.1","_npmVersion":"10.2.4","dist":{"integrity":"sha512-noPuOIYAwSPNfjrh45rFfaiw58r4Ze7r4HDgKXmVcx9qSs2N3wDRlRhMngCKP9f2rEEZrryPYH6cjeDsxW0iXg==","shasum":"5ab35805de68d4ff61ef65254b2320df2c5bf7ce","tarball":"https://registry.npmjs.org/@buildwithsygma/sygma-x-solidity/-/sygma-x-solidity-2.4.2.tgz","fileCount":287,"unpackedSize":10709761,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCppw5Z5RxWiE490H3v1d54/AMPNw3WqOPxFCITWcP25AIhAMNZAdfHk1e7kLiw2ap22NFHvZguKHdC6RFkYRIunqeK"}]},"_npmUser":{"name":"buildwithsygma","email":"dev@buildwithsygma.com"},"directories":{},"maintainers":[{"name":"buildwithsygma","email":"dev@buildwithsygma.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/sygma-x-solidity_2.4.2_1711385340073_0.7318937272997885"},"_hasShrinkwrap":false}},"time":{"created":"2024-03-25T16:48:59.948Z","2.4.2":"2024-03-25T16:49:00.332Z","modified":"2024-03-25T16:49:00.609Z"},"maintainers":[{"name":"buildwithsygma","email":"dev@buildwithsygma.com"}],"description":"<p align=\"center\"><a href=\"https://buildwithsygma.com\"><img width=\"250\" title=\"Sygma solidity\" src='assets/full-logo.png'/></a></p>","author":{"name":"Sygma"},"license":"BUSL-1.1","readme":"<p align=\"center\"><a href=\"https://buildwithsygma.com\"><img width=\"250\" title=\"Sygma solidity\" src='assets/full-logo.png'/></a></p>\n\n# sygma-x-solidity\n\nSygma uses Solidity smart contracts to enable transfers to and from EVM compatible chains. These contracts consist of a core bridge contract (Bridge.sol) and a set of handler contracts (ERC20Handler.sol, PermissionlessGenericHandler.sol). The bridge contract is responsible for initiating and executing proposed transfers. The handlers are used by the bridge contract to interact with other existing contracts.\n\n## Deployments\n\nTo deploy contracts run `npx hardhat run --network NETWORK_NAME scripts/deploy.ts`.\n\nFor more details check out the [official hardhat documentation](https://hardhat.org/hardhat-runner/docs/guides/deploying).\n\nTo add another network do the following:\n * update `hardhat.config.ts` with the desired configuration\n\n## Dependencies\n\nRequires `yarn` and `@nomicfoundation/hardhat`.\n\n## Commands\n  * hardhat commands: <br>\n    `check` - Check whatever you need <br>\n    `clean` - Clears the cache and deletes all artifacts <br>\n    `compile` - Compiles the entire project, building all artifacts <br>\n    `console` - Opens a hardhat console <br>\n    `coverage` - Generates a code coverage report for tests <br>\n    `flatten` - Flattens and prints contracts and their dependencies <br>\n    `help` - Prints this message <br>\n    `node` - Starts a JSON-RPC server on top of Hardhat Network <br>\n    `run` - Runs a user-defined script after compiling the project <br>\n    `test` - Runs mocha tests <br>\n    `typechain` - Generate Typechain typings for compiled contracts <br>\n    `verify` - Verifies contract on Etherscan <br>\n  * custom commands: <br>\n    `yarn run test`: Runs tests.\n\n# Sygma Security Policy\n\n## Reporting a Security Bug\n\nWe take all security issues seriously, if you believe you have found a security issue within a Sygma\nproject please notify us immediately. If an issue is confirmed, we will take all necessary precautions\nto ensure a statement and patch release is made in a timely manner.\n\nPlease email us a description of the flaw and any related information (e.g. reproduction steps, version) to\n[dev@buildwithsygma.com](mailto:dev@buildwithsygma.com).\n","readmeFilename":"README.md"}