From 9d692d4e74aea95c95865a675c55f0acf5a2d5b3 Mon Sep 17 00:00:00 2001 From: Bot Anik <98603954+bot-anik@users.noreply.github.com> Date: Thu, 28 Sep 2023 14:29:38 +0000 Subject: [PATCH] docs(contracts): add contracts v3.0.0 version --- contracts/okp4-cognitarium.md | 2 +- contracts/okp4-law-stone.md | 2 +- contracts/okp4-objectarium.md | 2 +- .../version-v3.0.0/okp4-cognitarium.md | 481 ++++++++++++++++ .../version-v3.0.0/okp4-law-stone.md | 129 +++++ .../version-v3.0.0/okp4-objectarium.md | 519 ++++++++++++++++++ .../version-v3.0.0-sidebars.json | 8 + contracts_versions.json | 1 + 8 files changed, 1141 insertions(+), 3 deletions(-) create mode 100644 contracts_versioned_docs/version-v3.0.0/okp4-cognitarium.md create mode 100644 contracts_versioned_docs/version-v3.0.0/okp4-law-stone.md create mode 100644 contracts_versioned_docs/version-v3.0.0/okp4-objectarium.md create mode 100644 contracts_versioned_sidebars/version-v3.0.0-sidebars.json diff --git a/contracts/okp4-cognitarium.md b/contracts/okp4-cognitarium.md index 9915ffbec7c..31d762dcb56 100644 --- a/contracts/okp4-cognitarium.md +++ b/contracts/okp4-cognitarium.md @@ -478,4 +478,4 @@ Represents a condition in a [WhereClause]. --- -*Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `okp4-cognitarium.json` (`f3c6fe24ffc06133`)* \ No newline at end of file +*Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `okp4-cognitarium.json` (`0b746186a6e8df78`)* \ No newline at end of file diff --git a/contracts/okp4-law-stone.md b/contracts/okp4-law-stone.md index 085b88f53de..d1a628a8f98 100644 --- a/contracts/okp4-law-stone.md +++ b/contracts/okp4-law-stone.md @@ -126,4 +126,4 @@ A string containing Base64-encoded data. --- -*Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `okp4-law-stone.json` (`d2b5da624dff3dad`)* \ No newline at end of file +*Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `okp4-law-stone.json` (`023b72150b485c6b`)* \ No newline at end of file diff --git a/contracts/okp4-objectarium.md b/contracts/okp4-objectarium.md index c64eceb6752..afd8b3e3714 100644 --- a/contracts/okp4-objectarium.md +++ b/contracts/okp4-objectarium.md @@ -516,4 +516,4 @@ A string containing a 128-bit integer in decimal representation. --- -*Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `okp4-objectarium.json` (`c9bbaeefb8b85833`)* \ No newline at end of file +*Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `okp4-objectarium.json` (`51f0131cd7a4ebf9`)* \ No newline at end of file diff --git a/contracts_versioned_docs/version-v3.0.0/okp4-cognitarium.md b/contracts_versioned_docs/version-v3.0.0/okp4-cognitarium.md new file mode 100644 index 00000000000..31d762dcb56 --- /dev/null +++ b/contracts_versioned_docs/version-v3.0.0/okp4-cognitarium.md @@ -0,0 +1,481 @@ +# Cognitarium + +## Overview + +The `okp4-cognitarium` smart contract enables the storage of [RDF graphs triples](https://en.wikipedia.org/wiki/Semantic_triple) (i.e. `subject`-`predicate`-`object`) in any [Cosmos blockchains](https://cosmos.network/) using the [CosmWasm](https://cosmwasm.com/) framework. + +➡️ Checkout the [examples](https://github.com/okp4/contracts/tree/main/contracts/okp4-cognitarium/examples/) for usage information. + +## InstantiateMsg + +Instantiate message + +|parameter|description| +|----------|-----------| +|`limits`|**[StoreLimitsInput](#storelimitsinput)**. Limitations regarding store usage.| +|`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.
**Default:** `"340282366920938463463374607431768211455"`| +|`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.
**Default:** `"340282366920938463463374607431768211455"`| +|`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.
**Default:** `"340282366920938463463374607431768211455"`| +|`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.
**Default:** `30`| +|`limits.max_query_variable_count`|**integer**. The maximum number of variables a query can select. Default to 30 if not set.
**Default:** `30`| +|`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.
**Default:** `"340282366920938463463374607431768211455"`| +|`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.
**Default:** `"340282366920938463463374607431768211455"`| + +## ExecuteMsg + +Execute messages + +### ExecuteMsg::InsertData + +Insert the data as RDF triples in the store. For already existing triples it acts as no-op. + +Only the smart contract owner (i.e. the address who instantiated it) is authorized to perform this action. + +|parameter|description| +|----------|-----------| +|`insert_data`|*(Required.) * **object**. | +|`insert_data.data`|*(Required.) * **[Binary](#binary)**. The data to insert. The data must be serialized in the format specified by the `format` field. And the data are subject to the limitations defined by the `limits` specified at contract instantiation.| +|`insert_data.format`|**[DataFormat](#dataformat)\|null**. The data format in which the triples are serialized. If not provided, the default format is [Turtle](https://www.w3.org/TR/turtle/) format.| + +### ExecuteMsg::DeleteData + +Delete the data (RDF triples) from the store matching the patterns defined by the provided query. For non-existing triples it acts as no-op. + +Example: ```json { "prefixes": [ { "prefix": "foaf", "namespace": "http://xmlns.com/foaf/0.1/" } ], "delete": [ { "subject": { "variable": "s" }, "predicate": { "variable": "p" }, "object": { "variable": "o" } } ], "where": [ { "simple": { "triplePattern": { "subject": { "variable": "s" }, "predicate": { "node": { "namedNode": {"prefixed": "foaf:givenName"} } }, "object": { "literal": { "simple": "Myrddin" } } } } }, { "simple": { "triplePattern": { "subject": { "variable": "s" }, "predicate": { "variable": "p" }, "object": { "variable": "o" } } } } ] ``` + +Only the smart contract owner (i.e. the address who instantiated it) is authorized to perform this action. + +|parameter|description| +|----------|-----------| +|`delete_data`|*(Required.) * **object**. | +|`delete_data.delete`|*(Required.) * **Array<[TriplePattern](#triplepattern)>**. Specifies the specific triple patterns to delete. If nothing is provided, the patterns from the `where` clause are used for deletion.| +|`delete_data.prefixes`|*(Required.) * **Array<[Prefix](#prefix)>**. The prefixes used in the operation.| +|`delete_data.where`|*(Required.) * **Array<[WhereCondition](#wherecondition)>**. Defines the patterns that data (RDF triples) should match in order for it to be considered for deletion.| + +## QueryMsg + +Query messages + +### QueryMsg::Store + +Returns information about the triple store. + +|literal| +|-------| +|`"store"`| + +### QueryMsg::Select + +Returns the resources matching the criteria defined by the provided query. + +|parameter|description| +|----------|-----------| +|`select`|*(Required.) * **object**. | +|`select.query`|*(Required.) * **[SelectQuery](#selectquery)**. The query to execute.| + +### QueryMsg::Describe + +Returns a description of the resource identified by the provided IRI as a set of RDF triples serialized in the provided format. + +|parameter|description| +|----------|-----------| +|`describe`|*(Required.) * **object**. | +|`describe.format`|**[DataFormat](#dataformat)\|null**. The format in which the triples are serialized. If not provided, the default format is [Turtle](https://www.w3.org/TR/turtle/) format.| +|`describe.query`|*(Required.) * **[DescribeQuery](#describequery)**. The query to execute.| + +### QueryMsg::Construct + +Returns the resources matching the criteria defined by the provided query as a set of RDF triples serialized in the provided format. + +|parameter|description| +|----------|-----------| +|`construct`|*(Required.) * **object**. | +|`construct.format`|**[DataFormat](#dataformat)\|null**. The format in which the triples are serialized. If not provided, the default format is [Turtle](https://www.w3.org/TR/turtle/) format.| +|`construct.query`|*(Required.) * **[ConstructQuery](#constructquery)**. The query to execute.| + +## Responses + +### construct + +Represents the response of a [QueryMsg::Construct] query. + +|property|description| +|----------|-----------| +|`data`|*(Required.) * **[Binary](#binary)**. The data serialized in the specified format.| +|`format`|*(Required.) * **[DataFormat](#dataformat)**. The format of the data.| + +### describe + +Represents the response of a [QueryMsg::Describe] query. + +|property|description| +|----------|-----------| +|`data`|*(Required.) * **[Binary](#binary)**. The data serialized in the specified format.| +|`format`|*(Required.) * **[DataFormat](#dataformat)**. The format of the data.| + +### select + +Represents the response of a [QueryMsg::Select] query. + +|property|description| +|----------|-----------| +|`head`|*(Required.) * **[Head](#head)**. The head of the response, i.e. the set of variables mentioned in the results.| +|`head.vars`|**Array<string>**. The variables selected in the query.| +|`results`|*(Required.) * **[Results](#results)**. The results of the select query.| +|`results.bindings`|**Array<object>**. The bindings of the results.| + +### store + +Contains information related to triple store. + +|property|description| +|----------|-----------| +|`limits`|*(Required.) * **[StoreLimits](#storelimits)**. The store limits.| +|`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.| +|`limits.max_insert_data_byte_size`|**[Uint128](#uint128)**. The maximum number of bytes an insert data query can contain.| +|`limits.max_insert_data_triple_count`|**[Uint128](#uint128)**. The maximum number of triples an insert data query can contain (after parsing).| +|`limits.max_query_limit`|**integer**. The maximum limit of a query, i.e. the maximum number of triples returned by a select query.| +|`limits.max_query_variable_count`|**integer**. The maximum number of variables a query can select.| +|`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.| +|`limits.max_triple_count`|**[Uint128](#uint128)**. The maximum number of triples the store can contain.| +|`owner`|*(Required.) * **string**. The store owner.| +|`stat`|*(Required.) * **[StoreStat](#storestat)**. The store current usage.| +|`stat.byte_size`|**[Uint128](#uint128)**. The total triple size in the store, in bytes.| +|`stat.namespace_count`|**[Uint128](#uint128)**. The total number of IRI namespace present in the store.| +|`stat.triple_count`|**[Uint128](#uint128)**. The total number of triple present in the store.| + +## Definitions + +### Binary + +A string containing Base64-encoded data. + +|type| +|----| +|**string**.| + +### BlankNode + +An RDF [blank node](https://www.w3.org/TR/rdf11-concepts/#dfn-blank-node). + +|property|description| +|----------|-----------| +|`blank_node`|*(Required.) * **string**. | + +### ConstructQuery + +Represents a CONSTRUCT query over the triple store, allowing to retrieve a set of triples serialized in a specific format. + +|property|description| +|----------|-----------| +|`construct`|*(Required.) * **Array<[TriplePattern](#triplepattern)>**. The triples to construct. If nothing is provided, the patterns from the `where` clause are used for construction.| +|`prefixes`|*(Required.) * **Array<[Prefix](#prefix)>**. The prefixes used in the query.| +|`where`|*(Required.) * **Array<[WhereCondition](#wherecondition)>**. The WHERE clause. This clause is used to specify the triples to construct using variable bindings.| + +### DataFormat + +Represents the format in which the data are serialized, for example when returned by a query or when inserted in the store. + +|variant|description| +|-------|-----------| +|[RDF XML](#rdf-xml)|**string**: `rdf_xml`. Output in [RDF/XML](https://www.w3.org/TR/rdf-syntax-grammar/) format.| +|[Turtle](#turtle)|**string**: `turtle`. Output in [Turtle](https://www.w3.org/TR/turtle/) format.| +|[N-Triples](#n-triples)|**string**: `n_triples`. Output in [N-Triples](https://www.w3.org/TR/n-triples/) format.| +|[N-Quads](#n-quads)|**string**: `n_quads`. Output in [N-Quads](https://www.w3.org/TR/n-quads/) format.| + +### DescribeQuery + +Represents a DESCRIBE query over the triple store, allowing to retrieve a description of a resource as a set of triples serialized in a specific format. + +|property|description| +|----------|-----------| +|`prefixes`|*(Required.) * **Array<[Prefix](#prefix)>**. The prefixes used in the query.| +|`resource`|*(Required.) * **[VarOrNamedNode](#varornamednode)**. The resource to describe given as a variable or a node.| +|`where`|*(Required.) * **Array<[WhereCondition](#wherecondition)>**. The WHERE clause. This clause is used to specify the resource identifier to describe using variable bindings.| + +### Full + +A full IRI. + +|property|description| +|----------|-----------| +|`full`|*(Required.) * **string**. | + +### Head + +Represents the head of a [SelectResponse]. + +|property|description| +|----------|-----------| +|`vars`|*(Required.) * **Array<string>**. The variables selected in the query.| + +### IRI + +Represents an IRI. + +|variant|description| +|-------|-----------| +|[Prefixed](#prefixed)|**object**. An IRI prefixed with a prefix. The prefixed IRI is expanded to a full IRI using the prefix definition specified in the query. For example, the prefixed IRI `rdf:type` is expanded to `http://www.w3.org/1999/02/22-rdf-syntax-ns#type`.| +|[Full](#full)|**object**. A full IRI.| + +### LanguageTaggedString + +A [language-tagged string](https://www.w3.org/TR/rdf11-concepts/#dfn-language-tagged-string) + +|property|description| +|----------|-----------| +|`language_tagged_string`|*(Required.) * **object**. | +|`language_tagged_string.language`|*(Required.) * **string**. The [language tag](https://www.w3.org/TR/rdf11-concepts/#dfn-language-tag).| +|`language_tagged_string.value`|*(Required.) * **string**. The [lexical form](https://www.w3.org/TR/rdf11-concepts/#dfn-lexical-form).| + +### Literal + +An RDF [literal](https://www.w3.org/TR/rdf11-concepts/#dfn-literal). + +|variant|description| +|-------|-----------| +|[Simple](#simple)|**object**. A [simple literal](https://www.w3.org/TR/rdf11-concepts/#dfn-simple-literal) without datatype or language form.| +|[LanguageTaggedString](#languagetaggedstring)|**object**. A [language-tagged string](https://www.w3.org/TR/rdf11-concepts/#dfn-language-tagged-string)| +|[TypedValue](#typedvalue)|**object**. A value with a datatype.| + +### N-Quads + +Output in [N-Quads](https://www.w3.org/TR/n-quads/) format. + +|literal| +|-------| +|`"n_quads"`| + +### N-Triples + +Output in [N-Triples](https://www.w3.org/TR/n-triples/) format. + +|literal| +|-------| +|`"n_triples"`| + +### NamedNode + +An RDF [IRI](https://www.w3.org/TR/rdf11-concepts/#dfn-iri). + +|property|description| +|----------|-----------| +|`named_node`|*(Required.) * **[Prefixed](#prefixed)\|[Full](#full)**. | + +### Node + +Represents either an IRI (named node) or a blank node. + +|variant|description| +|-------|-----------| +|[NamedNode](#namednode)|**object**. An RDF [IRI](https://www.w3.org/TR/rdf11-concepts/#dfn-iri).| +|[BlankNode](#blanknode)|**object**. An RDF [blank node](https://www.w3.org/TR/rdf11-concepts/#dfn-blank-node).| + +### Prefix + +Represents a prefix, i.e. a shortcut for a namespace used in a query. + +|property|description| +|----------|-----------| +|`namespace`|*(Required.) * **string**. The namespace associated with the prefix.| +|`prefix`|*(Required.) * **string**. The prefix.| + +### Prefixed + +An IRI prefixed with a prefix. The prefixed IRI is expanded to a full IRI using the prefix definition specified in the query. For example, the prefixed IRI `rdf:type` is expanded to `http://www.w3.org/1999/02/22-rdf-syntax-ns#type`. + +|property|description| +|----------|-----------| +|`prefixed`|*(Required.) * **string**. | + +### RDF XML + +Output in [RDF/XML](https://www.w3.org/TR/rdf-syntax-grammar/) format. + +|literal| +|-------| +|`"rdf_xml"`| + +### Results + +Represents the results of a [SelectResponse]. + +|property|description| +|----------|-----------| +|`bindings`|*(Required.) * **Array<object>**. The bindings of the results.| + +### SelectItem + +Represents an item to select in a [SelectQuery]. + +|variant|description| +|-------|-----------| +|[Variable](#variable)|**object**. Represents a variable.| + +### SelectQuery + +Represents a SELECT query over the triple store, allowing to select variables to return and to filter the results. + +|property|description| +|----------|-----------| +|`limit`|**integer\|null**. The maximum number of results to return. If `None`, there is no limit. Note: the value of the limit cannot exceed the maximum query limit defined in the store limitations.| +|`prefixes`|*(Required.) * **Array<[Prefix](#prefix)>**. The prefixes used in the query.| +|`select`|*(Required.) * **Array<[SelectItem](#selectitem)>**. The items to select. Note: the number of items to select cannot exceed the maximum query variable count defined in the store limitations.| +|`where`|*(Required.) * **Array<[WhereCondition](#wherecondition)>**. The WHERE clause. If `None`, there is no WHERE clause, i.e. all triples are returned without filtering.| + +### Simple + +A [simple literal](https://www.w3.org/TR/rdf11-concepts/#dfn-simple-literal) without datatype or language form. + +|property|description| +|----------|-----------| +|`simple`|*(Required.) * **string**. | + +### SimpleWhereCondition + +Represents a simple condition in a [WhereCondition]. + +|variant|description| +|-------|-----------| +|[TriplePattern](#triplepattern)|**object**. Represents a triple pattern, i.e. a condition on a triple based on its subject, predicate and object.| + +### StoreLimits + +Contains limitations regarding store usages. + +|property|description| +|----------|-----------| +|`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.| +|`max_insert_data_byte_size`|*(Required.) * **[Uint128](#uint128)**. The maximum number of bytes an insert data query can contain.| +|`max_insert_data_triple_count`|*(Required.) * **[Uint128](#uint128)**. The maximum number of triples an insert data query can contain (after parsing).| +|`max_query_limit`|*(Required.) * **integer**. The maximum limit of a query, i.e. the maximum number of triples returned by a select query.| +|`max_query_variable_count`|*(Required.) * **integer**. The maximum number of variables a query can select.| +|`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.| +|`max_triple_count`|*(Required.) * **[Uint128](#uint128)**. The maximum number of triples the store can contain.| + +### StoreLimitsInput + +Contains requested limitations regarding store usages. + +|property|description| +|----------|-----------| +|`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.| +|`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.| +|`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.| +|`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.| +|`max_query_variable_count`|**integer**. The maximum number of variables a query can select. Default to 30 if not set.| +|`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.| +|`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.| + +### StoreStat + +Contains usage information about the triple store. + +|property|description| +|----------|-----------| +|`byte_size`|*(Required.) * **[Uint128](#uint128)**. The total triple size in the store, in bytes.| +|`namespace_count`|*(Required.) * **[Uint128](#uint128)**. The total number of IRI namespace present in the store.| +|`triple_count`|*(Required.) * **[Uint128](#uint128)**. The total number of triple present in the store.| + +### TriplePattern + +Represents a triple pattern in a [SimpleWhereCondition]. + +|property|description| +|----------|-----------| +|`object`|*(Required.) * **[VarOrNodeOrLiteral](#varornodeorliteral)**. The object of the triple pattern.| +|`predicate`|*(Required.) * **[VarOrNode](#varornode)**. The predicate of the triple pattern.| +|`subject`|*(Required.) * **[VarOrNode](#varornode)**. The subject of the triple pattern.| + +### Turtle + +Output in [Turtle](https://www.w3.org/TR/turtle/) format. + +|literal| +|-------| +|`"turtle"`| + +### TypedValue + +A value with a datatype. + +|property|description| +|----------|-----------| +|`typed_value`|*(Required.) * **object**. | +|`typed_value.datatype`|*(Required.) * **[IRI](#iri)**. The [datatype IRI](https://www.w3.org/TR/rdf11-concepts/#dfn-datatype-iri).| +|`typed_value.value`|*(Required.) * **string**. The [lexical form](https://www.w3.org/TR/rdf11-concepts/#dfn-lexical-form).| + +### URI + +Represents an IRI. + +|property|description| +|----------|-----------| +|`type`|*(Required.) * **string**. | +|`value`|*(Required.) * **[IRI](#iri)**. The value of the IRI.| + +### Uint128 + +A string containing a 128-bit integer in decimal representation. + +|type| +|----| +|**string**.| + +### Value + + + +|variant|description| +|-------|-----------| +|[URI](#uri)|**object**. Represents an IRI.| +|[Literal](#literal)|**object**. Represents a literal S with optional language tag L or datatype IRI D.| +|[BlankNode](#blanknode)|**object**. Represents a blank node.| + +### VarOrNamedNode + +Represents either a variable or a named node (IRI). + +|variant|description| +|-------|-----------| +|[Variable](#variable)|**object**. A variable.| +|[NamedNode](#namednode)|**object**. An RDF [IRI](https://www.w3.org/TR/rdf11-concepts/#dfn-iri).| + +### VarOrNode + +Represents either a variable or a node. + +|variant|description| +|-------|-----------| +|[Variable](#variable)|**object**. A variable.| +|[Node](#node)|**object**. A node, i.e. an IRI or a blank node.| + +### VarOrNodeOrLiteral + +Represents either a variable, a node or a literal. + +|variant|description| +|-------|-----------| +|[Variable](#variable)|**object**. A variable.| +|[Node](#node)|**object**. A node, i.e. an IRI or a blank node.| +|[Literal](#literal)|**object**. An RDF [literal](https://www.w3.org/TR/rdf11-concepts/#dfn-literal), i.e. a simple literal, a language-tagged string or a typed value.| + +### Variable + +A variable. + +|property|description| +|----------|-----------| +|`variable`|*(Required.) * **string**. | + +### WhereCondition + +Represents a condition in a [WhereClause]. + +|variant|description| +|-------|-----------| +|[Simple](#simple)|**object**. Represents a simple condition.| + +--- + +*Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `okp4-cognitarium.json` (`0b746186a6e8df78`)* \ No newline at end of file diff --git a/contracts_versioned_docs/version-v3.0.0/okp4-law-stone.md b/contracts_versioned_docs/version-v3.0.0/okp4-law-stone.md new file mode 100644 index 00000000000..d1a628a8f98 --- /dev/null +++ b/contracts_versioned_docs/version-v3.0.0/okp4-law-stone.md @@ -0,0 +1,129 @@ +# Law Stone + +## Overview + +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. + +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. + +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. + +To ensure reliability over time, the associated Prolog program is stored and pinned in a `okp4-objectarium` contract. Moreover, all the eventual loaded files must be stored in a `okp4-objectarium` contract as well, allowing the contract to pin them. + +To be able to free the underlying resources (i.e. objects in `okp4-objectarium`) if not used anymore, the contract admin can break the stone. + +➡️ Checkout the [examples](https://github.com/okp4/contracts/tree/main/contracts/okp4-law-stone/examples/) for usage information. + +## InstantiateMsg + +Instantiate message + +|parameter|description| +|----------|-----------| +|`program`|*(Required.) * **[Binary](#binary)**. The Prolog program carrying law rules and facts.| +|`storage_address`|*(Required.) * **string**. The `okp4-objectarium` contract address on which to store the law program.| + +## ExecuteMsg + +Execute messages + +### ExecuteMsg::BreakStone + +Break the stone making this contract unusable, by clearing all the related resources: - Unpin all the pinned objects on `okp4-objectarium` contracts, if any. - Forget the main program (i.e. or at least unpin it). Only the contract admin is authorized to break it, if any. If already broken, this is a no-op. + +|literal| +|-------| +|`"break_stone"`| + +## QueryMsg + +Query messages + +### QueryMsg::Ask + +If not broken, ask the logic module the provided query with the law program loaded. + +|parameter|description| +|----------|-----------| +|`ask`|*(Required.) * **object**. | +|`ask.query`|*(Required.) * **string**. | + +### QueryMsg::Program + +If not broken, returns the law program location information. + +|literal| +|-------| +|`"program"`| + +## Responses + +### ask + + + +|property|description| +|----------|-----------| +|`answer`|**[Answer](#answer)\|null**. | +|`gas_used`|*(Required.) * **integer**. | +|`height`|*(Required.) * **integer**. | + +### program + +ProgramResponse carry elements to locate the program in a `okp4-objectarium` contract. + +|property|description| +|----------|-----------| +|`object_id`|*(Required.) * **string**. The program object id in the `okp4-objectarium` contract.| +|`storage_address`|*(Required.) * **string**. The `okp4-objectarium` contract address on which the law program is stored.| + +## Definitions + +### Answer + + + +|property|description| +|----------|-----------| +|`has_more`|*(Required.) * **boolean**. | +|`results`|*(Required.) * **Array<[Result](#result)>**. | +|`success`|*(Required.) * **boolean**. | +|`variables`|*(Required.) * **Array<string>**. | + +### Binary + +A string containing Base64-encoded data. + +|type| +|----| +|**string**.| + +### Result + + + +|property|description| +|----------|-----------| +|`substitutions`|*(Required.) * **Array<[Substitution](#substitution)>**. | + +### Substitution + + + +|property|description| +|----------|-----------| +|`term`|*(Required.) * **object**. | +|`variable`|*(Required.) * **string**. | + +### Term + + + +|property|description| +|----------|-----------| +|`arguments`|*(Required.) * **Array<[Term](#term)>**. | +|`name`|*(Required.) * **string**. | + +--- + +*Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `okp4-law-stone.json` (`023b72150b485c6b`)* \ No newline at end of file diff --git a/contracts_versioned_docs/version-v3.0.0/okp4-objectarium.md b/contracts_versioned_docs/version-v3.0.0/okp4-objectarium.md new file mode 100644 index 00000000000..afd8b3e3714 --- /dev/null +++ b/contracts_versioned_docs/version-v3.0.0/okp4-objectarium.md @@ -0,0 +1,519 @@ +# Objectarium + +A [CosmWasm](https://cosmwasm.com/) smart contract designed to store arbitrary objects on the blockchain. + +## Purpose + +The smart contract serves as a robust storage solution, allowing for the storage of arbitrary `objects` on any blockchain within the [Cosmos blockchains](https://cosmos.network/) network, utilizing the [CosmWasm](https://cosmwasm.com/) framework. The key features of the contract include: + +**Versatile Data Storage:** +The contract is designed to accommodate any type of data, be it text, images, or complex data structures. This flexibility makes it an ideal choice for a wide range of decentralized applications (dApps) that require diverse storage needs. + +**On-chain Data:** +By design, the contract stores data on the blockchain, ensuring that it is immutable and publicly accessible. This is particularly useful for applications that require a high level of transparency, and also for any other smart contract that needs to store data on the blockchain. + +**Pinning and Unpinning:** +One unique feature is the ability to 'pin' and 'unpin' objects associated with a specific sender address. Pinning ensures that the object remains stored and accessible, while unpinning releases it from being permanently stored, offering a level of control over data persistence. + +**Object Removal:** +The contract also includes a 'forget' function, allowing for the removal of objects that are no longer pinned. This is particularly useful for managing storage costs and ensuring that only relevant data remains on the blockchain. + +**Cost Management:** +Features like pinning, unpinning, and discarding objects offer a strategic way to control storage costs. Additionally, setting limits on contract size — for instance in terms of object count and their individual sizes — serves as a practical tool to regulate storage costs. + +## Rationale + +In a sense, we can consider blockchains built on the [Cosmos L0](https://docs.cosmos.network/main) layer as decentralized databases, and their nature can be shaped and modeled through the smart contracts or modules. Given this, it provides a great opportunity to address the wide range of data management needs. One such important area is the management of unstructured, immutable data, which is written once but accessed frequently — commonly known as object storage. This is the primary focus of `okp4-objectarium`: a specialized smart contract designed to offer a versatile and efficient approach to handling *on-chain*, *unstructured*, *immutable* data in a *decentralized* manner. + +## Terminology + +### Object + +In the context of the `okp4-objectarium` smart contract, an `object` refers to a piece of data stored on the blockchain. It can represent various types of information, such as documents, binary files, or any other digital content. Objects are immutable once stored and are identified by their cryptographic hash, which can be generated using algorithms like MD5 or SHA256. This ensures the integrity and security of the stored data, as any modification to the object would result in a different hash value. + +### Bucket + +The smart contract is organized around buckets. A bucket represents a logical container within the `okp4-objectarium` smart contract instance that groups related Objects together. It acts as a storage unit for Objects and provides a context for managing and organizing them. Each bucket has a unique name and is associated with a set of configurations and limits that define its behaviour and characteristics. + +### Pin + +Pin refers to a mechanism that allows users to mark or "pin" specific objects within a bucket. Pinning an object serves as a way to ensure that the object remains in storage and cannot be removed (this is called "forgotten"). It provides protection and guarantees that the pinned object will persist in the protocol. When an object is pinned, it is associated with the identity (or sender) that performed the pinning action. + +## Usage + +The unstructured nature of the data stored in the chain opens up a plethora of possibilities for decentralized applications that require this type of versatile storage. + +### In the OKP4 protocol + +The primary function of this smart contract within the OKP4 protocol is to enable the persistence of governance rules, which are encoded in Prolog. These programs are stored in an immutable format within the protocol and can be referenced by their unique identifiers in situations where there is a need to refer to these rules. + +### In the wild world + +A plethora of possibilities opens up for decentralized applications (dApps) that require this kind of versatile storage. However, it's important to consider the following constraints: the data is immutable, the cost of recording the data is proportional to its size, and the data is publicly accessible. + +## Play + +### Instantiation + +The `okp4-objectarium` can be instantiated as follows, refer to the schema for more information on configuration, limits and pagination configuration: + +```bash +okp4d tx wasm instantiate $CODE_ID \ + --label "my-storage" \ + --from $ADDR \ + --admin $ADMIN_ADDR \ + --gas 1000000 \ + --broadcast-mode block \ + '{"bucket":"my-bucket"}' +``` + +### Execution + +We can store an object by providing its data in base64 encoded, we can pin the stored object to prevent it from being removed: + +```bash +okp4d tx wasm execute $CONTRACT_ADDR \ + --from $ADDR \ + --gas 1000000 \ + --broadcast-mode block \ + "{\"store_object\":{\"data\": \"$(cat my-data | base64)\",\"pin\":true}}" +``` + +The object id is stable as it is a hash, we can't store an object twice. + +With the following commands we can pin and unpin existing objects: + +```bash +okp4d tx wasm execute $CONTRACT_ADDR \ + --from $ADDR \ + --gas 1000000 \ + --broadcast-mode block \ + "{\"pin_object\":{\"id\": \"$OBJECT_ID\"}}" + +okp4d tx wasm execute $CONTRACT_ADDR \ + --from $ADDR \ + --gas 1000000 \ + --broadcast-mode block \ + "{\"unpin_object\":{\"id\": \"$OBJECT_ID\"}}" +``` + +And if an object is not pinned, or pinned by the sender of transaction, we can remove it: + +```bash +okp4d tx wasm execute $CONTRACT_ADDR \ + --from $ADDR \ + --gas 1000000 \ + --broadcast-mode block \ + "{\"forget_object\":{\"id\": \"$OBJECT_ID\"}}" +``` + +### Querying + +Query an object by its id: + +```bash +okp4d query wasm contract-state smart $CONTRACT_ADDR \ + "{\"object\": {\"id\": \"$OBJECT_ID\"}}" +``` + +Or its data: + +```bash +okp4d query wasm contract-state smart $CONTRACT_ADDR \ + "{\"object_data\": {\"id\": \"$OBJECT_ID\"}}" +``` + +We can also list the objects, eventually filtering on the object owner: + +```bash +okp4d query wasm contract-state smart $CONTRACT_ADDR \ + "{\"objects\": {\"address\": \"okp41p8u47en82gmzfm259y6z93r9qe63l25dfwwng6\"}}" +``` + +And navigate in a cursor based pagination: + +```bash +okp4d query wasm contract-state smart $CONTRACT_ADDR \ + "{\"objects\": {\"first\": 5, \"after\": \"23Y5t5DBe7DkPwfJo3Sd26Y8Z9epmtpA1FTpdG7DiG6MD8vPRTzzbQ9TccmyoBcePkPK6atUiqcAzJVo3TfYNBGY\"}}" +``` + +We can also query object pins with the same cursor based pagination: + +```bash +okp4d query wasm contract-state smart $CONTRACT_ADDR \ + "{\"object_pins\": {\"id\": \"$OBJECT_ID\", \"first\": 5, \"after\": \"23Y5t5DBe7DkPwfJo3Sd26Y8Z9epmtpA1FTpdG7DiG6MD8vPRTzzbQ9TccmyoBcePkPK6atUiqcAzJVo3TfYNBGY\"}}" +``` + +## InstantiateMsg + +Instantiate messages + +|parameter|description| +|----------|-----------| +|`bucket`|*(Required.) * **string**. The name of the bucket. The name could not be empty or contains whitespaces. If name contains whitespace, they will be removed.| +|`config`|**[BucketConfig](#bucketconfig)**. The configuration of the bucket.| +|`config.accepted_compression_algorithms`|**Array<[CompressionAlgorithm](#compressionalgorithm)>**. The acceptable compression algorithms for the objects in the bucket. If this parameter is not set (none or empty array), then all compression algorithms are accepted. If this parameter is set, then only the compression algorithms in the array are accepted.

When an object is stored in the bucket without a specified compression algorithm, the first algorithm in the array is used. Therefore, the order of the algorithms in the array is significant. Typically, the most efficient compression algorithm, such as the NoCompression algorithm, should be placed first in the array.

Any attempt to store an object using a different compression algorithm than the ones specified here will fail.
**Default:** `["passthrough","snappy","lzma"]`| +|`config.hash_algorithm`|**[HashAlgorithm](#hashalgorithm)**. The algorithm used to hash the content of the objects to generate the id of the objects. The algorithm is optional and if not set, the default algorithm is used.

The default algorithm is Sha256 if not set.
**Default:** `"sha256"`| +|`limits`|**[BucketLimits](#bucketlimits)**. The limits of the bucket.| +|`limits.max_object_pins`|**[Uint128](#uint128)\|null**. The maximum number of pins in the bucket for an object.| +|`limits.max_object_size`|**[Uint128](#uint128)\|null**. The maximum size of the objects in the bucket.| +|`limits.max_objects`|**[Uint128](#uint128)\|null**. The maximum number of objects in the bucket.| +|`limits.max_total_size`|**[Uint128](#uint128)\|null**. The maximum total size of the objects in the bucket.| +|`pagination`|**[PaginationConfig](#paginationconfig)**. The configuration for paginated query.| +|`pagination.default_page_size`|**integer**. The default number of elements in a page.

Shall be less or equal than `max_page_size`. Default to '10' if not set.
**Default:** `10`| +|`pagination.max_page_size`|**integer**. The maximum elements a page can contain.

Shall be less than `u32::MAX - 1`. Default to '30' if not set.
**Default:** `30`| + +## ExecuteMsg + +Execute messages + +### ExecuteMsg::StoreObject + +StoreObject store an object to the bucket and make the sender the owner of the object. The object is referenced by the hash of its content and this value is returned. If the object is already stored, an error is returned. + +The "pin" parameter specifies if the object should be pinned for the sender. In such case, the object cannot be removed (forget) from the storage. + +The "compression_algorithm" parameter specifies the algorithm for compressing the object before storing it in the storage, which is optional. If no algorithm is specified, the algorithm used is the first algorithm of the bucket configuration limits. Note that the chosen algorithm can save storage space, but it will increase CPU usage. Depending on the chosen compression algorithm and the achieved compression ratio, the gas cost of the operation will vary, either increasing or decreasing. + +|parameter|description| +|----------|-----------| +|`store_object`|*(Required.) * **object**. | +|`store_object.compression_algorithm`|**[CompressionAlgorithm](#compressionalgorithm)\|null**. Specifies the compression algorithm to use when storing the object. If None, the first algorithm specified in the list of accepted compression algorithms of the bucket is used (see [BucketLimits::accepted_compression_algorithms]).| +|`store_object.data`|*(Required.) * **[Binary](#binary)**. The content of the object to store.| +|`store_object.pin`|*(Required.) * **boolean**. Specifies if the object should be pinned for the sender.| + +### ExecuteMsg::ForgetObject + +ForgetObject first unpin the object from the bucket for the considered sender, then remove it from the storage if it is not pinned anymore. If the object is pinned for other senders, it is not removed from the storage and an error is returned. If the object is not pinned for the sender, this is a no-op. + +|parameter|description| +|----------|-----------| +|`forget_object`|*(Required.) * **object**. | +|`forget_object.id`|*(Required.) * **string**. | + +### ExecuteMsg::PinObject + +PinObject pins the object in the bucket for the considered sender. If the object is already pinned for the sender, this is a no-op. While an object is pinned, it cannot be removed from the storage. + +|parameter|description| +|----------|-----------| +|`pin_object`|*(Required.) * **object**. | +|`pin_object.id`|*(Required.) * **string**. | + +### ExecuteMsg::UnpinObject + +UnpinObject unpins the object in the bucket for the considered sender. If the object is not pinned for the sender, this is a no-op. The object can be removed from the storage if it is not pinned anymore. + +|parameter|description| +|----------|-----------| +|`unpin_object`|*(Required.) * **object**. | +|`unpin_object.id`|*(Required.) * **string**. | + +## QueryMsg + +Query messages + +### QueryMsg::Bucket + +Bucket returns the bucket information. + +|parameter|description| +|----------|-----------| +|`bucket`|*(Required.) * **object**. | + +### QueryMsg::Object + +Object returns the object information with the given id. + +|parameter|description| +|----------|-----------| +|`object`|*(Required.) * **object**. | +|`object.id`|*(Required.) * **string**. The id of the object to get.| + +### QueryMsg::Objects + +Objects returns the list of objects in the bucket with support for pagination. + +|parameter|description| +|----------|-----------| +|`objects`|*(Required.) * **object**. | +|`objects.address`|**string\|null**. The owner of the objects to get.| +|`objects.after`|**string\|null**. The point in the sequence to start returning objects.| +|`objects.first`|**integer\|null**. The number of objects to return.| + +### QueryMsg::ObjectData + +ObjectData returns the content of the object with the given id. + +|parameter|description| +|----------|-----------| +|`object_data`|*(Required.) * **object**. | +|`object_data.id`|*(Required.) * **string**. The id of the object to get.| + +### QueryMsg::ObjectPins + +ObjectPins returns the list of addresses that pinned the object with the given id with support for pagination. + +|parameter|description| +|----------|-----------| +|`object_pins`|*(Required.) * **object**. | +|`object_pins.after`|**string\|null**. The point in the sequence to start returning pins.| +|`object_pins.first`|**integer\|null**. The number of pins to return.| +|`object_pins.id`|*(Required.) * **string**. The id of the object to get the pins for.| + +## Responses + +### bucket + +BucketResponse is the response of the Bucket query. + +|property|description| +|----------|-----------| +|`config`|*(Required.) * **[BucketConfig](#bucketconfig)**. The configuration of the bucket.| +|`config.accepted_compression_algorithms`|**Array<[CompressionAlgorithm](#compressionalgorithm)>**. The acceptable compression algorithms for the objects in the bucket. If this parameter is not set (none or empty array), then all compression algorithms are accepted. If this parameter is set, then only the compression algorithms in the array are accepted.

When an object is stored in the bucket without a specified compression algorithm, the first algorithm in the array is used. Therefore, the order of the algorithms in the array is significant. Typically, the most efficient compression algorithm, such as the NoCompression algorithm, should be placed first in the array.

Any attempt to store an object using a different compression algorithm than the ones specified here will fail.
**Default:** `["passthrough","snappy","lzma"]`| +|`config.hash_algorithm`|**[HashAlgorithm](#hashalgorithm)**. The algorithm used to hash the content of the objects to generate the id of the objects. The algorithm is optional and if not set, the default algorithm is used.

The default algorithm is Sha256 if not set.
**Default:** `"sha256"`| +|`limits`|*(Required.) * **[BucketLimits](#bucketlimits)**. The limits of the bucket.| +|`limits.max_object_pins`|**[Uint128](#uint128)\|null**. The maximum number of pins in the bucket for an object.| +|`limits.max_object_size`|**[Uint128](#uint128)\|null**. The maximum size of the objects in the bucket.| +|`limits.max_objects`|**[Uint128](#uint128)\|null**. The maximum number of objects in the bucket.| +|`limits.max_total_size`|**[Uint128](#uint128)\|null**. The maximum total size of the objects in the bucket.| +|`name`|*(Required.) * **string**. The name of the bucket.| +|`pagination`|*(Required.) * **[PaginationConfig](#paginationconfig)**. The configuration for paginated query.| +|`pagination.default_page_size`|**integer**. The default number of elements in a page.

Shall be less or equal than `max_page_size`. Default to '10' if not set.
**Default:** `10`| +|`pagination.max_page_size`|**integer**. The maximum elements a page can contain.

Shall be less than `u32::MAX - 1`. Default to '30' if not set.
**Default:** `30`| + +### object + +ObjectResponse is the response of the Object query. + +|property|description| +|----------|-----------| +|`compressed_size`|*(Required.) * **[Uint128](#uint128)**. The size of the object when compressed. If the object is not compressed, the value is the same as `size`.| +|`compression_algorithm`|*(Required.) * **[CompressionAlgorithm](#compressionalgorithm)**. The compression algorithm used to compress the content of the object.| +|`id`|*(Required.) * **string**. The id of the object.| +|`is_pinned`|*(Required.) * **boolean**. Tells if the object is pinned by at least one address.| +|`owner`|*(Required.) * **string**. The owner of the object.| +|`size`|*(Required.) * **[Uint128](#uint128)**. The size of the object.| + +### object_data + +Binary is a wrapper around Vec<u8> to add base64 de/serialization with serde. It also adds some helper methods to help encode inline. + +This is only needed as serde-json-{core,wasm} has a horrible encoding for Vec<u8>. See also <https://github.com/CosmWasm/cosmwasm/blob/main/docs/MESSAGE_TYPES.md>. + +|type| +|----| +|**string**.| + +### object_pins + +ObjectPinsResponse is the response of the GetObjectPins query. + +|property|description| +|----------|-----------| +|`data`|*(Required.) * **Array<string>**. The list of addresses that pinned the object.| +|`page_info`|*(Required.) * **[PageInfo](#pageinfo)**. The page information.| +|`page_info.cursor`|**string**. The cursor to the next page.| +|`page_info.has_next_page`|**boolean**. Tells if there is a next page.| + +### objects + +ObjectsResponse is the response of the Objects query. + +|property|description| +|----------|-----------| +|`data`|*(Required.) * **Array<[ObjectResponse](#objectresponse)>**. The list of objects in the bucket.| +|`page_info`|*(Required.) * **[PageInfo](#pageinfo)**. The page information.| +|`page_info.cursor`|**string**. The cursor to the next page.| +|`page_info.has_next_page`|**boolean**. Tells if there is a next page.| + +## Definitions + +### Binary + +A string containing Base64-encoded data. + +|type| +|----| +|**string**.| + +### BucketConfig + +BucketConfig is the type of the configuration of a bucket. + +The configuration is set at the instantiation of the bucket, and is immutable and cannot be changed. The configuration is optional and if not set, the default configuration is used. + +|property|description| +|----------|-----------| +|`accepted_compression_algorithms`|**Array<[CompressionAlgorithm](#compressionalgorithm)>**. The acceptable compression algorithms for the objects in the bucket. If this parameter is not set (none or empty array), then all compression algorithms are accepted. If this parameter is set, then only the compression algorithms in the array are accepted.

When an object is stored in the bucket without a specified compression algorithm, the first algorithm in the array is used. Therefore, the order of the algorithms in the array is significant. Typically, the most efficient compression algorithm, such as the NoCompression algorithm, should be placed first in the array.

Any attempt to store an object using a different compression algorithm than the ones specified here will fail.| +|`hash_algorithm`|**[HashAlgorithm](#hashalgorithm)**. The algorithm used to hash the content of the objects to generate the id of the objects. The algorithm is optional and if not set, the default algorithm is used.

The default algorithm is Sha256 if not set.| + +### BucketLimits + +BucketLimits is the type of the limits of a bucket. + +The limits are optional and if not set, there is no limit. + +|property|description| +|----------|-----------| +|`max_object_pins`|**[Uint128](#uint128)\|null**. The maximum number of pins in the bucket for an object.| +|`max_object_size`|**[Uint128](#uint128)\|null**. The maximum size of the objects in the bucket.| +|`max_objects`|**[Uint128](#uint128)\|null**. The maximum number of objects in the bucket.| +|`max_total_size`|**[Uint128](#uint128)\|null**. The maximum total size of the objects in the bucket.| + +### CompressionAlgorithm + +CompressionAlgorithm is an enumeration that defines the different compression algorithms supported for compressing the content of objects. The compression algorithm specified here are relevant algorithms for compressing data on-chain, which means that they are fast to compress and decompress, and have a low computational cost. + +The order of the compression algorithms is based on their estimated computational cost (quite opinionated) during both compression and decompression, ranging from the lowest to the highest. This particular order is utilized to establish the default compression algorithm for storing an object. + +|variant|description| +|-------|-----------| +|[Passthrough](#passthrough)|**string**: `passthrough`. Represents no compression algorithm. The object is stored as is without any compression.| +|[Snappy](#snappy)|**string**: `snappy`. Represents the Snappy algorithm. Snappy is a compression/decompression algorithm that does not aim for maximum compression. Instead, it aims for very high speeds and reasonable compression.

See [the snappy web page](https://google.github.io/snappy/) for more information.| +|[Lzma](#lzma)|**string**: `lzma`. Represents the LZMA algorithm. LZMA is a lossless data compression/decompression algorithm that features a high compression ratio and a variable compression-dictionary size up to 4 GB.

See [the LZMA wiki page](https://en.wikipedia.org/wiki/Lempel%E2%80%93Ziv%E2%80%93Markov_chain_algorithm) for more information.| + +### HashAlgorithm + +HashAlgorithm is an enumeration that defines the different hash algorithms supported for hashing the content of objects. + +|variant|description| +|-------|-----------| +|[MD5](#md5)|**string**: `m_d5`. Represents the MD5 algorithm. MD5 is a widely used cryptographic hash function that produces a 128-bit hash value. The computational cost of MD5 is relatively low compared to other hash functions, but its short hash length makes it easier to find hash collisions. It is now considered insecure for cryptographic purposes, but can still used in non-security contexts.

MD5 hashes are stored on-chain as 32 hexadecimal characters.

See [the MD5 Wikipedia page](https://en.wikipedia.org/wiki/MD5) for more information.| +|[SHA1](#sha1)|**string**: `sha224`. Represents the SHA-224 algorithm. SHA-224 is a variant of the SHA-2 family of hash functions that produces a 224-bit hash value. It is similar to SHA-256, but with a shorter output size. The computational cost of SHA-224 is moderate, and its relatively short hash length makes it easier to store and transmit.

SHA-224 hashes are stored on-chain as 56 hexadecimal characters.

See [the SHA-2 Wikipedia page](https://en.wikipedia.org/wiki/SHA-2) for more information.| +|[SHA256](#sha256)|**string**: `sha256`. Represents the SHA-256 algorithm. SHA-256 is a member of the SHA-2 family of hash functions that produces a 256-bit hash value. It is widely used in cryptography and other security-related applications. The computational cost of SHA-256 is moderate, and its hash length strikes a good balance between security and convenience.

SHA-256 hashes are stored on-chain as 64 hexadecimal characters.

See [the SHA-2 Wikipedia page](https://en.wikipedia.org/wiki/SHA-2) for more information.| +|[SHA384](#sha384)|**string**: `sha384`. Represents the SHA-384 algorithm. SHA-384 is a variant of the SHA-2 family of hash functions that produces a 384-bit hash value. It is similar to SHA-512, but with a shorter output size. The computational cost of SHA-384 is relatively high, but its longer hash length provides better security against hash collisions.

SHA-384 hashes are stored on-chain as 96 hexadecimal characters.

See [the SHA-2 Wikipedia page](https://en.wikipedia.org/wiki/SHA-2) for more information.| +|[SHA512](#sha512)|**string**: `sha512`. Represents the SHA-512 algorithm. SHA-512 is a member of the SHA-2 family of hash functions that produces a 512-bit hash value. It is widely used in cryptography and other security-related applications. The computational cost of SHA-512 is relatively high, but its longer hash length provides better security against hash collisions.

SHA-512 hashes are stored on-chain as 128 hexadecimal characters.

See [the SHA-2 Wikipedia page](https://en.wikipedia.org/wiki/SHA-2) for more information.| + +### Lzma + +Represents the LZMA algorithm. LZMA is a lossless data compression/decompression algorithm that features a high compression ratio and a variable compression-dictionary size up to 4 GB. + +See [the LZMA wiki page](https://en.wikipedia.org/wiki/Lempel%E2%80%93Ziv%E2%80%93Markov_chain_algorithm) for more information. + +|literal| +|-------| +|`"lzma"`| + +### MD5 + +Represents the MD5 algorithm. MD5 is a widely used cryptographic hash function that produces a 128-bit hash value. The computational cost of MD5 is relatively low compared to other hash functions, but its short hash length makes it easier to find hash collisions. It is now considered insecure for cryptographic purposes, but can still used in non-security contexts. + +MD5 hashes are stored on-chain as 32 hexadecimal characters. + +See [the MD5 Wikipedia page](https://en.wikipedia.org/wiki/MD5) for more information. + +|literal| +|-------| +|`"m_d5"`| + +### ObjectResponse + +ObjectResponse is the response of the Object query. + +|property|description| +|----------|-----------| +|`compressed_size`|*(Required.) * **[Uint128](#uint128)**. The size of the object when compressed. If the object is not compressed, the value is the same as `size`.| +|`compression_algorithm`|*(Required.) * **[CompressionAlgorithm](#compressionalgorithm)**. The compression algorithm used to compress the content of the object.| +|`id`|*(Required.) * **string**. The id of the object.| +|`is_pinned`|*(Required.) * **boolean**. Tells if the object is pinned by at least one address.| +|`owner`|*(Required.) * **string**. The owner of the object.| +|`size`|*(Required.) * **[Uint128](#uint128)**. The size of the object.| + +### PageInfo + +PageInfo is the page information returned for paginated queries. + +|property|description| +|----------|-----------| +|`cursor`|*(Required.) * **string**. The cursor to the next page.| +|`has_next_page`|*(Required.) * **boolean**. Tells if there is a next page.| + +### PaginationConfig + +PaginationConfig is the type carrying configuration for paginated queries. + +The fields are optional and if not set, there is a default configuration. + +|property|description| +|----------|-----------| +|`default_page_size`|**integer**. The default number of elements in a page.

Shall be less or equal than `max_page_size`. Default to '10' if not set.| +|`max_page_size`|**integer**. The maximum elements a page can contain.

Shall be less than `u32::MAX - 1`. Default to '30' if not set.| + +### Passthrough + +Represents no compression algorithm. The object is stored as is without any compression. + +|literal| +|-------| +|`"passthrough"`| + +### SHA1 + +Represents the SHA-224 algorithm. SHA-224 is a variant of the SHA-2 family of hash functions that produces a 224-bit hash value. It is similar to SHA-256, but with a shorter output size. The computational cost of SHA-224 is moderate, and its relatively short hash length makes it easier to store and transmit. + +SHA-224 hashes are stored on-chain as 56 hexadecimal characters. + +See [the SHA-2 Wikipedia page](https://en.wikipedia.org/wiki/SHA-2) for more information. + +|literal| +|-------| +|`"sha224"`| + +### SHA256 + +Represents the SHA-256 algorithm. SHA-256 is a member of the SHA-2 family of hash functions that produces a 256-bit hash value. It is widely used in cryptography and other security-related applications. The computational cost of SHA-256 is moderate, and its hash length strikes a good balance between security and convenience. + +SHA-256 hashes are stored on-chain as 64 hexadecimal characters. + +See [the SHA-2 Wikipedia page](https://en.wikipedia.org/wiki/SHA-2) for more information. + +|literal| +|-------| +|`"sha256"`| + +### SHA384 + +Represents the SHA-384 algorithm. SHA-384 is a variant of the SHA-2 family of hash functions that produces a 384-bit hash value. It is similar to SHA-512, but with a shorter output size. The computational cost of SHA-384 is relatively high, but its longer hash length provides better security against hash collisions. + +SHA-384 hashes are stored on-chain as 96 hexadecimal characters. + +See [the SHA-2 Wikipedia page](https://en.wikipedia.org/wiki/SHA-2) for more information. + +|literal| +|-------| +|`"sha384"`| + +### SHA512 + +Represents the SHA-512 algorithm. SHA-512 is a member of the SHA-2 family of hash functions that produces a 512-bit hash value. It is widely used in cryptography and other security-related applications. The computational cost of SHA-512 is relatively high, but its longer hash length provides better security against hash collisions. + +SHA-512 hashes are stored on-chain as 128 hexadecimal characters. + +See [the SHA-2 Wikipedia page](https://en.wikipedia.org/wiki/SHA-2) for more information. + +|literal| +|-------| +|`"sha512"`| + +### Snappy + +Represents the Snappy algorithm. Snappy is a compression/decompression algorithm that does not aim for maximum compression. Instead, it aims for very high speeds and reasonable compression. + +See [the snappy web page](https://google.github.io/snappy/) for more information. + +|literal| +|-------| +|`"snappy"`| + +### Uint128 + +A string containing a 128-bit integer in decimal representation. + +|type| +|----| +|**string**.| + +--- + +*Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `okp4-objectarium.json` (`51f0131cd7a4ebf9`)* \ No newline at end of file diff --git a/contracts_versioned_sidebars/version-v3.0.0-sidebars.json b/contracts_versioned_sidebars/version-v3.0.0-sidebars.json new file mode 100644 index 00000000000..cff0c94e170 --- /dev/null +++ b/contracts_versioned_sidebars/version-v3.0.0-sidebars.json @@ -0,0 +1,8 @@ +{ + "defaultSidebar": [ + { + "type": "autogenerated", + "dirName": "." + } + ] +} diff --git a/contracts_versions.json b/contracts_versions.json index 5f4d884f3f8..3a97e4d280c 100644 --- a/contracts_versions.json +++ b/contracts_versions.json @@ -1,4 +1,5 @@ [ + "v3.0.0", "v2.1.0", "v2.0.0", "v1.0.0"