search

olta-art / olta.js

2 stars 0 forks source link

improve explanation on generated properties #8

Closed george-e-d-g-e closed 6 months ago

george-e-d-g-e commented 6 months ago

When talking about generated properties in the docs it is confusing.

Line in question: https://github.com/olta-art/olta.js/blob/b91883ca1b0394360e92c72268730d5198d6fa2e/README.md?plain=1#L136

Is there a better place to introduce this concept? Can it be handled in a clearer manner?

The reason it is useful is for updating a document you need an id hence introducing _id early on. For sorting based on user you can use the _creator and for order you can use _sortkey

Currently the hidden properties are defined here and there is _id, _sortkey and _creator

terencereilly commented 6 months ago

Ok, thanks for explaining. Right, I see both _ID and _creator properties on the contracts :) So the _sortkey property can be used to create the timeline feature, right?

george-e-d-g-e commented 6 months ago

_sortkey property can be used to create the timeline feature, right?

currently not really. It is just a counter of number of transactions on the contract. It is more for ordering as it lacks any time related data.

May be worth adding _timeCreated _timeUpdated but... to fully implement a timeline feature my feeling is it is best not on the smart-contract and instead use an indexing service like a subgraph on the graph. The reason being you get all the querying power and you don't increase the fee's paid to interact.