Nerdy Programmers Mingling

    iotex-antenna
    TypeScript icon, indicating that this package has built-in type declarations

    0.31.6 • Public • Published

    CircleCI

    iotex-antenna

    iotex-antenna is our SDK allowing you to interact with a local or remote iotex blockchain node, using a gRPC or gRPC-web connection.

    Antenna features

    Features antenna antenna-java antenna-go antenna-swift
    crypto Yes Yes Yes Yes
    rpc-method Yes Yes Yes Yes
    account Yes Yes Yes Yes
    action Yes Yes Yes Yes
    contract Yes Yes Yes Yes
    token support Yes Yes No Yes

    Developing

    nvm use 10.15.1
    npm install
    
    # test
    # prepare flow type definitions
    npm run flow-install
    # run all tests
    npm run test
    # run a single test file
    npm run ava ./path/to/test-file.js

    To run a single test case, follow instructions here.

    Scripts

    • npm run build: build source code from src to dist
    • npm publish: publish code to npm
    • npm run changelog-patch bump version patch (bug fixes)
    • npm run changelog-minor bump version minor (new features)
    • npm run changelog-major bump version major (breaking change)

    Update Proto

    1. Prerequisite
    npm install grpc
    npm install grpc-web
    npm install protoc
    
    npm i grpc-web

    (original link: https://github.com/grpc/grpc-web/tree/master/packages/grpc-web) Download protoc and the protoc-gen-grpc-web protoc plugin. You can download the protoc binary from the official protocolbuffers release page.

    You can download the protoc-gen-grpc-web protoc plugin from our Github release page.

    Make sure they are both executable and are discoverable from your PATH.

    For example, in MacOS, you can do:

    $ sudo mv ~/Downloads/protoc-gen-grpc-web-1.0.3-darwin-x86_64 \
      /usr/local/bin/protoc-gen-grpc-web
    $ chmod +x /usr/local/bin/protoc-gen-grpc-web
    1. copy proto files from iotex-core master branch to /iotex-antenna/proto/

    2. Run

    npm run build-proto

    Keywords

    none

    Install

    npm i iotex-antenna

    DownloadsWeekly Downloads

    157

    Version

    0.31.6

    License

    APACHE

    Unpacked Size

    13.5 MB

    Total Files

    128

    Last publish

    Collaborators

    • qevan1
    • haaai_202108
    • taozhiyuzhuo
    • zongzheng
    • xueping
    • koishi
    • solan
    • maswalker