Comment PR #502

nxsaken · 2024-07-03T09:35:41Z

PR to hopefully use for comments. Do not merge this.

Signed-off-by: Aleksandr Petrosyan <[email protected]>

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Co-authored-by: William Richter <[email protected]> Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

* [documentation]: Review Triggers chapter Signed-off-by: Ekaterina Mekhnetsova <[email protected]> * Fix formatting Signed-off-by: Ekaterina Mekhnetsova <[email protected]> * Apply suggestions from code review Co-authored-by: William Richter <[email protected]> Signed-off-by: Ekaterina Mekhnetsova <[email protected]> * Fix formatting Signed-off-by: Ekaterina Mekhnetsova <[email protected]> * Add a link to queries Signed-off-by: Ekaterina Mekhnetsova <[email protected]> Co-authored-by: William Richter <[email protected]>

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Co-authored-by: William Richter <[email protected]> Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Co-authored-by: William Richter <[email protected]> Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Co-authored-by: William Richter <[email protected]> Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Co-authored-by: Aleksandr Petrosyan <[email protected]> Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Co-authored-by: William Richter <[email protected]> Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Co-authored-by: Aleksandr Petrosyan <[email protected]> Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Signed-off-by: 0x009922 <[email protected]>

* ADD: Table of tokens Signed-off-by: Stukalov-A-M <[email protected]> * [EDIT] #460,#461,#462 : Permissions example Signed-off-by: Stukalov-A-M <[email protected]> * [EDIT] #460,#461,#462 : Permissions example; Metadata links to permissions updated. Signed-off-by: Stukalov-A-M <[email protected]> * [EDIT] #460,#461,#462 : Permissions example; Metadata links to permissions updated. Signed-off-by: Stukalov-A-M <[email protected]> * [EDIT] #460,#461,#462 : Permissions example; Metadata links to permissions updated. Signed-off-by: Stukalov-A-M <[email protected]> * [EDIT] #460,#461,#462 : Permissions example; Metadata links to permissions updated. Signed-off-by: Stukalov-A-M <[email protected]> * Update src/guide/blockchain/metadata.md Co-authored-by: Ekaterina Mekhnetsova <[email protected]> Signed-off-by: Stukalov-A-M <[email protected]> * Update src/reference/permissions.md Co-authored-by: Ekaterina Mekhnetsova <[email protected]> Signed-off-by: Stukalov-A-M <[email protected]> * Update src/reference/permissions.md Co-authored-by: Ekaterina Mekhnetsova <[email protected]> Signed-off-by: Stukalov-A-M <[email protected]> * Update src/reference/permissions.md Co-authored-by: Ekaterina Mekhnetsova <[email protected]> Signed-off-by: Stukalov-A-M <[email protected]> --------- Signed-off-by: Stukalov-A-M <[email protected]> Signed-off-by: Stukalov-A-M <[email protected]> Co-authored-by: Ekaterina Mekhnetsova <[email protected]>

* Updated and polished Torii Endpoints; fixed and/or removed dead links in related topics Signed-off-by: yamkovoy <[email protected]> * Apply suggestions from code review Co-authored-by: 0x009922 <[email protected]> Signed-off-by: yamkovoy <[email protected]> * Updated after review Signed-off-by: yamkovoy <[email protected]> * Apply suggestions from code review Co-authored-by: 0x009922 <[email protected]> Signed-off-by: yamkovoy <[email protected]> * Torii: Updated after review, minor fixes Signed-off-by: yamkovoy <[email protected]> --------- Signed-off-by: yamkovoy <[email protected]> Signed-off-by: yamkovoy <[email protected]> Co-authored-by: 0x009922 <[email protected]>

* [chore]: update deps Signed-off-by: Dmitry Balashov <[email protected]> * [chore]: `type: module`, fixing warning from Vitest Signed-off-by: Dmitry Balashov <[email protected]> * [revert]: project is not ready for ESM Signed-off-by: Dmitry Balashov <[email protected]> --------- Signed-off-by: Dmitry Balashov <[email protected]>

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

…483) * Updated Rust guide to include information about transferring assets Signed-off-by: enxtur <[email protected]> * Apply suggestions from code review Signed-off-by: Ekaterina Mekhnetsova <[email protected]> * Update instructions.md Signed-off-by: Ekaterina Mekhnetsova <[email protected]> * Update instructions.md Signed-off-by: Ekaterina Mekhnetsova <[email protected]> --------- Signed-off-by: enxtur <[email protected]> Signed-off-by: Ekaterina Mekhnetsova <[email protected]> Co-authored-by: Ekaterina Mekhnetsova <[email protected]>

Signed-off-by: Nikita Strygin <[email protected]>

…g paths Signed-off-by: Nikita Strygin <[email protected]>

…4544 Signed-off-by: Nikita Strygin <[email protected]>

