Skip to content

Commit f079b99

Browse files
authored
Merge pull request #400 from vivian1912/master
update SR description
2 parents a0a80b0 + 45af72a commit f079b99

File tree

7 files changed

+65
-65
lines changed

7 files changed

+65
-65
lines changed

docs/api/http.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -836,7 +836,7 @@ curl http://127.0.0.1:8090/wallet/getnodeinfo
836836
Return: The node information
837837

838838
#### wallet/getchainparameters
839-
Description: Query the parameters of the blockchain used for witnessses to create a proposal
839+
Description: Query the parameters of the blockchain used for SR(Super Representatives) to create a proposal
840840
```
841841
curl -X POST http://127.0.0.1:8090/wallet/getchainparameters
842842
```
@@ -1318,7 +1318,7 @@ The following are voting and SR related APIs:
13181318
- [wallet/getnextmaintenancetime](#walletgetnextmaintenancetime)
13191319

13201320
#### wallet/createwitness
1321-
Description: Apply to become a witness
1321+
Description: Apply to become a super representative
13221322
```console
13231323
$ curl -X POST http://127.0.0.1:8090/wallet/createwitness -d
13241324
'{
@@ -1337,7 +1337,7 @@ Return: Transaction object
13371337

13381338

13391339
#### wallet/updatewitness
1340-
Description: Update the witness' website url
1340+
Description: Update the super representative' website url
13411341
```console
13421342
$ curl -X POST http://127.0.0.1:8090/wallet/updatewitness -d
13431343
'{
@@ -1356,16 +1356,16 @@ Return: Transaction object
13561356

13571357

13581358
#### wallet/listwitnesses
1359-
Description: Qyery the list of the witnesses
1359+
Description: Qyery the list of the super representatives
13601360
```
13611361
curl -X POST http://127.0.0.1:8090/wallet/listwitnesses
13621362
```
13631363
Parameters: N/A
13641364

1365-
Return:witness list
1365+
Return:SR(Super Representatives) list
13661366

13671367
#### wallet/withdrawbalance
1368-
Description: Withdraw reward to account balance for witnesses
1368+
Description: Withdraw reward to account balance for super representatives
13691369
```console
13701370
$ curl -X POST http://127.0.0.1:8090/wallet/withdrawbalance -d
13711371
'{
@@ -1386,7 +1386,7 @@ Note: It can only withdraw once for every 24 hours
13861386

13871387

13881388
#### wallet/votewitnessaccount
1389-
Description: Vote for witnesses
1389+
Description: Vote for super representatives
13901390
```console
13911391
$ curl -X POST http://127.0.0.1:8090/wallet/votewitnessaccount -d
13921392
'{
@@ -1403,21 +1403,21 @@ $ curl -X POST http://127.0.0.1:8090/wallet/votewitnessaccount -d
14031403
Parameters:
14041404

14051405
- `owner_address`: Owner address, default hexString
1406-
- `votes`: 'vote_address' stands for the address of the witness you want to vote, default hexString, 'vote_count' stands for the number of votes you want to vote
1406+
- `votes`: 'vote_address' stands for the address of the super representative you want to vote, default hexString, 'vote_count' stands for the number of votes you want to vote
14071407
- `permission_id`: Optional, for multi-signature use
14081408

14091409
Return: Transaction object
14101410

14111411
#### wallet/getBrokerage
1412-
Description: Query the ratio of brokerage of the witness
1412+
Description: Query the ratio of brokerage of the super representative
14131413
```console
14141414
$ curl -X GET http://127.0.0.1:8090/wallet/getBrokerage -d '{
14151415
"address":"41E552F6487585C2B58BC2C9BB4492BC1F17132CD0"}'
14161416
```
14171417

1418-
Parameter `address`: The address of the witness's account, default hexString
1418+
Parameter `address`: The address of the SR's account, default hexString
14191419

1420-
Return: The ratio of brokerage of the witness
1420+
Return: The ratio of brokerage of the SR
14211421

14221422
#### wallet/updateBrokerage
14231423
Description: Update the ratio of brokerage
@@ -1430,7 +1430,7 @@ $ curl -X POST http://127.0.0.1:8090/wallet/updateBrokerage -d '{
14301430

14311431
Parameters:
14321432

1433-
- `owner_address`: The address of the witness's account, default hexString
1433+
- `owner_address`: The address of the SR's account, default hexString
14341434
- `brokerage`: The ratio of brokerage you want to update to
14351435

14361436

@@ -2661,13 +2661,13 @@ Return: Two lists will return, one is the list of addresses the account has dele
26612661
### Voting & SRs
26622662

26632663
#### walletsolidity/listwitnesses
2664-
Description: Query the list of witnesses
2664+
Description: Query the list of super representatives
26652665
```
26662666
curl -X POST http://127.0.0.1:8091/walletsolidity/listwitnesses
26672667
```
26682668
Parameters: N/A
26692669

2670-
Return: List of all witnesses
2670+
Return: List of all super representatives
26712671

26722672
### TRC10 Token
26732673

docs/api/rpc.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ rpc BroadcastTransaction (Transaction) returns (Return) {}
2929
Nodes: Fullnode
3030

3131
Description:
32-
Transfer, vote, issuance of token, or participation in token offering. Sending signed transaction information to node, and broadcasting it to the entire network after witness verification.
32+
Transfer, vote, issuance of token, or participation in token offering. Sending signed transaction information to node, and broadcasting it to the entire network after super representatives verification.
3333

3434
**4. Create an account**
3535

@@ -50,7 +50,7 @@ rpc VoteWitnessAccount (VoteWitnessContract) returns (Transaction) {}
5050
```
5151
Nodes: FullNode
5252

53-
**7. Query the ratio of brokerage of the witness**
53+
**7. Query the ratio of brokerage of the super representative**
5454
```protobuf
5555
rpc GetBrokerageInfo (BytesMessage) returns (NumberMessage) {}
5656
```

docs/clients/wallet-cli-command.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -206,10 +206,10 @@ wallet>UpdateAccountPermission [ownerAddress] [permissions]
206206
This command is used to assign permissions to other accounts, is utilized for **multi-signature** transactions, which allows other users to access the account with paritcular permission in order to better manage it. There are three types of permissions:
207207

208208
* owner: access to the owner of account
209-
* active: access to other features of accounts, and access that authorizes a certain feature. Block production authorization is not included if it's for witness purposes.
210-
* witness: only for witness, block production authorization will be granted to one of the other users.
209+
* active: access to other features of accounts, and access that authorizes a certain feature. Block production authorization is not included if it's for SR purposes.
210+
* witness: only for super representatives, block production authorization will be granted to one of the other users.
211211

212-
**NOTE** the parameter`Permission` must written in JSON format and entered in line. If the owner accountis not SR, then do not assign witness permission.
212+
**NOTE** the parameter`Permission` must written in JSON format and entered in line. If the owner accountis not SR, then do not assign super representative permission.
213213
```shell
214214
wallet> updateaccountpermission TSzdGHnhYnQKFF4LKrRLztkjYAvbNoxnQ8 {"owner_permission":{"keys":[{"address":"TSzdGHnhYnQKFF4LKrRLztkjYAvbNoxnQ8","weight":1}],"threshold":1,"type":0,"permission_name":"owner"},"active_permissions":[{"operations":"7fff1fc0033e0000000000000000000000000000000000000000000000000000","keys":[{"address":"TB9qhqbev6DpX8mxdf3zDdtSQ6GC6Vb6Ej","weight":1},{"address":"TXBpeye7UQ4dDZEnmGDv4vX37mBYDo1tUE","weight":1}],"threshold":2,"type":2,"permission_name":"active12323"}]}
215215
{
@@ -1886,7 +1886,7 @@ wallet> getproposal 34
18861886
18871887
Voting requires Tron Power, which can be obtained by freezing funds.
18881888
```
1889-
wallet> votewitness [witness address] [Tron Power Amount]
1889+
wallet> votewitness [SR(Super Representatives) address] [Tron Power Amount]
18901890
```
18911891
18921892
* The share calculation method is: 1 unit of share can be obtained for every 1TRX frozen.
@@ -1898,11 +1898,11 @@ For example:
18981898
```shell
18991899
wallet> freezeBalance 100000000 3 1 address # Freeze 10TRX and acquire 10 units of Tron Power
19001900
1901-
wallet> votewitness [witness1] 4 [witness2] 6 # Cast 4 votes for witness1 and 6 votes for witness2 at the same time
1901+
wallet> votewitness [SR1] 4 [SR2] 6 # Cast 4 votes for SR1 and 6 votes for SR2 at the same time
19021902
1903-
wallet> votewitness [witness1] 10 # Voted 10 votes for witness1
1903+
wallet> votewitness [SR1] 10 # Voted 10 votes for SR1
19041904
```
1905-
The final result of the above command was 10 votes for witness1 and 0 vote for witness2.
1905+
The final result of the above command was 10 votes for SR1 and 0 vote for SR2.
19061906
19071907
### ListWitnesses
19081908
@@ -1935,14 +1935,14 @@ wallet> listwitnesses
19351935
```
19361936
19371937
### GetBrokerage
1938-
View the ratio of brokerage of the witness.
1938+
View the ratio of brokerage of the SR(Super Representatives).
19391939
1940-
After voting for the witness, you will receive the rewards. The witness has the right to decide the ratio of brokerage. The default ratio is 20%, and the witness can adjust it.
1940+
After voting for the super representative, you will receive the rewards. The super representative has the right to decide the ratio of brokerage. The default ratio is 20%, and the super representative can adjust it.
19411941
1942-
By default, if a witness is rewarded, he will receive 20% of the whole rewards, and 80% of the rewards will be distributed to his voters.
1942+
By default, if a super representative is rewarded, he will receive 20% of the whole rewards, and 80% of the rewards will be distributed to his voters.
19431943
19441944
1945-
`OwnerAddress` is the address of the witness's account, it is a base58check type address.
1945+
`OwnerAddress` is the address of the SR's account, it is a base58check type address.
19461946
```shell
19471947
wallet> getbrokerage TSzdGHnhYnQKFF4LKrRLztkjYAvbNoxnQ8
19481948
The brokerage is : 20
@@ -1959,11 +1959,11 @@ The reward is : 0
19591959
19601960
19611961
### UpdateBrokerage
1962-
Update the ratio of brokerage, this command is usually used by a witness account.
1962+
Update the ratio of brokerage, this command is usually used by a super representative account.
19631963
``` shell
19641964
wallet> updateBrokerage [OwnerAddress] [brokerage]
19651965
```
1966-
`OwnerAddress` is the address of the witness's account, it is a base58check type address.
1966+
`OwnerAddress` is the address of the super representative's account, it is a base58check type address.
19671967
19681968
`brokerage` is the ratio of brokerage you want to update to, the limit of it: 0-100.
19691969

0 commit comments

Comments
 (0)