Skip to content

Commit e07e673

Browse files
committed
docs: update draft docs for contracts
1 parent b6b8894 commit e07e673

File tree

3 files changed

+25
-25
lines changed

3 files changed

+25
-25
lines changed

contracts/okp4-cognitarium.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ Instantiate message
1313
|parameter|description|
1414
|----------|-----------|
1515
|`limits`|**[StoreLimitsInput](#storelimitsinput)**. Limitations regarding store usage.|
16-
|`limits.max_byte_size`|**[Uint128](#uint128)**. The maximum number of bytes the store can contains. The size of a triple is counted as the sum of the size of its subject, predicate and object, including the size of data types and language tags if any. Default to [Uint128::MAX] if not set, which can be considered as no limit.<br />**Default:** `"340282366920938463463374607431768211455"`|
17-
|`limits.max_insert_data_byte_size`|**[Uint128](#uint128)**. The maximum number of bytes an insert data query can contains. Default to [Uint128::MAX] if not set, which can be considered as no limit.<br />**Default:** `"340282366920938463463374607431768211455"`|
18-
|`limits.max_insert_data_triple_count`|**[Uint128](#uint128)**. The maximum number of triples an insert data query can contains (after parsing). Default to [Uint128::MAX] if not set, which can be considered as no limit.<br />**Default:** `"340282366920938463463374607431768211455"`|
16+
|`limits.max_byte_size`|**[Uint128](#uint128)**. The maximum number of bytes the store can contain. The size of a triple is counted as the sum of the size of its subject, predicate and object, including the size of data types and language tags if any. Default to [Uint128::MAX] if not set, which can be considered as no limit.<br />**Default:** `"340282366920938463463374607431768211455"`|
17+
|`limits.max_insert_data_byte_size`|**[Uint128](#uint128)**. The maximum number of bytes an insert data query can contain. Default to [Uint128::MAX] if not set, which can be considered as no limit.<br />**Default:** `"340282366920938463463374607431768211455"`|
18+
|`limits.max_insert_data_triple_count`|**[Uint128](#uint128)**. The maximum number of triples an insert data query can contain (after parsing). Default to [Uint128::MAX] if not set, which can be considered as no limit.<br />**Default:** `"340282366920938463463374607431768211455"`|
1919
|`limits.max_query_limit`|**integer**. The maximum limit of a query, i.e. the maximum number of triples returned by a select query. Default to 30 if not set.<br />**Default:** `30`|
2020
|`limits.max_query_variable_count`|**integer**. The maximum number of variables a query can select. Default to 30 if not set.<br />**Default:** `30`|
21-
|`limits.max_triple_byte_size`|**[Uint128](#uint128)**. The maximum number of bytes the store can contains for a single triple. The size of a triple is counted as the sum of the size of its subject, predicate and object, including the size of data types and language tags if any. The limit is used to prevent storing very large triples, especially literals. Default to [Uint128::MAX] if not set, which can be considered as no limit.<br />**Default:** `"340282366920938463463374607431768211455"`|
22-
|`limits.max_triple_count`|**[Uint128](#uint128)**. The maximum number of triples the store can contains. Default to [Uint128::MAX] if not set, which can be considered as no limit.<br />**Default:** `"340282366920938463463374607431768211455"`|
21+
|`limits.max_triple_byte_size`|**[Uint128](#uint128)**. The maximum number of bytes the store can contain for a single triple. The size of a triple is counted as the sum of the size of its subject, predicate and object, including the size of data types and language tags if any. The limit is used to prevent storing very large triples, especially literals. Default to [Uint128::MAX] if not set, which can be considered as no limit.<br />**Default:** `"340282366920938463463374607431768211455"`|
22+
|`limits.max_triple_count`|**[Uint128](#uint128)**. The maximum number of triples the store can contain. Default to [Uint128::MAX] if not set, which can be considered as no limit.<br />**Default:** `"340282366920938463463374607431768211455"`|
2323

2424
## ExecuteMsg
2525

@@ -131,13 +131,13 @@ Contains information related to triple store.
131131
|property|description|
132132
|----------|-----------|
133133
|`limits`|*(Required.) * **[StoreLimits](#storelimits)**. The store limits.|
134-
|`limits.max_byte_size`|**[Uint128](#uint128)**. The maximum number of bytes the store can contains. The size of a triple is counted as the sum of the size of its subject, predicate and object, including the size of data types and language tags if any.|
135-
|`limits.max_insert_data_byte_size`|**[Uint128](#uint128)**. The maximum number of bytes an insert data query can contains.|
136-
|`limits.max_insert_data_triple_count`|**[Uint128](#uint128)**. The maximum number of triples an insert data query can contains (after parsing).|
134+
|`limits.max_byte_size`|**[Uint128](#uint128)**. The maximum number of bytes the store can contain. The size of a triple is counted as the sum of the size of its subject, predicate and object, including the size of data types and language tags if any.|
135+
|`limits.max_insert_data_byte_size`|**[Uint128](#uint128)**. The maximum number of bytes an insert data query can contain.|
136+
|`limits.max_insert_data_triple_count`|**[Uint128](#uint128)**. The maximum number of triples an insert data query can contain (after parsing).|
137137
|`limits.max_query_limit`|**integer**. The maximum limit of a query, i.e. the maximum number of triples returned by a select query.|
138138
|`limits.max_query_variable_count`|**integer**. The maximum number of variables a query can select.|
139-
|`limits.max_triple_byte_size`|**[Uint128](#uint128)**. The maximum number of bytes the store can contains for a single triple. The size of a triple is counted as the sum of the size of its subject, predicate and object, including the size of data types and language tags if any. The limit is used to prevent storing very large triples, especially literals.|
140-
|`limits.max_triple_count`|**[Uint128](#uint128)**. The maximum number of triples the store can contains.|
139+
|`limits.max_triple_byte_size`|**[Uint128](#uint128)**. The maximum number of bytes the store can contain for a single triple. The size of a triple is counted as the sum of the size of its subject, predicate and object, including the size of data types and language tags if any. The limit is used to prevent storing very large triples, especially literals.|
140+
|`limits.max_triple_count`|**[Uint128](#uint128)**. The maximum number of triples the store can contain.|
141141
|`owner`|*(Required.) * **string**. The store owner.|
142142
|`stat`|*(Required.) * **[StoreStat](#storestat)**. The store current usage.|
143143
|`stat.byte_size`|**[Uint128](#uint128)**. The total triple size in the store, in bytes.|
@@ -345,27 +345,27 @@ Contains limitations regarding store usages.
345345

346346
|property|description|
347347
|----------|-----------|
348-
|`max_byte_size`|*(Required.) * **[Uint128](#uint128)**. The maximum number of bytes the store can contains. The size of a triple is counted as the sum of the size of its subject, predicate and object, including the size of data types and language tags if any.|
349-
|`max_insert_data_byte_size`|*(Required.) * **[Uint128](#uint128)**. The maximum number of bytes an insert data query can contains.|
350-
|`max_insert_data_triple_count`|*(Required.) * **[Uint128](#uint128)**. The maximum number of triples an insert data query can contains (after parsing).|
348+
|`max_byte_size`|*(Required.) * **[Uint128](#uint128)**. The maximum number of bytes the store can contain. The size of a triple is counted as the sum of the size of its subject, predicate and object, including the size of data types and language tags if any.|
349+
|`max_insert_data_byte_size`|*(Required.) * **[Uint128](#uint128)**. The maximum number of bytes an insert data query can contain.|
350+
|`max_insert_data_triple_count`|*(Required.) * **[Uint128](#uint128)**. The maximum number of triples an insert data query can contain (after parsing).|
351351
|`max_query_limit`|*(Required.) * **integer**. The maximum limit of a query, i.e. the maximum number of triples returned by a select query.|
352352
|`max_query_variable_count`|*(Required.) * **integer**. The maximum number of variables a query can select.|
353-
|`max_triple_byte_size`|*(Required.) * **[Uint128](#uint128)**. The maximum number of bytes the store can contains for a single triple. The size of a triple is counted as the sum of the size of its subject, predicate and object, including the size of data types and language tags if any. The limit is used to prevent storing very large triples, especially literals.|
354-
|`max_triple_count`|*(Required.) * **[Uint128](#uint128)**. The maximum number of triples the store can contains.|
353+
|`max_triple_byte_size`|*(Required.) * **[Uint128](#uint128)**. The maximum number of bytes the store can contain for a single triple. The size of a triple is counted as the sum of the size of its subject, predicate and object, including the size of data types and language tags if any. The limit is used to prevent storing very large triples, especially literals.|
354+
|`max_triple_count`|*(Required.) * **[Uint128](#uint128)**. The maximum number of triples the store can contain.|
355355

356356
### StoreLimitsInput
357357

358358
Contains requested limitations regarding store usages.
359359

360360
|property|description|
361361
|----------|-----------|
362-
|`max_byte_size`|**[Uint128](#uint128)**. The maximum number of bytes the store can contains. The size of a triple is counted as the sum of the size of its subject, predicate and object, including the size of data types and language tags if any. Default to [Uint128::MAX] if not set, which can be considered as no limit.|
363-
|`max_insert_data_byte_size`|**[Uint128](#uint128)**. The maximum number of bytes an insert data query can contains. Default to [Uint128::MAX] if not set, which can be considered as no limit.|
364-
|`max_insert_data_triple_count`|**[Uint128](#uint128)**. The maximum number of triples an insert data query can contains (after parsing). Default to [Uint128::MAX] if not set, which can be considered as no limit.|
362+
|`max_byte_size`|**[Uint128](#uint128)**. The maximum number of bytes the store can contain. The size of a triple is counted as the sum of the size of its subject, predicate and object, including the size of data types and language tags if any. Default to [Uint128::MAX] if not set, which can be considered as no limit.|
363+
|`max_insert_data_byte_size`|**[Uint128](#uint128)**. The maximum number of bytes an insert data query can contain. Default to [Uint128::MAX] if not set, which can be considered as no limit.|
364+
|`max_insert_data_triple_count`|**[Uint128](#uint128)**. The maximum number of triples an insert data query can contain (after parsing). Default to [Uint128::MAX] if not set, which can be considered as no limit.|
365365
|`max_query_limit`|**integer**. The maximum limit of a query, i.e. the maximum number of triples returned by a select query. Default to 30 if not set.|
366366
|`max_query_variable_count`|**integer**. The maximum number of variables a query can select. Default to 30 if not set.|
367-
|`max_triple_byte_size`|**[Uint128](#uint128)**. The maximum number of bytes the store can contains for a single triple. The size of a triple is counted as the sum of the size of its subject, predicate and object, including the size of data types and language tags if any. The limit is used to prevent storing very large triples, especially literals. Default to [Uint128::MAX] if not set, which can be considered as no limit.|
368-
|`max_triple_count`|**[Uint128](#uint128)**. The maximum number of triples the store can contains. Default to [Uint128::MAX] if not set, which can be considered as no limit.|
367+
|`max_triple_byte_size`|**[Uint128](#uint128)**. The maximum number of bytes the store can contain for a single triple. The size of a triple is counted as the sum of the size of its subject, predicate and object, including the size of data types and language tags if any. The limit is used to prevent storing very large triples, especially literals. Default to [Uint128::MAX] if not set, which can be considered as no limit.|
368+
|`max_triple_count`|**[Uint128](#uint128)**. The maximum number of triples the store can contain. Default to [Uint128::MAX] if not set, which can be considered as no limit.|
369369

370370
### StoreStat
371371

@@ -478,4 +478,4 @@ Represents a condition in a [WhereClause].
478478

479479
---
480480

481-
*Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `okp4-cognitarium.json` (`889a2c1536ecfea5`)*
481+
*Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `okp4-cognitarium.json` (`889a2c1536ecfea5`)*

contracts/okp4-law-stone.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
The `okp4-law-stone` smart contract aims to provide GaaS (i.e. Governance as a Service) in any [Cosmos blockchains](https://cosmos.network/) using the [CosmWasm](https://cosmwasm.com/) framework and the [Logic](https://docs.okp4.network/modules/next/logic) OKP4 module.
66

7-
This contract is built around a Prolog program describing the law by rules and facts. The law stone is immutable, this means it can only been questioned, there is no update mechanisms.
7+
This contract is built around a Prolog program describing the law by rules and facts. The law stone is immutable, this means it can only be questioned, there are no update mechanisms.
88

99
The `okp4-law-stone` responsibility is to guarantee the availability of its rules in order to question them, but not to ensure the rules application.
1010

@@ -126,4 +126,4 @@ A string containing Base64-encoded data.
126126

127127
---
128128

129-
*Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `okp4-law-stone.json` (`20c06a648259a4b3`)*
129+
*Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `okp4-law-stone.json` (`20c06a648259a4b3`)*

contracts/okp4-objectarium.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Instantiate messages
116116
|`limits.max_total_size`|**[Uint128](#uint128)\|null**. The maximum total size of the objects in the bucket.|
117117
|`pagination`|**[PaginationConfig](#paginationconfig)**. The configuration for paginated query.|
118118
|`pagination.default_page_size`|**integer**. The default number of elements in a page.<br /><br />Shall be less or equal than `max_page_size`. Default to '10' if not set.<br />**Default:** `10`|
119-
|`pagination.max_page_size`|**integer**. The maximum elements a page can contains.<br /><br />Shall be less than `u32::MAX - 1`. Default to '30' if not set.<br />**Default:** `30`|
119+
|`pagination.max_page_size`|**integer**. The maximum elements a page can contain.<br /><br />Shall be less than `u32::MAX - 1`. Default to '30' if not set.<br />**Default:** `30`|
120120

121121
## ExecuteMsg
122122

@@ -471,4 +471,4 @@ A string containing a 128-bit integer in decimal representation.
471471

472472
---
473473

474-
*Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `okp4-objectarium.json` (`8624f6ec32a56a5d`)*
474+
*Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `okp4-objectarium.json` (`8624f6ec32a56a5d`)*

0 commit comments

Comments
 (0)