Skip to content

Commit fa2a01e

Browse files
author
Hubert Marteau
committed
3.0 - Complete change - API calls directly RPC Server (compatible for a
few systems), Architecture is complelty changed, test are modified to give examples.
1 parent eec51d1 commit fa2a01e

1 file changed

Lines changed: 25 additions & 17 deletions

File tree

README.md

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,13 @@ https://github.com/SimplyUb/MultiChainJavaAPI
1111

1212
### System requirements
1313

14-
These compilation instructions have been tested on Ubuntu 12.4 x64 only with Java 1.7.0_80
14+
These compilation instructions have been tested on Windows 7.0 and Ubuntu 12.4 x64 only with Java 1.7.0_80
1515

1616

17-
## Linux Build Notes (on Ubuntu 12.4 x64 only with Java 1.7.0_80)
18-
19-
### ClassPath dependencies
17+
## Dependecies
2018

2119
* Java 1.7.0 is needed, upper version should be compatible
22-
* Project uses [Gson API](https://github.com/google/gson)
23-
24-
### Notes
25-
26-
* The classpath file is called "project.classpath" and has to ne rename in ".classpath" for compilation.
20+
* All other depencies are managed by Maven.
2721

2822
## Architecture
2923

@@ -39,20 +33,23 @@ Next versions will decide to integrate (or not) theses commands.
3933

4034
### Project Architecture
4135

42-
#### multichain.command
43-
The package `multichain.command` is the essential of the project.
44-
The package contains Java commands to call.
36+
#### multichain.command and MultiChainCommand
37+
The package multichain.command and the Class `MultiChainCommand` are the essential of the project.
38+
They contain Java commands to call.
4539

4640
Examples of command calls can be found in `multichain.test.command`.
4741

4842
A simple example to get addresses :
4943
```
50-
//BlockChain TestCommand has to be created and started before
51-
ChainCommand.initializeChain("TestCommand");
44+
//BlockChain has to be created and started before
45+
multiChainCommand = new MultiChainCommand("localhost", "6824", "multichainrpc","73oYQWzx45hossFPPWUgicpLvHhsD8PempYxnSF6bnY9");
46+
// localhost is the IP used by Multichain
47+
// 6824 is, here, the port used by the BlockChain, corresponding of the value of default-rpc-port in the file params.dat
48+
// multichainrpc and 73oYQWzx45h... are login and password to access to RPC commands, values can be found in the file multichain.conf
5249
5350
List<String> result = null;
5451
try {
55-
result = AddressCommand.getAddresses();
52+
result = multiChainCommand.getAddressCommand().getAddresses();
5653
} catch (MultichainException e) {
5754
// TODO Auto-generated catch block
5855
e.printStackTrace();
@@ -90,9 +87,20 @@ Integrated functions about :
9087
* Transaction
9188
* Transaction RAW
9289

90+
### 2.0
91+
Based on functions contained in MultiChain 1.0 Beta 1
92+
93+
Integrated functions about :
94+
* Streams
95+
96+
97+
### 3.0
98+
* Direct RPC Server calls
99+
* Dependencies under Maven
100+
101+
93102
Todo :
94-
* integrate new functions (actually MultiChain Alpha 28)
95-
* integrate Stream functions
103+
* integrate new functions
96104

97105

98106
## License

0 commit comments

Comments
 (0)