Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: typos in documentation files #1884

Merged
merged 5 commits into from
Nov 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions design/anoncreds.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Anoncreds protocol links:
1. CredDef Issuer needs to be able to create multiple CredDefs by the same issuer DID.
1. CredDef Issuer needs to be able to create multiple CredDefs for the same Schema by the same issuer DID.
1. We need to keep reputation for CredDef's Issuer DID.
1. Creation of Revocation Registry (Def and Enteries):
1. Creation of Revocation Registry (Def and Entries):
1. RevocReg Issuer may not be the same as Schema Author and CredDef issuer.
1. RevocReg Issuer needs to be able to create multiple RevocRegs for the same issuer DID.
1. RevocReg Issuer needs to be able to create multiple RevocReg for the same CredDef by the same issuer DID.
Expand Down Expand Up @@ -267,7 +267,7 @@ reference to the CredDef, plus some revocation registry specific data.
* `maxCredNum` (int): maximum number of credentials the Registry can serve.
* `publicKeys` (json): Registry's public key.
* `tailsHash` (string): hash of tails.
* `tailsLocaiton` (string): location of tails file.
* `tailsLocation` (string): location of tails file.


#### Restrictions
Expand Down Expand Up @@ -461,7 +461,7 @@ Reply:
```
Notes:
* accum_to and accum_from it's a transactions from ledger "as-is",
like reply for for GET_REVOC_REG query.
like reply for GET_REVOC_REG query.
* general STATE_PROOF in reply is:
* STATE_PROOF for "to" accum value if "from" was found.
* STATE_PROOF for REG_ENTRY transaction if "from" was not found or not presented in request
Expand Down Expand Up @@ -634,4 +634,4 @@ Result for the Example above:
* `B < issuanceTime < C` => [C,D] => state at timeC => key2 (deprecated credentials)
* `C <= issuanceTime <= D` => [C,D] => state at timeC => key2 (OK)
* `D < issuanceTime < E` => [E,...] => state at timeE => key3 (deprecated credentials)
* `issuanceTime > E` => [E,...] => state at timeE => key3 (OK)
* `issuanceTime > E` => [E,...] => state at timeE => key3 (OK)
2 changes: 1 addition & 1 deletion design/pool_restart_txn.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ If POOL_RESTART was successfully received, then the reply will be as follows:
}
```
If there are any problems at the stage of static validation, will send REQNACK with a description of the problem.
If an error is detected during the processing of the command, Reply will contains field "isSuccess=Flase" and field "msg" will contains information about the error.
If an error is detected during the processing of the command, Reply will contains field "isSuccess=False" and field "msg" will contains information about the error.
Reply will sended before node restart.

For reference: [INDY-1173](https://jira.hyperledger.org/browse/INDY-1173)
4 changes: 2 additions & 2 deletions design/transaction_endorser.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ As a transaction author, I need my transactions to be written to the ledger pres
- It should not be possible to endorse a transaction without explicitly specifying the Endorser.

## Proposed workflow
1. Transaction Author builds a new request (`indy_build_xxx_reqeust`).
1. Transaction Author builds a new request (`indy_build_xxx_request`).
1. If no endorser is needed for a transaction (for example, the transaction author is an endorser, or auth rules are configured in a way that transaction author can send requests in permissionless mode), then the author signs and submits the transaction.
1. Otherwise the author chooses an Endorser and adds Endorser's DID into the request calling `indy_append_request_endorser`.
1. Transaction author signs the request (`indy_multi_sign_request` or `indy_sign_request`) with the added endorser field (output of `indy_append_request_endorser`).
Expand Down Expand Up @@ -79,4 +79,4 @@ Since we check in Request static validation that a `signatures` field containing
No changes are required.
- `is_owner` must always be checked against `identifier` field (this is how it is now).
- number of signatures of expected roles is checked against `signature` or `signatures` by common logic. Since Endorser's signature is there, existing common logic will work.


2 changes: 1 addition & 1 deletion design/txn_author_agreement.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ pub extern fn indy_build_get_txn_author_agreement_request(command_handle: Comman
///
/// #Params
/// request_json - original request
/// text and version - (optional) raw data about TAA from ledger. These parameters should be passed together. These parameters are required if digest parameter is ommited.
/// text and version - (optional) raw data about TAA from ledger. These parameters should be passed together. These parameters are required if digest parameter is omitted.
/// digest - (optional) hash on text and version. This parameter is required if text and version parameters are ommited.
/// acc_mech_type - mechanism how user has accepted the TAA
/// time_of_acceptance - UTC timestamp when user has accepted the TAA
Expand Down
4 changes: 2 additions & 2 deletions design/validator_info.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ the user who has a read access to the \<node name\>_info.json file from the node
This file is updated by node once a minute and contains following information:
```
{
"did": "Gw6pDLhcBcoQesN72qfotTgFa7cbuqZpkX3Xo6pLhPhv", # node's identidier
"did": "Gw6pDLhcBcoQesN72qfotTgFa7cbuqZpkX3Xo6pLhPhv", # node's identifier
"response-version": "0.0.1", # 0.0.1 for now
"timestamp": 1519711338, # current time
"verkey": "33nHHYKnqmtGAVfZZGoP8hpeExeH45Fo8cKmd5mcnKYk7XgWNBxkkKJ", # node's verkey
Expand Down Expand Up @@ -52,7 +52,7 @@ This file is updated by node once a minute and contains following information:
"read-transactions": 0.0
},
"uptime": 300 # uptaime
"uptime": 300 # uptime
},
"software": { # packets' versions
Expand Down