Skip to content

Commit 996d079

Browse files
Benson0224Benson0224
authored
Merge pull request #239 from vivian1912/reorganize-the-doc
optimize privacy information
2 parents 7514a6b + 268dc7f commit 996d079

File tree

9 files changed

+17
-932
lines changed

9 files changed

+17
-932
lines changed

‎docs/api/http.md

Lines changed: 0 additions & 771 deletions
Large diffs are not rendered by default.

‎docs/api/rpc.md

Lines changed: 0 additions & 144 deletions
Original file line numberDiff line numberDiff line change
@@ -238,150 +238,6 @@ rpc TriggerContract (TriggerSmartContract) returns (TransactionExtention) {}
238238
```
239239
Nodes: FullNode
240240

241-
## Create a shielded transaction
242-
```protobuf
243-
rpc CreateShieldedTransaction (PrivateParameters) returns (TransactionExtention) {}
244-
```
245-
Nodes: FullNode
246-
247-
## Get a Merkle tree information of a note
248-
```protobuf
249-
rpc GetMerkleTreeVoucherInfo (OutputPointInfo) returns (IncrementalMerkleVoucherInfo) {}
250-
```
251-
Nodes: FullNode
252-
253-
## Scan note by ivk
254-
```protobuf
255-
rpc ScanNoteByIvk (IvkDecryptParameters) returns (DecryptNotes) {}
256-
```
257-
Nodes: FullNode
258-
259-
## Scan note by ovk
260-
```protobuf
261-
rpc ScanNoteByOvk (OvkDecryptParameters) returns (DecryptNotes) {}
262-
```
263-
Nodes: FullNode
264-
265-
## Get spending key
266-
```protobuf
267-
rpc GetSpendingKey (EmptyMessage) returns (BytesMessage) {}
268-
```
269-
Nodes: FullNode
270-
271-
## Get expanded spending key
272-
```protobuf
273-
rpc GetExpandedSpendingKey (BytesMessage) returns (ExpandedSpendingKeyMessage) {}
274-
```
275-
Nodes: FullNode
276-
277-
## Get ak from ask
278-
```protobuf
279-
rpc GetAkFromAsk (BytesMessage) returns (BytesMessage) {}
280-
```
281-
Nodes: FullNode
282-
283-
## Get nk from nsk
284-
```protobuf
285-
rpc GetNkFromNsk (BytesMessage) returns (BytesMessage) {}
286-
```
287-
Nodes: FullNode
288-
289-
## Get incoming viewing key
290-
```protobuf
291-
rpc GetIncomingViewingKey (ViewingKeyMessage) returns (IncomingViewingKeyMessage) {}
292-
```
293-
Nodes: FullNode
294-
295-
## Get diversifier
296-
```protobuf
297-
rpc GetDiversifier (EmptyMessage) returns (DiversifierMessage) {}
298-
```
299-
Nodes: FullNode
300-
301-
## Get zen payment address
302-
```protobuf
303-
rpc GetZenPaymentAddress (IncomingViewingKeyDiversifierMessage) returns (PaymentAddressMessage) {}
304-
```
305-
Nodes: FullNode
306-
307-
## Get rcm
308-
```protobuf
309-
rpc GetRcm (EmptyMessage) returns (BytesMessage) {}
310-
```
311-
Nodes: FullNode
312-
313-
## Get a note status of is spent or not
314-
```protobuf
315-
rpc IsSpend (NoteParameters) returns (SpendResult) {}
316-
```
317-
Nodes: FullNode
318-
319-
## Create a shielded transaction without using ask
320-
```protobuf
321-
rpc CreateShieldedTransactionWithoutSpendAuthSig (PrivateParametersWithoutAsk) returns (TransactionExtention) {}
322-
```
323-
Nodes: FullNode
324-
325-
## Create a shielded transaction hash
326-
```protobuf
327-
rpc GetShieldTransactionHash (Transaction) returns (BytesMessage) {}
328-
```
329-
Nodes: FullNode
330-
331-
## Create a signature for a shielded transaction
332-
```protobuf
333-
rpc CreateSpendAuthSig (SpendAuthSigParameters) returns (BytesMessage) {}
334-
```
335-
Nodes: FullNode
336-
337-
## Create a shield nullifier
338-
```protobuf
339-
rpc CreateShieldNullifier (NfParameters) returns (BytesMessage) {}
340-
```
341-
Nodes: FullNode
342-
343-
## Get new shielded address
344-
```protobuf
345-
rpc GetNewShieldedAddress (EmptyMessage) returns (ShieldedAddressInfo){}
346-
```
347-
Nodes: FullNode
348-
349-
## Create shielded contract parameters
350-
```protobuf
351-
rpc CreateShieldedContractParameters (PrivateShieldedTRC20Parameters) returns (ShieldedTRC20Parameters) {}
352-
```
353-
Nodes: FullNode
354-
355-
## Create shielded contract parameters without ask
356-
```protobuf
357-
rpc CreateShieldedContractParametersWithoutAsk (PrivateShieldedTRC20ParametersWithoutAsk) returns (ShieldedTRC20Parameters) {}
358-
```
359-
Nodes: FullNode
360-
361-
## Scan shielded TRC20 notes by ivk
362-
```protobuf
363-
rpc ScanShieldedTRC20NotesbyIvk (IvkDecryptTRC20Parameters) returns (DecryptNotesTRC20) {}
364-
```
365-
Nodes: FullNode, SolidityNode
366-
367-
## Scan shielded TRC20 notes by ovk
368-
```protobuf
369-
rpc ScanShieldedTRC20NotesbyOvk (OvkDecryptTRC20Parameters) returns (DecryptNotesTRC20) {}
370-
```
371-
Nodes: FullNode, SolidityNode
372-
373-
## Get the status of shielded TRC20 note of spent or not
374-
```protobuf
375-
rpc IsShieldedTRC20ContractNoteSpent (NfTRC20Parameters) returns (NullifierResult) {}
376-
```
377-
Nodes: FullNode, SolidityNode
378-
379-
## Get the trigger input for the shielded TRC20
380-
```protobuf
381-
rpc GetTriggerInputForShieldedTRC20Contract (ShieldedTRC20TriggerContractParameters) returns (BytesMessage) {}
382-
```
383-
Nodes: FullNode
384-
385241
## Create an market order
386242
```
387243
rpc MarketSellAsset (MarketSellAssetContract) returns (TransactionExtention) {};