Signed-off-by: Nikita Strygin <[email protected]>

Signed-off-by: Nurzhan Sakén <[email protected]>

* Replace `docker-compose` (V1) with `docker compose` (V2) * Fix spelling in bare metal tutorial * Update src/guide/advanced/running-iroha-on-bare-metal.md --------- Signed-off-by: Nurzhan Saken <[email protected]> Signed-off-by: yamkovoy <[email protected]> Co-authored-by: yamkovoy <[email protected]>

vercel · 2024-07-03T09:35:45Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
iroha-2-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 7, 2024 7:44am

nxsaken · 2024-07-03T09:49:39Z

src/guide/blockchain/data-model.md

+```
+
+   +-----------------------------------------------+
+   |                                               |
+   |     +-----------------+                       |
+   |     |Domain           |                       |
+   |     +--------------+  |                       |
+   |     ||Asset        |  |                       |
+--+--+  ||Definition(s)|  |                       |
+|World|  +--------------+  |                       |
+--+--+  |                 |                       |
+   |     +------------+    |                       |
+   |     ||Account(s)||    | has   +-----------+   |
+   |     |------------------------->Signatories|   |
+   |     +-----------------+       +-----------+   |
+   |                       |                       |
+   |                       |  has  +--------+      |
+   |                       +------->Asset(s)|      |
+   |                               +--------+      |
+   +-----------------------------------------------+
+
+```


This is changing to a flat model implementation-wise: hyperledger-iroha/iroha#3921, but this diagram is conceptually still valid. Except I believe an account can only have one signatory now: hyperledger-iroha/iroha#4411

Yeah, I think it is a good point to consider keeping conceptual diagrams:
In the future, internal representation of objects may diverge from their appearance at user interface.
For example, the primary key for account storage might be signatory, as opposed to the (UI) account ID signatory@domain, which is btw an intent of this suggestion.
However, it is not the implementation details that should be included in the user guide, but the conceptual diagram at UI

nxsaken · 2024-07-03T12:31:46Z

src/guide/blockchain/assets.md

+The assets can be **fungible** (every £1 is exactly the same as every other
+£1) or **non-fungible** (a £1 bill signed by the Queen of Hearts is not the
+same as a £1 bill signed by the King of Spades).


I don't think asset definitions work like that. We don't have NFTs, only numeric assets (with elastic or fixed supply) and store assets (arbitrary JSON data even within a single definition)

My understanding is that Store/Numeric corresponds to NFT/FT, respectively

