{"id":19269058,"url":"https://github.com/ethereumjs/ultralight","last_synced_at":"2025-04-11T02:11:57.617Z","repository":{"id":37072317,"uuid":"434367716","full_name":"ethereumjs/ultralight","owner":"ethereumjs","description":"Ethereum Portal Network TypeScript implementation","archived":false,"fork":false,"pushed_at":"2025-04-09T18:10:41.000Z","size":33363,"stargazers_count":111,"open_issues_count":17,"forks_count":28,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-04-11T02:11:48.577Z","etag":null,"topics":["ethereum","typescript"],"latest_commit_sha":null,"homepage":"https://github.com/ethereum/portal-network-specs","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ethereumjs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2021-12-02T20:38:14.000Z","updated_at":"2025-04-09T18:10:46.000Z","dependencies_parsed_at":"2024-04-10T15:40:30.634Z","dependency_job_id":"1db41e99-94cb-4d41-a1ef-d9753af1291e","html_url":"https://github.com/ethereumjs/ultralight","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethereumjs%2Fultralight","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethereumjs%2Fultralight/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethereumjs%2Fultralight/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethereumjs%2Fultralight/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ethereumjs","download_url":"https://codeload.github.com/ethereumjs/ultralight/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248328160,"owners_count":21085261,"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":["ethereum","typescript"],"created_at":"2024-11-09T20:18:17.831Z","updated_at":"2025-04-11T02:11:57.579Z","avatar_url":"https://github.com/ethereumjs.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ultralight - A Portal Network implementation in Typescript\n\nThis monorepo comprises an implementation of the [Portal Network spec](https://github.com/ethereum/portal-network-specs) and is **under active development**.  It aspires to allow dapps, wallet providers, and any Javascript based Ethereum application to leverage the Portal Network for access to the Ethereum chain history and state. \n\n## Prerequisites\n\nNode v20+, NPM v10+\n\n## Quick Start\n\nClone this repo and run `npm i` from the root directory.  This project leverages [`npm workspaces`](https://docs.npmjs.com/cli/v7/using-npm/workspaces) so requires NPM v7 or above.\n\n- From the `packages/cli` subfolder, start the Ultralight `nodejs` client - `DEBUG=* npm run dev` and you should see some logs like below indicating the node is starting up:\n```sh\nde2f8:ultralight Started JSON RPC Server address=http://localhost:8545\n```\n\nThis will start a single instance of the Ultralight client running locally.  \n\n### Error related to `node-gyp` or `bcrypto.node`\n\nIf you encounter errors related to `bcrypto.node` or `node-gyp` when running `npm i`, you need to add `npm i -g @mapbox/node-pre-gyp` prior to running building Ultralight.\n\nFor Mac users, you may need to run `sudo xcodebuild -license` and accept it, as `node-gyp` relies on Xcode commands.\n\n\n## Connecting to the devnet (developer testnet)\n\n1. Change active folder: `cd packages/cli`\n2. Run: `npm run devnet`\n3. Client starts with the current list of bootnodes which will attempt to ping all of bootnodes in the provided default bootnode list (specified in `packages/cli/bootnodes.txt`)\n\n### Additional Documentation\n\nSee the [`cli`](./packages/cli/README.md) documentation for more specific usage of the NodeJS Ultralight client.\n\nSee the [interop instructions](./INTEROP.md) for running Ultralight in conjunction with the [Fluffy](https://github.com/status-im/nimbus-eth1/tree/master/fluffy) and [Trin](https://github.com/ethereum/trin) portal clients.\n\n### Development Notes\n\nUse `npm run dev` in the `portalnetwork` library to have Typescript automatically recompile code as changes are made.  \n\n\n## Monorepo Structure\n\n### [`portalnetwork`](./packages/portalnetwork)\n\nThe `portalnetwork` library is the application layer needed to interact with the Portal Network and depends on `discv5` for its networking layer\n\n\n### [`NodeJS Client`](./packages/cli)\n\nThis is a technical demonstration of a NodeJS application that uses the `portalnetwork` module to connect to the Portal Network\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fethereumjs%2Fultralight","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fethereumjs%2Fultralight","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fethereumjs%2Fultralight/lists"}