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.

Sign up for GitHub

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

Update transaction structure description. #1207

Merged
merged 2 commits into from
Mar 19, 2019
Merged

Update transaction structure description. #1207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
17cad5b
Update transaction description to reflect current workings of the fra…
ntn-x2 Mar 13, 2019
3ebb38d
Update request docs to disambiguate DID as verkey and not as public key.
ntn-x2 Mar 18, 2019
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
9 changes: 1 addition & 8 deletions docs/source/requests-new.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -954,15 +954,8 @@ Adds a new node to the pool, or updates existing node in the pool.

- `did` (base58-encoded string):

Target Node's DID as base58-encoded string for 16 or 32 bit DID value.
Target Node's verkey as base58-encoded string for 16 or 32 byte DID value.
It differs from `from` metadata field, where `from` is the DID of the transaction submitter (Steward"s DID).

*Example*: `from` is a DID of a Steward creating a new Node, and `did` is the DID of this Node.

- `verkey` (base58-encoded string; optional):

Target Node verification key as base58-encoded string.
It may absent if `did` is 32-bit cryptonym CID.

- `alias` (string):

Expand Down
9 changes: 2 additions & 7 deletions docs/source/requests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -710,15 +710,10 @@ Adds a new node to the pool, or updates existing node in the pool.

- `dest` (base58-encoded string):

Target Node's DID as base58-encoded string for 16 or 32 byte DID value.
Target Node's verkey as base58-encoded string for 16 or 32 byte DID value.
It differs from `identifier` metadata field, where `identifier` is the DID of the transaction submitter (Steward's DID).

*Example*: `identifier` is a DID of a Steward creating a new Node, and `dest` is the DID of this Node.

- `verkey` (base58-encoded string, possibly starting with "~"; optional):

Target Node verification key as base58-encoded string.
It may absent if `dest` is 32-bit cryptonym CID.
*Example*: `identifier` is a DID of a Steward creating a new Node, and `dest` is the verkey of this Node.

If there is no NODE transaction with the specified Node ID (`dest`), then it can be considered as creation of a new NODE.

Expand Down
10 changes: 2 additions & 8 deletions docs/source/transactions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,16 +458,10 @@ Adds a new node to the pool or updates an existing node in the pool

- `dest` (base58-encoded string):

Target Node's DID as base58-encoded string for 16 or 32 byte DID value.
Target Node's verkey as base58-encoded string for 16 or 32 byte DID value.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, you are right. abbreviated verkeys are currently not supported. Can you please also fix the documentation for NODE request in requests.md?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey! Just updated the same info in both requests.md and requests-new.md.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you very much!

It differs from `identifier` metadata field, where `identifier` is the DID of the transaction submitter (Steward's DID).

*Example*: `identifier` is a DID of a Steward creating a new Node, and `dest` is the DID of this Node.

- `verkey` (base58-encoded string, possibly starting with "~"; optional):

Target Node verification key as base58-encoded string.
It may absent if `dest` is 32-bit cryptonym CID.

*Example*: `identifier` is a DID of a Steward creating a new Node, and `dest` is the verkey of this Node.

If there is no NODE transaction with the specified Node ID (`dest`), then it can be considered as creation of a new NODE.

Expand Down