‎docs/clients/wallet-cli.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,28 +59,28 @@ Login successful !!!
5959
#### BackupWallet
6060
备份钱包时需要输入秘密，成功后将会导出你的私钥, 如下面示例中的
6161
```
62-
721d63b074f18d41c147e04c952ec93467777a30b6f16745bc47a8eae5076545
62+
721d63b0...e5076545
6363
```
6464

6565
```shell
6666
wallet> backupwallet
6767
Please input your password.
6868
password:
6969
BackupWallet successful !!
70-
721d63b074f18d41c147e04c952ec93467777a30b6f16745bc47a8eae5076545
70+
721d63b0...e5076545
7171
```
7272
#### BackupWallet2Base64
7373
备份钱包时需要输入秘密，成功后将会以base64格式导出你的私钥, 如下面示例中的
7474
```
75-
ch1jsHTxjUHBR+BMlS7JNGd3ejC28WdFvEeo6uUHZUU=
75+
ch1j...ZUU=
7676
```
7777

7878
```shell
7979
wallet> backupwallet
8080
Please input your password.
8181
password:
8282
BackupWallet successful !!
83-
ch1jsHTxjUHBR+BMlS7JNGd3ejC28WdFvEeo6uUHZUU=
83+
ch1j...ZUU=
8484
```
8585
#### ChangePassword
8686
使用本命令来更改密码
@@ -110,7 +110,7 @@ password:
110110
Please input password again.
111111
password:
112112
Please input private key. Max retry time:3
113-
bd1ff0f4f852db45316bf08755bf6eee45d0678bfbf852a00020a13d42a1fb5b
113+
bd1ff0f4...42a1fb5b
114114
Import a wallet successful, keystore file name is UTC--2022-06-28T06-52-56.928000000Z--TB9qhqbev6DpX8mxdf3zDdtSQ6GC6Vb6Ej.json
115115
```
116116
#### ImportWalletByBase64
@@ -122,7 +122,7 @@ password:
122122
Please input password again.
123123
password:
124124
Please input private key by base64. Max retry time:3
125-
vR/w9PhS20Uxa/CHVb9u7kXQZ4v7+FKgACChPUKh+1s=
125+
...your private key...
126126
Import a wallet successful, keystore file name is UTC--2022-06-28T06-51-56.154000000Z--TB9qhqbev6DpX8mxdf3zDdtSQ6GC6Vb6Ej.json
127127

128128
```
@@ -143,7 +143,7 @@ Import a wallet successful, keystore file name is UTC--2022-06-28T06-51-56.15400
143143
wallet> generateaddress
144144
{
145145
"address": "TQAvi6bemLa1t1irdV1KuaSC5vKc2EswTj",
146-
"privateKey": "610a8a809114a96140e1cb040a7813afc74603e58c3d7824c3f68ccc642c297e"
146+
"privateKey": "610a8a80...642c297e"
147147
}
148148
```
149149
**注意：** 生成的地址及其私钥不会被保存，如需使用请单独留存。

‎docs/developers/deployment.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ java -jar SolidityNode.jar -c config.conf //make sure that your config.conf is d
7777
```shell
7878
java -jar FullNode.jar -p your private key --witness -c your config.conf(Example：/data/java-tron/config.conf)
7979
Example:
80-
java -jar FullNode.jar -p 650950B193DDDDB35B6E48912DD28F7AB0E7140C1BFDEFD493348F02295BD812 --witness -c /data/java-tron/config.conf
80+
java -jar FullNode.jar -p 650950B1...295BD812 --witness -c /data/java-tron/config.conf
8181
```
8282

8383
这与运行一个个人测试网相似，除了`config.conf`中的IP不一样。
@@ -95,7 +95,7 @@ java -jar FullNode.jar -p 650950B193DDDDB35B6E48912DD28F7AB0E7140C1BFDEFD493348F
9595
cd build/libs
9696
java -jar FullNode.jar -p your private key --witness -c your config.conf (Example：/data/java-tron/config.conf)
9797
Example:
98-
java -jar FullNode.jar -p 650950B193DDDDB35B6E48912DD28F7AB0E7140C1BFDEFD493348F02295BD812 --witness -c /data/java-tron/config.conf
98+
java -jar FullNode.jar -p 650950B1...295BD812 --witness -c /data/java-tron/config.conf
9999
```
100100

