github.com/intfoundation/intchain@v0.0.0-20220727031208-4316ad31ca73/README.md (about)

     1  # INT Chain
     2  
     3  [![Go Report Card](https://goreportcard.com/badge/github.com/intfoundation/intchain)](https://goreportcard.com/report/github.com/intfoundation/intchain)
     4  ![INTChain License](https://img.shields.io/github/license/intfoundation/intchain)
     5  ![Go](https://github.com/intfoundation/intchain/workflows/Go/badge.svg)
     6  ![Top Languages](https://img.shields.io/github/languages/top/intfoundation/intchain?color=blueviolet)
     7  ![Languages Count](https://img.shields.io/github/languages/count/intfoundation/intchain?color=green)
     8  ![INTChain Counter](https://img.shields.io/github/search/intfoundation/intchain/intchain)
     9  ![INTChain Size](https://img.shields.io/github/repo-size/intfoundation/intchain?color=ff69b4)
    10  ![Go Version](https://img.shields.io/github/go-mod/go-version/intfoundation/intchain?color=yellow)
    11  ![Last Commit](https://img.shields.io/github/last-commit/intfoundation/intchain)
    12  
    13  ![intchain](https://raw.githubusercontent.com/intfoundation/intchain/master/docs/intchain.jpg)
    14  
    15  INT Chain is the world's first bottom up new-generation blockchain of things (BoT) communication standard and base application platform. The ecosystem is specifically designed for easy integration with any IoT protocol.
    16  
    17  To both improve and encourage device interconnectivity, we have built an economy driven ecosystem by providing token-incentives through a decentralized TCP/IP based architecture of IoT. This new business model, molded by IoT devices, will support an entirely new ecosystem of the Internet of Things.
    18  
    19  
    20  ## Install
    21  
    22  ### Latest Version
    23  
    24  The latest INT Chain version is v4.2.0
    25  
    26  ### Install `Go`
    27  
    28  
    29  **Go 1.14+** is required for building and installing the INT Chain software.
    30  
    31  
    32  Install `Go` by following the [official docs](https://golang.org/doc/install).
    33  
    34  Remember to set your `$GOPATH`, `$GOBIN`, and `$PATH` environment variables, for example:
    35  
    36  ```bash
    37  mkdir -p $HOME/go/bin
    38  echo "export GOPATH=$HOME/go" >> ~/.bashrc
    39  echo "export GOBIN=$GOPATH/bin" >> ~/.bashrc
    40  echo "export PATH=$PATH:$GOBIN" >> ~/.bashrc
    41  source ~/.bashrc
    42  ```
    43  
    44  Verify that `Go` has been installed successfully
    45  
    46  ```bash
    47  go version
    48  ```
    49  
    50  ### Install `C compiler`
    51  
    52  You can install C compiler by your favourite package manager.
    53  
    54  
    55  ### Install `intchain`
    56  
    57  After setting up `Go` and `C compiler` correctly, you should be able to compile and run `intchain`.
    58  
    59  Make sure that your server can access to google.com because our project depends on some libraries provided by google. (If you are not able to access google.com, you can also try to add a proxy: `export GOPROXY=https://goproxy.io`)
    60  
    61  ```bash
    62  git clone https://github.com/intfoundation/intchain
    63  cd intchain
    64  make intchain
    65  ```
    66  
    67  If your environment variables have set up correctly, you should not get any errors by running the above commands.
    68  Now check your `intchain` version.
    69  
    70  ```bash
    71  intchain version
    72  ```
    73  
    74  ## Running `intchain`
    75  
    76  `intchain` is the entry point into the INT Chain network(main, test or private network). It can be used by other processes as a gateway into the INT Chain network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports.
    77  
    78  We've enumerated a few common command to let you run your own `intchain` instance quickly. If you want to look over all command line options, please use `intchain --help`
    79  
    80  
    81  ### Main network
    82  
    83  The most common condition is that users want to simply interact with the INT Chain network: create accounts; transfer funds; deploy and interact with contracts.
    84  
    85  ```bash
    86  intchain 
    87  ```
    88  
    89  Then you can attach to an already running `intchain` instance with `intchain attach`, and you can invoke all official methods.
    90  
    91  ```bash
    92  intchain attach <datadir>/intchain/intchain.ipc
    93  ```
    94  
    95  
    96  ### Test network
    97  
    98  For developers, you would like to deploy contracts for testing, but you do not want to do that with real money spending.
    99  In other words, instead of attaching to the main network, you want to join the test network with your node, which is fully equivalent to the main network.
   100  
   101  ```bash
   102  git checkout -b testnet origin/testnet
   103  make intchain
   104  ```
   105  
   106  
   107  ```bash
   108  intchain --testnet
   109  ```
   110  
   111  Specifying the `--testnet` flag, will reconfigure `intchain` instance a bit:
   112     
   113     * Instead of using the default data directory(`~/.intchain/intchain` on Linux for example), `intchain` will use `testnet` (`~/.intchain/testnet` on Linux). This means that attaching to a running testnet node requires the use of a custom endpoint(`intchain attach <datadir>/testnet/intchain.ipc`).
   114     * The client will connect to the test network, which uses different bootnodes, different network IDs and genesis file.
   115  
   116  ## Resources
   117      
   118     * Explorer: <http://titansexplorer.intchain.io/#/>
   119     * Wallet: <http://titanswallet.intchain.io/#/>
   120     * Document: <https://titansdocs.intchain.io/>
   121     * SDK: <https://github.com/intfoundation/int4.js>
   122  
   123  
   124  ## Contribution
   125  
   126   See the [contribution](./CONTRIBUTING.md)
   127  
   128  
   129  ## License
   130  
   131  [License](./COPYING)
   132  
   133  
   134  
   135  
   136  
   137  
   138  
   139  
   140  
   141  
   142  
   143  
   144  
   145  
   146  
   147  
   148  
   149  
   150