lukechilds
/
SuperNET
mirror of https://github.com/lukechilds/SuperNET.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Merge pull request #1 from flamingice/patch-1 

update README.md
release/v0.1
jl777 9 years ago
parent
163485cfc9 8098b98ed0
commit
e848ff65e7
1 changed files with 50 additions and 39 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 89
      README.md

89
README.md
View File

@ -1,59 +1,70 @@
iguana is easy to build. start by cloning (or downloading) this repo
#SuperNET Client "iguana"
DEPENDENCIES
for native (unix, osx): just make sure you have the dev versions of openssl and curl installed:
sudo apt-get install libcurl4-gnutls-dev libssl-dev
[![Join the chat at https://gitter.im/jl777/SuperNET](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/jl777/SuperNET?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
for native (win32, win64): this still needs to be ported, pthreads is the only non-native windows system functions being used. OS_portable.c and OS_nonportable.c have the few windows functions that are needed to be ported and also a compile/link process needs to be done. I think cygwin or even mingw would work, alternatively compiling the codebase with VS shouldnt be too much work. until this is done the instructions below about m_win32 and m_win64 wont actually work
> #TL;DR#
>
> ```sudo apt-get update; sudo apt-get install libcurl4-gnutls-dev libssl-dev; git clone https://github.com/jl777/SuperNET; cd SuperNET; ./m_onetime m_unix; ./m_unix; agents/iguana```
>
> The above one line gets SuperNET installed, built and launched for unix.
>
> After that ```./m_unix``` updates to latest.
> *Continue below at "Running".*
for chrome app:
you need to make sure the nacl sdk is properly installed and you are able to build the examples
Now you will need to get the external libs, which can be built from scratch using naclports or
there use the reference builds of libssl.a, libcrypto.a, libcurl.a and libz.a in the SuperNET/libs
You can just copy those over into $(NACL_SDK_ROOT)/lib/pnacl
**iguana is easy to build. Start by cloning (or downloading) this repository.**
ONETIME
#DEPENDENCIES#
##for native (unix, osx)##
Just make sure you have the dev versions of openssl and curl installed:
```sudo apt-get install libcurl4-gnutls-dev libssl-dev```
##For native (win32, win64)##
This still needs to be ported, pthreads is the only non-native windows system functions being used. OS_portable.c and OS_nonportable.c have the few windows functions that are needed to be ported and also a compile/link process needs to be done. I think cygwin or even mingw would work, alternatively compiling the codebase with VS shouldnt be too much work. Until this is done the instructions below about m_win32 and m_win64 wont actually work.
##For chrome app##
You need to make sure the nacl sdk is properly installed and you are able to build the examples.
Now you will need to get the external libs, which can be built from scratch using naclports or there use the reference builds of libssl.a, libcrypto.a, libcurl.a and libz.a in the SuperNET/libs. You can just copy those over into $(NACL_SDK_ROOT)/lib/pnacl.
#ONETIME#
Now you are ready to build.
I try to make the build process as simple as possible, so there are no autoconf, autoreconf, configure, cmake, make, to get properly installed and running and run, etc. You do need a C compiler, like gcc
I try to make the build process as simple as possible, so there are no `autoconf`, `autoreconf`, `configure`, `cmake`, `make`, to get properly installed and running and run, etc. You do need a C compiler, like gcc.
The first time you need to build libcrypto777.a and to do that you need to run:
For unix: ./m_onetime m_unix
For osx: ./m_onetime m_osx
For win32: ./m_onetime m_win32
For win64: ./m_onetime m_win64
The **first time** you need to build libcrypto777.a and to do that you need to run:
For unix: ```./m_onetime m_unix```
For osx: ```./m_onetime m_osx```
For win32: ```./m_onetime m_win32```
For win64: ```./m_onetime m_win64```
(RE)BUILD
#(RE)BUILD
Once libcrypto777.a is built, you can build the agents.
For pnacl: ./m_pnacl
For unix: ./m_unix
For osx: ./m_osx
For win32: ./m_win32
For win64: ./m_win64
For pnacl: ```./m_pnacl```
For unix: ```./m_unix```
For osx: ```./m_osx```
For win32: ```./m_win32```
For win64: ```./m_win64```
The m_(OS) is a standard I follow and should be self explanatory. within each is usually just a few lines, ie compile all the .c files and link with the standard libs.
To build just iguana, you can cd into SuperNET/iguana and do ./m_unix (or ./m_osx, ...)
./m_clean will remove the files created from the building
To build just iguana, you can ```cd``` into SuperNET/iguana and do ```./m_unix``` (or ```./m_osx```, ...).
TLDR: sudo apt-get update; sudo apt-get install libcurl4-gnutls-dev libssl-dev; git clone https://github.com/jl777/SuperNET; cd SuperNET; ./m_onetime m_unix; ./m_unix; agents/iguana
The above one line gets SuperNET installed, built and launched for unix.
After that ./m_unix updates to latest
```./m_clean``` will remove the files created from the building
RUNNING
#RUNNING#
The native versions are command line applications: agents/iguana {JSON}
The chrome app pexe requires that the chrome is launched with a command line parameter (tools/chrome.localhost) and then browse to http://127.0.0.1:7777 to see the pexe
The chrome app pexe requires that the chrome is launched with a command line parameter (tools/chrome.localhost) and then browse to *http://127.0.0.1:7777* to see the pexe
SUPERUGLYGUI
Once iguana is running, you can see the superuglyGUI at http://127.0.0.1:7778/?method
by submitting API calls using the forms, you will see it go to some specific URL. You can also do a programmatic GET request to http://127.0.0.1:7778/api/<path to apicall>
#SUPERUGLYGUI#
Once iguana is running, you can see the superuglyGUI at *http://127.0.0.1:7778/?method*
by submitting API calls using the forms, you will see it go to some specific URL. You can also do a programmatic GET request to ```http://127.0.0.1:7778/api/<path to apicall>```
http://127.0.0.1:7778/ramchain/block/height/0 -> full webpage
*http://127.0.0.1:7778/ramchain/block/height/0* -> full webpage
http://127.0.0.1:7778/json/ramchain/block/height/0 -> JSON only
*http://127.0.0.1:7778/json/ramchain/block/height/0* -> JSON only
curl --url "http://127.0.0.1:7778/ramchain/BTCD/block/height/0" --> full webpage returned (probably not what you want)
curl --url "http://127.0.0.1:7778/json/ramchain/BTCD/block/height/0" --> returns just the json object from the api call
```curl --url "http://127.0.0.1:7778/ramchain/BTCD/block/height/0"``` --> full webpage returned (probably not what you want)
```curl --url "http://127.0.0.1:7778/json/ramchain/BTCD/block/height/0"``` --> returns just the json object from the api call
Internall, all paths convert the request into a standard SuperNET JSON request. you can use a POST command to directly submit such JSON requests:
curl --url "http://127.0.0.1:7778/?" --data "{\"agent\":\"ramchain\",\"method\":\"block\",\"coin\":\"BTCD\",\"height\":0}"
```curl --url "http://127.0.0.1:7778/?" --data "{\"agent\":\"ramchain\",\"method\":\"block\",\"coin\":\"BTCD\",\"height\":0}"```

Write Preview
Loading…
Cancel
Save