{"_id":"@blockdag/blockdagd","_rev":"1-ccf828ad5a8b1b47bb7b9dbeb78b4d9a","name":"@blockdag/blockdagd","dist-tags":{"latest":"1.0.1"},"versions":{"0.6.41":{"name":"@blockdag/blockdagd","version":"0.6.41","author":{"name":"Blockdag Team"},"license":"MIT","_id":"@blockdag/blockdagd@0.6.41","maintainers":[{"name":"bdag","email":"app@blockdag.network"}],"bin":{"blockdagd":"src/bin/blockdagd.js"},"dist":{"shasum":"678c8ec4a519c0eb12c7d002c06dc6085631a411","tarball":"https://registry.npmjs.org/@blockdag/blockdagd/-/blockdagd-0.6.41.tgz","fileCount":18,"integrity":"sha512-2r5qpaUCn8RCHbu12gZTk6WwTIFAvAG8FlkyY80G8rRoHck+9/zEadrWOwi+eyBmgUL4Yoj0XECmDiejtLylNg==","signatures":[{"sig":"MEUCIQCzeh/rRCJBjJBlDXhMp85WoUlbbpAhTe3IF9Cd+GSsogIgK+1duVdNWSQ9TxhqX23bt4027HfZV7ZKmlM0VD83DE8=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":68109},"main":"index.js","types":"./index.d.ts","python":{"execPath":"python3","dependencies":{"vyper":">=0.1.0b3"}},"gitHead":"ba6b2b226349d035146bd6deb120fef3d499ed16","scripts":{"blockdagd":"node ./build/bin/blockdagd.js --blockdag-ide http://localhost:8080","blockdagd:dev":"ts-node ./src/bin/blockdagd.ts --blockdag-ide http://localhost:8080 --shared-folder /data","blockdagd:run":"tsc && node ./build/bin/blockdagd.js --blockdag-ide http://localhost:8080","blockdagd:build-cli":"tsc","blockdagd:dev-currentPath":"ts-node ./src/bin/blockdagd.ts --blockdag-ide http://localhost:8080"},"typings":"index.d.ts","_npmUser":{"name":"bdag","email":"app@blockdag.network"},"_npmVersion":"10.2.3","description":"blockdagd server: allow accessing file system from blockdag ide and start a dev environment (see help section)","directories":{},"_nodeVersion":"20.10.0","dependencies":{"ws":"^7.3.0","semver":"^6.3.0","chokidar":"^2.1.8","fs-extra":"^3.0.1","commander":"^9.4.1","isbinaryfile":"^3.0.2","latest-version":"^5.1.0","@remixproject/plugin":"0.3.33","@remixproject/plugin-ws":"0.3.33","@remixproject/plugin-api":"0.3.33","@remixproject/plugin-utils":"0.3.33","@remix-project/remix-solidity":"^0.5.36"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"6.8.0","nodemon":"^2.0.4","ts-node":"^8.10.1","@types/ws":"^7.2.4","typescript":"^5.7.2","@types/node":"^18.16.1","@types/fs-extra":"^9.0.1","eslint-plugin-node":"11.1.0","eslint-plugin-import":"2.20.2","eslint-plugin-promise":"4.2.1","eslint-config-standard":"14.1.1","eslint-plugin-standard":"4.0.1","@typescript-eslint/parser":"^3.2.0","@typescript-eslint/eslint-plugin":"^3.2.0"},"_npmOperationalInternal":{"tmp":"tmp/blockdagd_0.6.41_1736422896490_0.29795876740205274","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@blockdag/blockdagd","version":"1.0.1","description":"blockdagd server: allow accessing file system from blockdag ide and start a dev environment (see help section)","main":"build/index.js","types":"build/index.d.ts","bin":{"blockdagd":"build/bin/blockdagd.js"},"publishConfig":{"access":"public"},"scripts":{"build":"tsc","blockdagd":"tsc node ./build/bin/blockdagd.js","prepare":"npm run build","start":"node ./build/bin/blockdagd.js","dev":"ts-node ./src/bin/blockdagd.ts","prepack":"npm run build"},"license":"MIT","author":{"name":"Blockdag Team"},"dependencies":{"@remix-project/remix-solidity":"^0.5.36","@remixproject/plugin":"0.3.33","@remixproject/plugin-api":"0.3.33","@remixproject/plugin-utils":"0.3.33","@remixproject/plugin-ws":"0.3.33","chokidar":"^2.1.8","commander":"^9.4.1","fs-extra":"^3.0.1","isbinaryfile":"^3.0.2","latest-version":"^5.1.0","semver":"^6.3.0","ws":"^7.3.0"},"python":{"execPath":"python3","dependencies":{"vyper":">=0.1.0b3"}},"devDependencies":{"@types/fs-extra":"^9.0.1","@types/node":"^18.16.1","@types/ws":"^7.2.4","@typescript-eslint/eslint-plugin":"^3.2.0","@typescript-eslint/parser":"^3.2.0","eslint":"6.8.0","eslint-config-standard":"14.1.1","eslint-plugin-import":"2.20.2","eslint-plugin-node":"11.1.0","eslint-plugin-promise":"4.2.1","eslint-plugin-standard":"4.0.1","nodemon":"^2.0.4","ts-node":"^8.10.1","typescript":"^5.7.2"},"typings":"index.d.ts","engines":{"node":">=14.0.0"},"_id":"@blockdag/blockdagd@1.0.1","gitHead":"0aa0639ea1a0e9c834df3c41c6f76cf3baf2157a","_nodeVersion":"20.18.1","_npmVersion":"10.8.2","dist":{"integrity":"sha512-2Ryt5FDWfO8rKD9kV8J/1CP7GPL9SrD2BHlW0aDXOyzzRcOltkuIl4ie6onV/Zuv9rsgNeUBTYetiS+ew6ruvw==","shasum":"7a179d0febed8ebdf3f74dcb906d834ad8663194","tarball":"https://registry.npmjs.org/@blockdag/blockdagd/-/blockdagd-1.0.1.tgz","fileCount":54,"unpackedSize":216048,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDTDMOa/otaR/1xdFI3JNTgfkdiu0H6klJcI5gCeCRMwAiEA62bR7nGrJPGnBpChIu1GVtP3tnz2UNGIMEpDSuFYIh8="}]},"_npmUser":{"name":"bdag","email":"app@blockdag.network"},"directories":{},"maintainers":[{"name":"bdag","email":"app@blockdag.network"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/blockdagd_1.0.1_1736768698461_0.9525667354097587"},"_hasShrinkwrap":false}},"time":{"created":"2025-01-09T11:41:36.380Z","modified":"2025-01-13T11:44:58.807Z","0.6.41":"2025-01-09T11:41:36.830Z","1.0.1":"2025-01-13T11:44:58.633Z"},"author":{"name":"Blockdag Team"},"license":"MIT","description":"blockdagd server: allow accessing file system from blockdag ide and start a dev environment (see help section)","maintainers":[{"name":"bdag","email":"app@blockdag.network"}],"readme":"# BlockDAGd: Access Your Local Filesystems with the BlockDAG IDE\n\n\n`@blockdag/blockdagd` is an NPM module that intends to be used with [BlockDAG IDE](https://ide.blockdag.network) web application. It establishes a two-way websocket connection between the local computer and BlockDAG IDE for a particular project directory.\n\n`blockdagd` can be used to set up a development environment with other popular frameworks like Hardhat, Truffle, Slither etc.\n\nMore details are explained further\n\n## Installation\n\n`npm install -g @blockdag/blockdagd`\n\nNOTE: When the blockdagd NPM module is installed, it also installs [Slither](https://github.com/crytic/slither), [solc-select](https://github.com/crytic/solc-select#quickstart) and sets [solc](https://docs.soliditylang.org/en/latest/installing-solidity.html) to latest version i.e. 0.8.15 currently.\n\nALSO NOTE: Python3.6+ (pip3) needs to already be installed on the System. In case of any discrepancy, Slither can also be installed along with other dependencies using the command:\n```\n> blockdagd -i slither\n``` \n\n### Warning for quite old users\nThere is a new version of blockdagd with a new npm address: https://npmjs.com/package/@blockdag-project/blockdagd\nIf you were using the old one you need to:\n\n  1. uninstall the old one: `npm uninstall -g blockdagd`\n  2. install the new: `npm install -g @blockdag/blockdagd`\n\n## blockdagd command\n\nThe blockdagd command without options shares present working directory and the shared with the BlockDAG IDE.\n\nThe blockdagd command is:\n```\n> blockdagd\n```\n\nIf you are using BlockDAG IDE from localhost or you are not running the command from your working directory, you’ll need to use the command with flags.\n\n```\n> blockdagd -h\nUsage: blockdagd [options]\n\nEstablish a two-way websocket connection between the local computer and BlockDAG IDE for a folder\n\nOptions:\n  -v, --version               output the version number\n  -u, --blockdag-ide  <url>      URL of blockdag instance allowed to connect\n  -s, --shared-folder <path>  Folder to share with BlockDAG IDE (Default: CWD)\n  -i, --install <name>        Module name to install locally (Supported: [\"slither\"])\n  -r, --read-only             Treat shared folder as read-only (experimental)\n  -h, --help                  output usage information\n\nExample:\n\n    blockdagd -s ./shared_project -u http://localhost:8080\n\n```\n\n## Share a project directory\n\n`blockdagd -s ./shared_project -u https://ide.blockdag.network`\n\nThe current user should have `read/write` access to the folder (at least `read` access).\n\nIt is important to notice that changes made to the current file in `BlockDAG IDE` are automatically saved to the local computer every 5000 ms. There is no `Save` action. But the `Ctrl-Z` (undo) can be used.\n\nFurthermore:\n - No copy of the shared folder is kept in the browser storage.\n - Clicking on the new folder or new file icon under localhost will create a new file or folder in the shared folder.\n - If a folder does not contain any file, the folder will not be displayed in the explorer (that might change).\n - Symbolic links are not forwarded to BlockDAG IDE.\n\n## Ports Usage\nblockdagd creates a websocket connection with BlockDAG IDE on different ports. Ports are defined according to specific purposes. Port usage details are as:\n\n- **65520** : For `blockdagd` websocket listener, to share a project from local device with BlockDAG IDE. Shared folder will be loaded in the BlockDAG IDE File Explorer workspace named localhost\n- **65522** : For `Hardhat` websocket listener, to enable the Hardhat Compilation using BlockDAG IDE Solidity Compiler plugin, if shared folder is a Hardhat project\n- **65523** : For `Slither` websocket listener, to enable the Slither Analysis using BlockDAG IDE Solidity Static Analysis plugin \n- **65524** : For `Truffle` websocket listener, to enable the Truffle Compilation using BlockDAG IDE Solidity Compiler plugin, if shared folder is a Truffle project\n\nNote: Please make sure your system is secured enough and these ports are not opened nor forwarded.\n \n","readmeFilename":"README.md"}