Skip to content

Commit 0970aa6

Browse files
committed
feat: enhance readme
Signed-off-by: grapebaba <281165273@qq.com>
1 parent fad7454 commit 0970aa6

File tree

1 file changed

+127
-17
lines changed

1 file changed

+127
-17
lines changed

README.md

Lines changed: 127 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -22,42 +22,152 @@ To get started you need to install JDK8+, then run the following command:
2222
$ ./gradlew build
2323
```
2424

25-
## Working with DevNet
26-
27-
Todo
28-
29-
## Working with local network
30-
31-
Refer to the [JSON RPC](https://github.com/MystenLabs/sui/blob/main/doc/src/build/json-rpc.md) topic
32-
for instructions about how to start a local network and local RPC server.
33-
3425
## Javadoc
3526

3627
For the latest javadocs for the `main` branch, run `./gradlew docs` and open
37-
the [build/docs/javadoc/index.html](build/docs/javadoc/index.html) in your browser.
28+
the [javadoc](build/docs/javadoc/index.html) in your browser.
3829

3930
## Testing
4031

41-
To run unit tests
32+
### To run unit tests
4233

4334
```
4435
./gradlew test
4536
```
4637

47-
To run E2E tests against local network
38+
### To run E2E tests against local network
39+
40+
You can start sui local network refer
41+
to [sui-local-network](https://github.com/MystenLabs/sui/blob/main/doc/src/build/sui-local-network.md)
42+
doc.
43+
44+
#### Start local network
4845

4946
```
50-
./gradlew integrationTest
47+
git clone git@github.com:MystenLabs/sui.git
48+
cd sui
49+
cargo build --release
50+
cd sui/target/release
51+
./sui genesis
52+
./sui start
5153
```
5254

53-
To run E2E tests against DevNet
55+
#### To run Integration tests
5456

55-
TODO
57+
```
58+
./gradlew integrationTest
59+
```
5660

57-
## Connecting to Sui Network
61+
### To run E2E tests against DevNet
5862

5963
TODO
6064

6165
## Examples
6266

63-
TODO
67+
### create client
68+
69+
```java
70+
final String BASE_URL="http://localhost:9000";
71+
final JsonHandler jsonHandler=new GsonJsonHandler();
72+
73+
final JsonRpcClientProvider jsonRpcClientProvider=
74+
new OkHttpJsonRpcClientProvider(BASE_URL,jsonHandler);
75+
final SuiClient client=new SuiClientImpl(jsonRpcClientProvider);
76+
```
77+
78+
### sui_getCommitteeInfo
79+
80+
```java
81+
CompletableFuture<CommitteeInfoResponse> res=client.getCommitteeInfo(1L);
82+
```
83+
84+
### sui_getEvents
85+
86+
```java
87+
TransactionEventQuery query=new TransactionEventQuery();
88+
query.setTransaction("ov1tDrhdOqRW2uFweTbSSTaQbBbnjHWmrsh675lwb0Q=");
89+
CompletableFuture<PaginatedEvents> res=client.getEvents(query,null,1,false);
90+
```
91+
92+
### sui_getMoveFunctionArgTypes
93+
94+
```java
95+
CompletableFuture<List<MoveFunctionArgType>>res=
96+
client.getMoveFunctionArgTypes("0x0000000000000000000000000000000000000002","bag","add");
97+
```
98+
99+
### sui_getNormalizedMoveFunction
100+
101+
```java
102+
CompletableFuture<MoveNormalizedFunction> res=
103+
client.getNormalizedMoveFunction(
104+
"0x0000000000000000000000000000000000000002","bag","add");
105+
```
106+
107+
### sui_getNormalizedMoveModule
108+
109+
```java
110+
CompletableFuture<MoveNormalizedModule> res=
111+
client.getNormalizedMoveModule("0x0000000000000000000000000000000000000002","bag");
112+
```
113+
114+
### sui_getNormalizedMoveModulesByPackage
115+
116+
```java
117+
CompletableFuture<Map<String, MoveNormalizedModule>>res=
118+
client.getNormalizedMoveModulesByPackage("0x0000000000000000000000000000000000000002");
119+
```
120+
121+
### sui_getNormalizedMoveStruct
122+
123+
```java
124+
CompletableFuture<MoveNormalizedStruct> res=
125+
client.getNormalizedMoveStruct("0x0000000000000000000000000000000000000002","bag","Bag");
126+
```
127+
128+
### sui_getObject
129+
130+
```java
131+
CompletableFuture<GetObjectResponse> res=
132+
client.getObject("0x342950ba2451c2f27ed128e591c2b4551e5177c2");
133+
```
134+
135+
### sui_getObjectsOwnedByAddress
136+
137+
```java
138+
CompletableFuture<List<SuiObjectInfo>>res=
139+
client.getObjectsOwnedByAddress("0xea79464d86786b7a7a63e3f13f798f29f5e65947");
140+
```
141+
142+
### sui_getObjectsOwnedByObject
143+
144+
```java
145+
CompletableFuture<List<SuiObjectInfo>>res=
146+
client.getObjectsOwnedByObject("0xde2952390ab3d0cfbb0a0602532480ed5ec99cf3");
147+
```
148+
149+
### sui_getRawObject
150+
151+
```java
152+
CompletableFuture<GetObjectResponse> res=
153+
client.getRawObject("0x342950ba2451c2f27ed128e591c2b4551e5177c2");
154+
```
155+
156+
### sui_getTotalTransactionNumber
157+
158+
```java
159+
CompletableFuture<Long> res=client.getTotalTransactionNumber();
160+
```
161+
162+
### sui_getTransaction
163+
164+
```java
165+
CompletableFuture<TransactionResponse> res=
166+
client.getTransaction("3Dda4/74LXf6GmOxMxp3qdbW/WdQ6/8EHobZ1LvSyYk=");
167+
```
168+
169+
### sui_getTransactionsInRange
170+
171+
```java
172+
CompletableFuture<List<String>>res=client.getTransactionsInRange(0L,100L);
173+
```

0 commit comments

Comments
 (0)