Skip to content

Commit e9d56f6

Browse files
committed
Remove Object postfix from type names in JSON RPC specification
1 parent 4cfe664 commit e9d56f6

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

spec/JSON-RPC.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -19,22 +19,22 @@ A XXX-bit hexadecimal string. (e.g. H160: 160-bit hexadecimal string)
1919

2020
A hexadecimal string for XXX-bit unsigned integer
2121

22-
## BlockObject
22+
## Block
2323

2424
- author: `H160`
2525
- extraData: `any[]`
2626
- hash: `H256`
2727
- invoicesRoot: `H256`
2828
- number: `number`
29-
- parcels: `ParcelObject[]`
29+
- parcels: `Parcel[]`
3030
- parcelsRoot: `H256`
3131
- parentHash: `H256`
3232
- score: `number`
3333
- seal: `string[]`
3434
- stateRoot: `H256`
3535
- timestamp: `number`
3636

37-
## ParcelObject
37+
## Parcel
3838

3939
- blockHash: `H256`
4040
- blockNumber: `number`
@@ -44,45 +44,45 @@ A hexadecimal string for XXX-bit unsigned integer
4444
- nonce: `U256`
4545
- parcelIndex: `number`
4646
- sig: `Signature`
47-
- action: `ActionObject`
47+
- action: `Action`
4848

49-
## ActionObjects
49+
## Actions
5050

51-
### ChangeShardState ActionObject
51+
### ChangeShardState Action
5252

5353
- action: "changeShardState"
54-
- transactions: `TransactionObject[]`
54+
- transactions: `Transaction[]`
5555

56-
### Payment ActionObject
56+
### Payment Action
5757

5858
- action: "payment"
5959
- receiver: `H160`
6060
- amount: `U256`
6161

62-
### SetRegularKey ActionObject
62+
### SetRegularKey Action
6363

6464
- action: "setRegularKey"
6565
- key: `H512`
6666

67-
## TransactionObject
67+
## Transaction
6868

6969
- type: "assetMint" | "assetTransfer"
70-
- data: `AssetMintObject` | `AssetTransferObject`
70+
- data: `AssetMint` | `AssetTransfer`
7171

72-
## AssetSchemeObject
72+
## AssetScheme
7373

7474
- amount: `number`
7575
- metadata: `string`
7676
- registrar: `H160` | `null`
7777

78-
## AssetObject
78+
## Asset
7979

8080
- amount: `number`
8181
- asset_type: `H256`
8282
- lock_script_hash: `H256`
8383
- parameters: `hexadecimal string[]`
8484

85-
## ChangeShardObject
85+
## ChangeShard
8686
- shard_id: `number`
8787
- pre_root: `H256`
8888
- post_root: `H256`
@@ -269,7 +269,7 @@ Gets the block with the given hash.
269269
Params:
270270
1. hash: `H256`
271271

272-
Return Type: `null` | `BlockObject`
272+
Return Type: `null` | `Block`
273273

274274
Request Example:
275275
```
@@ -352,7 +352,7 @@ Gets a parcel with the given hash.
352352
Params:
353353
1. parcel hash - `H256`
354354

355-
Return Type: `null` or `ParcelObject`
355+
Return Type: `null` or `Parcel`
356356

357357
Request Example
358358
```
@@ -444,7 +444,7 @@ Params:
444444
1. transaction hash of AssetMintTransaction - `H256`
445445
2. shard id - `number`
446446

447-
Return Type: `null` | `AssetSchemeObject`
447+
Return Type: `null` | `AssetScheme`
448448

449449
Request Example
450450
```
@@ -473,7 +473,7 @@ Gets an asset scheme with the given asset type.
473473
Params:
474474
1. type of asset - `H256`
475475

476-
Return Type: `null` | `AssetSchemeObject`
476+
Return Type: `null` | `AssetScheme`
477477

478478
Request Example
479479
```
@@ -504,7 +504,7 @@ Params:
504504
2. index - `number`
505505
3. block number: `number` | `null`
506506

507-
Return Type: `null` | `AssetObject`
507+
Return Type: `null` | `Asset`
508508

509509
Request Example
510510
```
@@ -665,7 +665,7 @@ Gets parcels in the current parcel queue.
665665

666666
Params: No parameters
667667

668-
Return Type: `ParcelObject[]`
668+
Return Type: `Parcel[]`
669669

670670
Request Example
671671
```
@@ -735,9 +735,9 @@ Response Example
735735
Executes the transactions and returns the current shard root and the changed shard root.
736736

737737
Params:
738-
1. transactions: `hexadecimal string` - RLP encoded hex string of `TransactionObject[]`
738+
1. transactions: `hexadecimal string` - RLP encoded hex string of `Transaction[]`
739739

740-
Return Type: `ChangeShardObject[]`
740+
Return Type: `ChangeShard[]`
741741

742742
Request Example
743743
```
@@ -771,7 +771,7 @@ Returns the hash of the current block and score.
771771

772772
Params: No parameters
773773

774-
Return Type: `WorkObject`
774+
Return Type: `Work`
775775

776776
Request Example
777777
```

0 commit comments

Comments
 (0)