@s8sato I was under the same impression, but then realized that true NFTs should disallow instantiating more than one of an asset definition (monalisa#louvre#alice@wland and monalisa#louvre#bob@wland cannot co-exist since there is only one Mona Lisa in Louvre).

BTW, I think that Store assets, as designed right now, don't make much sense because two instances of the same definition can have totally different keys.

Indeed, we might move away from the idea of representing Store by a combination of a shared definition and its own value.
Maybe ideally the identifier should be smt like a hash of the value.
We may move this discussion somewhere else, maybe hyperledger-iroha/iroha#4087 or hyperledger-iroha/iroha#4782 ?

Apart from that, as for this doc, what do you think about not mentioning to FT/NFT but just mentioning it is planned to be implemented

I think we can omit NFT/FT and focus on the distinction between Numeric (with elastic or fixed global supply) and Store assets for now

nxsaken · 2024-07-03T12:35:09Z

src/guide/blockchain/assets.md

+same as a £1 bill signed by the King of Spades).
+
+The assets can also be **mintable** (you can make more of them) and
+**non-mintable** (you can only specify their initial quantity in the


Assets with a fixed supply can be minted once, but it doesn't have to be in the genesis. We should also rethink "non-mintable" as it really means "mintable but only once"

nxsaken · 2024-07-03T12:36:08Z

src/guide/blockchain/assets.md

+Additionally, the assets have different underlying value types.
+Specifically, we have `AssetValueType.Quantity`, which is effectively an
+unsigned 32-bit integer, a `BigQuantity`, which is an unsigned 128-bit
+integer, and `Fixed`, which is a positive (though signed) 64-bit
+fixed-precision number with nine significant digits after the decimal
+point. All three types can be registered as either **mintable** or
+**non-mintable**.


We only have Numeric now, which is backed by the rust_decimal crate.

nxsaken · 2024-07-03T12:38:50Z

src/guide/blockchain/assets.md

+There is also the `Store` asset type, which is used for storing key-values
+in object's metadata. We talk in detail about `Store` asset in the chapter
+related to [metadata](metadata.md).


A bit confusing. Store assets contain Metadata (a Metadata is just a mapping between keys and JSON strings, IMO we should rename this to smth like JsonMap), and most objects also contain separate Metadata (same key-JSON map type) but unrelated to assets.

Yes, "metadata" sounds secondary, but it should be primary in Store assets

nxsaken · 2024-07-03T12:42:20Z

src/guide/blockchain/expressions.md

@@ -0,0 +1,17 @@
+# Expressions, Conditionals, Logic


Outdated section. This was replaced by Custom Instructions, which should be documented with the Executor probably.

nxsaken · 2024-07-03T12:42:40Z

src/guide/blockchain/instructions.md

+| [Grant/Revoke](#grant-revoke)                             | Give or remove certain permissions from accounts. |
+| [Transfer](#transfer)                                     | Transfer assets between accounts.                 |
+| [ExecuteTrigger](#executetrigger)                         | Execute triggers.                                 |
+| [If, Pair, Sequence](#composite-instructions)             | Use to create composite instructions.             |


nxsaken · 2024-07-03T12:43:18Z

src/guide/blockchain/metadata.md

+
+- domains
+- accounts
+- assets


Only store assets

Yes, but it's not exactly what attached to the main object

nxsaken · 2024-07-03T12:44:10Z

src/guide/blockchain/metadata.md

+The metadata can be of very different types, such as:
+
+- structures with named or unnamed fields
+- enums
+- integers
+- numbers with fixed decimal precision
+- strings
+- Boolean values
+- arrays
+- associative arrays
+- vectors
+- request results


Metadata maps keys to JSON strings: hyperledger-iroha/iroha#4353

nxsaken · 2024-07-03T12:56:47Z

src/guide/blockchain/world.md

+- Iroha [configuration parameters](./../configure/client-configuration.md)
+- the list of
+  [trusted peers](/guide/configure/peer-configuration#trusted-peers)
+- registered domains


These have been unnested from domains, see hyperledger-iroha/iroha#3921:

accounts

asset definitions

assets

nxsaken · 2024-07-08T09:20:33Z

src/guide/blockchain/wasm.md

Should be renamed according to hyperledger-iroha/iroha#4810, see the change in the README for smart contracts

* Getting started update and overhaul Signed-off-by: a_zorina <[email protected]> Signed-off-by: a-zorina <[email protected]> * fix broken links Signed-off-by: a_zorina <[email protected]> Signed-off-by: a-zorina <[email protected]> * fix section links Signed-off-by: a_zorina <[email protected]> Signed-off-by: a-zorina <[email protected]> * Language and structure improvements Signed-off-by: a-zorina <[email protected]> * External links and crate names fixes Signed-off-by: a-zorina <[email protected]> * Switch to using cargo install for iroha binaries in getting started Signed-off-by: a-zorina <[email protected]> * Minor post-review fixes Signed-off-by: a-zorina <[email protected]> * Fixes and suggestions after review Signed-off-by: yamkovoy <[email protected]> * Changes after discussion Signed-off-by: yamkovoy <[email protected]> * Minor tweaks in instructions Signed-off-by: yamkovoy <[email protected]> * Additional post-review updates Signed-off-by: a-zorina <[email protected]> * link fixes Signed-off-by: a-zorina <[email protected]> * final post-review changes Signed-off-by: a-zorina <[email protected]> --------- Signed-off-by: a_zorina <[email protected]> Signed-off-by: a-zorina <[email protected]> Signed-off-by: yamkovoy <[email protected]> Co-authored-by: yamkovoy <[email protected]>

* Update new structure with recent changes Signed-off-by: a-zorina <[email protected]> * tweaks to structure after discussions Signed-off-by: a-zorina <[email protected]> * tweaks to Iroha Explained section Signed-off-by: a-zorina <[email protected]> * format fix Signed-off-by: a-zorina <[email protected]> --------- Signed-off-by: a-zorina <[email protected]>

* link fixes due to migration Signed-off-by: a-zorina <[email protected]> * Update src/guide/tutorials/rust.md Signed-off-by: Ekaterina Mekhnetsova <[email protected]> --------- Signed-off-by: a-zorina <[email protected]> Signed-off-by: Ekaterina Mekhnetsova <[email protected]> Co-authored-by: Ekaterina Mekhnetsova <[email protected]>

misc: update dependencies Signed-off-by: qua <[email protected]>

appetrosyan and others added 30 commits May 31, 2022 11:41

Add WARN

1c78b1d

Signed-off-by: Aleksandr Petrosyan <[email protected]>

[documentation]: Review peer management

3dfe00f

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Apply suggestions from code review

2dac246

Co-authored-by: William Richter <[email protected]> Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

[documentation]: Review the Queries chapter

520e5dd

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Update src/guide/advanced/queries.md

eba668d

Co-authored-by: William Richter <[email protected]> Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Update src/guide/advanced/queries.md

ac6bfb0

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Review Bash chapter

15c3967

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Review JS chapter

3e0bf47

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Review Kotlin chapter

b583fd3

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Review Python chapter

86855a5

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Review Rust chapter

1abc9b8

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Add minor changes to lang-specific chapters

e8d3bbf

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Apply suggestions from code review

158789a

Co-authored-by: William Richter <[email protected]> Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Fix formatting

4de14b2

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

[documentation]: Review the Iroha 2 vs. Iroha 1 chapter

459743e

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Rephrase the intro

f295b73

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

[documentation]: Review Installation chapter

e8f2aea

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Apply suggestions from code review

985f0eb

Co-authored-by: William Richter <[email protected]> Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Fix formatting

c7eebf2

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Apply suggestions from code review

f4f4ded

Co-authored-by: Aleksandr Petrosyan <[email protected]> Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Revert changes

b513876

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Fix formatting

88cd287

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

[documentation]: Review Iroha on bare metal chapter

6ce8ed2

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Apply suggestions from code review

2d3215e

Co-authored-by: William Richter <[email protected]> Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Fix formatting

70ebd66

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Apply suggestions from code review

cda8e50

Co-authored-by: Aleksandr Petrosyan <[email protected]> Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Revert changes (quotation mark)

fa9d610

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Fix formatting

e3d05d8

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

[CI]: target main branch in GitHub workflows

3fe53d7

Signed-off-by: 0x009922 <[email protected]>

Stukalov-A-M and others added 11 commits January 26, 2024 15:21

Update CODEOWNERS (#482)

45f94c4

Signed-off-by: Ekaterina Mekhnetsova <[email protected]>

Support generating reference for bitmaps in schema

5b3f600

Signed-off-by: Nikita Strygin <[email protected]>

Update to snippets to use the latest iroha dev revision, update confi…

7af87b2

…g paths Signed-off-by: Nikita Strygin <[email protected]>

Update torii reference to be up-to-date with hyperledger-iroha/iroha#…

a561d6e

…4544 Signed-off-by: Nikita Strygin <[email protected]>

Fix broken link to VersionedSignedTransaction (SignedTransaction now)

070bb2e

Signed-off-by: Nikita Strygin <[email protected]>

Stop labeling issues (#488)

61eb82c

Signed-off-by: Nurzhan Sakén <[email protected]>

nxsaken commented Jul 3, 2024

View reviewed changes

nxsaken mentioned this pull request Jul 4, 2024

Interim review of the Blockchain section #501

Closed

s8sato self-assigned this Jul 5, 2024

nxsaken mentioned this pull request Jul 5, 2024

[suggestion] Eliminate AssetType inconsistencies hyperledger-iroha/iroha#4087

Open

nxsaken commented Jul 8, 2024

View reviewed changes

nxsaken added the zh-migration label Sep 4, 2024

vercel bot deployed to Production September 11, 2024 07:58 View deployment

mergify bot mentioned this pull request Sep 18, 2024

docs structure overhaul #506

Closed

vercel bot deployed to Preview September 18, 2024 07:57 View deployment

Rename crates iroha_cli and iroha_kagami (#507)

a2df2bf

vercel bot deployed to Production September 25, 2024 05:40 View deployment

vercel bot deployed to Production September 26, 2024 15:12 View deployment

vercel bot deployed to Production October 31, 2024 09:36 View deployment

Housekeeping (#510)

bc65d77

misc: update dependencies Signed-off-by: qua <[email protected]>

vercel bot deployed to Production November 7, 2024 07:44 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comment PR #502

Comment PR #502

nxsaken commented Jul 3, 2024

vercel bot commented Jul 3, 2024 •

edited

Loading

nxsaken Jul 3, 2024

s8sato Jul 5, 2024 •

edited

Loading

nxsaken Jul 3, 2024

s8sato Jul 5, 2024 •

edited

Loading

nxsaken Jul 5, 2024

s8sato Jul 5, 2024 •

edited

Loading

s8sato Jul 5, 2024

nxsaken Jul 5, 2024

nxsaken Jul 3, 2024

nxsaken Jul 3, 2024

nxsaken Jul 3, 2024

s8sato Jul 5, 2024

nxsaken Jul 3, 2024

nxsaken Jul 3, 2024

nxsaken Jul 3, 2024

s8sato Jul 5, 2024

nxsaken Jul 3, 2024

nxsaken Jul 3, 2024

nxsaken Jul 8, 2024

Comment PR #502

Are you sure you want to change the base?

Comment PR #502

Conversation

nxsaken commented Jul 3, 2024

vercel bot commented Jul 3, 2024 • edited Loading

Choose a reason for hiding this comment

s8sato Jul 5, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

s8sato Jul 5, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

s8sato Jul 5, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vercel bot commented Jul 3, 2024 •

edited

Loading

s8sato Jul 5, 2024 •

edited

Loading

s8sato Jul 5, 2024 •

edited

Loading

s8sato Jul 5, 2024 •

edited

Loading