{"id":20841170,"url":"https://github.com/iotexproject/iotex-antenna","last_synced_at":"2025-02-26T23:12:12.411Z","repository":{"id":45153871,"uuid":"170791382","full_name":"iotexproject/iotex-antenna","owner":"iotexproject","description":"IoTeX Javascript SDK","archived":false,"fork":false,"pushed_at":"2024-08-28T07:50:37.000Z","size":2020,"stargazers_count":32,"open_issues_count":55,"forks_count":21,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-02-12T21:12:00.381Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/iotexproject.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG","contributing":null,"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-02-15T02:44:28.000Z","updated_at":"2024-11-14T07:49:25.000Z","dependencies_parsed_at":"2022-07-13T18:19:46.672Z","dependency_job_id":"d2ba8927-3008-45f7-a2a1-0545be13e05c","html_url":"https://github.com/iotexproject/iotex-antenna","commit_stats":{"total_commits":395,"total_committers":17,"mean_commits":"23.235294117647058","dds":0.6936708860759493,"last_synced_commit":"8ad6e9b7e9d5ee16a6201e2f1908330a7114ad71"},"previous_names":[],"tags_count":52,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iotexproject%2Fiotex-antenna","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iotexproject%2Fiotex-antenna/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iotexproject%2Fiotex-antenna/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iotexproject%2Fiotex-antenna/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iotexproject","download_url":"https://codeload.github.com/iotexproject/iotex-antenna/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239742408,"owners_count":19689309,"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-18T01:19:05.677Z","updated_at":"2025-02-19T22:09:26.754Z","avatar_url":"https://github.com/iotexproject.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# iotex-antenna\n\niotex-antenna is iotex native SDK allowing you to interact with a local or remote iotex blockchain node, using a gRPC or gRPC-web connection.\n\n- [Documentation](https://docs.iotex.io/native-development/antenna-overview)\n- [Reference](https://iotexproject.github.io/iotex-antenna/)\n\n## Antenna features\n\n| Features | antenna | [antenna-java](https://github.com/iotexproject/iotex-antenna-java) | [antenna-go](https://github.com/iotexproject/iotex-antenna-go) | [antenna-swift](https://github.com/iotexproject/iotex-antenna-swift) |\n| ------------- | ------- | ------------------------------------------------------------------ | -------------------------------------------------------------- | -------------------------------------------------------------------- |\n| crypto | Yes | Yes | Yes | Yes |\n| rpc-method | Yes | Yes | Yes | Yes |\n| account | Yes | Yes | Yes | Yes |\n| action | Yes | Yes | Yes | Yes |\n| contract | Yes | Yes | Yes | Yes |\n| token support | Yes | Yes | No | Yes |\n\n## Developing\n\n```bash\nnvm use 10.15.1\nnpm install\n\n# test\n# prepare flow type definitions\nnpm run flow-install\n# run all tests\nnpm run test\n# run a single test file\nnpm run ava ./path/to/test-file.js\n```\n\nTo run a single test case, follow instructions [here](https://github.com/avajs/ava/blob/master/docs/01-writing-tests.md#running-specific-tests).\n\n## Scripts\n\n- `npm run build`: build source code from `src` to `dist`\n- `npm publish`: publish code to npm\n- `npm run changelog-patch` bump version patch (bug fixes)\n- `npm run changelog-minor` bump version minor (new features)\n- `npm run changelog-major` bump version major (breaking change)\n\n## Update Proto\n\n1. Prerequisite\n\n```bash\nnpm install grpc\nnpm install grpc-web\nnpm install protoc\n\nnpm i grpc-web\n```\n\n(original link: https://github.com/grpc/grpc-web/tree/master/packages/grpc-web)\nDownload protoc and the protoc-gen-grpc-web protoc plugin.\nYou can download the protoc binary from the official protocolbuffers release page.\n\nYou can download the protoc-gen-grpc-web protoc plugin from our Github release page.\n\nMake sure they are both executable and are discoverable from your PATH.\n\nFor example, in MacOS, you can do:\n\n```bash\n$ sudo mv ~/Downloads/protoc-gen-grpc-web-1.0.3-darwin-x86_64 \\\n /usr/local/bin/protoc-gen-grpc-web\n$ chmod +x /usr/local/bin/protoc-gen-grpc-web\n```\n\n2. copy proto files from iotex-core master branch to /iotex-antenna/proto/\n\n3. Run\n\n```bash\nnpm run build-proto\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiotexproject%2Fiotex-antenna","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiotexproject%2Fiotex-antenna","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiotexproject%2Fiotex-antenna/lists"}