Comment PR #502
Comment PR #502
Conversation
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]>
Signed-off-by: Ekaterina Mekhnetsova <[email protected]>
Signed-off-by: Ekaterina Mekhnetsova <[email protected]>
Signed-off-by: Ekaterina Mekhnetsova <[email protected]>
Signed-off-by: Ekaterina Mekhnetsova <[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]>
Signed-off-by: Ekaterina Mekhnetsova <[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: 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: Ekaterina Mekhnetsova <[email protected]>
Signed-off-by: 0x009922 <[email protected]>
[CI]: target `main` branch in GitHub workflows
* [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]>
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
src/guide/blockchain/data-model.md
Outdated
| ``` | ||
|
|
||
| +-----------------------------------------------+ | ||
| | | | ||
| | +-----------------+ | | ||
| | |Domain | | | ||
| | +--------------+ | | | ||
| | ||Asset | | | | ||
| +--+--+ ||Definition(s)| | | | ||
| |World| +--------------+ | | | ||
| +--+--+ | | | | ||
| | +------------+ | | | ||
| | ||Account(s)|| | has +-----------+ | | ||
| | |------------------------->Signatories| | | ||
| | +-----------------+ +-----------+ | | ||
| | | | | ||
| | | has +--------+ | | ||
| | +------->Asset(s)| | | ||
| | +--------+ | | ||
| +-----------------------------------------------+ | ||
|
|
||
| ``` |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
src/guide/blockchain/assets.md
Outdated
| 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). |
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
My understanding is that Store/Numeric corresponds to NFT/FT, respectively
There was a problem hiding this comment.
@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.
There was a problem hiding this comment.
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 ?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
src/guide/blockchain/assets.md
Outdated
| 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 |
There was a problem hiding this comment.
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"
src/guide/blockchain/assets.md
Outdated
| 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**. |
There was a problem hiding this comment.
We only have Numeric now, which is backed by the rust_decimal crate.
src/guide/blockchain/assets.md
Outdated
| 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). |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Yes, "metadata" sounds secondary, but it should be primary in Store assets
src/guide/blockchain/expressions.md
Outdated
| @@ -0,0 +1,17 @@ | |||
| # Expressions, Conditionals, Logic | |||
There was a problem hiding this comment.
Outdated section. This was replaced by Custom Instructions, which should be documented with the Executor probably.
src/guide/blockchain/instructions.md
Outdated
| | [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. | |
src/guide/blockchain/metadata.md
Outdated
|
|
||
| - domains | ||
| - accounts | ||
| - assets |
There was a problem hiding this comment.
Yes, but it's not exactly what attached to the main object
src/guide/blockchain/metadata.md
Outdated
| 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 |
There was a problem hiding this comment.
Metadata maps keys to JSON strings: hyperledger-iroha/iroha#4353
src/guide/blockchain/world.md
Outdated
| - Iroha [configuration parameters](./../configure/client-configuration.md) | ||
| - the list of | ||
| [trusted peers](/guide/configure/peer-configuration#trusted-peers) | ||
| - registered domains |
There was a problem hiding this comment.
These have been unnested from domains, see hyperledger-iroha/iroha#3921:
- accounts
- asset definitions
- assets
src/guide/blockchain/wasm.md
Outdated
There was a problem hiding this comment.
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]>
Signed-off-by: tarmovannas <[email protected]>
PR to hopefully use for comments. Do not merge this.