101101
## 日志与网络连接验证

‎docs/introduction/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -853,7 +853,7 @@ java -jar wallet-cli.jar
853853
```shell
854854
importwallet
855855
<输入你自己的设定的钱包密码2次>
856-
<输入私钥：da146374a75310b9666e834ee4ad0866d6f4035967bfc76217c5a495fff9f0d0>
856+
<输入私钥：da146374...fff9f0d0>
857857
login
858858
<输入你自己的设定的钱包密码>
859859
getbalance

‎docs/using_javatron/installing_javatron.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ java -Xmx24g -XX:+UseConcMarkSweepGC -jar FullNode.jar -c main_net_config.conf
9090

9191
```json
9292
localwitness = [
93-
650950B193DDDDB35B6E48912DD28F7AB0E7140C1BFDEFD493348F02295BD812
93+
650950B1...295BD812
9494
]
9595
```
9696

‎docs/using_javatron/private_network.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@
9494
var TronWeb = require('tronweb');
9595
var tronWeb = new TronWeb({
9696
fullHost: 'http://localhost:16887',
97-
privateKey: 'c741f5c0224020d7ccaf4617a33cc099ac13240f150cf35f496db5bfc7d220dc'
97+
privateKey: 'c741f5c0...c7d220dc'
9898
})
9999
100100
var parametersForProposal1 = [{"key":9,"value":1},{"key":10,"value":1}];

‎docs_without_index/TestNet/如何建立节点.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ java -jar java-tron.jar
8585
cd build/libs
8686
java -jar java-tron.jar -p yourself private key --witness -c yourself config.conf(Example：/data/java-tron/config.conf)
8787
Example:
88-
java -jar java-tron.jar -p 650950B193DDDDB35B6E48912DD28F7AB0E7140C1BFDEFD493348F02295BD812 --witness -c /data/java-tron/config.conf
88+
java -jar java-tron.jar -p 650950B1...295BD812 --witness -c /data/java-tron/config.conf
8989

9090
```
9191

@@ -105,7 +105,7 @@ java -jar java-tron.jar -p 650950B193DDDDB35B6E48912DD28F7AB0E7140C1BFDEFD493348
105105
Using TaskInputs.file() with something that doesn't resolve to a File object has been deprecated and is scheduled to be removed in Gradle 5.0. Use TaskInputs.files() instead.
106106
107107
> Task :run
108-
20:39:22.749 INFO [o.t.c.c.a.Args] private.key = 63e62a71ed39e30bac7223097a173924aad5855959de517ff2987b0e0ec89f1a
108+
20:39:22.749 INFO [o.t.c.c.a.Args] private.key = 63e62a71...0ec89f1a
109109
20:39:22.816 WARN [o.t.c.c.a.Args] localwitness size must be one, get the first one
110110
20:39:22.832 INFO [o.t.p.FullNode] Here is the help message.output-directory/
111111
三月 22, 2018 8:39:23 下午 org.tron.core.services.RpcApiService start
@@ -246,7 +246,7 @@ java -jar java-tron.jar
246246
cd build/libs
247247
java -jar java-tron.jar -p yourself private key --witness -c yourself config.conf(Example：/data/java-tron/config.conf)
248248
Example:
249-
java -jar java-tron.jar -p 650950B193DDDDB35B6E48912DD28F7AB0E7140C1BFDEFD493348F02295BD812 --witness -c /data/java-tron/config.conf
249+
java -jar java-tron.jar -p 650950B1...295BD812 --witness -c /data/java-tron/config.conf
250250
251251
```
252252

‎docs_without_index/VM/搭建自己的Dapp开发环境.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Version 0.1
1414

1515
该私有链的产块节点的地址：TPL66VK2gCXNCD7EJg9pgJRfqcRazjhUZY
1616

17-
Witness私钥：da146374a75310b9666e834ee4ad0866d6f4035967bfc76217c5a495fff9f0d0
17+
Witness私钥：da146374...fff9f0d0
1818

1919
注意：如果要支持constant的请求，需要在配置文件config.conf中填写：supportConstant = true，默认是false。
2020

@@ -93,7 +93,7 @@ java -jar wallet-cli.jar
9393
```shell
9494
importwallet
9595
<输入你自己的设定的钱包密码2次>
96-
<输入私钥：da146374a75310b9666e834ee4ad0866d6f4035967bfc76217c5a495fff9f0d0>
96+
<输入私钥：da146374...fff9f0d0>
9797
login
9898
<输入你自己的设定的钱包密码>
9999
getbalance

0 commit comments

Comments
 (0)