glitter-sdk-js

<!DOCTYPE html> <html class="writer-html5" lang="en" > <head> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Examples — glitter-sdk-js documentation</title> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <link rel="stylesheet" href="_static/tabs.css" type="text/css" />  <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/jquery.js"></script> <script src="_static/underscore.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/doctools.js"></script> <script src="_static/js/theme.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="Library Reference" href="libref.html" /> <link rel="prev" title="Quickstart" href="quickstart.html" /> </head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search" > <a href="index.html" class="icon icon-home"> glitter-sdk-js </a> <div role="search"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="text" name="q" placeholder="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <ul class="current"> <li class="toctree-l1"><a class="reference external" href="https://glitterprotocol.io/">← glitternetwork</a></li> <li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li> <li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Examples</a><ul> <li class="toctree-l2"><a class="reference internal" href="#getting-started">Getting Started</a></li> <li class="toctree-l2"><a class="reference internal" href="#create-schema">Create Schema</a></li> <li class="toctree-l2"><a class="reference internal" href="#show-schema">Show Schema</a></li> <li class="toctree-l2"><a class="reference internal" href="#list-all-schema">List All Schema</a></li> <li class="toctree-l2"><a class="reference internal" href="#put-document-to-glitter">Put Document to Glitter</a></li> <li class="toctree-l2"><a class="reference internal" href="#check-whether-the-document-exists">Check Whether the Document Exists</a></li> <li class="toctree-l2"><a class="reference internal" href="#simple-search-without-filter-condition">Simple Search without Filter Condition</a></li> <li class="toctree-l2"><a class="reference internal" href="#app-status">App Status</a></li> <li class="toctree-l2"><a class="reference internal" href="#search-transaction">Search Transaction</a></li> <li class="toctree-l2"><a class="reference internal" href="#search-block">Search Block</a></li> <li class="toctree-l2"><a class="reference internal" href="#fetch-validator-status">Fetch Validator Status</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="libref.html">Library Reference</a></li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <a href="index.html">glitter-sdk-js</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="Page navigation"> <ul class="wy-breadcrumbs"> <li><a href="index.html" class="icon icon-home"></a> »</li> <li>Examples</li> <li class="wy-breadcrumbs-aside"> <a href="_sources/examples.rst.txt" rel="nofollow"> View page source</a> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <section id="examples"> <h1>Examples<a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h1> For the examples on this page, we assume you’ve <a class="reference internal" href="install.html">installed the glitter sdk Python package</a>. <section id="getting-started"> <h2>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this heading">¶</a></h2> We begin by creating an object of class GlitterClient: <div class="highlight-python notranslate"><div class="highlight"><pre>from glitter_sdk import GlitterClient url = 'http://127.0.0.1:26659' glitter_client = GlitterClient(url) </pre></div> </div> Or use the default root url <div class="highlight-python notranslate"><div class="highlight"><pre>from glitter_sdk import GlitterClient glitter_client = GlitterClient() </pre></div> </div> </section> <section id="create-schema"> <h2>Create Schema<a class="headerlink" href="#create-schema" title="Permalink to this heading">¶</a></h2> <div class="highlight-python notranslate"><div class="highlight"><pre>schema_name="demo" fields = [ { "name": "doi", "type": "string", "primary": "true", "index": { "type": "keyword" } }, { "name": "title", "type": "string", "index": { "type": "text" } }, { "name": "ipfs_cid", "type": "string", "index": { "index": "false" } } ] res = glitter_client.db.create_schema(schema_name, fields) print(res) </pre></div> </div> if create schema success, the return like: <div class="highlight-json notranslate"><div class="highlight"><pre>{ "code": 0, "message": "ok", "tx": "B88CEA8172F0B8BD7EAC3021C1B347786F74EDCD9110A7525C61237CD91FCE73", } </pre></div> </div> if the schema all ready exist, the return like: <div class="highlight-json notranslate"><div class="highlight"><pre>{ "code": 500, "message": "schema already exist: schema_name=demo", } </pre></div> </div> </section> <section id="show-schema"> <h2>Show Schema<a class="headerlink" href="#show-schema" title="Permalink to this heading">¶</a></h2> get schema by name. <div class="highlight-python notranslate"><div class="highlight"><pre>res = glitter_client.db.get_schema("demo") </pre></div> </div> if success: <div class="highlight-json notranslate"><div class="highlight"><pre>{ "code": 0, "message": "ok", "data": { "fields": [{ "index": { "type": "keyword" }, "name": "doi", "primary": "true", "type": "string" }, { "index": { "type": "text" }, "name": "title", "type": "string" }, { "index": { "index": "false" }, "name": "ipfs_cid", "type": "string" }], "name": "demo", "type": "record" } } </pre></div> </div> otherwise: <div class="highlight-json notranslate"><div class="highlight"><pre>{ "code": 505, "message": "SchemaNotExist", } </pre></div> </div> </section> <section id="list-all-schema"> <h2>List All Schema<a class="headerlink" href="#list-all-schema" title="Permalink to this heading">¶</a></h2> <div class="highlight-python notranslate"><div class="highlight"><pre>res = glitter_client.db.list_schema() # return { "code": 0, "message": "ok", "data": { "demo": { "fields": [{ "index": { "type": "keyword" }, "name": "doi", "primary": "true", "type": "string" }, { "index": { "type": "text" }, "name": "title", "type": "string" }, { "index": { "index": "false" }, "name": "ipfs_cid", "type": "string" }], "name": "demo", "type": "record" }, } } </pre></div> </div> </section> <section id="put-document-to-glitter"> <h2>Put Document to Glitter<a class="headerlink" href="#put-document-to-glitter" title="Permalink to this heading">¶</a></h2> define a document and put it to glitter For example: <div class="highlight-python notranslate"><div class="highlight"><pre>demo_doc = { "doi": "10.1002/(sci)1099-1697(199803/04)7:2<65::aid-jsc357>3.0.c", "title": "British Steel Corporation: probably the biggest turnaround story in UK industrial history", "ipfs_cid": "bafybeibxvp6bawmr4u24vuza2vyretip4n7sfvivg7hdbyolxrvbodwlte" } res = glitter_client.db.put_doc(schema_name, demo_doc) </pre></div> </div> if put_doc success, the return like: <div class="highlight-json notranslate"><div class="highlight"><pre>{ "code": 0, "message": "ok", "tx": "49429CDC575C0ED6D021FE9BEE1D44578AC7EDAD61A25EBBF0DE72746E0064F8", } </pre></div> </div> if fails, the return may be like: <div class="highlight-json notranslate"><div class="highlight"><pre>{ "code": 500, "message": "RPC error -32603 - Internal error: tx already exists in cache", } </pre></div> </div> </section> <section id="check-whether-the-document-exists"> <h2>Check Whether the Document Exists<a class="headerlink" href="#check-whether-the-document-exists" title="Permalink to this heading">¶</a></h2> Query by primary key of document,for example:doi. <div class="highlight-python notranslate"><div class="highlight"><pre>schema_name = "demo" doi = "10.1002/(sci)1099-1697(199803/04)7:2<65::aid-jsc357>3.0.c" res = glitter_client.db.get_docs(schema_name, [doi]) </pre></div> </div> return the document: <div class="highlight-json notranslate"><div class="highlight"><pre>{ "code": 0, "message": "ok", "data": { "total": 1, "hits": { "10.1002/(sci)1099-1697(199803/04)7:2<65::aid-jsc357>3.0.c": { "_schema_name": "demo", "doi": "10.1002/(sci)1099-1697(199803/04)7:2<65::aid-jsc357>3.0.c", "ipfs_cid": "bafybeibxvp6bawmr4u24vuza2vyretip4n7sfvivg7hdbyolxrvbodwlte", "title": "British Steel Corporation: probably the biggest turnaround story in UK industrial history" } } } } </pre></div> </div> </section> <section id="simple-search-without-filter-condition"> <h2>Simple Search without Filter Condition<a class="headerlink" href="#simple-search-without-filter-condition" title="Permalink to this heading">¶</a></h2> The search is the standard query for performing a full-text search, including options for fuzzy matching. <div class="highlight-python notranslate"><div class="highlight"><pre>query_word = "British Steel Corporation" query_field = ["title"] res = glitter_client.db.search(schema_name, query_word, query_field) </pre></div> </div> the hit result like: <div class="highlight-json notranslate"><div class="highlight"><pre>{ "code": 0, "message": "ok", "data": { "search_time": 695, "index": "demo", "meta": { "page": { "current_page": 1, "total_pages": 1, "total_results": 1, "size": 10, "sorted_by": "" } }, "items": [{ "highlight": { "title": ["British Steel Corporation: probably the biggest turnaround story in UK industrial history"] }, "data": { "_schema_name": "demo", "doi": "10.1002/(sci)1099-1697(199803/04)7:2<65::aid-jsc357>3.0.c", "ipfs_cid": "bafybeibxvp6bawmr4u24vuza2vyretip4n7sfvivg7hdbyolxrvbodwlte", "title": "British Steel Corporation: probably the biggest turnaround story in UK industrial history" } }], "facet": {} } } </pre></div> </div> </section> <section id="app-status"> <h2>App Status<a class="headerlink" href="#app-status" title="Permalink to this heading">¶</a></h2> <div class="highlight-python notranslate"><div class="highlight"><pre>res = glitter_client.db.app_status() # { "code": 0, "message": "ok", "data": { "schema_state": { "demo": { "count": 3, "last_update_time": "2022-04-04T08:00:27.617071816Z" }, "rss": { "count": 12385, "last_update_time": "2022-04-04T12:04:52.704777642Z" } } } } </pre></div> </div> </section> <section id="search-transaction"> <h2>Search Transaction<a class="headerlink" href="#search-transaction" title="Permalink to this heading">¶</a></h2> You can search transaction by transaction height, transaction hash. <div class="highlight-python notranslate"><div class="highlight"><pre># search by transaction hash. res = glitter_client.chain.tx_search(query="tx.hash='ACB6696C22B601D544FE05C8899090B4C1E98EF87636AA07EBCD63548786B561'") # search by transaction height. res = glitter_client.chain.tx_search(query="tx.height=460844") # the return like: { "jsonrpc": "2.0", "id": -1, "result": { "txs": [ { "hash": "ACB6696C22B601D544FE05C8899090B4C1E98EF87636AA07EBCD63548786B561", "height": "460844", "index": 0, "tx_result": { "code": 0, "data": null, "log": "", "info": "", "gas_wanted": "0", "gas_used": "0", "events": [ { "type": "update_doc", "attributes": [ { "key": "dG9rZW4=", "value": "bXlfdG9rZW4=", "index": true } ] } ], "codespace": "" }, "tx": "CghteV90b2tlbhrRBxIGbGliZ2VuGiA1MTczMjc1ZjAyOWE3ZjBiNzhiZGNhY2EzNGE2ZGFjYyKkB3sidGl0bGUiOiAiXHUwNDFjXHUwNDM1XHUwNDM2XHUwNDM0XHUwNDQzXHUwNDNkXHUwNDMwXHUwNDQwXHUwNDNlXHUwNDM0XHUwNDNkXHUwNDMwXHUwNDRmIFx1MDQzMFx1MDQzZFx1MDQzMFx1MDQ0Mlx1MDQzZVx1MDQzY1x1MDQzOFx1MDQ0N1x1MDQzNVx1MDQ0MVx1MDQzYVx1MDQzMFx1MDQ0ZiBcdTA0M2RcdTA0M2VcdTA0M2NcdTA0MzVcdTA0M2RcdTA0M2FcdTA0M2JcdTA0MzBcdTA0NDJcdTA0NDNcdTA0NDBcdTA0MzAgKFBhcmlzaWFuYSBub21pbmEgYW5hdG9taWNhKSIsICJzZXJpZXMiOiBbIiJdLCAiYXV0aG9yIjogWyJcdTA0MWNcdTA0MzhcdTA0NDVcdTA0MzBcdTA0MzlcdTA0M2JcdTA0M2VcdTA0MzIgXHUwNDIxLlx1MDQyMS4gKFx1MDQ0MFx1MDQzNVx1MDQzNC4pIl0sICJwdWJsaXNoZXIiOiAiXHUwNDFjXHUwNDM1XHUwNDM0XHUwNDM4XHUwNDQ2XHUwNDM4XHUwNDNkXHUwNDMwIiwgImxhbmd1YWdlIjogWyJSdXNzaWFuIl0sICJtZDUiOiAiIiwgInRhZ3MiOiBbIlx1MDQxMVx1MDQzOFx1MDQzZVx1MDQzYlx1MDQzZVx1MDQzM1x1MDQzOFx1MDQ0N1x1MDQzNVx1MDQ0MVx1MDQzYVx1MDQzOFx1MDQzNSBcdTA0MzRcdTA0MzhcdTA0NDFcdTA0NDZcdTA0MzhcdTA0M2ZcdTA0M2JcdTA0MzhcdTA0M2RcdTA0NGIiLCAiXHUwNDEwXHUwNDNkXHUwNDMwXHUwNDQyXHUwNDNlXHUwNDNjXHUwNDM4XHUwNDRmIiwgIlx1MDQyMVx1MDQzYlx1MDQzZVx1MDQzMlx1MDQzMFx1MDQ0MFx1MDQzOCBcdTA0MzggXHUwNDQwXHUwNDMwXHUwNDM3XHUwNDMzXHUwNDNlXHUwNDMyXHUwNDNlXHUwNDQwXHUwNDNkXHUwNDM4XHUwNDNhXHUwNDM4Il0sICJpc3NuIjogIiIsICJpcGZzX2NpZCI6ICJiYWZ5a2J6YWNlZGptMjd5bWFwdDRqdDRoMnVlanJveWkydmw2cW4zcW9lMm9zcWUzamphN2E3bzZsbmtseSIsICJleHRlbnNpb24iOiAiZGp2dSJ9", "proof": { "root_hash": "711715C5DD2D929F5FA6128E73E63690C4CE876D92BE120040F379B50897E567", "data": "CghteV90b2tlbhrRBxIGbGliZ2VuGiA1MTczMjc1ZjAyOWE3ZjBiNzhiZGNhY2EzNGE2ZGFjYyKkB3sidGl0bGUiOiAiXHUwNDFjXHUwNDM1XHUwNDM2XHUwNDM0XHUwNDQzXHUwNDNkXHUwNDMwXHUwNDQwXHUwNDNlXHUwNDM0XHUwNDNkXHUwNDMwXHUwNDRmIFx1MDQzMFx1MDQzZFx1MDQzMFx1MDQ0Mlx1MDQzZVx1MDQzY1x1MDQzOFx1MDQ0N1x1MDQzNVx1MDQ0MVx1MDQzYVx1MDQzMFx1MDQ0ZiBcdTA0M2RcdTA0M2VcdTA0M2NcdTA0MzVcdTA0M2RcdTA0M2FcdTA0M2JcdTA0MzBcdTA0NDJcdTA0NDNcdTA0NDBcdTA0MzAgKFBhcmlzaWFuYSBub21pbmEgYW5hdG9taWNhKSIsICJzZXJpZXMiOiBbIiJdLCAiYXV0aG9yIjogWyJcdTA0MWNcdTA0MzhcdTA0NDVcdTA0MzBcdTA0MzlcdTA0M2JcdTA0M2VcdTA0MzIgXHUwNDIxLlx1MDQyMS4gKFx1MDQ0MFx1MDQzNVx1MDQzNC4pIl0sICJwdWJsaXNoZXIiOiAiXHUwNDFjXHUwNDM1XHUwNDM0XHUwNDM4XHUwNDQ2XHUwNDM4XHUwNDNkXHUwNDMwIiwgImxhbmd1YWdlIjogWyJSdXNzaWFuIl0sICJtZDUiOiAiIiwgInRhZ3MiOiBbIlx1MDQxMVx1MDQzOFx1MDQzZVx1MDQzYlx1MDQzZVx1MDQzM1x1MDQzOFx1MDQ0N1x1MDQzNVx1MDQ0MVx1MDQzYVx1MDQzOFx1MDQzNSBcdTA0MzRcdTA0MzhcdTA0NDFcdTA0NDZcdTA0MzhcdTA0M2ZcdTA0M2JcdTA0MzhcdTA0M2RcdTA0NGIiLCAiXHUwNDEwXHUwNDNkXHUwNDMwXHUwNDQyXHUwNDNlXHUwNDNjXHUwNDM4XHUwNDRmIiwgIlx1MDQyMVx1MDQzYlx1MDQzZVx1MDQzMlx1MDQzMFx1MDQ0MFx1MDQzOCBcdTA0MzggXHUwNDQwXHUwNDMwXHUwNDM3XHUwNDMzXHUwNDNlXHUwNDMyXHUwNDNlXHUwNDQwXHUwNDNkXHUwNDM4XHUwNDNhXHUwNDM4Il0sICJpc3NuIjogIiIsICJpcGZzX2NpZCI6ICJiYWZ5a2J6YWNlZGptMjd5bWFwdDRqdDRoMnVlanJveWkydmw2cW4zcW9lMm9zcWUzamphN2E3bzZsbmtseSIsICJleHRlbnNpb24iOiAiZGp2dSJ9", "proof": { "total": "1", "index": "0", "leaf_hash": "cRcVxd0tkp9fphKOc+Y2kMTOh22SvhIAQPN5tQiX5Wc=", "aunts": [] } } } ], "total_count": "1" } } </pre></div> </div> </section> <section id="search-block"> <h2>Search Block<a class="headerlink" href="#search-block" title="Permalink to this heading">¶</a></h2> You can search block by block_search or fetch the latest block. <div class="highlight-python notranslate"><div class="highlight"><pre>res = glitter_client.chain.block() # or res = glitter_client.chain.block_search(query="block.height = 17835") # the return like: { "jsonrpc": "2.0", "id": -1, "result": { "blocks": [{ "block_id": { "hash": "8E05ECB6E8D9A455C39786A841A494EF5F1A556DD69D7BFE8087D944C0D58E9F", "parts": { "total": 1, "hash": "441EC5490877F1CB88BDF9E98B8A8D0F94AA50F51408616ED0895D2F68144F4E" } }, "block": { "header": { "version": { "block": "11", "app": "1" }, "chain_id": "chain-86acvw", "height": "17835", "time": "2022-04-04T12:11:57.151540264Z", "last_block_id": { "hash": "A3DE887AC31ED3EC61E7F5546AD93A10C04FC5EF877C8482BC348BCA34F132E2", "parts": { "total": 1, "hash": "6AA71359A2436CC468DA33F51240E542B191C886D179B2A13CC289011A22BAD6" } }, "last_commit_hash": "2CDE9E0FACFAC12823BE0AEE338126AFDEB9C104F6D7B0CA671D7073A034D5BE", "data_hash": "BE70FDA4F06352C81AD76F06FCDE79B453BD1442982D89C801EA8220A7749F06", "validators_hash": "BD3B1DAB2563D85FA57961054C2DB23BDDB08434DBA0DBB5523D357ABA062EDD", "next_validators_hash": "BD3B1DAB2563D85FA57961054C2DB23BDDB08434DBA0DBB5523D357ABA062EDD", "consensus_hash": "048091BC7DDC283F77BFBF91D73C44DA58C3DF8A9CBC867405D8B7F3DAADA22F", "app_hash": "", "last_results_hash": "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855", "evidence_hash": "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855", "proposer_address": "F6749E28383C329AAEF0B2974EC9F6A8F37155E8" }, "data": { "txs": ["eyJ0eXBlIjoiZG9jIiwiY3JlYXRvciI6InRlc3RfYnJva3MiLCJib2R5Ijp7InNjaGVtYV9uYW1lIjoicnNzIiwiZG9jX2RhdGEiOnsiZmVlZF9saW5rIjoiaHR0cHM6Ly9jcnlwdG9uZXdtZWRpYS5wcmVzcyIsInRpdGxlIjoiSGVyZVx1MjAxOXMgV2hhdCBXaWxsIElnbml0ZSBhIEJpdGNvaW4gKEJUQykgRXJ1cHRpb24gdG8gJDU4LDAwMCwgQWNjb3JkaW5nIHRvIFRvcCBDcnlwdG8gU3RyYXRlZ2lzdCIsImRlc2NyaXB0aW9uIjoiQSBjbG9zZWx5IGZvbGxvd2VkIGNyeXB0byBhbmFseXN0IGFuZCB0cmFkZXIgaXMuLi5cdTAwM2NiciAvXHUwMDNlXG5cdTAwM2NiciAvXHUwMDNlXG5bWyBUaGlzIGlzIGEgY29udGVudCBzdW1tYXJ5IG9ubHkuIFZpc2l0IG15IHdlYnNpdGUgZm9yIGZ1bGwgbGlua3MsIG90aGVyIGNvbnRlbnQsIGFuZCBtb3JlISBdXSIsImxpbmsiOiJodHRwczovL2NyeXB0b25ld21lZGlhLnByZXNzL2hlcmVzLXdoYXQtd2lsbC1pZ25pdGUtYS1iaXRjb2luLWJ0Yy1lcnVwdGlvbi10by01ODAwMC1hY2NvcmRpbmctdG8tdG9wLWNyeXB0by1zdHJhdGVnaXN0LyIsInB1Ymxpc2hlZCI6Ik1vbiwgMDQgQ