{"id":18966871,"url":"https://github.com/tronprotocol/tronbox","last_synced_at":"2025-04-15T02:15:33.672Z","repository":{"id":38417594,"uuid":"185483754","full_name":"tronprotocol/tronbox","owner":"tronprotocol","description":"TronBox - Simple development framework for tronweb","archived":false,"fork":false,"pushed_at":"2025-03-13T09:45:47.000Z","size":44473,"stargazers_count":176,"open_issues_count":11,"forks_count":98,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-04-15T02:15:23.751Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tronprotocol.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-05-07T21:58:55.000Z","updated_at":"2025-04-08T09:09:41.000Z","dependencies_parsed_at":"2024-06-18T16:42:19.629Z","dependency_job_id":"42c91aae-2993-439b-95ec-26565989de4f","html_url":"https://github.com/tronprotocol/tronbox","commit_stats":{"total_commits":487,"total_committers":19,"mean_commits":25.63157894736842,"dds":0.6632443531827515,"last_synced_commit":"cad2b34664ca37a7eeb0d2d500ad6e32f4dff477"},"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tronprotocol%2Ftronbox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tronprotocol%2Ftronbox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tronprotocol%2Ftronbox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tronprotocol%2Ftronbox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tronprotocol","download_url":"https://codeload.github.com/tronprotocol/tronbox/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248991559,"owners_count":21194894,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T14:38:50.041Z","updated_at":"2025-04-15T02:15:33.642Z","avatar_url":"https://github.com/tronprotocol.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://tronbox.io/\" title=\"TronBox Website\"\u003e\n    \u003cimg alt=\"TronBox\" src=\"https://raw.githubusercontent.com/tronprotocol/tronbox/master/assets/TronBox-logo.png\" width=\"160\"/\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n# TronBox\n\nTronBox is a tool for developing, testing, and deploying smart contracts. It is designed for blockchains using the TRON Virtual Machine (TVM).\n\n- Built-in smart contract compilation, linking, deployment, and binary management.\n- External script runner that executes scripts within a TronBox environment.\n- Interactive console for direct contract communication.\n- Automated contract testing for rapid development.\n- Scriptable, extensible deployment \u0026 migrations framework.\n- Network management for deploying to any number of public \u0026 private networks.\n\nTronBox is a fork of [Truffle](https://www.trufflesuite.com/truffle).\n\n## Quick Start\n\n### Install\n\nBefore you can use TronBox, install it using the npm command. For details, see [Install TronBox](https://developers.tron.network/reference/install).\n\n```\n$ npm install -g tronbox\n```\n\n_Note: To verify the PGP signature, see [here](https://github.com/tronprotocol/tronbox/blob/master/FURTHER_INFO.md#verifying-the-pgp-signature)._\n\n### Create a default Tron-Box Project\n\nYou can create a bare project without smart contracts, run:\n\n```\n$ tronbox init\n```\n\nOnce this operation is completed, you'll now have a project structure with the following items:\n\n`contracts/`: Directory for Solidity contracts\n\n`migrations/`: Directory for scriptable deployment files\n\n`test/`: Directory for test files for testing your application and contracts\n\n`tronbox.js`: TronBox configuration file\n\nFor those getting started, you can use TronBox Boxes, which offers example applications and project templates. For details, see [Create a TronBox Project](https://developers.tron.network/reference/create-a-tronbox-project).\n\n### Compile\n\nIf you want to only compile, run:\n\n```\n$ tronbox compile\n```\n\nTo compile all contracts, use the `--compile-all` option.\n\nSpecify a network using the `--network` option. Network name must exist in the configuration. For details, see [Compile a Project](https://developers.tron.network/reference/compile-a-contract).\n\n### Migrate\n\nTo deploy our smart contracts, you need to connect to a blockchain. Use the **TronBox Runtime Environment** to create and interact with the blockchain. For details, see [Contract Deployment (Migrations)](https://developers.tron.network/reference/contract-deploymentmigrations).\n\nTo run your migrations, run the following:\n\n```\n$ tronbox migrate\n```\n\n### Test\n\nTo run all tests, run:\n\n```\n$ tronbox test\n```\n\nAlternatively, you can specify a path to a specific file you want to run: `tronbox test ./path/to/test/file.js`. For details, see [Test Your Contracts](https://developers.tron.network/reference/test-your-contracts).\n\n### Interact with the contract\n\nTo interact with the contract, run:\n\n```\n$ tronbox console\n```\n\nYou will see the following prompt:\n\n```\n$ tronbox(development)\u003e\n```\n\nThe name in the parentheses of the prompt `tronbox(development)\u003e` is the network that is currently connected to. For details, see [Interact with a Contract](https://developers.tron.network/reference/interact-with-a-contract).\n\n# Integrity Check\n\n- The package files will be signed using a GPG key pair, and the correctness of the signature will be verified using the following public key:\n\n```\npub: 82C1 BB84 1BFA FD01 9CA6  1ACB E98F C329 87F3 BF76\nuid: dev@tronbox.io\n```\n\n## Development\n\nTo dive deeper into advanced topics of the TronBox project lifecycle, please see the [Official TronBox Documentation](https://developers.tron.network/reference/what-is-tronbox) for guides, tips, and examples.\n\nTo contribute, see [CONTRIUTING.MD](https://github.com/tronprotocol/tronbox/blob/master/CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftronprotocol%2Ftronbox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftronprotocol%2Ftronbox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftronprotocol%2Ftronbox/lists"}