![\"introduction](\"http://img.youtube.com/vi/-VYpjpLXU5Q/0.jpg\")
](http://www.youtube.com/watch?v=-VYpjpLXU5Q)\n\nAs of current AquilaDB release features, you can build **[Neural Information Retrieval](https://www.microsoft.com/en-us/research/uploads/prod/2017/06/INR-061-Mitra-neuralir-intro.pdf)** applications out of the box without any external dependencies. Here are some useful links to learn more about it and start building:\n\n* Microsoft published a paper and youtube video on this to onboard anyone interested: \n * paper: https://www.microsoft.com/en-us/research/uploads/prod/2017/06/INR-061-Mitra-neuralir-intro.pdf\n * video: https://www.youtube.com/watch?v=g1Pgo5yTIKg\n* Embeddings for Everything: Search in the Neural Network Era: https://www.youtube.com/watch?v=JGHVJXP9NHw\n* Autoencoders are one such deep learning algorithms that will help you to build semantic vectors - foundation for Neural Information retrieval. Here are some links to Autoencoders based IR:\n * go to chapter 15 in this link: https://www.cs.toronto.edu/~hinton/coursera_lectures.html\n * https://www.coursera.org/lecture/ml-foundations/examples-of-document-retrieval-in-action-CW25H\n * https://www.coursera.org/lecture/intro-to-deep-learning/autoencoders-101-QqBOa\n* Note that, the idea of information retrieval applies not only to text data but for any data. All you need to do is, encode any source datatype to a dense vector with deep neural networks.\n\n\n
Our Sponsors
\n\n\n
\n\n> email us to sponsor this project [adbadmin@protonmail.ch](mailto:adbadmin@protonmail.ch).\n\n
\n\n# Citing Aquila DB\nIf you use Aquila DB in an academic paper, we would 😍 to be cited. Here are the two ways of citing Aquila DB:\n```\n\\footnote{https://github.com/Aquila-Network/AquilaDB}\n```\n```\n@misc{AquilaNetwork2019AquilaDB,\n title={AquilaDB: Neural Search Engine},\n author={Jubin Jose, Nibin Peter},\n howpublished={\\url{https://github.com/Aquila-Network/AquilaDB}},\n year={2019}\n}\n```\n\n# License\n\nApache License 2.0 [license file](https://github.com/Aquila-Network/AquilaDB/blob/master/LICENSE)\n\ncreated by ❤️ with a-mma (a_മ്മ)\n" }, { "path": "aquila/encoder/CODE_OF_CONDUCT.md", "content": "# AquilaDB Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as\ncontributors and maintainers pledge to making participation in our project and\nour community a harassment-free experience for everyone, regardless of age, body\nsize, disability, ethnicity, sex characteristics, gender identity and expression,\nlevel of experience, education, socio-economic status, nationality, personal\nappearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment\ninclude:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or\n advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic\n address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a\n professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable\nbehavior and are expected to take appropriate and fair corrective action in\nresponse to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or\nreject comments, commits, code, wiki edits, issues, and other contributions\nthat are not aligned to this Code of Conduct, or to ban temporarily or\npermanently any contributor for other behaviors that they deem inappropriate,\nthreatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces\nwhen an individual is representing the project or its community. Examples of\nrepresenting a project or community include using an official project e-mail\naddress, posting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event. Representation of a project may be\nfurther defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported by contacting the project team at humans@aquiladb.xyz. All\ncomplaints will be reviewed and investigated and will result in a response that\nis deemed necessary and appropriate to the circumstances. The project team is\nobligated to maintain confidentiality with regard to the reporter of an incident.\nFurther details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good\nfaith may face temporary or permanent repercussions as determined by other\nmembers of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,\navailable at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html\n\n[homepage]: https://www.contributor-covenant.org\n\nFor answers to common questions about this code of conduct, see\nhttps://www.contributor-covenant.org/faq\n" }, { "path": "aquila/encoder/Dockerfile", "content": "# start a new build stage\nFROM ubuntu:latest as builder\n\n# set work directory\nENV ROOT_DIR /home/root\nWORKDIR $ROOT_DIR\n\n# preperations\nENV PATH=\"$ROOT_DIR/env/bin:$PATH\"\n\nSHELL [\"/bin/bash\", \"-o\", \"pipefail\", \"-c\"]\n\nRUN apt update && apt install -y git nano python3.8 python3-pip libssl-dev && \\\n pip3 install virtualenv\n\nRUN cd $ROOT_DIR && \\\n mkdir -p ahub && \\\n cd ahub && \\\n git clone https://github.com/Aquila-Network/AquilaHub.git . && \\\n virtualenv $ROOT_DIR/env && \\\n source $ROOT_DIR/env/bin/activate && \\\n cd src && pip3 install -r requirements.txt\n\nRUN mkdir -p /ossl/ && \\\n openssl genrsa -passout pass:1234 -des3 -out /ossl/private.pem 2048 && \\\n openssl rsa -passin pass:1234 -in /ossl/private.pem -outform PEM -pubout -out /ossl/public.pem && \\\n openssl rsa -passin pass:1234 -in /ossl/private.pem -out /ossl/private_unencrypted.pem -outform PEM\n\n# install and start demon\nRUN mkdir -p /data && \\\n printf \"#!/bin/bash\\nsource env/bin/activate && cd ahub/src && \\\n python3 index.py\" > /bin/init.sh && chmod +x /bin/init.sh\n\n# expose port\nEXPOSE 5002\n\nENTRYPOINT [\"init.sh\"]" }, { "path": "aquila/encoder/LICENSE", "content": " Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright [yyyy] [name of copyright owner]\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n" }, { "path": "aquila/encoder/README.md", "content": "\n\nLoad and serve ML models to compress data into latent vectors. To be used with Aquila DB.\n\n# Technology\n\nAquila Hub automates the process of encoding information with the help of ML models. Here is where Aquila Hub fits in the entire ecosystem:\n
\n
\n
\n\n# Install\n### Debian\n\nRun `curl -s -L https://raw.githubusercontent.com/Aquila-Network/AquilaHub/main/install.sh | /bin/bash -s -- -d 1 `.\n\n### Docker\n\n**You need docker installed in your system**\n\nBuild image (one time process): `docker build https://raw.githubusercontent.com/Aquila-Network/AquilaHub/main/Dockerfile -t aquilahub:local`\n\nRun image (to deploy Aquila DB): `docker run -p 5002:5002 -d aquilahub:local`\n"
},
{
"path": "aquila/encoder/authentication.py",
"content": "from utils import cryptops\n\nimport os\n\npub_key = cryptops.read_public_key(os.environ[\"AUTH_KEY_FILE\"])\n\ndef check (json_data, signature):\n return cryptops.verify_signature(json_data, pub_key, signature)"
},
{
"path": "aquila/encoder/config.yml",
"content": "auth:\n pubkey: \"/ossl/public.pem\"\nipfs:\n gateway: \"http://127.0.0.1:8080\"\n"
},
{
"path": "aquila/encoder/encoder.py",
"content": "import logging\n\nimport fasttext\nfrom utils import downloader\nimport hashlib\nimport base58\nimport json\n\nfrom sentence_transformers import SentenceTransformer\n\nimport os\n\n# define constants\nMODEL_FASTTEXT = \"ftxt\"\nMODEL_S_TRANSFORMER = \"strn\"\nPREDICT_BATCH_SIZE = 1000\n\n# Maintain a model directory\ndata_dir = os.environ[\"DATA_STORE_LOCATION\"]\nmodel_dir = data_dir + \"models/\"\nmodel_dict = {}\n\ndef get_url (schema):\n \"\"\"\n Get model url from a schema\n \"\"\"\n \n if schema.get(\"encoder\") != None:\n return schema[\"encoder\"]\n else:\n return None\n\ndef get_url_hash (url):\n hash_ = hashlib.sha256(url.encode('utf-8'))\n b58c_ = base58.b58encode(hash_.digest())\n return b58c_.decode('utf-8')\n\ndef download_model (url, directory, file_name):\n \"\"\"\n Download a model from a URL\n \"\"\"\n\n # handle fasttext models from url or IPFS\n if url.split(\":\")[0] == MODEL_FASTTEXT:\n url = \":\".join(url.split(\":\")[1:])\n \n if url.split(\":\")[0] == \"http\" or url.split(\":\")[0] == \"https\":\n return MODEL_FASTTEXT, downloader.http_download(url, directory, file_name+\".bin\")\n\n elif url.split(\":\")[0] == \"ipfs\":\n return MODEL_FASTTEXT, downloader.ipfs_download(url, directory, file_name+\".bin\")\n elif url.split(\":\")[0] == MODEL_S_TRANSFORMER:\n url = \":\".join(url.split(\":\")[1:])\n return MODEL_S_TRANSFORMER, url\n else:\n logging.error(\"Invalid encoder specified in schema definition.\")\n return None, \"\"\n\ndef memload_model (model_type, model_filename):\n \"\"\"\n Load a model from disk\n \"\"\"\n\n if model_type == MODEL_FASTTEXT:\n if model_filename:\n logging.debug(\"loading fasttext model into memory..\")\n return model_type, fasttext.load_model(model_filename)\n else:\n return None, None\n elif model_type == MODEL_S_TRANSFORMER:\n if model_filename:\n logging.debug(\"loading STransformer model into memory..\")\n return model_type, SentenceTransformer(model_filename)\n else:\n return None, None\n else:\n return None, None\n\nclass EncodeRequest ():\n def __init__(self, id_in, text_in):\n self.id = id_in\n self.text = text_in\n\nclass Encoder ():\n def __init__(self, encoder_name_in, request_queue_in):\n self.encoder_name = get_url_hash(encoder_name_in)\n # to handle requests\n self.request_queue = request_queue_in\n self.request_id_counter = 0\n self.request_id_counter_max = 10000\n # to handle responses\n self.response_queue = [None] * self.request_id_counter_max\n\n def __del__(self):\n logging.debug(\"killed encoder for database\")\n\n def count_request_id (self):\n ret_ = self.request_id_counter\n self.request_id_counter = (self.request_id_counter + 1) % self.request_id_counter_max\n return ret_\n\n def preload_model (self, json_schema, database_name):\n \"\"\"\n Download a model and load it into memory\n \"\"\"\n\n # prefill model & hash dictionary\n global model_dict\n \n try:\n # load model if not done already\n if not model_dict.get(self.encoder_name):\n model_type_, model_file_loc_ = download_model(get_url(json_schema), model_dir, self.encoder_name)\n # download success\n if model_file_loc_ != None:\n model_dict[self.encoder_name] = {}\n # load into memory\n model_dict[self.encoder_name][\"type\"], model_dict[self.encoder_name][\"model\"] = memload_model(model_type_, model_file_loc_)\n # memory loading failed\n if model_dict[self.encoder_name][\"type\"] == None:\n logging.error(\"Memory loading of model failed\")\n return False\n else:\n return False\n\n if model_dict[self.encoder_name].get(\"model\"):\n logging.debug(\"Model loaded for database: \"+database_name)\n return True\n else:\n logging.error(\"Model loading failed for database: \"+database_name)\n # reset DB - hash map\n del model_dict[self.encoder_name]\n return False\n else:\n return True\n\n except Exception as e:\n logging.error(e)\n return False\n\n async def enqueue_compress_data (self, texts):\n \"\"\"\n Add to request queue for compression \n \"\"\"\n request_ = EncodeRequest(self.count_request_id(), texts)\n\n await self.request_queue.put(request_)\n\n return request_.id\n\n async def process_queue (self):\n \"\"\"\n Load an already existing model, pop request queue,\n compress information, push to response queue\n \"\"\"\n\n request_data = []\n request_metadata = []\n max_batch_len = PREDICT_BATCH_SIZE # model's batching capacity\n # create batch from req. queue\n while(not self.request_queue.empty()):\n # get an item from queue\n section_ = await self.request_queue.get()\n request_data += section_.text\n request_metadata.append( (section_.id, len(section_.text)) )\n # check max. batch length achieved\n if len(request_data) > max_batch_len:\n break\n\n\n # prefill model & hash dictionary\n global model_dict\n\n # model_dict[self.encoder_name]\n if not model_dict.get(self.encoder_name):\n # try dynamic loading of model\n try:\n model_dict[self.encoder_name] = {}\n model_dict[self.encoder_name][\"type\"], model_dict[self.encoder_name][\"model\"] = memload_model(MODEL_FASTTEXT, model_dir + self.encoder_name + \".bin\")\n except Exception as e:\n logging.error(\"Model not pre-loaded for database.\")\n logging.error(e)\n return []\n \n result = []\n try:\n # fasttext model prediction\n if model_dict[self.encoder_name][\"type\"] == MODEL_FASTTEXT:\n result = []\n # fasttext doesn't take in batch; so, loop it.\n for line_ in request_data:\n result.append(model_dict[self.encoder_name][\"model\"].get_sentence_vector(line_).tolist())\n # stransformer model prediction\n if model_dict[self.encoder_name][\"type\"] == MODEL_S_TRANSFORMER:\n result = model_dict[self.encoder_name][\"model\"].encode(request_data).tolist()\n\n except Exception as e:\n logging.error(e)\n logging.error(\"Model prediction error for database.\")\n \n # add results to response queue\n self.response_queue[request_metadata[0][0]] = result[0:request_metadata[0][1]]\n old_metadata = request_metadata[0]\n for metadata_ in request_metadata[1:]:\n self.response_queue[metadata_[0]] = result[old_metadata[1]:old_metadata[1]+metadata_[1]]\n old_metadata = metadata_\n"
},
{
"path": "aquila/encoder/index.py",
"content": "import logging\n\nfrom quart import Quart\nfrom quart import request\n\nfrom functools import wraps\nimport asyncio\n\nfrom utils import config\nimport authentication\nimport manager as man_\n\napp = Quart(__name__, instance_relative_config=True)\n\n# Server starter\ndef quartserver ():\n \"\"\"\n start server\n \"\"\"\n app.run(host='0.0.0.0', port=5002, debug=False)\n\n# Add authentication\ndef authenticate ():\n def decorator (f):\n @wraps(f)\n async def wrapper (*args, **kwargs):\n params = await extract_request_params(request)\n\n if not params or not \"data\" in params or not \"signature\" in params:\n return \"Unauthorised access\", 401\n\n if not authentication.check(params[\"data\"], params[\"signature\"]):\n return \"Unauthorised access\", 401\n\n return await f(*args, **kwargs)\n\n return wrapper\n return decorator\n\nasync def extract_request_params (request):\n if not request.is_json:\n logging.error(\"Cannot parse request parameters\")\n\n # request is invalid\n return {}\n\n # Extract JSON data\n data_ = await request.get_json()\n\n return data_\n\n@app.route(\"/\", methods=['GET'])\ndef info ():\n \"\"\"\n Check server status\n \"\"\"\n\n # Build response\n return {\n \"success\": True,\n \"message\": \"AquilaHub is running healthy\"\n }, 200\n\n@app.route(\"/prepare\", methods=['POST'])\n@authenticate()\nasync def prepare_model ():\n \"\"\"\n Preload and prepare model from schema definition\n \"\"\"\n\n # get parameters\n params = (await extract_request_params(request)).get(\"data\")\n\n if not params:\n # Build error response\n return {\n \"success\": False,\n \"message\": \"Invalid parameters\"\n }, 400\n\n if \"schema\" in params:\n database_name = app.manager.preload_model(params.get(\"schema\"))\n\n # Build response\n if database_name:\n return {\n \"success\": True,\n \"databaseName\": database_name\n }, 200\n else:\n return {\n \"success\": False,\n \"message\": \"Invalid schema definition\"\n }, 400\n else:\n return {\n \"success\": False,\n \"message\": \"Invalid parameters\"\n }, 400\n\n@app.route(\"/compress\", methods=['POST'])\nasync def compress_data ():\n \"\"\"\n generate embeddings for an input data\n \"\"\"\n\n # get parameters\n params = (await extract_request_params(request)).get(\"data\")\n\n if not params:\n # Build error response\n return {\n \"success\": False,\n \"message\": \"Invalid parameters\"\n }, 400\n\n if \"text\" in params and \"databaseName\" in params:\n vectors = await app.manager.compress_data(params.get(\"databaseName\"), params.get(\"text\"))\n\n # Build response\n if vectors:\n return {\n \"success\": True,\n \"vectors\": vectors\n }, 200\n else:\n return {\n \"success\": False,\n \"message\": \"Database not found\"\n }, 400\n else:\n return {\n \"success\": False,\n \"message\": \"Invalid parameters\"\n }, 400\n\n@app.before_serving\nasync def init_variables():\n app.manager = man_.Manager()\n # prepare HUB from backup\n try:\n app.manager.prepare_hub()\n except Exception as e:\n logging.error(\"Backup restore failed\")\n logging.error(e)\n # initialize background task controller\n app.manager.bg_task_active = True\n\n@app.before_serving\nasync def init_tasks():\n # initialize background task\n app.manager.background_task = asyncio.ensure_future(app.manager.background_task())\n # app.add_background_task(background_task)\n\n@app.after_serving\nasync def shutdown():\n # shutdown background task\n app.manager.bg_task_active = False\n app.manager.background_task.cancel()\n\nif __name__ == \"__main__\":\n quartserver()"
},
{
"path": "aquila/encoder/ipfs.service",
"content": "[Unit]\nDescription=IPFS daemon\nAfter=network.target\n\n[Service]\n### custom ipfs datastore location\n# Environment=IPFS_PATH=/path/to/your/ipfs/datastore\nExecStart=/usr/local/bin/ipfs daemon\nRestart=on-failure\n\n[Install]\nWantedBy=default.target\n"
},
{
"path": "aquila/encoder/manager.py",
"content": "import logging\nlogging.basicConfig()\nlogging.getLogger().setLevel(logging.DEBUG)\n\nimport asyncio\nimport os\nimport json\nimport copy\n\nfrom utils import CID, schema\n\nimport encoder as enc_\n\nSLEEP_PROTECTION = 0.0001\n\ndef get_database_name (schema_in):\n \"\"\"\n Get databse name from schema\n \"\"\"\n\n database_name = None\n try:\n schema_def = schema.generate_schema(schema_in)\n database_name = CID.doc2CID(schema_def)\n except Exception as e:\n logging.error(e)\n\n return database_name\n\ndef get_encoder_name (schema_in):\n \"\"\"\n Get encoder name from schema\n \"\"\"\n\n encoder_name = None\n try:\n schema_def = schema.generate_schema(schema_in)\n encoder_name = schema_def[\"encoder\"]\n except Exception as e:\n logging.error(e)\n\n return encoder_name\n\nclass Manager ():\n def __init__ (self):\n # to track all database - encoder mappings\n self.db_to_encoders_map = {}\n self.encoders_to_obj_map = {}\n\n def __del__ (self):\n logging.debug(\"Killed manager\")\n\n def persist_db (self, json_schema, database_name, persist=True):\n # do nothing \n if not persist:\n logging.debug(\"Skipping schema persist to Disk\")\n return database_name\n\n # create backup directory\n location = os.environ[\"DATA_STORE_LOCATION\"]+\"hub_backup/\"\n try:\n if not os.path.exists(location):\n # create backup directory\n os.mkdir(location)\n except Exception as e:\n logging.error(\"Backup directory creation failed\")\n logging.error(e)\n return None\n\n # store schema, replacing the old one\n try:\n with open(location+database_name, \"w\") as f_:\n json.dump(json_schema, f_)\n except Exception as e:\n logging.error(\"Schema JSON writing failed\")\n logging.error(e)\n return None\n\n return database_name\n\n # initial preperation of Aquila HUB from backup\n def prepare_hub (self):\n # load schema files\n location = os.environ[\"DATA_STORE_LOCATION\"]+\"hub_backup/\"\n for database_name in os.listdir(location):\n with open(location+database_name, \"r\") as schema__:\n schema_ = json.load(schema__)\n database_name_ = self.preload_model(schema_, persist=False)\n if database_name_ == None:\n logging.debug(\"Model preloading failed for database: \"+database_name)\n elif database_name_ == database_name:\n logging.debug(\"Model preloaded for database: \"+database_name)\n else:\n logging.debug(\"Model missmatch for database \"+database_name+\", schema backup is modified. Hope you know what you're doing.\")\n\n def preload_model (self, json_schema, persist=True):\n \"\"\"\n Download a model and load it into memory\n \"\"\"\n # create a schema copy\n schema_copy = copy.deepcopy(json_schema)\n # parse schema\n # NOTE: get_database_name makes modifications to \"json_schema\" variable\n # so, beware of it's subsequent usage. If you want to use the original schema,\n # use \"schema_copy\" variable instead\n database_name = get_database_name(json_schema)\n encoder_name = get_encoder_name(json_schema)\n \n # load model for database\n if database_name:\n # database already not created?\n if not self.db_to_encoders_map.get(database_name):\n self.db_to_encoders_map[database_name] = encoder_name\n # encoder already not created?\n if not self.encoders_to_obj_map.get(encoder_name):\n self.encoders_to_obj_map[encoder_name] = enc_.Encoder(encoder_name, asyncio.Queue())\n # encoder already loaded?\n if self.encoders_to_obj_map[encoder_name].preload_model(json_schema, database_name):\n return self.persist_db(schema_copy, database_name, persist)\n else:\n # reset all, don't create DB & encoder\n self.encoders_to_obj_map[encoder_name] = None\n self.db_to_encoders_map[database_name] = None\n return None\n else:\n return self.persist_db(schema_copy, database_name, persist)\n else:\n return self.persist_db(schema_copy, database_name, persist)\n else:\n return None\n\n async def compress_data (self, database_name, texts):\n \"\"\"\n Load an already existing database \n \"\"\"\n if self.db_to_encoders_map.get(database_name):\n encoder_name = self.db_to_encoders_map[database_name]\n if self.encoders_to_obj_map.get(encoder_name):\n response_ = None\n # add compression request to queue, get request id\n req_id = await self.encoders_to_obj_map[encoder_name].enqueue_compress_data(texts)\n # wait until request id is processed\n while (True):\n # response available yet?\n response_ = self.encoders_to_obj_map[encoder_name].response_queue[req_id]\n if response_ != None:\n # response available; take it, reset queue & break waiting\n self.encoders_to_obj_map[encoder_name].response_queue[req_id] = None\n break\n # sleep for a while\n await asyncio.sleep(SLEEP_PROTECTION)\n return response_\n else:\n return None\n else:\n return None\n\n # define background task to process request queue for each database object\n async def background_task(self):\n logging.debug(\"===== Background task INIT =====\")\n while self.bg_task_active:\n # for each database object\n for key_ in self.encoders_to_obj_map:\n # any request available in queue?\n if self.encoders_to_obj_map[key_].request_queue.empty():\n continue\n # process request\n await self.encoders_to_obj_map[key_].process_queue()\n\n await asyncio.sleep(SLEEP_PROTECTION)\n"
},
{
"path": "aquila/encoder/requirements.txt",
"content": "aiofiles==0.8.0\nbase58==2.1.1\nblinker==1.4\nbson==0.5.10\ncertifi==2021.10.8\nchardet==4.0.0\ncharset-normalizer==2.0.10\nclick==8.0.3\nfastjsonschema==2.15.3\nfasttext==0.9.2\nfilelock==3.4.2\nh11==0.12.0\nh2==4.1.0\nhpack==4.0.0\nhuggingface-hub==0.4.0\nhypercorn==0.13.2\nhyperframe==6.0.1\nidna==3.3\nitsdangerous==2.0.1\nJinja2==3.0.3\njoblib==1.1.0\nMarkupSafe==2.0.1\nnltk==3.6.7\nnumpy==1.22.0\npackaging==21.3\nPillow==9.0.0\npriority==2.0.0\npybind11==2.9.0\npycryptodome==3.12.0\npyparsing==3.0.6\npython-dateutil==2.8.2\nPyYAML==6.0\nquart==0.16.2\nregex==2021.11.10\nrequests==2.27.1\nsacremoses==0.0.47\nscikit-learn==1.0.2\nscipy==1.7.3\nsentence-transformers==2.1.0\nsentencepiece==0.1.96\nsix==1.16.0\nthreadpoolctl==3.0.0\ntokenizers==0.10.3\ntoml==0.10.2\ntorch==1.10.1\ntorchvision==0.11.2\ntqdm==4.62.3\ntransformers==4.15.0\ntyping-extensions==4.0.1\nurllib3==1.26.8\nWerkzeug==2.0.2\nwsproto==1.0.0"
},
{
"path": "aquila/encoder/run_tests.sh",
"content": "# rm -r /data/*\n\npython3 -m unittest test.apis.hub_fns -v"
},
{
"path": "aquila/encoder/test/__init__.py",
"content": ""
},
{
"path": "aquila/encoder/test/apis/hub_fns.py",
"content": "import unittest\n\nfrom utils import CID, schema\n\nfrom Crypto.Hash import SHA384\nfrom Crypto.PublicKey import RSA\nfrom Crypto.Signature import pkcs1_15\nimport base58\n\nimport requests\nfrom requests.structures import CaseInsensitiveDict\nimport json\nimport bson\n\nhost = \"127.0.0.1:5002\"\n\n\n# load private key\nwith open(\"private_unencrypted.pem\", \"r\") as pkf:\n k = pkf.read()\n priv_key = RSA.import_key(k)\n\nclass TestAuth (unittest.TestCase):\n\n # Preload a model\n def test_1_auth_preload_http (self):\n\n schema_def_ = {\n \"description\": \"this is my database\",\n \"unique\": \"r8and0mseEd905\",\n \"encoder\": \"ftxt:https://ftxt-models.s3.us-east-2.amazonaws.com/ftxt_base_min.bin\",\n \"codelen\": 25,\n \"metadata\": {}\n }\n\n # generate schema \n schema_def = schema.generate_schema(schema_def_)\n database_name = CID.doc2CID(schema_def)\n\n # 1. test preperation\n data_ = { \"schema\": schema_def_ }\n data_bson = bson.dumps(data_)\n # generate hash\n hash = SHA384.new()\n hash.update(data_bson)\n \n # Sign with pvt key\n signer = pkcs1_15.new(priv_key)\n signature = signer.sign(hash)\n signature = base58.b58encode(signature).decode(\"utf-8\")\n\n url = \"http://\"+host+\"/prepare\"\n\n headers = CaseInsensitiveDict()\n headers[\"Content-Type\"] = \"application/json\"\n\n data = {\n \"data\": data_,\n \"signature\": signature\n }\n\n data = json.dumps(data)\n\n\n resp = requests.post(url, headers=headers, data=data)\n \n database_name_ = resp.json()[\"databaseName\"]\n # check databases are the same\n self.assertEqual(database_name, database_name_, \"DB name doesn't match\")\n\n # 2. test compression\n data_ = {\"databaseName\": database_name_, \"text\": [\"data one\", \"data two\"]}\n url = \"http://\"+host+\"/compress\"\n\n headers = CaseInsensitiveDict()\n headers[\"Content-Type\"] = \"application/json\"\n\n data = {\n \"data\": data_\n }\n\n data = json.dumps(data)\n\n\n resp = requests.post(url, headers=headers, data=data)\n\n # # check returned array is valid\n self.assertEqual(len(resp.json()[\"vectors\"]), len(data_[\"text\"]), \"Compressed items doesn't match query\")\n self.assertEqual(len(resp.json()[\"vectors\"][0]), schema_def_[\"codelen\"], \"Compressed code length doesn't match\")\n\n # Preload a model\n def test_2_auth_preload_ipfs (self):\n\n schema_def_ = {\n \"description\": \"this is my database\",\n \"unique\": \"r8and0mseEd905\",\n \"encoder\": \"ftxt:ipfs://QmT9CECrTwUhAPw6VHgxcLciH4EBepkXJmSB9y2rchsVQz\",\n \"codelen\": 25,\n \"metadata\": {}\n }\n\n # generate schema \n schema_def = schema.generate_schema(schema_def_)\n database_name = CID.doc2CID(schema_def)\n\n # 1. test preperation\n data_ = { \"schema\": schema_def_ }\n data_bson = bson.dumps(data_)\n # generate hash\n hash = SHA384.new()\n hash.update(data_bson)\n \n # Sign with pvt key\n signer = pkcs1_15.new(priv_key)\n signature = signer.sign(hash)\n signature = base58.b58encode(signature).decode(\"utf-8\")\n\n url = \"http://\"+host+\"/prepare\"\n\n headers = CaseInsensitiveDict()\n headers[\"Content-Type\"] = \"application/json\"\n\n data = {\n \"data\": data_,\n \"signature\": signature\n }\n\n data = json.dumps(data)\n\n\n resp = requests.post(url, headers=headers, data=data)\n \n database_name_ = resp.json()[\"databaseName\"]\n # check databases are the same\n self.assertEqual(database_name, database_name_, \"DB name doesn't match\")\n\n # 2. test compression\n data_ = {\"databaseName\": data_[\"databaseName\"], \"text\": [\"data one\", \"data two\"]}\n url = \"http://\"+host+\"/compress\"\n\n headers = CaseInsensitiveDict()\n headers[\"Content-Type\"] = \"application/json\"\n\n data = {\n \"data\": data_\n }\n\n data = json.dumps(data)\n\n\n resp = requests.post(url, headers=headers, data=data)\n\n # check returned array is valid\n self.assertEqual(len(resp.json()[\"vectors\"]), len(data_[\"text\"]), \"Compressed items doesn't match query\")\n self.assertEqual(len(resp.json()[\"vectors\"][0]), schema_def_[\"codelen\"], \"Compressed code length doesn't match\")\n\n\nif __name__ == '__main__':\n unittest.main()\n"
},
{
"path": "aquila/encoder/test.py",
"content": "from aquilapy import Wallet, DB, Hub\nimport numpy as np\nimport time\n\nimport multiprocessing as mp\n\n# Create a wallet instance from private key\nwallet = Wallet(\"/home/iamjbn/aquilax/ossl/private_unencrypted.pem\")\n\nhost = \"http://127.0.0.1\"\n\n# Connect to Aquila Hub instance\nhub = Hub(host, \"5002\", wallet)\n\n# Schema definition to be used\nschema_def = {\n \"description\": \"AquilaX-CE default user index\",\n \"unique\": \"user_id1\",\n \"encoder\": \"ftxt:http://0.0.0.0:2000/cc.en.300.bin\",\n \"codelen\": 300,\n \"metadata\": {\n \"url\": \"string\",\n \"text\": \"string\"\n }\n}\n\ndef run_test (index_in):\n print('index_in:', index_in)\n\n # Craete a database with the schema definition provided\n db_name_ = hub.create_database(schema_def)\n\n # Generate encodings\n texts = [\"Sure, technically these are processes, and this program should really be called a process spawning manager, but this is only due to the way that BASH works when it forks using the ampersand, it uses the fork() or perhaps clone() system call which clones into a separate memory space, rather than something like pthread_create() which would share memory. If BASH supported the latter, each sequence of execution would operate just the same and could be termed to be traditional threads whilst gaining a more efficient memory footprint.\",\n \"Sure, technically these are processes, and this program should really be called a process spawning manager, but this is only due to the way that BASH works when it forks using the ampersand, it uses the fork() or perhaps clone() system call which clones into a separate memory space, rather than something like pthread_create() which would share memory. If BASH supported the latter, each sequence of execution would operate just the same and could be termed to be traditional threads whilst gaining a more efficient memory footprint.\",\n \"Sure, technically these are processes, and this program should really be called a process spawning manager, but this is only due to the way that BASH works when it forks using the ampersand, it uses the fork() or perhaps clone() system call which clones into a separate memory space, rather than something like pthread_create() which would share memory. If BASH supported the latter, each sequence of execution would operate just the same and could be termed to be traditional threads whilst gaining a more efficient memory footprint.\",\n \"Sure, technically these are processes, and this program should really be called a process spawning manager, but this is only due to the way that BASH works when it forks using the ampersand, it uses the fork() or perhaps clone() system call which clones into a separate memory space, rather than something like pthread_create() which would share memory. If BASH supported the latter, each sequence of execution would operate just the same and could be termed to be traditional threads whilst gaining a more efficient memory footprint.\"]\n compression = hub.compress_documents(db_name_, texts)\n print(len(compression)==len(texts))\n\n# test concurrency\ndef test_concurrency_thread (counter_upto):\n start = time.time()\n print(\"starting thread\")\n \n pool = mp.Pool(500) #mp.cpu_count())\n pool.map(run_test, range(counter_upto))\n pool.close()\n pool.join()\n \n end = time.time()\n print(end-start, counter_upto)\n start = end\n\ntest_concurrency_thread(10000)\n\n\n# test model downloads from different sources\nschema_def[\"encoder\"] = \"ftxt:http://0.0.0.0:2000/cc.en.300.bin\"\nschema_def[\"codelen\"] = 300\nprint(schema_def)\n\ndb_name_ = hub.create_database(schema_def)\nprint(db_name_)\n\n\n# test model downloads from different sources\nschema_def[\"encoder\"] = \"ftxt:ipfs://QmY2FFRuW4xVeCDkwgwkWcq1aHaKFjfbEHPXjEEuQYax4P\"\nschema_def[\"codelen\"] = 300\n\ndb_name_ = hub.create_database(schema_def)\nprint(db_name_)\n"
},
{
"path": "aquila/encoder/utils/CID.py",
"content": "import logging\n\nimport bson\nimport hashlib\nimport base58\n\ndef doc2CID (inp):\n try:\n # JSON OBJ to BSON encode\n bson_ = bson.dumps(inp)\n # SHA-256 Double Hashing\n hash_ = hashlib.sha256(bson_)\n hash_ = hashlib.sha256(hash_.digest())\n # Convert to Base-58 string\n b58c_ = base58.b58encode(hash_.digest())\n\n return b58c_.decode('utf-8')\n except Exception as e:\n logging.debug(e)\n return None\n\ndef doc2bson (inp):\n try:\n # JSON OBJ to BSON encode\n bson_ = bson.dumps(inp)\n\n return bson_\n except Exception as e:\n logging.debug(e)\n return None\n\ndef bson2doc (inp):\n try:\n # BSON to JSON OBJ\n json_ = bson.loads(inp)\n\n return json_\n except Exception as e:\n logging.debug(e)\n return None"
},
{
"path": "aquila/encoder/utils/config.py",
"content": "import yaml\nimport os\n\nos.environ[\"DATA_STORE_LOCATION\"] = \"/data/\"\n\nwith open(\"config.yml\", \"r\") as stream:\n DB_config = yaml.safe_load(stream)\n \n if \"AUTH_KEY_FILE\" not in os.environ:\n os.environ[\"AUTH_KEY_FILE\"] = str(DB_config[\"auth\"][\"pubkey\"])\n if \"IPFS_GATEWAY\" not in os.environ:\n os.environ[\"IPFS_GATEWAY\"] = str(DB_config[\"ipfs\"][\"gateway\"])\n"
},
{
"path": "aquila/encoder/utils/cryptops.py",
"content": "import logging\n\nfrom Crypto.Hash import SHA384\nfrom Crypto.PublicKey import RSA\nfrom Crypto.Signature import pkcs1_15\n\nimport base58\n\nimport chardet\n\nimport bson\n\ndef read_public_key (location):\n # disk read public key\n with open(location, \"r\") as pkf:\n k = pkf.read()\n pub_key = RSA.import_key(k)\n\n return pub_key\n\ndef verify_signature (json_data, pub_key, signature):\n \n ret = True\n\n binary_data = bson.dumps(json_data)\n\n # generate hash\n hash = SHA384.new()\n hash.update(binary_data)\n \n signature = base58.b58decode(signature)\n\n # Verify with pub key\n verifier = pkcs1_15.new(pub_key)\n \n try:\n verifier.verify(hash, signature)\n except Exception as e:\n logging.debug(e)\n ret = False\n\n return ret"
},
{
"path": "aquila/encoder/utils/downloader.py",
"content": "import logging\n\nimport os\nimport time\n\nimport requests\nfrom tqdm import tqdm\n\ndef download_large_file (url, location, method=\"get\"):\n r = None\n if method == \"get\":\n r = requests.get(url, stream=True)\n if method == \"post\":\n r = requests.post(url, stream=True)\n\n if r != None:\n r.raise_for_status()\n total_size_in_bytes= int(r.headers.get('content-length', 0))\n block_size = 1024*5\n progress_bar = tqdm(total=total_size_in_bytes, unit='iB', unit_scale=True)\n with open(location, 'wb') as f:\n for chunk in r.iter_content(chunk_size=block_size):\n progress_bar.update(len(chunk))\n f.write(chunk)\n\n r.close()\n progress_bar.close()\n if total_size_in_bytes != 0 and progress_bar.n != total_size_in_bytes:\n logging.error(\"Download failed.\")\n os.remove(location)\n return False\n return True\n\ndef http_download (url, directory, file_name):\n \"\"\"\n Download model via http\n \"\"\"\n try:\n # create models dir, if not exists\n if not os.path.exists(directory):\n os.makedirs(directory)\n\n original_bin_file_name = url.split(\"/\")[-1]\n # check if model already exists\n if not os.path.exists(directory+original_bin_file_name):\n # download file\n logging.debug(\"Downloading model..\")\n # download from given url\n status = download_large_file(url, directory+original_bin_file_name)\n # failed??\n if not status:\n return None\n if not os.path.exists(directory+file_name):\n # copy and rename model\n logging.debug(\"Copy model..\")\n os.symlink(directory+original_bin_file_name, directory+file_name)\n except Exception as e:\n logging.error(e)\n return None\n\n return directory+file_name\n\ndef ipfs_download (url, directory, file_name):\n \"\"\"\n Download model via IPFS\n \"\"\"\n try:\n # create models dir, if not exists\n if not os.path.exists(directory):\n os.makedirs(directory)\n\n IPFS_CID = url.split(\"ipfs://\")[1]\n original_bin_file_name = IPFS_CID\n # check if model already exists\n if not os.path.exists(directory+original_bin_file_name):\n # download file\n logging.debug(\"Downloading model..\")\n logging.debug(\"Connecting to local IPFS demon..\")\n # download from IPFS local API\n url_ = os.environ[\"IPFS_GATEWAY\"]+\"/ipfs/\"+IPFS_CID\n status = download_large_file(url_, directory+original_bin_file_name)\n # failed??\n if not status:\n return None\n if not os.path.exists(directory+file_name):\n # copy and rename model\n logging.debug(\"Copy model..\")\n os.symlink(directory+original_bin_file_name, directory+file_name)\n except Exception as e:\n logging.error(e)\n return None\n \n return directory+file_name\n "
},
{
"path": "aquila/encoder/utils/schema.py",
"content": "import logging\n\nimport fastjsonschema\n\ndef generate_schema (template):\n # get all keys from template schema\n metadata_templ = template.get(\"metadata\")\n if metadata_templ:\n del template[\"metadata\"]\n else:\n metadata_templ = {}\n\n keys_ = list(template.keys())\n\n # sort keys\n keys_.sort()\n\n # validate required keys\n req_k = [\"description\", \"encoder\", \"unique\"]\n for r_ in req_k:\n if r_ not in keys_:\n # cannot continue, invalid schema\n return None\n\n # generate schema in sorted keys\n generated_schema = { \n \"$schema\": \"http://json-schema.org/schema#\", \n \"$id\": \"http://aquilanetwork.com/schema/id/v1\", \n \"title\": \"Schema\", \n \"description\": \"\",\n \"encoder\": \"\",\n \"unique\": \"\",\n \"type\": \"object\",\n \"properties\": {\n \"code\": {\n \"description\": \"Encoded data\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"number\"\n }\n },\n \"metadata\": {\n \"$ref\": \"#/definitions/metadata\"\n }\n },\n \"definitions\": {\n \"metadata\": {\n \"description\": \"User defined metadata\",\n \"type\": \"object\",\n \"properties\": {},\n \"required\": []\n }\n },\n \"required\": [\"code\", \"metadata\"]\n }\n\n metadata = {}\n metadata_types = [\"number\", \"string\"]\n\n for key_ in keys_:\n if key_ in req_k:\n # fill in root level keys\n generated_schema[key_] = template[key_]\n elif key_ == \"codelen\":\n generated_schema[\"properties\"][\"code\"][\"maxItems\"] = template[key_]\n else:\n # fill in root level keys :: extra info that we don't care\n generated_schema[key_] = template[key_]\n\n for key_ in metadata_templ.keys():\n # check type is predefined\n if metadata_templ[key_] not in metadata_types:\n return None\n\n # fill in metadata keys\n metadata[key_] = {\n \"type\": metadata_templ[key_]\n }\n\n generated_schema[\"definitions\"][\"metadata\"][\"properties\"] = metadata\n generated_schema[\"definitions\"][\"metadata\"][\"required\"] = list(metadata.keys())\n\n # validate values\n if type(generated_schema[\"properties\"][\"code\"].get(\"maxItems\")) != int:\n return None\n \n return generated_schema\n\ndef compile (schema_def):\n # compile schema\n validator = fastjsonschema.compile(schema_def)\n\n return validator\n\ndef validate_json_docs (validator, json_doc):\n try:\n # validate doc on schema :: will except on fail\n validator(json_doc)\n # validated\n # logging.debug(\"Schema validation success\")\n return True\n except Exception as e:\n logging.error(e)\n return False\n"
},
{
"path": "aquila/metricstore/.travis.yml",
"content": "language: node_js\n\nservices:\n - docker\n\nnode_js:\n - \"11\"\n\nbefore_install:\n - docker build -f Dockerfile_local_build -t ammaorg/aquiladb:travis .\n - docker run -d -i -p 50051:50051 -t ammaorg/aquiladb:travis\n - docker ps -a\n - sudo apt-get install -y make\n - cd src\n\ninstall:\n - npm install\n - cd test\n\nscript:\n - node test.js\n\nbranches:\n only:\n - develop"
},
{
"path": "aquila/metricstore/CODE_OF_CONDUCT.md",
"content": "# AquilaDB Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as\ncontributors and maintainers pledge to making participation in our project and\nour community a harassment-free experience for everyone, regardless of age, body\nsize, disability, ethnicity, sex characteristics, gender identity and expression,\nlevel of experience, education, socio-economic status, nationality, personal\nappearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment\ninclude:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or\n advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic\n address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a\n professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable\nbehavior and are expected to take appropriate and fair corrective action in\nresponse to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or\nreject comments, commits, code, wiki edits, issues, and other contributions\nthat are not aligned to this Code of Conduct, or to ban temporarily or\npermanently any contributor for other behaviors that they deem inappropriate,\nthreatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces\nwhen an individual is representing the project or its community. Examples of\nrepresenting a project or community include using an official project e-mail\naddress, posting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event. Representation of a project may be\nfurther defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported by contacting the project team at humans@aquiladb.xyz. All\ncomplaints will be reviewed and investigated and will result in a response that\nis deemed necessary and appropriate to the circumstances. The project team is\nobligated to maintain confidentiality with regard to the reporter of an incident.\nFurther details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good\nfaith may face temporary or permanent repercussions as determined by other\nmembers of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,\navailable at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html\n\n[homepage]: https://www.contributor-covenant.org\n\nFor answers to common questions about this code of conduct, see\nhttps://www.contributor-covenant.org/faq\n"
},
{
"path": "aquila/metricstore/DB_config.yml",
"content": "docs:\n cswap: 10101 # minimum data required to start indexing\n vd: 784 # fixed vector dimension\nfaiss:\n init:\n nlist: 1 # number of cells \n nprobe: 1 # number of cells that are visited to perform a search\n bpv: 8 # bytes per vector\n bpsv: 8 # bytes per sub vector\nannoy:\n init:\n smetric: \"dot\" # similarity metric to be used\n ntrees: 500 # no. of trees\n search_k: -1 # search_k is provided in runtime and affects the search performance. A larger value will give more accurate results, but will take longer time to return.\nqueue:\n qlen: 100000 # length limit for quesues used\n sleep: 1 # thread waiting in seconds\nauth:\n pubkey: \"/ossl/public.pem\"\n"
},
{
"path": "aquila/metricstore/Dockerfile",
"content": "# start a new build stage\nFROM ubuntu:latest as builder\n\nRUN ls\n\n# set work directory\nENV ROOT_DIR /home/root\nWORKDIR $ROOT_DIR\n\n# install aquiladb\nRUN apt update && apt install -y curl && \\\n curl -s -L https://raw.githubusercontent.com/Aquila-Network/AquilaDB/master/install.sh | /bin/bash\n\n# preperations\nENV PATH=\"$ROOT_DIR/env/bin:$PATH\"\n\nSHELL [\"/bin/bash\", \"-o\", \"pipefail\", \"-c\"]\n\n# install and start demon\nRUN mkdir -p /data && \\\n printf \"#!/bin/bash\\nsource env/bin/activate && export MINI_AQDB='active' && cd adb/src && \\\n python3 index.py\" > /bin/init.sh && chmod +x /bin/init.sh\n\n# expose port\nEXPOSE 5001\n\nENTRYPOINT [\"init.sh\"]"
},
{
"path": "aquila/metricstore/DockerfileBig",
"content": "# start a new build stage\nFROM ubuntu:latest as builder\n\n# set work directory\nENV ROOT_DIR /home/root\nWORKDIR $ROOT_DIR\n\n# install aquiladb\nRUN apt update && apt install -y curl && \\\n curl -s -L https://raw.githubusercontent.com/Aquila-Network/AquilaDB/master/install.sh | /bin/bash -s -- -m 0\n\n\n# start a new runner stage\nFROM ubuntu:latest as runner\n\n# set work directory\nENV ROOT_DIR /home/root\nWORKDIR $ROOT_DIR\n\nRUN echo \"$ROOT_DIR\"\n\n# copy required files from builder stage\nCOPY --from=builder $ROOT_DIR/env $ROOT_DIR/env\nCOPY --from=builder $ROOT_DIR/adb $ROOT_DIR/adb\nCOPY --from=builder /ossl /ossl\n\n# preperations\nENV PATH=\"$ROOT_DIR/env/bin:$PATH\"\nWORKDIR $ROOT_DIR\nSHELL [\"/bin/bash\", \"-o\", \"pipefail\", \"-c\"]\n\n# install and start demon\nRUN export DEBIAN_FRONTEND=noninteractive && mkdir -p /data && apt update && \\\n apt install -y python3 libgomp1 libblas-dev liblapack-dev && \\\n printf \"#!/bin/bash\\nsource env/bin/activate && cd adb/src && \\\n python3 index.py\" > /bin/init.sh && chmod +x /bin/init.sh\n\n# expose port\nEXPOSE 5001\n\nENTRYPOINT [\"init.sh\"]\n"
},
{
"path": "aquila/metricstore/LICENSE",
"content": " Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright [yyyy] [name of copyright owner]\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n"
},
{
"path": "aquila/metricstore/README.md",
"content": "\n\n**[Aquila DB](https://github.com/Aquila-Network/AquilaDB)** is a Neural search engine. In other words, it is a database to index **Latent Vectors** generated by ML models along with **JSON Metadata** to perform **k-NN** retrieval. It is dead simple to set up, language-agnostic, and drop in addition to your Machine Learning Applications. Aquila DB, as of current features is a ready solution for Machine Learning engineers and Data scientists to build **[Neural Information Retrieval](https://www.microsoft.com/en-us/research/uploads/prod/2017/06/INR-061-Mitra-neuralir-intro.pdf)** applications out of the box with minimal dependencies.\n\n> This project is still in alpha version & we're already using it in production to power semantic search at https://aquila.network. \n\n\nWanna support this project? Yes, we love getting a **star** ⭐ and **shout-out** 🗣️ 🤗\n\nJoin [Community chat and get support: ](https://discord.gg/5YP7zHS)\n\n\n# Who is this for\n\n* If you are working on a data science project and need to store a hell of a lot of data and retrieve similar data based on some feature vector, this will be a useful tool to you, with extra benefits a real world web application needs.\n* Are you dealing with a lot of images and related metadata? Want to find similar ones? You are at the right place.\n* If you are looking for a document database, this is not the right place for you.\n\n# Technology\nAquila DB powers search features of Aquila Network. Here is where Aquila DB fits in the entire ecosystem:\n\n
\n
\n
\n\n\n\nIf you are serious and wanna dive down the rabbit hole, read our **[whitepapers](https://github.com/Aquila-Network/whitepaper)** and **[technical specifications](https://github.com/Aquila-Network/specs)** (being actively worked on). \n\n\n\n**As a side note**, everything in **[Aquila Network](https://github.com/Aquila-Network)** is defined by the specifications and a large chunk of our efforts goes into it. We also maintain quality implementations of those specifications with non-technical users in mind. This is to make sure that - Aquila Network is fully open, decentralized by design, and Fair. You can follow those specifications to implement your alternative software and still interact with the network without any restrictions.\n\n# Install\n### Debian\n\nRun `curl -s -L https://raw.githubusercontent.com/Aquila-Network/AquilaDB/master/install.sh | /bin/bash -s -- -d 1 `.\n\n### Docker\n\n**You need docker installed in your system**\n\nBuild image (lite): `docker build https://raw.githubusercontent.com/Aquila-Network/AquilaDB/master/Dockerfile -t aquiladb:local`\n\nBuild image (big data): `docker build https://raw.githubusercontent.com/Aquila-Network/AquilaDB/master/DockerfileBig -t aquiladb:localbg`\n\nRun image (to deploy Aquila DB lite): `docker run -p 5001:5001 -d aquiladb:local`\n\nRun image (to deploy Aquila DB big): `docker run -p 5001:5001 -d aquiladb:localbg`\n\n# Client SDKs\nWe currently have multiple client libraries in progress to abstract the communication between deployed Aquila DB and your applications.\n\n[Python](https://github.com/Aquila-Network/AquilaPy)\n\n[Node JS](https://github.com/Aquila-Network/AquilaJS)\n\n## Where to get private key (wallet key) for client authentication\nWhen you use a client library to authenticate with AquilaDB, you might need access the same private key (wallet key) used by AquilaDB. This key is located inside `/ossl/` directory within AquilaDB docker container (in your computer if you have installed AquilaDB directly without docker). To access the keys inside your AquilaDB container, follow below steps:\n\n* identify `CONTAINER ID` for the already running `aquiladb` docker instance:\n`docker ps`\n* take a copy of private keys from docker container to your host machine:\n`docker cp CONTAINER_ID:/ossl/ ./`\n* now you will see a new directory named `ossl` at your current location. Use the keys inside it.\n#### tips for advanced users\nIf your pipeline requires the private keys to be generated in advance, you can do it in your host machine and then mount it to the container's `/ossl/` directory. \n\nRun:\n```\nmkdir -p \n
](http://www.youtube.com/watch?v=-VYpjpLXU5Q)\n\nAs of current AquilaDB release features, you can build **[Neural Information Retrieval](https://www.microsoft.com/en-us/research/uploads/prod/2017/06/INR-061-Mitra-neuralir-intro.pdf)** applications out of the box without any external dependencies. Here are some useful links to learn more about it and start building:\n\n* Microsoft published a paper and youtube video on this to onboard anyone interested: \n * paper: https://www.microsoft.com/en-us/research/uploads/prod/2017/06/INR-061-Mitra-neuralir-intro.pdf\n * video: https://www.youtube.com/watch?v=g1Pgo5yTIKg\n* Embeddings for Everything: Search in the Neural Network Era: https://www.youtube.com/watch?v=JGHVJXP9NHw\n* Autoencoders are one such deep learning algorithms that will help you to build semantic vectors - foundation for Neural Information retrieval. Here are some links to Autoencoders based IR:\n * go to chapter 15 in this link: https://www.cs.toronto.edu/~hinton/coursera_lectures.html\n * https://www.coursera.org/lecture/ml-foundations/examples-of-document-retrieval-in-action-CW25H\n * https://www.coursera.org/lecture/intro-to-deep-learning/autoencoders-101-QqBOa\n* Note that, the idea of information retrieval applies not only to text data but for any data. All you need to do is, encode any source datatype to a dense vector with deep neural networks.\n\n\n
Our Sponsors
\n\n\n
\n\n> email us to sponsor this project [adbadmin@protonmail.ch](mailto:adbadmin@protonmail.ch).\n\n
\n\n# Citing Aquila DB\nIf you use Aquila DB in an academic paper, we would 😍 to be cited. Here are the two ways of citing Aquila DB:\n```\n\\footnote{https://github.com/Aquila-Network/AquilaDB}\n```\n```\n@misc{AquilaNetwork2019AquilaDB,\n title={AquilaDB: Neural Search Engine},\n author={Jubin Jose, Nibin Peter},\n howpublished={\\url{https://github.com/Aquila-Network/AquilaDB}},\n year={2019}\n}\n```\n\n# License\n\nApache License 2.0 [license file](https://github.com/Aquila-Network/AquilaDB/blob/master/LICENSE)\n\ncreated by ❤️ with a-mma (a_മ്മ)\n" }, { "path": "aquila/metricstore/authentication.py", "content": "from utils import cryptops\n\nimport os\n\npub_key = cryptops.read_public_key(os.environ[\"AUTH_KEY_FILE\"])\n\ndef check (json_data, signature):\n return cryptops.verify_signature(json_data, pub_key, signature)" }, { "path": "aquila/metricstore/index.py", "content": "import logging\n\nfrom flask import Flask, request\nfrom flask_cors import CORS\nfrom flask import jsonify\nfrom functools import wraps\n\nfrom utils import config\nimport authentication\n\nimport router\n\napp = Flask(__name__, instance_relative_config=True)\n\n# Enable CORS\nCORS(app)\n\n# preload databases\nrouter.preload_databases()\n\n# Add authentication\ndef authenticate ():\n def decorator (f):\n @wraps(f)\n def wrapper (*args, **kwargs):\n params = extract_request_params(request)\n\n if not params or not \"data\" in params or not \"signature\" in params:\n return \"Unauthorised access\", 401\n\n if not authentication.check(params[\"data\"], params[\"signature\"]):\n return \"Unauthorised access\", 401\n\n return f(*args, **kwargs)\n\n return wrapper\n return decorator\n\ndef extract_request_params (request):\n if not request.is_json:\n logging.error(\"Cannot parse request parameters\")\n\n # request is invalid\n return None\n\n # Extract JSON data\n data_ = request.get_json()\n return data_\n\n@app.route(\"/\", methods=['GET'])\ndef info ():\n \"\"\"\n Check server status\n \"\"\"\n\n # Build response\n return {\n \"success\": True,\n \"message\": \"AquilaDB is running healthy\"\n }, 200\n\n@app.route(\"/db/create\", methods=['POST'])\n@authenticate()\ndef db_create ():\n \"\"\"\n Create database from schema definition\n \"\"\"\n\n # get parameters\n params = extract_request_params(request)[\"data\"]\n\n if not params:\n # Build error response\n return {\n \"success\": False,\n \"message\": \"Invalid parameters\"\n }, 400\n\n if \"schema\" in params:\n database_name = router.create_database(params.get(\"schema\"))\n\n # Build response\n if database_name:\n return {\n \"success\": True,\n \"database_name\": database_name\n }, 200\n else:\n return {\n \"success\": False,\n \"message\": \"Invalid schema definition\"\n }, 400\n\n@app.route(\"/db/doc/insert\", methods=['POST'])\n@authenticate()\ndef doc_insert ():\n \"\"\"\n insert documents\n \"\"\"\n\n # get parameters\n params = extract_request_params(request)[\"data\"]\n\n if not params:\n # Build error response\n return {\n \"success\": False,\n \"message\": \"Invalid parameters\"\n }, 400\n\n if \"docs\" in params and \"database_name\" in params:\n cids = router.insert_docs(params.get(\"docs\"), params.get(\"database_name\"))\n\n # Build response\n return {\n \"success\": True,\n \"ids\": cids\n }, 200\n\n@app.route(\"/db/doc/delete\", methods=['POST'])\n@authenticate()\ndef doc_delete ():\n \"\"\"\n delete documents by cid\n \"\"\"\n\n # get parameters\n params = extract_request_params(request)[\"data\"]\n\n if not params:\n # Build error response\n return {\n \"success\": False,\n \"message\": \"Invalid parameters\"\n }, 400\n\n if \"ids\" in params and \"database_name\" in params:\n ids = router.delete_docs(params.get(\"ids\"), params.get(\"database_name\"))\n\n # Build response\n return {\n \"success\": True,\n \"ids\": ids\n }, 200\n\n@app.route(\"/db/search\", methods=['GET'])\n@authenticate()\ndef db_search ():\n \"\"\"\n search documents\n \"\"\"\n\n # get parameters\n params = extract_request_params(request)[\"data\"]\n\n if not params:\n # Build error response\n return {\n \"success\": False,\n \"message\": \"Invalid parameters\"\n }, 400\n\n if \"matrix\" in params and \"k\" in params and \"database_name\" in params:\n docs, dists = router.search(params.get(\"matrix\"), params.get(\"k\"), None, params.get(\"database_name\"))\n\n # Build response\n return {\n \"success\": True,\n \"docs\": docs,\n \"dists\": dists\n }, 200\n\n\ndef flaskserver ():\n \"\"\"\n start server\n \"\"\"\n app.run(host='0.0.0.0', port=5001, debug=False)\n\nif __name__ == \"__main__\":\n flaskserver()\n" }, { "path": "aquila/metricstore/install.sh", "content": "#!/bin/bash -e\n\nexport DEBIAN_FRONTEND=noninteractive\napt update\n\nexport USER=$(whoami)\nexport ROOT_DIR=/home/$USER\n\nmkdir -p /data/\nmkdir -p $ROOT_DIR\ncd $ROOT_DIR\n\nmini=1\ngpu=0\ntest=0\ndemon=0\n\nwhile getopts m:g:t:d: flag\ndo\n case \"${flag}\" in\n m) mini=${OPTARG};;\n g) gpu=${OPTARG};;\n t) test=${OPTARG};;\n d) demon=${OPTARG};;\n esac\ndone\n\nif [[ $mini -eq 1 ]]; # if minimal install enabled\nthen\n echo \"Aquila DB minimal install will be done by default. \\\n Minimal install is recommended for personal use - \\\n install process is fast and lightweight. If you are planning to deal \\\n with big-data, disable minimal install with '-m 0' argument\"\nfi\n\n# system packs install\napt install -y git wget nano python3 python3-pip libssl-dev\nif [[ $mini -eq 0 ]]; # if minimal install disabled\nthen\n apt install -y libblas-dev liblapack-dev swig\nfi\n\n# setup venv\npip3 install virtualenv\nvirtualenv $ROOT_DIR/env\nsource $ROOT_DIR/env/bin/activate\n\n# install python packages\npip3 install numpy pycryptodome base58 chardet Flask requests flask_cors PyYAML bson fastjsonschema annoy plyvel\n\nif [[ $mini -eq 0 ]]; # if minimal install disabled\nthen\n # install cmake\n apt purge --auto-remove cmake\n\n version=3.19\n build=1\n mkdir -p $ROOT_DIR/temp\n cd $ROOT_DIR/temp\n wget https://cmake.org/files/v$version/cmake-$version.$build.tar.gz\n tar -xzvf cmake-$version.$build.tar.gz\n cd cmake-$version.$build/\n\n ./bootstrap\n make -j$(nproc)\n make install\n\n cmake --version\n\n # install faiss\n cd $ROOT_DIR\n mkdir -p faiss\n cd faiss\n git clone https://github.com/facebookresearch/faiss.git .\n\n if [[ $gpu -eq 0 ]]; # if gpu not enabled\n then\n echo \"build FAISS without GPU\"\n cmake -DFAISS_ENABLE_GPU=OFF -B build .\n else\n echo \"build FAISS with GPU\"\n cmake -B build .\n fi\n make -C build\n\n # For the Python interface:\n cd build/faiss/python\n python setup.py install\n\n cp -r $ROOT_DIR/faiss/build/faiss/python/ $ROOT_DIR/env/lib/python3.8/site-packages/faiss\nfi\n\n# clone & test AquilaDB\ncd $ROOT_DIR\nmkdir -p adb\ncd adb\ngit clone https://github.com/Aquila-Network/AquilaDB.git .\n\nmkdir -p /ossl/\nopenssl genrsa -passout pass:1234 -des3 -out /ossl/private.pem 2048\nopenssl rsa -passin pass:1234 -in /ossl/private.pem -outform PEM -pubout -out /ossl/public.pem\nopenssl rsa -passin pass:1234 -in /ossl/private.pem -out /ossl/private_unencrypted.pem -outform PEM\n\ncd $ROOT_DIR/adb/src\nif [[ $test -eq 1 ]]; # if tests enabled\nthen\n\tchmod +x run_tests.sh\n\t./run_tests.sh\nelse\n\techo \"Not running tests\"\nfi\n\necho \"===================================\"\necho \" AquilaDB setup complete. \"\necho \"===================================\"\n\nif [[ $demon -eq 1 ]]; # if demon run enabled\nthen\n # install node\n apt install -y nodejs npm\n # install pm2\n npm i pm2 -g\n\n # start server\n pm2 start index.py\n # Keep logs alive\n pm2 logs -f\nfi\n" }, { "path": "aquila/metricstore/manager.py", "content": "import logging\n\nfrom utils import CID, schema\n\nfrom vec_index import hannoy \n\nimport os\nis_mini_instance = os.environ[\"MINI_AQDB\"]\nif is_mini_instance == \"inactive\":\n from vec_index import hfaiss\n\nimport plyvel\n\nimport numpy as np\n\nimport json\nimport random\nimport threading\nimport queue\nimport time\nimport pickle\n\nINDEX_LABEL = [\"annoy\", \"faiss\"]\nSTORE_LOCATION = os.environ[\"DATA_STORE_LOCATION\"]\n\nTRAIN_DAT_LEN = int(os.environ[\"MIN_SAWP_COUNT\"])\nPROCESS_TIMEOUT = int(os.environ[\"THREAD_SLEEP\"])\nMAX_Q_LEN = int(os.environ[\"FIXED_Q_LEN\"])\n\ndef byt (inp):\n return bytes(str(inp), 'ascii')\n\nclass VecManager:\n\n def __init__ (self, json_schema):\n # get database name from schema CID\n database_name = CID.doc2CID(json_schema)\n\n # keep database name\n self.database_name = database_name\n\n # set DB disk location\n self.DB_disk_location = STORE_LOCATION + database_name\n\n # create data directory for database\n if not os.path.exists(self.DB_disk_location):\n os.makedirs(self.DB_disk_location)\n\n # keep schema in store location\n with open(self.DB_disk_location + '/schema.json', 'w') as oschema:\n json.dump(json_schema, oschema)\n \n # get vector index\n self.active_index = INDEX_LABEL[0]\n self.index = self.get_index(self.DB_disk_location)\n\n # Create KV store instance\n self.KV_store = plyvel.DB(self.DB_disk_location + \"/kv.db\", create_if_missing=True)\n if self.KV_store.get(byt(-1)) == None:\n self.KV_store.put(byt(-1), byt(0))\n\n # Training data holder\n self.training_data = []\n self.TD_location = self.DB_disk_location + \"/TD\"\n # Try loading training data\n self.load_TD_from_disk()\n\n # spawn worker thread\n self.q_maxsize = MAX_Q_LEN\n self.process_flag = True\n self.process_timeout_sec = PROCESS_TIMEOUT\n self.spawn()\n\n def __del__(self):\n self.process_flag = False\n if self.process_thread:\n self.process_thread.join()\n logging.debug(\"Thread stopped\")\n # close level database connection\n self.KV_store.close()\n\n def add_vectors (self, documents):\n # add to KV store\n next_index = int(self.KV_store.get(byt(-1)))\n\n # check if it is ready to swap index\n if is_mini_instance == \"inactive\" and next_index > TRAIN_DAT_LEN \\\n and self.active_index == INDEX_LABEL[0] \\\n and len(self.training_data) >= TRAIN_DAT_LEN:\n # swap index\n self.swap_index(self.DB_disk_location)\n\n # init batch write to DB\n wb_ = self.KV_store.write_batch()\n for idx_, doc_ in enumerate(documents):\n cid_ = byt(doc_[\"CID\"])\n # resize \"code\"\n doc_[\"code\"] = self.resize_vector(doc_[\"code\"], int(os.environ[\"FIXED_VEC_DIMENSION\"]))\n # cod_ = pickle.dumps(cod_)\n documents[idx_][\"_id\"] = next_index\n\n # TBD: convert to bulk insert\n wb_.put(byt(next_index), byt(len(cid_)) + cid_ + CID.doc2bson(doc_))\n wb_.put(cid_, byt(next_index))\n \n next_index += 1\n\n wb_.put(byt(-1), byt(next_index))\n # commit DB write\n wb_.write()\n\n # push to training data\n self.update_training_data(documents)\n\n # add vectors to index\n return self.index.add_vectors(documents)\n\n def delete_vectors (self, cids):\n # get ids from cids\n ids_ = []\n wb_ = self.KV_store.write_batch()\n for cid_ in cids:\n id_ = self.KV_store.get(byt(cid_))\n if id_:\n ids_.append(int(id_))\n wb_.delete(id_)\n # commit db write\n wb_.write()\n # delete vectors by ID from index\n status, ids = self.index.delete_vectors(ids_)\n\n if status and len(ids) == len(cids):\n return cids\n else:\n return []\n\n def get_nearest (self, qmatrix, k, rad):\n ids = []\n dists = []\n\n qmatrix = self.resize_matrix(qmatrix, int(os.environ[\"FIXED_VEC_DIMENSION\"]))\n\n # radius defined, \n if rad is not None:\n if k is not None:\n ids, dists = self.index.get_nearest_rad(qmatrix, rad)\n else:\n ids, dists = self.index.get_nearest_rad(qmatrix, rad)[:k]\n else:\n ids, dists = self.index.get_nearest_k(qmatrix, k)\n\n # get docs\n for idx_, idb in enumerate(ids):\n for idx__, id_ in enumerate(idb):\n value = self.KV_store.get(byt(id_))\n if value:\n cid_len_ = int(value[:2]) + 2\n ids[idx_][idx__] = CID.bson2doc(value[cid_len_:])\n else:\n ids[idx_][idx__] = None\n\n return ids, dists\n \n\n def get_index (self, location):\n index = None\n annoy_location = location + \"/h_annoy\"\n faiss_location = location + \"/h_faiss\"\n\n if is_mini_instance == \"inactive\":\n # try loading faiss\n index = hfaiss.Faiss(faiss_location)\n # check if faiss is not loaded,\n if not index.is_initiated():\n # destruct faiss\n del index\n # load annoy\n index = hannoy.Annoy(annoy_location)\n self.active_index = INDEX_LABEL[0]\n else:\n self.active_index = INDEX_LABEL[1]\n else:\n # load annoy\n index = hannoy.Annoy(annoy_location)\n self.active_index = INDEX_LABEL[0]\n\n return index\n\n def resize_vector (self, vector, dim):\n # resize vectors\n vector_l = len(vector)\n # check if the vector length is below dimention limit\n # then pad vector with 0 by dimension\n if vector_l < dim:\n vector.extend([0]*(dim-vector_l))\n # make sure vector length doesn't exceed dimension limit\n vector = vector[:dim]\n return vector\n\n def resize_matrix (self, matrix_, dim):\n # numpize\n matrix = np.array(matrix_)\n # check for valid dimensions\n if matrix.ndim < 2:\n matrix = np.array([matrix_])\n elif matrix.ndim > 2:\n logging.error(\"Invalid query dimensions\")\n return [[]]\n\n # resize vectors\n vector_l = len(matrix_[0])\n # check if the vector length is below dimention limit\n # then pad vector with 0 by dimension\n if vector_l < dim:\n matrix = np.pad(matrix, ((0, 0), (0, dim-vector_l)))\n # make sure vector length doesn't exceed dimension limit\n matrix = matrix[:, :dim]\n # listize\n return matrix.tolist()\n\n def swap_index (self, location):\n logging.debug(\"Swapping index to FAISS\")\n \n faiss_location = location + \"/h_faiss\"\n\n # init faiss index\n self.index = hfaiss.Faiss(faiss_location)\n\n # train faiss index\n self.index.init_faiss(self.training_data)\n\n # migrate data\n for idx_ in range(int(self.KV_store.get(byt(-1)))):\n value = self.KV_store.get(byt(idx_))\n \n if value:\n cid_len_ = int(value[:2]) + 2\n\n self.index.add_vectors([{\n \"_id\": int(idx_),\n \"code\": CID.bson2doc(value[cid_len_:])[\"code\"]\n }])\n\n # set active index\n self.active_index = INDEX_LABEL[1]\n\n def update_training_data (self, documents):\n # insert new vectors to array\n self.pipeline.put(documents)\n\n def save_TD_to_disk (self):\n try:\n # write index\n np.save(self.TD_location, np.array(self.training_data))\n logging.debug('Training data writing success')\n return True\n except Exception as e:\n logging.error('Training data writing failed' + str(e))\n return False\n\n def load_TD_from_disk (self):\n try:\n # load training data\n self.training_data = np.load(self.TD_location+'.npy').tolist()\n logging.debug('Training data loaded successfully')\n return True\n except Exception as e:\n logging.error('Training data loading failed' + str(e))\n self.training_data = []\n return False\n\n def process (self):\n while (self.process_flag):\n\n # set a timeout\n time.sleep(self.process_timeout_sec)\n\n # check if queue is not empty\n if not self.pipeline.empty():\n \n # fetch all currently available codes from queue\n while not self.pipeline.empty():\n # pop available codes\n for doc_ in self.pipeline.get_nowait():\n self.training_data.append(doc_[\"code\"])\n\n # shuffle array\n random.shuffle(self.training_data)\n # resize array\n self.training_data = self.training_data[:TRAIN_DAT_LEN]\n \n # write to disk\n self.save_TD_to_disk()\n\n def spawn (self):\n # create pipeline to add documents\n self.pipeline = queue.Queue(maxsize=self.q_maxsize)\n # create process thread\n self.process_thread = threading.Thread(target=self.process, args=(), daemon=True)\n # start process thread\n self.process_thread.start()\n \n" }, { "path": "aquila/metricstore/router.py", "content": "import logging\nlogging.basicConfig()\nlogging.getLogger().setLevel(logging.DEBUG)\n\nimport manager\n\nimport os\nimport json\n\nfrom utils import CID, schema\n\nSTORE_LOCATION = os.environ[\"DATA_STORE_LOCATION\"]\n\n# databases dictionary\ndatabases = {}\n\ndef preload_databases ():\n \"\"\"\n Load available databases from disk\n \"\"\"\n # list database names\n for content_ in os.listdir(STORE_LOCATION):\n # simple validation for database name (CID lenngth)\n if len(content_) >= 43: # TODO: 43 check is a bad method, replace it soon\n database_name = content_\n\n with open(STORE_LOCATION + database_name + \"/schema.json\") as ischema:\n json_schema = json.load(ischema)\n\n manager_h = manager.VecManager(json_schema)\n\n # load and create databases dict\n validator_fn = schema.compile(json_schema)\n databases[database_name] = {\n \"manager_h\": manager_h,\n \"schema\": {\n \"json\": json_schema,\n \"validator\": validator_fn\n }\n }\n\n logging.debug(\"Loaded all existing databases\")\n\ndef create_database (json_schema):\n \"\"\"\n Create a database from a given valid JSON schema\n \"\"\"\n # TBD: write ahead logging (INIT)\n\n # generate proper schema definition from templete schema\n json_schema = schema.generate_schema(json_schema)\n\n # identify invalid schema template\n if json_schema == None:\n return None\n\n # Check if database already exists\n database_name = CID.doc2CID(json_schema)\n if databases.get(database_name):\n # return database name\n logging.debug(\"Database already exists\")\n return database_name\n\n # If database doesn't exist already,\n # then create one\n manager_h = manager.VecManager(json_schema)\n\n database_name = manager_h.database_name\n\n validator_fn = schema.compile(json_schema)\n databases[database_name] = {\n \"manager_h\": manager_h,\n \"schema\": {\n \"json\": json_schema,\n \"validator\": validator_fn\n }\n }\n\n # TBD: save schema to storage\n # TBD: write ahead logging (END)\n\n return database_name\n\ndef load_database (database_name):\n \"\"\"\n Load an already existing database \n \"\"\"\n\n return databases.get(database_name)\n\ndef insert_docs (docs, database_name):\n \"\"\"\n Insert a set of valid documents to database\n \"\"\"\n\n # write ahead log (INIT)\n\n cids_ = []\n docs_ = []\n\n # get manager_h for database_name\n database_h = load_database(database_name)\n # invalid database name\n if not database_h:\n logging.debug(\"Database doesn't exist. Please create one.\")\n return cids_\n\n # validate docs against schema\n # and add CID\n \n for doc_ in docs:\n payload = doc_[\"payload\"]\n if schema.validate_json_docs(database_h[\"schema\"][\"validator\"], payload):\n CID_ = CID.doc2CID(payload)\n cids_.append(CID_)\n payload[\"CID\"] = CID_\n docs_.append(payload)\n else:\n cids_.append(None)\n \n # get manager_h for database_name\n manager_h = database_h[\"manager_h\"]\n\n manager_h.add_vectors(docs_)\n\n # write ahead log (END)\n\n return cids_\n\ndef delete_docs (ids, database_name):\n\n # write ahead log (INIT)\n\n # get manager_h for database_name\n database_h = load_database(database_name)\n # invalid database name\n if not database_h:\n logging.debug(\"Database doesn't exist. Please create one.\")\n return []\n\n return database_h[\"manager_h\"].delete_vectors(ids)\n\ndef search (matrix, k, rad, database_name):\n\n # write ahead log (INIT)\n\n # get manager_h for database_name\n database_h = load_database(database_name)\n\n return database_h[\"manager_h\"].get_nearest(matrix, k, rad)\n" }, { "path": "aquila/metricstore/run_tests.sh", "content": "rm -r /data/*\n\npython3 -m unittest test.apis.db_fns -v\npython3 -m unittest test.apis.doc_fns -v\npython3 -m unittest test.apis.search_fns -v\npython3 -m unittest test.apis.auth_fns -v" }, { "path": "aquila/metricstore/test/__init__.py", "content": "" }, { "path": "aquila/metricstore/test/apis/auth_fns.py", "content": "import unittest\n\nimport index\nfrom utils import CID, schema\n\nfrom Crypto.Hash import SHA384\nfrom Crypto.PublicKey import RSA\nfrom Crypto.Signature import pkcs1_15\nimport base58\n\nimport requests\nfrom requests.structures import CaseInsensitiveDict\nimport json\nimport bson\n\nfrom multiprocessing import Process\n\n\n# load private key\nwith open(\"/ossl/private_unencrypted.pem\", \"r\") as pkf:\n k = pkf.read()\n priv_key = RSA.import_key(k)\n\nclass TestAuth (unittest.TestCase):\n\n # A fresh DB is created\n def test_1_auth_create_db (self):\n # deploy app\n server = Process(target=index.flaskserver)\n server.start()\n\n schema_def = {\n \"description\": \"this is my database\",\n \"unique\": \"r8and0mseEd905\",\n \"encoder\": \"example.com/autoencoder/API\",\n \"codelen\": 30,\n \"metadata\": {\n \"name\": \"string\",\n \"age\": \"number\"\n }\n }\n data_ = { \"schema\": schema_def }\n data_bson = bson.dumps(data_)\n # generate hash\n hash = SHA384.new()\n hash.update(data_bson)\n \n # Sign with pvt key\n signer = pkcs1_15.new(priv_key)\n signature = signer.sign(hash)\n signature = base58.b58encode(signature).decode(\"utf-8\")\n\n url = \"http://127.0.0.1:5001/db/create\"\n\n headers = CaseInsensitiveDict()\n headers[\"Content-Type\"] = \"application/json\"\n\n data = {\n \"data\": data_,\n \"signature\": signature\n }\n\n data = json.dumps(data)\n\n\n resp = requests.post(url, headers=headers, data=data)\n \n database_name_ = resp.json()[\"database_name\"]\n\n schema_def = schema.generate_schema(schema_def)\n database_name = CID.doc2CID(schema_def)\n\n server.terminate()\n server.join()\n\n self.assertEqual(database_name, database_name_, \"DB name doesn't match\")\n\nif __name__ == '__main__':\n unittest.main()\n" }, { "path": "aquila/metricstore/test/apis/db_fns.py", "content": "import unittest\n\nimport index # includes preloading databases\nimport router\nfrom utils import CID, schema\n\nclass TestDB (unittest.TestCase):\n\n # A fresh DB is created\n def test_1_db_fresh_create (self):\n schema_def1 = {\n \"description\": \"this is my database\",\n \"unique\": \"r8and0mseEd90\",\n \"encoder\": \"example.com/autoencoder/API\",\n \"codelen\": 3,\n \"metadata\": {\n \"name\": \"string\",\n \"age\": \"number\"\n }\n }\n schema_def2 = {\n \"description\": \"this is my database\",\n \"unique\": \"r8and0mseEd90\",\n \"encoder\": \"example.com/autoencoder/API\",\n \"codelen\": 3,\n \"metadata\": {\n \"name\": \"string\",\n \"age\": \"number\"\n }\n }\n database_name = router.create_database(schema_def1)\n\n schema_def = schema.generate_schema(schema_def2)\n database_name_ = CID.doc2CID(schema_def)\n\n self.assertEqual(database_name, database_name_, \"DB name doesn't match\")\n\n # An existing DB is created\n def test_2_db_exist_create (self):\n schema_def1 = {\n \"description\": \"this is my database\",\n \"unique\": \"r8and0mseEd90\",\n \"encoder\": \"example.com/autoencoder/API\",\n \"codelen\": 3,\n \"metadata\": {\n \"name\": \"string\",\n \"age\": \"number\"\n }\n }\n schema_def2 = {\n \"description\": \"this is my database\",\n \"unique\": \"r8and0mseEd90\",\n \"encoder\": \"example.com/autoencoder/API\",\n \"codelen\": 3,\n \"metadata\": {\n \"name\": \"string\",\n \"age\": \"number\"\n }\n }\n database_name = router.create_database(schema_def1)\n\n schema_def = schema.generate_schema(schema_def2)\n database_name_ = CID.doc2CID(schema_def)\n\n self.assertEqual(database_name, database_name_, \"DB name doesn't match\")\n\nif __name__ == '__main__':\n unittest.main()\n" }, { "path": "aquila/metricstore/test/apis/doc_fns.py", "content": "import unittest\n\nimport index # includes preloading databases\nimport router\nfrom utils import CID\nimport numpy as np\n\nimport time\n\nclass TestDocs (unittest.TestCase):\n\n # A fresh doc is created\n def test_1_doc_fresh_create (self):\n # create database\n schema_def = {\n \"description\": \"this is my database\",\n \"unique\": \"r8and0mseEd901\",\n \"encoder\": \"example.com/autoencoder/API\",\n \"codelen\": 3,\n \"metadata\": {\n \"name\": \"string\",\n \"age\": \"number\"\n }\n }\n database_name = router.create_database(schema_def)\n\n # add document\n docs = [{\n \"metadata\": {\n \"name\":\"name1\", \n \"age\": 20\n },\n \"code\": [1,2,3]\n }, {\n \"metadata\": {\n \"name\":\"name2\", \n \"age\": 30\n },\n \"code\": [1,2,3]\n }]\n cids = router.insert_docs(docs, database_name)\n\n self.assertEqual(len(cids), len(docs), \"Document creation failed\")\n\n # An incomplete doc is created\n def test_1a_doc_incomplete_create (self):\n # create database\n schema_def = {\n \"description\": \"this is my database\",\n \"unique\": \"r8and0mseEd901\",\n \"encoder\": \"example.com/autoencoder/API\",\n \"codelen\": 3,\n \"metadata\": {\n \"name\": \"string\",\n \"age\": \"number\"\n }\n }\n database_name = router.create_database(schema_def)\n\n # add document with \"code\" missing\n docs = [{\n \"metadata\": {\n \"name\":\"name1\", \n \"age\": 20\n }\n }, {\n \"metadata\": {\n \"name\":\"name2\", \n \"age\": 30\n }\n }]\n cids = router.insert_docs(docs, database_name)\n\n self.assertEqual(cids, [None, None], \"Document creation test failed\")\n\n # An existing doc is created\n def test_2_doc_exist_create (self):\n # create database\n schema_def = {\n \"description\": \"this is my database\",\n \"unique\": \"r8and0mseEd901\",\n \"encoder\": \"example.com/autoencoder/API\",\n \"codelen\": 3,\n \"metadata\": {\n \"name\": \"string\",\n \"age\": \"number\"\n }\n }\n database_name = router.create_database(schema_def)\n\n # add existing document\n docs = [{\n \"metadata\": {\n \"name\":\"name1\", \n \"age\": 20\n },\n \"code\": [1,2,3]\n }, {\n \"metadata\": {\n \"name\":\"name2\", \n \"age\": 30\n },\n \"code\": [1,2,3]\n }]\n cids = router.insert_docs(docs, database_name)\n\n self.assertEqual(len(cids), len(docs), \"Document creation failed\")\n\n # A non existing DB is used to create doc\n def test_3_db_fresh_doc_create (self):\n # create random DB name\n database_name = \"BRANDOM\"\n\n # add existing document\n docs = [{\n \"metadata\": {\n \"name\":\"name1\", \n \"age\": 20\n },\n \"code\": [1,2,3]\n }, {\n \"metadata\": {\n \"name\":\"name2\", \n \"age\": 30\n },\n \"code\": [1,2,3]\n }]\n cids = router.insert_docs(docs, database_name)\n\n self.assertEqual(len(cids), 0, \"Document creation failed\")\n\n # A fresh doc is deleted\n def test_4_doc_fresh_delete (self):\n # create database\n schema_def = {\n \"description\": \"this is my database\",\n \"unique\": \"r8and0mseEd901fr\",\n \"encoder\": \"example.com/autoencoder/API\",\n \"codelen\": 3,\n \"metadata\": {\n \"name\": \"string\",\n \"age\": \"number\"\n }\n }\n database_name = router.create_database(schema_def)\n\n # delete non existing documents\n cids = router.delete_docs([\"sdfsdfsdf\", \"tret456\"], database_name)\n\n self.assertEqual(len(cids), 0, \"Doc deletion failed\")\n\n # An existing doc is deleted for small dataset\n def test_5a_doc_exist_delete_small (self):\n # create database\n schema_def = {\n \"description\": \"this is my database\",\n \"unique\": \"r8and0mseEd902\",\n \"encoder\": \"example.com/autoencoder/API\",\n \"codelen\": 100,\n \"metadata\": {\n \"name\": \"string\",\n \"age\": \"number\"\n }\n }\n database_name = router.create_database(schema_def)\n\n # add small epoch document\n docs = []\n # create special doc\n matrix_r_spec = np.random.rand(1, 100)\n docs.append({\n \"metadata\": {\"name\":\"special\", \"age\":11},\n \"code\": matrix_r_spec[0].tolist()\n })\n cids_spec = router.insert_docs(docs, database_name)\n\n # create other docs\n for _ in range(90):\n docs = []\n # create random matrix\n matrix_r = np.random.rand(100, 100)\n # create documents\n for item in matrix_r:\n docs.append({\n \"metadata\": {\"name\":\"generic\", \"age\":10},\n \"code\": item.tolist()\n })\n \n cids = router.insert_docs(docs, database_name)\n\n # check for doc existance\n k = 2\n docs, dists = router.search([matrix_r_spec[0].tolist()], k, None, database_name)\n self.assertEqual(docs[0][0][\"metadata\"][\"name\"], \"special\", \"Doc doesn't exist\")\n\n # delete special doc\n cids = router.delete_docs(cids_spec, database_name)\n time.sleep(10)\n\n # check for doc existance\n k = 2\n docs, dists = router.search([matrix_r_spec[0].tolist()], k, None, database_name)\n self.assertEqual(len(docs[0]), k, \"Doc deletion failed\")\n self.assertEqual(docs[0][0][\"metadata\"][\"name\"], \"generic\", \"Doc deletion failed\")\n\n # An existing doc is deleted for large dataset\n def test_5b_doc_exist_delete_large (self):\n # create database\n schema_def = {\n \"description\": \"this is my database\",\n \"unique\": \"r8and0mseEd902\",\n \"encoder\": \"example.com/autoencoder/API\",\n \"codelen\": 100,\n \"metadata\": {\n \"name\": \"string\",\n \"age\": \"number\"\n }\n }\n database_name = router.create_database(schema_def)\n\n # add small epoch document\n docs = []\n # create special doc\n matrix_r_spec = np.random.rand(1, 100)\n docs.append({\n \"metadata\": {\"name\":\"special\", \"age\":11},\n \"code\": matrix_r_spec[0].tolist()\n })\n cids_spec = router.insert_docs(docs, database_name)\n\n # create other docs\n for _ in range(120):\n docs = []\n # create random matrix\n matrix_r = np.random.rand(100, 100)\n # create documents\n for item in matrix_r:\n docs.append({\n \"metadata\": {\"name\":\"generic\", \"age\":10},\n \"code\": item.tolist()\n })\n \n cids = router.insert_docs(docs, database_name)\n\n time.sleep(60)\n # check for doc existance\n k = 2\n docs, dists = router.search([matrix_r_spec[0].tolist()], k, None, database_name)\n self.assertEqual(docs[0][0][\"metadata\"][\"name\"], \"special\", \"Doc doesn't exist\")\n\n # delete special doc\n cids = router.delete_docs(cids_spec, database_name)\n time.sleep(60)\n\n # check for doc existance\n k = 2\n docs, dists = router.search([matrix_r_spec[0].tolist()], k, None, database_name)\n \n self.assertEqual(len(docs[0]), k, \"Doc deletion failed\")\n self.assertEqual(docs[0][0][\"metadata\"][\"name\"], \"generic\", \"Doc deletion failed\")\n\n # A non existing DB is used to delete doc\n def test_6_db_fresh_doc_delete (self):\n # create random DB name\n database_name = \"BRANDOM\"\n\n # delete non existing documents\n cids = router.delete_docs([\"sdfsdfsdf\", \"tret456\"], database_name)\n\n self.assertEqual(len(cids), 0, \"Doc deletion failed\")\n\nif __name__ == '__main__':\n unittest.main()\n" }, { "path": "aquila/metricstore/test/apis/search_fns.py", "content": "import unittest\n\nimport time\n\nimport index # includes preloading databases\nimport router\nfrom utils import CID\n\nimport numpy as np\n\nclass TestSearch (unittest.TestCase):\n\n # Perform search on small data\n def test_1_insert_and_search_small (self):\n schema_def = {\n \"description\": \"this is my database\",\n \"unique\": \"r8and0mseEd903\",\n \"encoder\": \"example.com/autoencoder/API\",\n \"codelen\": 100,\n \"metadata\": {}\n }\n database_name = router.create_database(schema_def)\n\n # insert documents in bulk --------------------\n for i_ in range(99):\n # create random matrix\n matrix_r = np.random.rand(100, 100)\n # create documents\n docs = []\n for item in matrix_r:\n docs.append({\n \"metadata\": {},\n \"code\": item.tolist()\n })\n\n cids = router.insert_docs(docs, database_name)\n\n k = 10\n docs, dists = router.search(np.random.rand(1, 784), k, None, database_name)\n\n self.assertEqual(k, len(docs[0]), \"Search failed\")\n\n # Perform search on large data\n def test_2_insert_and_search_large (self):\n schema_def = {\n \"description\": \"this is my database\",\n \"unique\": \"r8and0mseEd904\",\n \"encoder\": \"example.com/autoencoder/API\",\n \"codelen\": 100,\n \"metadata\": {}\n }\n database_name = router.create_database(schema_def)\n\n # insert documents in bulk --------------------\n for i_ in range(120):\n # create random matrix\n matrix_r = np.random.rand(100, 100)\n # create documents\n docs = []\n for item in matrix_r:\n docs.append({\n \"metadata\": {},\n \"code\": item.tolist()\n })\n\n cids = router.insert_docs(docs, database_name)\n\n # time.sleep(5)\n\n k = 10\n docs, dists = router.search(np.random.rand(1, 784), k, None, database_name)\n\n self.assertEqual(k, len(docs[0]), \"Search failed\")\n\nif __name__ == '__main__':\n unittest.main()\n" }, { "path": "aquila/metricstore/utils/CID.py", "content": "import logging\n\nimport bson\nimport hashlib\nimport base58\n\ndef doc2CID (inp):\n try:\n # JSON OBJ to BSON encode\n bson_ = bson.dumps(inp)\n # SHA-256 Double Hashing\n hash_ = hashlib.sha256(bson_)\n hash_ = hashlib.sha256(hash_.digest())\n # Convert to Base-58 string\n b58c_ = base58.b58encode(hash_.digest())\n\n return b58c_.decode('utf-8')\n except Exception as e:\n logging.debug(e)\n return None\n\ndef doc2bson (inp):\n try:\n # JSON OBJ to BSON encode\n bson_ = bson.dumps(inp)\n\n return bson_\n except Exception as e:\n logging.debug(e)\n return None\n\ndef bson2doc (inp):\n try:\n # BSON to JSON OBJ\n json_ = bson.loads(inp)\n\n return json_\n except Exception as e:\n logging.debug(e)\n return None" }, { "path": "aquila/metricstore/utils/config.py", "content": "import yaml\nimport os\n\nos.environ[\"DATA_STORE_LOCATION\"] = \"/data/\"\nos.environ[\"LOG_CHUNK_LEN\"] = \"1000\"\n\nif \"MINI_AQDB\" not in os.environ:\n os.environ[\"MINI_AQDB\"] = \"inactive\"\nelse:\n os.environ[\"MINI_AQDB\"] = \"active\"\n\nwith open(\"DB_config.yml\", \"r\") as stream:\n DB_config = yaml.safe_load(stream)\n \n if \"AUTH_KEY_FILE\" not in os.environ:\n os.environ[\"AUTH_KEY_FILE\"] = str(DB_config[\"auth\"][\"pubkey\"])\n \n if \"FIXED_VEC_DIMENSION\" not in os.environ:\n os.environ[\"FIXED_VEC_DIMENSION\"] = str(DB_config[\"docs\"][\"vd\"])\n\n if \"MIN_SAWP_COUNT\" not in os.environ:\n os.environ[\"MIN_SAWP_COUNT\"] = str(DB_config[\"docs\"][\"cswap\"])\n \n if \"FIXED_Q_LEN\" not in os.environ:\n os.environ[\"FIXED_Q_LEN\"] = str(DB_config[\"queue\"][\"qlen\"])\n\n if \"THREAD_SLEEP\" not in os.environ:\n os.environ[\"THREAD_SLEEP\"] = str(DB_config[\"queue\"][\"sleep\"])\n\n if \"FAISS_MAX_CELLS\" not in os.environ:\n os.environ[\"FAISS_MAX_CELLS\"] = str(DB_config[\"faiss\"][\"init\"][\"nlist\"])\n\n if \"FAISS_VISIT_CELLS\" not in os.environ:\n os.environ[\"FAISS_VISIT_CELLS\"] = str(DB_config[\"faiss\"][\"init\"][\"nprobe\"])\n\n if \"FAISS_BYTES_PER_VEC\" not in os.environ:\n os.environ[\"FAISS_BYTES_PER_VEC\"] = str(DB_config[\"faiss\"][\"init\"][\"bpv\"])\n\n if \"FAISS_BYTES_PER_SUB_VEC\" not in os.environ:\n os.environ[\"FAISS_BYTES_PER_SUB_VEC\"] = str(DB_config[\"faiss\"][\"init\"][\"bpsv\"])\n\n if \"ANNOY_SIM_METRIC\" not in os.environ:\n os.environ[\"ANNOY_SIM_METRIC\"] = str(DB_config[\"annoy\"][\"init\"][\"smetric\"])\n\n if \"ANNOY_NTREES\" not in os.environ:\n os.environ[\"ANNOY_NTREES\"] = str(DB_config[\"annoy\"][\"init\"][\"ntrees\"])\n\n if \"ANNOY_SK\" not in os.environ:\n os.environ[\"ANNOY_SK\"] = str(DB_config[\"annoy\"][\"init\"][\"search_k\"])\n" }, { "path": "aquila/metricstore/utils/cryptops.py", "content": "import logging\n\nfrom Crypto.Hash import SHA384\nfrom Crypto.PublicKey import RSA\nfrom Crypto.Signature import pkcs1_15\n\nimport base58\n\nimport chardet\n\nimport bson\n\ndef read_public_key (location):\n # disk read public key\n with open(location, \"r\") as pkf:\n k = pkf.read()\n pub_key = RSA.import_key(k)\n\n return pub_key\n\ndef verify_signature (json_data, pub_key, signature):\n \n ret = True\n\n binary_data = bson.dumps(json_data)\n\n # generate hash\n hash = SHA384.new()\n hash.update(binary_data)\n \n signature = base58.b58decode(signature)\n\n # Verify with pub key\n verifier = pkcs1_15.new(pub_key)\n \n try:\n verifier.verify(hash, signature)\n except Exception as e:\n logging.debug(e)\n ret = False\n\n return ret" }, { "path": "aquila/metricstore/utils/schema.py", "content": "import logging\n\nimport fastjsonschema\n\ndef generate_schema (template):\n # get all keys from template schema\n metadata_templ = template.get(\"metadata\")\n if metadata_templ:\n del template[\"metadata\"]\n else:\n metadata_templ = {}\n\n keys_ = list(template.keys())\n\n # sort keys\n keys_.sort()\n\n # validate required keys\n req_k = [\"description\", \"encoder\", \"unique\"]\n for r_ in req_k:\n if r_ not in keys_:\n # cannot continue, invalid schema\n return None\n\n # generate schema in sorted keys\n generated_schema = { \n \"$schema\": \"http://json-schema.org/schema#\", \n \"$id\": \"http://aquilanetwork.com/schema/id/v1\", \n \"title\": \"Schema\", \n \"description\": \"\",\n \"encoder\": \"\",\n \"unique\": \"\",\n \"type\": \"object\",\n \"properties\": {\n \"code\": {\n \"description\": \"Encoded data\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"number\"\n }\n },\n \"metadata\": {\n \"$ref\": \"#/definitions/metadata\"\n }\n },\n \"definitions\": {\n \"metadata\": {\n \"description\": \"User defined metadata\",\n \"type\": \"object\",\n \"properties\": {},\n \"required\": []\n }\n },\n \"required\": [\"code\", \"metadata\"]\n }\n\n metadata = {}\n metadata_types = [\"number\", \"string\"]\n\n for key_ in keys_:\n if key_ in req_k:\n # fill in root level keys\n generated_schema[key_] = template[key_]\n elif key_ == \"codelen\":\n generated_schema[\"properties\"][\"code\"][\"maxItems\"] = template[key_]\n else:\n # fill in root level keys :: extra info that we don't care\n generated_schema[key_] = template[key_]\n\n for key_ in metadata_templ.keys():\n # check type is predefined\n if metadata_templ[key_] not in metadata_types:\n return None\n\n # fill in metadata keys\n metadata[key_] = {\n \"type\": metadata_templ[key_]\n }\n\n generated_schema[\"definitions\"][\"metadata\"][\"properties\"] = metadata\n generated_schema[\"definitions\"][\"metadata\"][\"required\"] = list(metadata.keys())\n\n\n # validate values\n if type(generated_schema[\"properties\"][\"code\"].get(\"maxItems\")) != int:\n return None\n \n return generated_schema\n\ndef compile (schema_def):\n # compile schema\n validator = fastjsonschema.compile(schema_def)\n\n return validator\n\ndef validate_json_docs (validator, json_doc):\n try:\n # validate doc on schema :: will except on fail\n validator(json_doc)\n # validated\n # logging.debug(\"Schema validation success\")\n return True\n except Exception as e:\n logging.error(e)\n return False\n" }, { "path": "aquila/metricstore/vec_index/hannoy.py", "content": "import logging\n\nimport numpy as np\nfrom annoy import AnnoyIndex\nimport yaml\nimport os\n\nimport threading\nimport queue\nimport time\n\nclass Annoy:\n def __init__(self, model_location):\n # set model location\n self.model_location = model_location\n\n # to keep the thread & queue running\n self.process_flag = True\n self.q_maxsize = int(os.environ[\"FIXED_Q_LEN\"])\n self.build_batch_size = int(os.environ[\"FIXED_Q_LEN\"])\n self.process_thread = None\n self._lock = threading.Lock()\n self.process_timeout_sec = int(os.environ[\"THREAD_SLEEP\"]) # seconds\n # this is to keep track of all vectors inserted\n # for saving into disk and retrieve later\n self.index_disk = None\n try:\n # make sure to parse env variables to their expected type\n self.dim = int(os.environ[\"FIXED_VEC_DIMENSION\"])\n self.sim_metric = str(os.environ[\"ANNOY_SIM_METRIC\"])\n self.n_trees = int(os.environ[\"ANNOY_NTREES\"])\n self.search_k = int(os.environ[\"ANNOY_SK\"])\n self.model_loaded = self.load_model_from_disk()\n if not self.model_loaded:\n if self.init_annoy():\n logging.debug(\"Annoy Init done\")\n else:\n logging.debug(\"Annoy Init Failed\")\n except Exception as e:\n logging.error('Error initializing Annoy: ' + e)\n\n # spawn process thread\n self.spawn()\n\n def __del__(self):\n self.process_flag = False\n if self.process_thread:\n self.process_thread.join()\n\n def spawn (self):\n # create pipeline to add documents\n self.pipeline = queue.Queue(maxsize=self.q_maxsize)\n # create process thread\n self.process_thread = threading.Thread(target=self.process, args=(), daemon=True)\n # start process thread\n self.process_thread.start()\n # return self.pipeline\n\n def init_annoy(self):\n # only do if no index loaded from disk\n if not self.model_loaded:\n logging.debug('Annoy init index')\n self.a_index = AnnoyIndex(self.dim, self.sim_metric)\n\n # Lock index read / wtite until it is built\n with self._lock:\n # build index\n build_ = self.a_index.build(self.n_trees)\n\n if build_:\n self.model_loaded = self.save_model_to_disk()\n\n return self.model_loaded\n\n def add_vectors(self, documents):\n # add documents to queue\n self.pipeline.put({\"action\":\"add\", \"docs\": documents})\n \n return True\n\n def process(self):\n while (self.process_flag):\n # set a timeout till next vector indexing\n time.sleep(self.process_timeout_sec)\n\n # check if queue is not empty\n if self.pipeline.qsize() > 0:\n # Lock index read / wtite until it is built\n with self._lock:\n\n # unbuild index first \n self.a_index.unbuild()\n len_documents = 0\n\n # fetch all currently available documents from queue\n while not self.pipeline.empty():\n # extract document & contents\n qitem = self.pipeline.get_nowait()\n if qitem[\"action\"] == \"add\":\n documents = qitem[\"docs\"]\n len_documents += len(documents)\n for document in documents:\n _id = document[\"_id\"]\n vector_e = document[\"code\"]\n \n # add vector to index\n self.a_index.add_item(int(_id), vector_e)\n # append to disk proxy\n if self.index_disk is None:\n self.index_disk = np.array([vector_e + [int(_id)]], dtype=float)\n else:\n self.index_disk = np.append(self.index_disk, [vector_e + [int(_id)]], axis=0)\n elif qitem[\"action\"] == \"delete\":\n ids = qitem[\"ids\"]\n len_documents += len(ids)\n # reset\n zero_ = np.zeros(self.dim + 1)\n for id_ in ids:\n # add zero vector to index\n self.a_index.add_item(int(id_), zero_[:-1].tolist())\n # reset npy disk array\n if self.index_disk is not None:\n self.index_disk[ids] = zero_\n\n # take a rest if doc length is > batch_size\n if len_documents > self.build_batch_size:\n break\n \n # build vector\n build_ = self.a_index.build(self.n_trees, n_jobs=-1)\n\n # write to disk\n if build_:\n self.model_loaded = self.save_model_to_disk()\n\n def delete_vectors(self, ids):\n # add documents to queue\n self.pipeline.put({\"action\":\"delete\", \"ids\": ids})\n\n return True, ids\n\n def get_nearest_k(self, matrix, k):\n ids = []\n dists = []\n\n # Lock index read / wtite until nearest neighbor search\n with self._lock:\n for vec_data in matrix:\n if self.search_k != -1:\n _id, _dist = self.a_index.get_nns_by_vector(vec_data, k, self.search_k, include_distances=True)\n else: \n _id, _dist = self.a_index.get_nns_by_vector(vec_data, k, include_distances=True)\n ids.append(_id)\n dists.append(_dist)\n\n return ids, dists\n\n def get_nearest_rad(self, matrix, rad):\n ids = []\n dists = []\n\n # Lock index read / wtite until nearest neighbor search\n with self._lock:\n for vec_data in matrix:\n if self.search_k != -1:\n _id, _dist = self.a_index.get_nns_by_vector(vec_data, k, self.search_k, include_distances=True)\n else: \n _id, _dist = self.a_index.get_nns_by_vector(vec_data, k, include_distances=True)\n ids.append(_id)\n dists.append(_dist)\n\n return ids, dists\n\n def load_model_from_disk(self):\n try:\n # prepare new index\n self.a_index = AnnoyIndex(self.dim, self.sim_metric)\n # read index\n self.index_disk = np.load(self.model_location+'.npy')\n # build Annoy Index\n for vec_ in self.index_disk.tolist():\n self.a_index.add_item(int(vec_[-1]), vec_[0:-1])\n # build index\n build_ = self.a_index.build(self.n_trees)\n logging.debug('Annoy index loading success')\n return True\n except Exception as e: \n logging.debug('Annoy index loading failed. Creating new index..')\n return False\n\n def save_model_to_disk(self):\n try:\n # write index\n np.save(self.model_location, self.index_disk)\n logging.debug('Annoy index writing success')\n return True\n except Exception as e:\n logging.error('Annoy index writing failed' + e)\n return False\n" }, { "path": "aquila/metricstore/vec_index/hfaiss.py", "content": "import logging\n\nimport numpy as np\nimport faiss\nimport yaml\n\nimport os\nimport threading\nimport queue\nimport time\n\nclass Faiss:\n def __init__(self, model_location):\n # set model location\n self.model_location = model_location\n\n self.is_active = False\n self.nlist = int(os.environ[\"FAISS_MAX_CELLS\"])\n self.nprobe = int(os.environ[\"FAISS_VISIT_CELLS\"])\n self.bytesPerVec = int(os.environ[\"FAISS_BYTES_PER_VEC\"])\n self.bytesPerSubVec = int(os.environ[\"FAISS_BYTES_PER_SUB_VEC\"])\n \n # make sure to parse env variables to their expected type\n self.dim = int(os.environ[\"FIXED_VEC_DIMENSION\"])\n\n self.model_loaded = self.load_model_from_disk(self.model_location)\n self.is_initiated_ = self.model_loaded\n\n # to keep the thread & queue running\n self.process_flag = True\n self.q_maxsize = int(os.environ[\"FIXED_Q_LEN\"])\n self.process_thread = None\n self._lock = threading.Lock()\n self.process_timeout_sec = int(os.environ[\"THREAD_SLEEP\"]) # seconds\n\n # spawn process thread\n self.spawn()\n\n def __del__(self):\n self.process_flag = False\n if self.process_thread:\n self.process_thread.join()\n\n def spawn (self):\n # create pipeline to add documents\n self.pipeline = queue.Queue(maxsize=self.q_maxsize)\n # create process thread\n self.process_thread = threading.Thread(target=self.process, args=(), daemon=True)\n # start process thread\n self.process_thread.start()\n # return self.pipeline\n\n def init_faiss(self, matrix):\n self.train_data = np.matrix(matrix).astype('float32')\n logging.debug('FAISS init quantizer')\n self.f_quantizer = faiss.IndexFlatIP(self.dim)\n # Lock index read / wtite until it is built\n with self._lock:\n logging.debug('FAISS init index')\n self.f_index = faiss.IndexIVFPQ(self.f_quantizer, self.dim, self.nlist, self.bytesPerVec, self.bytesPerSubVec)\n logging.debug('FAISS train index')\n self.f_index.train(self.train_data)\n logging.debug('FAISS train index finished')\n\n # write index to disk\n self.model_loaded = self.save_model_to_disk(self.model_location, self.f_index)\n self.is_initiated_ = self.model_loaded\n\n return self.is_initiated_\n\n def is_initiated(self):\n return self.is_initiated_\n\n def load_model_from_disk(self, location):\n try:\n # read index\n self.f_index = faiss.read_index(location)\n logging.debug('FAISS index loading success')\n return True\n except Exception as e: \n logging.error('FAISS index loading failed' + str(e))\n return False\n\n def save_model_to_disk(self, location, index):\n try:\n # write index\n faiss.write_index(index, location)\n logging.debug('FAISS index writing success')\n return True\n except:\n logging.error('FAISS index writing failed')\n return False\n\n def add_vectors(self, documents):\n # add document to queue\n self.pipeline.put({\"action\":\"add\", \"docs\": documents})\n \n return True\n\n def process(self):\n while (self.process_flag):\n # set a timeout till next vector indexing\n time.sleep(self.process_timeout_sec)\n\n # check if queue is not empty\n if self.pipeline.qsize() > 0:\n ids = []\n vecs = []\n # f_delete = False\n # f_add = False\n\n # fetch all currently available documents from queue\n while not self.pipeline.empty():\n # extract document & contents\n qitem = self.pipeline.get_nowait()\n if qitem[\"action\"] == \"add\":\n # f_add = True\n documents = qitem[\"docs\"]\n for document in documents:\n _id = document[\"_id\"]\n vector_e = document[\"code\"]\n ids.append(_id)\n vecs.append(vector_e)\n elif qitem[\"action\"] == \"delete\":\n # f_delete = True\n ids = qitem[\"ids\"]\n # remove vectors and add zero reset\n self.f_index.remove_ids(np.array(ids).astype('int'))\n vecs = np.zeros((len(ids), self.dim))\n\n # if f_add:\n # convert to np matrix\n vec_data = np.matrix(vecs).astype('float32')\n id_data = np.array(ids).astype('int')\n\n # Lock index read / wtite until it is built\n with self._lock:\n # add vectors\n self.f_index.add_with_ids(vec_data, id_data)\n\n # if f_delete:\n # pass\n \n # write to disk\n self.save_model_to_disk(self.model_location, self.f_index)\n\n def delete_vectors(self, ids):\n # remove vectors\n self.pipeline.put({\"action\":\"delete\", \"ids\": ids})\n \n return True, ids\n\n def get_nearest_rad(self, matrix, rad):\n pass\n # # convert to np matrix\n # vec_data = np.matrix(matrix).astype('float32')\n \n # # Lock index read / wtite until nearest neighbor search\n # with self._lock:\n # D, I = self.f_index.search(vec_data, k)\n # return I.tolist(), D.tolist()\n\n def get_nearest_k(self, matrix, k):\n # convert to np matrix\n vec_data = np.matrix(matrix).astype('float32')\n \n # Lock index read / wtite until nearest neighbor search\n with self._lock:\n D, I = self.f_index.search(vec_data, k)\n return I.tolist(), D.tolist()\n" }, { "path": "aquila/metricstore/wal/walman.py", "content": "import logging\n\nimport os\nimport time\nimport queue\nimport threading\n\nLOG_STORE_LOCATION = os.environ[\"DATA_STORE_LOCATION\"] + \"/log/\"\nLOG_CHUNK_LEN = int(os.environ[\"LOG_CHUNK_LEN\"])\nPROCESS_TIMEOUT = int(os.environ[\"THREAD_SLEEP\"])\nMAX_Q_LEN = int(os.environ[\"FIXED_Q_LEN\"])\n\nprocess_flag = True\npipeline = None\nprocess_thread = None\n\n# list logs in log directory\nlog_files_asc = os.listdir(LOG_STORE_LOCATION).sort()\n\n# load last log chunk\nlast_chunk_name = log_files_asc[-1]\nlast_chunk_data_len = 0\n\n# read last chunk\nwith open(LOG_STORE_LOCATION + last_chunk_name) as flog:\n # check if the file is full capacity\n if len(flog.split(\"\\n\")) >= LOG_CHUNK_LEN:\n create_new_chunk()\n else:\n last_chunk_data_len = len(flog.split(\"\\n\"))\n\ndef create_new_chunk ():\n global log_files_asc\n global last_chunk_name\n global last_chunk_data_len\n\n # name a new log file\n new_f_name = time.time()\n log_files_asc.append(new_f_name)\n last_chunk_name = new_f_name\n\n # initialize log file\n with open(LOG_STORE_LOCATION + last_chunk_name, \"a\") as aflog:\n aflog.write(\"WALOG INIT\")\n last_chunk_data_len = 1\n\ndef spawn ():\n # spawn worker thread\n global process_flag\n process_flag = True\n # create pipeline to add documents\n global pipeline\n pipeline = queue.Queue(maxsize=MAX_Q_LEN)\n # create process thread\n global process_thread\n process_thread = threading.Thread(target=process, args=(), daemon=True)\n # start process thread\n process_thread.start()\n\ndef add_log (batch_in):\n global pipeline\n pipeline.put(batch_in)\n return True\n\ndef terminate ():\n global process_flag\n process_flag = False\n\ndef process ():\n global pipeline\n\n while (process_flag):\n time.sleep(PROCESS_TIMEOUT)\n \n # check if queue is not empty\n if not pipeline.empty():\n # fetch all currently available codes from queue\n while not pipeline.empty():\n # pop available logs\n for batch in pipeline.get_nowait():\n for log_ in batch:\n # check if the batch length exceeded\n if last_chunk_data_len + 1 >= LOG_CHUNK_LEN:\n create_new_chunk()\n\n # write log to disk\n with open(LOG_STORE_LOCATION + last_chunk_name, \"a\") as aflog:\n aflog.write(\"\\n\" + log_)\n" }, { "path": "aquila/metricstore/wal/walmon.py", "content": "" }, { "path": "aquila/network/go.mod", "content": "module aquilaport\n\ngo 1.15\n\nrequire (\n\tgithub.com/gorilla/mux v1.8.0\n\tgithub.com/syndtr/goleveldb v1.0.0\n\tgo.mongodb.org/mongo-driver v1.4.4\n)\n" }, { "path": "aquila/network/go.sum", "content": "github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=\ngithub.com/aws/aws-sdk-go v1.34.28/go.mod h1:H7NKnBqNVzoTJpGfLrQkkD+ytBA93eiDYi/+8rV9s48=\ngithub.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=\ngithub.com/go-sql-driver/mysql v1.5.0/go.mod h1:DCzpHaOWr8IXmIStZouvnhqoel9Qv2LBy8hT2VhHyBg=\ngithub.com/go-stack/stack v1.8.0 h1:5SgMzNM5HxrEjV0ww2lTmX6E2Izsfxas4+YHWRs3Lsk=\ngithub.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY=\ngithub.com/gobuffalo/attrs v0.0.0-20190224210810-a9411de4debd/go.mod h1:4duuawTqi2wkkpB4ePgWMaai6/Kc6WEz83bhFwpHzj0=\ngithub.com/gobuffalo/depgen v0.0.0-20190329151759-d478694a28d3/go.mod h1:3STtPUQYuzV0gBVOY3vy6CfMm/ljR4pABfrTeHNLHUY=\ngithub.com/gobuffalo/depgen v0.1.0/go.mod h1:+ifsuy7fhi15RWncXQQKjWS9JPkdah5sZvtHc2RXGlg=\ngithub.com/gobuffalo/envy v1.6.15/go.mod h1:n7DRkBerg/aorDM8kbduw5dN3oXGswK5liaSCx4T5NI=\ngithub.com/gobuffalo/envy v1.7.0/go.mod h1:n7DRkBerg/aorDM8kbduw5dN3oXGswK5liaSCx4T5NI=\ngithub.com/gobuffalo/flect v0.1.0/go.mod h1:d2ehjJqGOH/Kjqcoz+F7jHTBbmDb38yXA598Hb50EGs=\ngithub.com/gobuffalo/flect v0.1.1/go.mod h1:8JCgGVbRjJhVgD6399mQr4fx5rRfGKVzFjbj6RE/9UI=\ngithub.com/gobuffalo/flect v0.1.3/go.mod h1:8JCgGVbRjJhVgD6399mQr4fx5rRfGKVzFjbj6RE/9UI=\ngithub.com/gobuffalo/genny v0.0.0-20190329151137-27723ad26ef9/go.mod h1:rWs4Z12d1Zbf19rlsn0nurr75KqhYp52EAGGxTbBhNk=\ngithub.com/gobuffalo/genny v0.0.0-20190403191548-3ca520ef0d9e/go.mod h1:80lIj3kVJWwOrXWWMRzzdhW3DsrdjILVil/SFKBzF28=\ngithub.com/gobuffalo/genny v0.1.0/go.mod h1:XidbUqzak3lHdS//TPu2OgiFB+51Ur5f7CSnXZ/JDvo=\ngithub.com/gobuffalo/genny v0.1.1/go.mod h1:5TExbEyY48pfunL4QSXxlDOmdsD44RRq4mVZ0Ex28Xk=\ngithub.com/gobuffalo/gitgen v0.0.0-20190315122116-cc086187d211/go.mod h1:vEHJk/E9DmhejeLeNt7UVvlSGv3ziL+djtTr3yyzcOw=\ngithub.com/gobuffalo/gogen v0.0.0-20190315121717-8f38393713f5/go.mod h1:V9QVDIxsgKNZs6L2IYiGR8datgMhB577vzTDqypH360=\ngithub.com/gobuffalo/gogen v0.1.0/go.mod h1:8NTelM5qd8RZ15VjQTFkAW6qOMx5wBbW4dSCS3BY8gg=\ngithub.com/gobuffalo/gogen v0.1.1/go.mod h1:y8iBtmHmGc4qa3urIyo1shvOD8JftTtfcKi+71xfDNE=\ngithub.com/gobuffalo/logger v0.0.0-20190315122211-86e12af44bc2/go.mod h1:QdxcLw541hSGtBnhUc4gaNIXRjiDppFGaDqzbrBd3v8=\ngithub.com/gobuffalo/mapi v1.0.1/go.mod h1:4VAGh89y6rVOvm5A8fKFxYG+wIW6LO1FMTG9hnKStFc=\ngithub.com/gobuffalo/mapi v1.0.2/go.mod h1:4VAGh89y6rVOvm5A8fKFxYG+wIW6LO1FMTG9hnKStFc=\ngithub.com/gobuffalo/packd v0.0.0-20190315124812-a385830c7fc0/go.mod h1:M2Juc+hhDXf/PnmBANFCqx4DM3wRbgDvnVWeG2RIxq4=\ngithub.com/gobuffalo/packd v0.1.0/go.mod h1:M2Juc+hhDXf/PnmBANFCqx4DM3wRbgDvnVWeG2RIxq4=\ngithub.com/gobuffalo/packr/v2 v2.0.9/go.mod h1:emmyGweYTm6Kdper+iywB6YK5YzuKchGtJQZ0Odn4pQ=\ngithub.com/gobuffalo/packr/v2 v2.2.0/go.mod h1:CaAwI0GPIAv+5wKLtv8Afwl+Cm78K/I/VCm/3ptBN+0=\ngithub.com/gobuffalo/syncx v0.0.0-20190224160051-33c29581e754/go.mod h1:HhnNqWY95UYwwW3uSASeV7vtgYkT2t16hJgV3AEPUpw=\ngithub.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=\ngithub.com/golang/snappy v0.0.0-20180518054509-2e65f85255db h1:woRePGFeVFfLKN/pOkfl+p/TAqKOfFu+7KPlMVpok/w=\ngithub.com/golang/snappy v0.0.0-20180518054509-2e65f85255db/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q=\ngithub.com/golang/snappy v0.0.1 h1:Qgr9rKW7uDUkrbSmQeiDsGa8SjGyCOGtuasMWwvp2P4=\ngithub.com/golang/snappy v0.0.1/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q=\ngithub.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=\ngithub.com/gorilla/mux v1.8.0 h1:i40aqfkR1h2SlN9hojwV5ZA91wcXFOvkdNIeFDP5koI=\ngithub.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So=\ngithub.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU=\ngithub.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=\ngithub.com/jmespath/go-jmespath v0.4.0/go.mod h1:T8mJZnbsbmF+m6zOOFylbeCJqk5+pHWvzYPziyZiYoo=\ngithub.com/jmespath/go-jmespath/internal/testify v1.5.1/go.mod h1:L3OGu8Wl2/fWfCI6z80xFu9LTZmf1ZRjMHUOPmWr69U=\ngithub.com/joho/godotenv v1.3.0/go.mod h1:7hK45KPybAkOC6peb+G5yklZfMxEjkZhHbwpqxOKXbg=\ngithub.com/karrick/godirwalk v1.8.0/go.mod h1:H5KPZjojv4lE+QYImBI8xVtrBRgYrIVsaRPx4tDPEn4=\ngithub.com/karrick/godirwalk v1.10.3/go.mod h1:RoGL9dQei4vP9ilrpETWE8CLOZ1kiN0LhBygSwrAsHA=\ngithub.com/klauspost/compress v1.9.5/go.mod h1:RyIbtBH6LamlWaDj8nUwkbUhJ87Yi3uG0guNDohfE1A=\ngithub.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=\ngithub.com/konsorten/go-windows-terminal-sequences v1.0.2/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=\ngithub.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=\ngithub.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=\ngithub.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=\ngithub.com/markbates/oncer v0.0.0-20181203154359-bf2de49a0be2/go.mod h1:Ld9puTsIW75CHf65OeIOkyKbteujpZVXDpWK6YGZbxE=\ngithub.com/markbates/safe v1.0.1/go.mod h1:nAqgmRi7cY2nqMc92/bSEeQA+R4OheNU2T1kNSCBdG0=\ngithub.com/montanaflynn/stats v0.0.0-20171201202039-1bf9dbcd8cbe/go.mod h1:wL8QJuTMNUDYhXwkmfOly8iTdp5TEcJFWZD2D7SIkUc=\ngithub.com/onsi/ginkgo v1.6.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE=\ngithub.com/onsi/ginkgo v1.7.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE=\ngithub.com/onsi/gomega v1.4.3/go.mod h1:ex+gbHU/CVuBBDIJjb2X0qEXbFg53c61hWP/1CpauHY=\ngithub.com/pelletier/go-toml v1.7.0/go.mod h1:vwGMzjaWMwyfHwgIBhI2YUM4fB6nL6lVAvS1LBMMhTE=\ngithub.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=\ngithub.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=\ngithub.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/rogpeppe/go-internal v1.1.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4=\ngithub.com/rogpeppe/go-internal v1.2.2/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4=\ngithub.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4=\ngithub.com/sirupsen/logrus v1.4.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo=\ngithub.com/sirupsen/logrus v1.4.1/go.mod h1:ni0Sbl8bgC9z8RoU9G6nDWqqs/fq4eDPysMBDgk/93Q=\ngithub.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6MwdIuYE2rE=\ngithub.com/spf13/cobra v0.0.3/go.mod h1:1l0Ry5zgKvJasoi3XT1TypsSe7PqH0Sj9dhYf7v3XqQ=\ngithub.com/spf13/pflag v1.0.3/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4=\ngithub.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=\ngithub.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=\ngithub.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=\ngithub.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=\ngithub.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=\ngithub.com/syndtr/goleveldb v1.0.0 h1:fBdIW9lB4Iz0n9khmH8w27SJ3QEJ7+IgjPEwGSZiFdE=\ngithub.com/syndtr/goleveldb v1.0.0/go.mod h1:ZVVdQEZoIme9iO1Ch2Jdy24qqXrMMOU6lpPAyBWyWuQ=\ngithub.com/tidwall/pretty v1.0.0/go.mod h1:XNkn88O1ChpSDQmQeStsy+sBenx6DDtFZJxhVysOjyk=\ngithub.com/xdg/scram v0.0.0-20180814205039-7eeb5667e42c/go.mod h1:lB8K/P019DLNhemzwFU4jHLhdvlE6uDZjXFejJXr49I=\ngithub.com/xdg/stringprep v0.0.0-20180714160509-73f8eece6fdc/go.mod h1:Jhud4/sHMO4oL310DaZAKk9ZaJ08SJfe+sJh0HrGL1Y=\ngo.mongodb.org/mongo-driver v1.4.4 h1:bsPHfODES+/yx2PCWzUYMH8xj6PVniPI8DQrsJuSXSs=\ngo.mongodb.org/mongo-driver v1.4.4/go.mod h1:WcMNYLx/IlOxLe6JRJiv2uXuCz6zBLndR4SoGjYphSc=\ngolang.org/x/crypto v0.0.0-20180904163835-0709b304e793/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=\ngolang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=\ngolang.org/x/crypto v0.0.0-20190422162423-af44ce270edf/go.mod h1:WFFai1msRO1wXaEeE5yQxYXgSfI8pQAWXbQop6sCtWE=\ngolang.org/x/crypto v0.0.0-20190530122614-20be4c3c3ed5/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=\ngolang.org/x/net v0.0.0-20180906233101-161cd47e91fd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=\ngolang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=\ngolang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=\ngolang.org/x/net v0.0.0-20200202094626-16171245cfb2/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=\ngolang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=\ngolang.org/x/sync v0.0.0-20190227155943-e225da77a7e6/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=\ngolang.org/x/sync v0.0.0-20190412183630-56d357773e84/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=\ngolang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=\ngolang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=\ngolang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=\ngolang.org/x/sys v0.0.0-20180909124046-d0be0721c37e/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=\ngolang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=\ngolang.org/x/sys v0.0.0-20190403152447-81d4e9dc473e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=\ngolang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=\ngolang.org/x/sys v0.0.0-20190419153524-e8e3143a4f4a/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=\ngolang.org/x/sys v0.0.0-20190422165155-953cdadca894/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=\ngolang.org/x/sys v0.0.0-20190531175056-4c3a928424d2/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=\ngolang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=\ngolang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=\ngolang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=\ngolang.org/x/tools v0.0.0-20190329151228-23e29df326fe/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=\ngolang.org/x/tools v0.0.0-20190416151739-9c9e1878f421/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=\ngolang.org/x/tools v0.0.0-20190420181800-aa740d480789/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=\ngolang.org/x/tools v0.0.0-20190531172133-b3315ee88b7d/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc=\ngolang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=\ngopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=\ngopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=\ngopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI=\ngopkg.in/fsnotify.v1 v1.4.7/go.mod h1:Tz8NjZHkW78fSQdbUxIjBTcgA1z1m8ZHf0WmKUhAMys=\ngopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7/go.mod h1:dt/ZhP58zS4L8KSrWDmTeBkI65Dw0HsyUHuEVlX15mw=\ngopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=\ngopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=\ngopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "aquila/network/main.go", "content": "// main.go\npackage main\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"net/http/cookiejar\"\n\t\"strings\"\n\t\"time\"\n\n\t\"github.com/gorilla/mux\"\n\t\"github.com/syndtr/goleveldb/leveldb\"\n\t\"go.mongodb.org/mongo-driver/bson\"\n)\n\nvar _localDb, _ = leveldb.OpenFile(\"./db/_local\", nil)\nvar replicationDb, _ = leveldb.OpenFile(\"./db/replication\", nil)\nvar sourceDb, _ = leveldb.OpenFile(\"./db/source\", nil)\n\nvar jar, err = cookiejar.New(nil)\n\n// if err != nil {\n// fmt.Println(err)\n// }\n\n// Document struct\ntype Document struct {\n\tID string `json:\"id\"`\n\tTitle string `json:\"title\"`\n\tDeleted bool `json:\"deleted\"`\n\tTimestamp string `json:\"timestamp\"`\n\tVersion string `json:\"version\"`\n}\n\nfunc homePage(w http.ResponseWriter, r *http.Request) {\n\tfmt.Fprintf(w, \"Welcome to the HomePage!\")\n\tfmt.Println(\"Endpoint Hit: homePage\")\n}\n\nfunc createNewDocument(w http.ResponseWriter, r *http.Request) {\n\t// decode json body\n\tvar documents []Document\n\tjson.NewDecoder(r.Body).Decode(&documents)\n\n\t// init a batch insert to level\n\tbatch := new(leveldb.Batch)\n\n\t// insert docs to batch\n\tfor _, doc := range documents {\n\t\t// update document version\n\t\tdoc.Version = string(getVersion(doc))\n\t\t// convert struct to bson\n\t\tdata, err := bson.Marshal(doc)\n\t\tfmt.Println(err)\n\t\t// insert doc\n\t\tbatch.Put([]byte(doc.ID), data)\n\t}\n\n\t// write batch to level db\n\terr := sourceDb.Write(batch, nil)\n\tfmt.Println(err)\n\n\t// iterate over leveldb and get key, val\n\titer := sourceDb.NewIterator(nil, nil)\n\tfor iter.Next() {\n\t\tkey := iter.Key()\n\t\tvalue := iter.Value()\n\n\t\tvar docRet Document\n\t\t// convert bson to byte\n\t\tbson.Unmarshal(value, &docRet)\n\n\t\tfmt.Println(string(key), docRet)\n\t}\n\titer.Release()\n\terr = iter.Error()\n\n\tjson.NewEncoder(w).Encode(documents)\n}\n\nfunc deleteDocument(w http.ResponseWriter, r *http.Request) {\n\tvar ids []string\n\n\tjson.NewDecoder(r.Body).Decode(&ids)\n\n\t// init a batch insert to level\n\tbatch := new(leveldb.Batch)\n\n\t// delete docs batch\n\tfor _, id := range ids {\n\t\t// delete doc\n\t\tbatch.Delete([]byte(id))\n\t}\n\n\t// write batch to level db\n\terr := sourceDb.Write(batch, nil)\n\tfmt.Println(err)\n\n\t// iterate over leveldb and get key, val\n\titer := sourceDb.NewIterator(nil, nil)\n\tfor iter.Next() {\n\t\tkey := iter.Key()\n\t\tvalue := iter.Value()\n\n\t\tvar docRet Document\n\t\t// convert bson to byte\n\t\tbson.Unmarshal(value, &docRet)\n\n\t\tfmt.Println(string(key), docRet)\n\t}\n\titer.Release()\n\terr = iter.Error()\n\n\tjson.NewEncoder(w).Encode(ids)\n}\n\nfunc getDocuments(selector string) []Document {\n\tvar documents []Document\n\n\tif selector == \"all\" {\n\t\t// iterate over leveldb and get key, val\n\t\titer := sourceDb.NewIterator(nil, nil)\n\t\tfor iter.Next() {\n\t\t\t// key := iter.Key()\n\t\t\tvalue := iter.Value()\n\n\t\t\tvar docRet Document\n\t\t\t// convert bson to byte\n\t\t\tbson.Unmarshal(value, &docRet)\n\n\t\t\tdocuments = append(documents, docRet)\n\t\t}\n\t\titer.Release()\n\t\terr = iter.Error()\n\t}\n\n\treturn documents\n}\n\nfunc getVersion(document Document) []byte {\n\t// version: timestamp (milliseconds, 13 digits) + deleted\n\tvar delStatus byte\n\tdelStatus = 48\n\tif document.Deleted {\n\t\tdelStatus = 49\n\t}\n\tversionGen := append([]byte(document.Timestamp), delStatus)\n\n\treturn versionGen\n}\n\n// =========================== COUCHDB ======================================================================\nfunc authenticate() (int, []byte) {\n\treturn request(\"http://127.0.0.1:5984/_session\", \"POST\", \"name=admin&password=password\", \"x-www-form-urlencoded\")\n\n}\n\nfunc checkDB(dbName string) (int, []byte) {\n\treturn request(\"http://127.0.0.1:5984/\"+dbName, \"HEAD\", \"\", \"\")\n}\n\nfunc createDB(dbName string) (int, []byte) {\n\treturn request(\"http://127.0.0.1:5984/\"+dbName, \"PUT\", \"\", \"\")\n}\n\nfunc getDBInfo(dbName string) (int, []byte) {\n\treturn request(\"http://127.0.0.1:5984/\"+dbName, \"GET\", \"\", \"\")\n}\n\nfunc getReplicationLog(dbName string, logID string) (int, []byte) {\n\treturn request(\"http://127.0.0.1:5984/\"+dbName+\"/_local/\"+logID, \"GET\", \"\", \"\")\n}\n\nfunc addBatchDocs(dbName string, documents []Document) (int, []byte) {\n\tdata, err := json.Marshal(documents)\n\tif err != nil {\n\t\tfmt.Println(err)\n\t}\n\n\tdataStr := `{\"docs\":` + string(data) + `}`\n\treturn request(\"http://127.0.0.1:5984/\"+dbName+\"/_bulk_docs\", \"POST\", dataStr, \"application/json\")\n}\n\nfunc getChanges(dbName string) (int, []byte) {\n\treturn request(\"http://127.0.0.1:5984/\"+dbName+\"/_changes?style=all_docs\", \"GET\", \"\", \"\")\n}\n\nfunc ensureCommit(dbName string) (int, []byte) {\n\treturn request(\"http://127.0.0.1:5984/\"+dbName+\"/_ensure_full_commit\", \"POST\", \"\", \"application/json\")\n}\n\nfunc setReplChkPoint(dbName string, replLog []byte) (int, []byte) {\n\treturn request(\"http://127.0.0.1:5984/\"+dbName+\"/_ensure_full_commit\", \"POST\", string(replLog), \"application/json\")\n}\n\nfunc request(url string, method string, payload string, contentType string) (int, []byte) {\n\n\tclient := &http.Client{\n\t\tJar: jar,\n\t}\n\n\tvar req *http.Request\n\tvar err error\n\n\tif payload == \"\" {\n\t\treq, err = http.NewRequest(method, url, nil)\n\t} else {\n\t\treq, err = http.NewRequest(method, url, strings.NewReader(payload))\n\t}\n\n\tif err != nil {\n\t\tfmt.Println(err)\n\t}\n\n\tif contentType == \"x-www-form-urlencoded\" {\n\t\treq.Header.Add(\"Content-Type\", \"application/x-www-form-urlencoded\")\n\t} else if contentType == \"application/json\" {\n\t\treq.Header.Add(\"Content-Type\", \"application/json\")\n\t}\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tfmt.Println(err)\n\n\t}\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tfmt.Println(err)\n\t}\n\n\treturn res.StatusCode, body\n}\n\nfunc handleRequests() {\n\tmyRouter := mux.NewRouter().StrictSlash(true)\n\tmyRouter.HandleFunc(\"/\", homePage)\n\tmyRouter.HandleFunc(\"/create\", createNewDocument).Methods(\"POST\")\n\tmyRouter.HandleFunc(\"/delete\", deleteDocument).Methods(\"POST\")\n\tlog.Fatal(http.ListenAndServe(\":10000\", myRouter))\n}\n\nfunc replicatorDemon() {\n\tfor {\n\t\t// authenticate couchDB\n\t\tstat, _ := authenticate()\n\t\tif stat != 200 {\n\t\t\tfmt.Println(\"CouchDB Authentication failed. Exiting demon.\")\n\t\t} else {\n\t\t\tfmt.Println(\"CouchDB authentication success.\")\n\t\t}\n\n\t\t// perform replication to target =======================================\n\t\t// sourceDB := \"source\"\n\t\ttargetDB := \"target\"\n\n\t\t// 1. verify peers\n\t\tstat, _ = checkDB(targetDB)\n\t\tif stat == 404 {\n\t\t\tfmt.Println(\"Target DB do not exist. Creating it..\")\n\t\t\t// create target database\n\t\t\tstat, _ = createDB(targetDB)\n\t\t\tif stat == 201 {\n\t\t\t\tfmt.Println(\"Target DB created.\")\n\t\t\t} else {\n\t\t\t\tfmt.Println(\"Target DB can not be created. Aborting replication..\")\n\t\t\t\tbreak\n\t\t\t}\n\t\t} else if stat == 200 {\n\t\t\tfmt.Println(\"Target DB exists\")\n\t\t}\n\t\t// 2. get peers information\n\t\tfmt.Println(\"Getting peers information..\")\n\t\tstat, _ = getDBInfo(targetDB)\n\t\treplicationID := \"\"\n\t\tif stat == 200 {\n\t\t\t// generate replication ID\n\t\t\treplicationID = \"123456\"\n\t\t}\n\n\t\t// 3. find common ascestry\n\t\tfullReplication := false\n\n\t\tif replicationID != \"\" {\n\t\t\tfmt.Println(\"Generated replication ID: \", replicationID)\n\t\t\t// get replication log from target\n\t\t\tfmt.Println(\"Getting replication log from target..\")\n\t\t\tstat, rlog := getReplicationLog(targetDB, replicationID)\n\t\t\tif stat == 200 {\n\t\t\t\t// compare logs\n\t\t\t\tfmt.Println(string(rlog))\n\t\t\t} else if stat == 404 {\n\t\t\t\tfullReplication = true\n\t\t\t\tfmt.Println(\"Replication log not available. Full replication needed.\")\n\t\t\t}\n\t\t} else {\n\t\t\tfmt.Println(\"Replication ID generation failed. Exiting.. \")\n\t\t\tbreak\n\t\t}\n\n\t\t// 4. locate changed documents\n\t\tvar documents []Document\n\t\tif fullReplication {\n\t\t\t// get all documents\n\t\t\tdocuments = getDocuments(\"all\")\n\t\t} else {\n\t\t\t// Get changed documents in target\n\t\t\tstat, changes := getChanges(targetDB)\n\t\t\tif stat == 200 {\n\t\t\t\tfmt.Println(\"Changes: \", changes)\n\t\t\t}\n\t\t\t// finalize documents to be replicated\n\t\t\tdocuments = getDocuments(\"all\") // TODO: To be changed to selectives\n\n\t\t\t// finalize replication if no change found\n\t\t\tif len(documents) <= 0 {\n\t\t\t\tfmt.Println(\"No more changes to replicate.\")\n\t\t\t}\n\t\t}\n\n\t\t// 5. replicate changes\n\t\tif len(documents) > 0 {\n\t\t\tstat, _ := addBatchDocs(targetDB, documents)\n\t\t\tif stat == 201 {\n\t\t\t\tfmt.Println(\"Documents written succesfully.\")\n\t\t\t} else {\n\t\t\t\tfmt.Println(\"Documents write failed.\")\n\t\t\t}\n\n\t\t\t// ensure in commit\n\t\t\tstat, data := ensureCommit(targetDB)\n\t\t\tif stat == 201 {\n\t\t\t\tfmt.Println(\"Documents commited succesfully.\")\n\n\t\t\t} else {\n\t\t\t\tfmt.Println(\"Documents commit failed.\", string(data))\n\t\t\t\tbreak\n\t\t\t}\n\n\t\t\t// set record replication checkpoint\n\t\t\tstat, _ = setReplChkPoint(targetDB, []byte(\"\"))\n\t\t}\n\n\t\t// wait 5 seconds before next replication loop\n\t\ttime.Sleep(time.Duration(5 * time.Second))\n\t}\n}\n\nfunc main() {\n\tgo replicatorDemon()\n\n\thandleRequests()\n}\n" }, { "path": "aquila/search/.dockerignore", "content": "node_modules\n.vscode\n.env*\ndist" }, { "path": "aquila/search/.nvmrc", "content": "v16.17.0" }, { "path": "aquila/search/Dockerfile", "content": "FROM node:16-alpine as builder\n\n# Browserless\nARG BROWSERLESS_API_KEY=your-api-key-here\n\nWORKDIR /app\n\nRUN apk add curl bash\nRUN apk add --no-cache git openssh\n\n\n# install node-prune (https://github.com/tj/node-prune)\nRUN curl -sfL https://gobinaries.com/tj/node-prune | bash -s -- -b /usr/local/bin\n\nCOPY . .\n\nRUN yarn\n\nRUN yarn build\n\n\nRUN npm prune --production\n\n# run node prune\nRUN /usr/local/bin/node-prune\n\nFROM node:16-alpine\n\n# Application Port\nENV PORT=5000\n\n# Database\nENV DB_HOST=host.docker.internal\nENV DB_PORT=5432\nENV DB_NAME=test_db\nENV DB_USERNAME=user\nENV DB_PASSWORD=password\n\n# Redis\nENV REDIS_HOST=redis-19166.c62.us-east-1-4.ec2.cloud.redislabs.com\nENV REDIS_PORT=19166\nENV REDIS_USERNAME=default\nENV REDIS_PASSWORD=WUFOqcuORH4VoVNKBmzPIQvwsmpHqE5a\n\n# Jwt\nENV JWT_SECRET=jwtsecret\nENV JWT_EXPIRES_IN=2h\n\n#Summarizer\nENV SUMMARIZER_URL=http://host.docker.internal:5008/process\n\n#Aquila\nENV AQUILA_DB_HOST=http://host.docker.internal\nENV AQUILA_DB_PORT=5001\nENV AQUILA_DB_KEY_PATH=../../private_unencrypted.pem\nENV AQUILA_HUB_HOST=http://host.docker.internal\nENV AQUILA_HUB_PORT=5002\nENV AQUILA_HUB_KEY_PATH=../../private_unencrypted_hub.pem\n\n# Browserless\nENV BROWSERLESS_API_KEY=b94a8c0c-3b5c-4342-ab2d-a4b19bf1f13b\n\nWORKDIR /app\n\nCOPY --from=builder /app/dist ./dist\nCOPY --from=builder /app/node_modules ./node_modules\n\nEXPOSE 5000\n\nCMD [\"node\", \"./dist/index.js\"]" }, { "path": "aquila/search/README.md", "content": "# AquilaX EE\n\n## ⚠️ Server and other Credentials are in workflow file\nNever make this repo Public\n\nSteps to run this project:\n\n1. Run `yarn` command\n2. Setup database settings inside `data-source.ts` file\n3. Run `yarn run start:dev` command\n4. Generate migration `yarn run typeorm -- migration:generate src/migrations/bookmark --dataSource src/config/db.ts`\n5. Run migration `yarn run typeorm -- migration:run --dataSource src/config/db.ts`\n\n\n## Run using Docker\nDocker build\n```bash\ndocker build -t manekshms/aquila-network-api .\n\ndocker run -d -p 5000:5000 \\\n-e DB_HOST=localhost \\\n-e DB_PORT=5432 \\\n-e DB_NAME=test_db \\\n-e DB_USERNAME=test \\\n-e DB_PASSWORD=example \\\n-e REDIS_HOST=localhost \\\n-e REDIS_PORT=6379 \\\n-e REDIS_USERNAME=default \\\n-e REDIS_PASSWORD=redis123 \\\n-e JWT_SECRET=jwtsecret \\\n-e JWT_EXPIRES_IN=2h \\\n-e SUMMARIZER_URL=http://localhost:5008/process \\\n-e AQUILA_DB_HOST=http://localhost.internal \\\n-e AQUILA_DB_PORT=5001 \\\n-e AQUILA_DB_KEY_PATH=/ossl/private_unencrypted.pem \\\n-e AQUILA_HUB_HOST=http://localhost.internal \\\n-e AQUILA_HUB_PORT=5002 \\\n-e AQUILA_HUB_KEY_PATH=/ossl/private_unencrypted.pem \\\n-e ENV BROWSERLESS_API_KEY=key \\\n-v ${HOME}/aquilax/ossl:/ossl\n--name manekshms/aquila-network-ui\n```\n\n" }, { "path": "aquila/search/package.json", "content": "{\n \"name\": \"aquilax-ee\",\n \"version\": \"1.0.0\",\n \"description\": \"AquilaX api\",\n \"main\": \"index.js\",\n \"repository\": \"https://github.com/Aquila-HQ/AquilaX-EE.git\",\n \"author\": \"manekshms
Decentralized cryptocurrency
\\n' +\n '"₿" redirects here. It is not to be confused with "฿" for Thai baht.
\\n' +\n '\\n' +\n '![\"Prevailing](\"https://upload.wikimedia.org/wikipedia/commons/thumb/c/c5/Bitcoin_logo.svg/252px-Bitcoin_logo.svg.png\"){kind=logo}
Prevailing bitcoin logo
₿))[a]Initially ₿50 per block, halved every 210,000 blocks[7]
\\n' +\n '
- \\n' +\n '
- ^ The symbol was encoded in Unicode version 10.0 at position U+20BF ₿ BITCOIN SIGN in the Currency Symbols block in June 2017.[1]\\n' +\n ' \\n' +\n '
- ^ Compatible with ISO 4217.\\n' +\n ' \\n' +\n '
- ^ May 2020 to approximately 2024, halved approximately every four years\\n' +\n ' \\n' +\n '
- ^ The supply will approach, but never reach, ₿21 million. Issuance will permanently halt c. 2140 at ₿20,999,999.9769.[6]:ch. 8\\n' +\n ' \\n' +\n '
| \\n' +\n ' | This article contains special characters. Without proper rendering support, you may see question marks, boxes, or other symbols. |
Bitcoin (₿) is a decentralized digital currency, without a central bank or single administrator, that can be sent from user to user on the peer-to-peer bitcoin network without the need for intermediaries.[7] Transactions are verified by network nodes through cryptography and recorded in a public distributed ledger called a blockchain. The cryptocurrency was invented in 2008 by an unknown person or group of people using the name Satoshi Nakamoto.[8] The currency began use in 2009[9] when its implementation was released as open-source software.[6]:ch. 1\\n' +\n '
Bitcoins are created as a reward for a process known as mining. They can be exchanged for other currencies, products, and services,[10] but the real-world value of the coins is extremely volatile.[11] Research produced by the University of Cambridge estimated that in 2017, there were 2.9 to 5.8 million unique users using a cryptocurrency wallet, most of them using bitcoin.[12] Users choose to participate in the digital currency for a number of reasons: ideologies such as commitment to anarchism, decentralization and libertarianism, convenience, using the currency as an investment and pseudonymity of transactions. Increased use has led to a desire among governments for regulation in order to tax, facilitate legal use in trade and for other reasons (such as investigations for money laundering and price manipulation).\\n' +\n '
Bitcoin has been criticized for its use in illegal transactions, the large amount of electricity (and thus carbon footprint) used by mining, price volatility, and thefts from exchanges. Some economists and commentators have characterized it as a speculative bubble at various times. Bitcoin has also been used as an investment, although several regulatory agencies have issued investor alerts about bitcoin.[11][13][14]\\n' +\n '
The word bitcoin was defined in a white paper published on 31 October 2008.[4][15] It is a compound of the words bit and coin.[16] No uniform convention for bitcoin capitalization exists; some sources use Bitcoin, capitalized, to refer to the technology and network and bitcoin, lowercase, for the unit of account.[17] The Wall Street Journal,[18] The Chronicle of Higher Education,[19] and the Oxford English Dictionary[16] advocate the use of lowercase bitcoin in all cases.\\n' +\n '
\\n' +\n '\\n' +\n '\\n' +\n 'History
\\n' +\n 'Main article: History of bitcoin
\\n' +\n 'Creation
\\n' +\n 'The domain name bitcoin.org was registered on 18 August 2008.[20] On 31 October 2008, a link to a paper authored by Satoshi Nakamoto titled Bitcoin: A Peer-to-Peer Electronic Cash System[4] was posted to a cryptography mailing list.[21] Nakamoto implemented the bitcoin software as open-source code and released it in January 2009.[22][23][9] Nakamoto's identity remains unknown.[8]\\n' +\n '
On 3 January 2009, the bitcoin network was created when Nakamoto mined the starting block of the chain, known as the genesis block.[24][25] Embedded in the coinbase of this block was the text "The Times 03/Jan/2009 Chancellor on brink of second bailout for banks".[9] This note references a headline published by The Times and has been interpreted as both a timestamp and a comment on the instability caused by fractional-reserve banking.[26]:18\\n' +\n '
The receiver of the first bitcoin transaction was cypherpunk Hal Finney, who had created the first reusable proof-of-work system (RPoW) in 2004.[27] Finney downloaded the bitcoin software on its release date, and on 12 January 2009 received ten bitcoins from Nakamoto.[28][29] Other early cypherpunk supporters were creators of bitcoin predecessors: Wei Dai, creator of b-money, and Nick Szabo, creator of bit gold.[24] In 2010, the first known commercial transaction using bitcoin occurred when programmer Laszlo Hanyecz bought two Papa John's pizzas for ₿10,000.[30]\\n' +\n '
Blockchain analysts estimate that Nakamoto had mined about one million bitcoins[31] before disappearing in 2010 when he handed the network alert key and control of the code repository over to Gavin Andresen. Andresen later became lead developer at the Bitcoin Foundation.[32][33] Andresen then sought to decentralize control. This left opportunity for controversy to develop over the future development path of bitcoin, in contrast to the perceived authority of Nakamoto's contributions.[34][33]\\n' +\n '
\\n' +\n '2011–2012
\\n' +\n 'After early "proof-of-concept" transactions, the first major users of bitcoin were black markets, such as Silk Road. During its 30 months of existence, beginning in February 2011, Silk Road exclusively accepted bitcoins as payment, transacting 9.9 million in bitcoins, worth about $214 million.[35]:222\\n' +\n '
In 2011, the price started at $0.30 per bitcoin, growing to $5.27 for the year. The price rose to $31.50 on 8 June. Within a month, the price fell to $11.00. The next month it fell to $7.80, and in another month to $4.77.[36]\\n' +\n '
In 2012, bitcoin prices started at $5.27, growing to $13.30 for the year.[36] By 9 January the price had risen to $7.38, but then crashed by 49% to $3.80 over the next 16 days. The price then rose to $16.41 on 17 August, but fell by 57% to $7.10 over the next three days.[37]\\n' +\n '
The Bitcoin Foundation was founded in September 2012 to promote bitcoin's development and uptake.[38]\\n' +\n '
On 1 November 2011, the reference implementation Bitcoin-Qt version 0.5.0 was released. It introduced a front end that used the Qt user interface toolkit.[39] The software previously used Berkeley DB for database management. Developers switched to LevelDB in release 0.8 in order to reduce blockchain synchronization time.[citation needed] The update to this release resulted in a minor blockchain fork on 11 March 2013. The fork was resolved shortly afterwards.[citation needed] Seeding nodes through IRC was discontinued in version 0.8.2. From version 0.9.0 the software was renamed to Bitcoin Core. Transaction fees were reduced again by a factor of ten as a means to encourage microtransactions.[citation needed] Although Bitcoin Core does not use OpenSSL for the operation of the network, the software did use OpenSSL for remote procedure calls. Version 0.9.1 was released to remove the network's vulnerability to the Heartbleed bug.[citation needed]\\n' +\n '
\\n' +\n '2013–2016
\\n' +\n 'In 2013, prices started at $13.30 rising to $770 by 1 January 2014.[36]\\n' +\n '
In March 2013 the blockchain temporarily split into two independent chains with different rules due to a bug in version 0.8 of the bitcoin software. The two blockchains operated simultaneously for six hours, each with its own version of the transaction history from the moment of the split. Normal operation was restored when the majority of the network downgraded to version 0.7 of the bitcoin software, selecting the backwards-compatible version of the blockchain. As a result, this blockchain became the longest chain and could be accepted by all participants, regardless of their bitcoin software version.[40] During the split, the Mt. Gox exchange briefly halted bitcoin deposits and the price dropped by 23% to $37[40][41] before recovering to the previous level of approximately $48 in the following hours.[42]\\n' +\n '
The US Financial Crimes Enforcement Network (FinCEN) established regulatory guidelines for "decentralized virtual currencies" such as bitcoin, classifying American bitcoin miners who sell their generated bitcoins as Money Service Businesses (MSBs), that are subject to registration or other legal obligations.[43][44][45]\\n' +\n '
In April, exchanges BitInstant and Mt. Gox experienced processing delays due to insufficient capacity[46] resulting in the bitcoin price dropping from $266 to $76 before returning to $160 within six hours.[47] The bitcoin price rose to $259 on 10 April, but then crashed by 83% to $45 over the next three days.[37]\\n' +\n '
On 15 May 2013, US authorities seized accounts associated with Mt. Gox after discovering it had not registered as a money transmitter with FinCEN in the US.[48][49] On 23 June 2013, the US Drug Enforcement Administration listed ₿11.02 as a seized asset in a United States Department of Justice seizure notice pursuant to 21 U.S.C. § 881. This marked the first time a government agency had seized bitcoin.[50] The FBI seized about ₿30,000[51] in October 2013 from the dark web website Silk Road, following the arrest of Ross William Ulbricht.[52][53][54] These bitcoins were sold at blind auction by the United States Marshals Service to venture capital investor Tim Draper.[51] Bitcoin's price rose to $755 on 19 November and crashed by 50% to $378 the same day. On 30 November 2013, the price reached $1,163 before starting a long-term crash, declining by 87% to $152 in January 2015.[37]\\n' +\n '
On 5 December 2013, the People's Bank of China prohibited Chinese financial institutions from using bitcoins.[55] After the announcement, the value of bitcoins dropped,[56] and Baidu no longer accepted bitcoins for certain services.[57] Buying real-world goods with any virtual currency had been illegal in China since at least 2009.[58]\\n' +\n '
In 2014, prices started at $770 and fell to $314 for the year.[36] On 30 July 2014, the Wikimedia Foundation started accepting donations of bitcoin.[59]\\n' +\n '
In 2015, prices started at $314 and rose to $434 for the year. In 2016, prices rose and climbed up to $998 by 1 January 2017.[36]\\n' +\n '
Release 0.10 of the software was made public on 16 February 2015. It introduced a consensus library which gave programmers easy access to the rules governing consensus on the network. In version 0.11.2 developers added a new feature which allowed transactions to be made unspendable until a specific time in the future.[60] Bitcoin Core 0.12.1 was released on 15 April 2016, and enabled multiple soft forks to occur concurrently.[61] Around 100 contributors worked on Bitcoin Core 0.13.0 which was released on 23 August 2016.\\n' +\n '
In July 2016, the CheckSequenceVerify soft fork activated.[62]\\n' +\n '
In October 2016, Bitcoin Core's 0.13.1 release featured the "Segwit" soft fork that included a scaling improvement aiming to optimize the bitcoin blocksize.[citation needed] The patch which was originally finalised in April, and 35 developers were engaged to deploy it.[citation needed] This release featured Segregated Witness (SegWit) which aimed to place downward pressure on transaction fees as well as increase the maximum transaction capacity of the network.[63][non-primary source needed] The 0.13.1 release endured extensive testing and research leading to some delays in its release date.[citation needed] SegWit prevents various forms of transaction malleability.[64][non-primary source needed]\\n' +\n '
\\n' +\n '2017–2019
\\n' +\n 'On 15 July 2017, the controversial Segregated Witness [SegWit] software upgrade was approved ("locked-in"). Segwit was intended to support the Lightning Network as well as improve scalability.[65] SegWit was subsequently activated on the network on 24 August 2017. The bitcoin price rose almost 50% in the week following SegWit's approval.[65] On 21 July 2017, bitcoin was trading at $2,748, up 52% from 14 July 2017's $1,835.[65] Supporters of large blocks who were dissatisfied with the activation of SegWit forked the software on 1 August 2017 to create Bitcoin Cash, becoming one of many forks of bitcoin such as Bitcoin Gold.[66] \\n' +\n '
Prices started at $998 in 2017 and rose to $13,412.44 on 1 January 2018,[36] after reaching its all-time high of $19,783.06 on 17 December 2017.[67]\\n' +\n '
China banned trading in bitcoin, with first steps taken in September 2017, and a complete ban that started on 1 February 2018. Bitcoin prices then fell from $9,052 to $6,914 on 5 February 2018.[37] The percentage of bitcoin trading in the Chinese renminbi fell from over 90% in September 2017 to less than 1% in June 2018.[68]\\n' +\n '
Throughout the rest of the first half of 2018, bitcoin's price fluctuated between $11,480 and $5,848. On 1 July 2018, bitcoin's price was $6,343.[69][70] The price on 1 January 2019 was $3,747, down 72% for 2018 and down 81% since the all-time high.[69][71]\\n' +\n '
In September 2018, an anonymous party discovered and reported an invalid-block denial-of-server vulnerability to developers of Bitcoin Core, Bitcoin ABC and Bitcoin Unlimited. Further analysis by bitcoin developers showed the issue could also allow the creation of blocks violating the 21 million coin limit and CVE-2018-17144 was assigned and the issue resolved.[72][non-primary source needed]\\n' +\n '
Bitcoin prices were negatively affected by several hacks or thefts from cryptocurrency exchanges, including thefts from Coincheck in January 2018, Bithumb in June, and Bancor in July. For the first six months of 2018, $761 million worth of cryptocurrencies was reported stolen from exchanges.[73] Bitcoin's price was affected even though other cryptocurrencies were stolen at Coinrail and Bancor as investors worried about the security of cryptocurrency exchanges.[74][75][76] In September 2019 the Intercontinental Exchange (the owner of the NYSE) began trading of bitcoin futures on its exchange called Bakkt.[77] Bakkt also announced that it would launch options on bitcoin in December 2019.[78] In December 2019, YouTube removed bitcoin and cryptocurrency videos, but later restored the content after judging they had "made the wrong call."[79]\\n' +\n '
In February 2019, Canadian cryptocurrency exchange Quadriga Fintech Solutions failed with approximately $200 million missing.[80] By June 2019 the price had recovered to $13,000.[81]\\n' +\n '
\\n' +\n '2020–present
\\n' +\n 'According to CoinMetrics and Forbes, on 11 March 281,000 bitcoins were sold by owners who held them for only thirty days. This compared to ₿4,131 that had laid dormant for a year or more, indicating that the vast majority of the bitcoin volatility on that day was from recent buyers.[81] During the week of 11 March 2020 as a result of the COVID-19 pandemic, cryptocurrency exchange Kraken experienced an 83% increase in the number of account signups over the week of bitcoin's price collapse, a result of buyers looking to capitalize on the low price.[81] On 13 March 2020, bitcoin fell below $4000 during a broad COVID-19 pandemic related market selloff, after trading above $10,000 in February 2020.[82]\\n' +\n '
In August 2020, MicroStrategy invested $250 million in bitcoin as a treasury reserve asset.[83] In October 2020, Square, Inc. put approximately 1% of their total assets ($50 million) in bitcoin.[84] In November 2020, PayPal announced that all users in the US could buy, hold, or sell bitcoin using PayPal.[85] On 30 November 2020, bitcoin hit a new all-time high of $19,860 topping the previous high from December 2017.[86] Alexander Vinnik, founder of BTC-e, was convicted and sentenced to 5 years in prison for money laundering in France while refusing to testify during his trial.[87] In December 2020 Massachusetts Mutual Life Insurance Company announced it has purchased $100 million in bitcoin, or roughly 0.04% of its general investment account.[88]\\n' +\n '
On 19 January 2021, Elon Musk placed #Bitcoin in his Twitter profile tweeting "In retrospect, it was inevitable", which caused the price to briefly rise about $5000 in an hour to $37,299.[89] On 25 January 2021 Microstrategy announced it continued to buy bitcoin and as of the same date it had holdings of ₿70,784 worth $2.38 billion.[90] On 8 February 2021 Tesla's announcement that it had purchased $1.5 billion in bitcoin and planned to start accepting bitcoin as payment for vehicles pushed the bitcoin price to an all-time high of $44,141.[91] On 18 February 2021, Elon Musk said that "owning bitcoin was only a little better than holding conventional cash, but that the slight difference made it a better asset to hold".[92]\\n' +\n '
It was announced in September 2020, that the Canton of Zug (in Switzerland) will start to accept tax payments in bitcoin from February 2021.[93][94]\\n' +\n '
\\n' +\n 'Design
\\n' +\n '![](\"https://en.wikipedia.org/wiki/File:Secp256k1.png\")
![\"R\"](\"https://wikimedia.org/api/rest_v1/media/math/render/svg/4b0bfb3769bf24d80e15374dc37b0441e2616e33\")
Bitcoin is based on an elliptic curve called secp256k1 and encrypted with the ECDSA algorithm.[95][better source needed] The equation for the Bitcoin secp256k1 curve is ![\"y\"](\"https://wikimedia.org/api/rest_v1/media/math/render/svg/b8a6208ec717213d4317e666f1ae872e00620a0d\")
![\"x\"](\"https://wikimedia.org/api/rest_v1/media/math/render/svg/87f9e315fd7e2ba406057a97300593c4802b53e4\")
Units and divisibility
\\n' +\n 'The unit of account of the bitcoin system is a bitcoin. Ticker symbols used to represent bitcoin are BTC[a] and XBT.[b][101]:2 Its Unicode character is ₿.[1] Small amounts of bitcoin used as alternative units are millibitcoin (mBTC), and satoshi (sat). Named in homage to bitcoin's creator, a satoshi is the smallest amount within bitcoin representing 1⁄100000000 bitcoins, one hundred millionth of a bitcoin.[2] A millibitcoin equals 1⁄1000 bitcoins; one thousandth of a bitcoin or 100,000 satoshis.[102]\\n' +\n '
\\n' +\n 'Blockchain
\\n' +\n '\\n' +\n '![](\"https://en.wikipedia.org/wiki/File:Bitcoin_Block_Data.png\")
![](\"https://en.wikipedia.org/wiki/File:BTC_number_of_transactions_per_month.svg\"){kind=spacer}
Number of bitcoin transactions per month, semilogarithmic plot[103]
![](\"https://en.wikipedia.org/wiki/File:Utxo-count.svg\")
Number of unspent transaction outputs[104]
For broader coverage of this topic, see Blockchain.
\\n' +\n 'The bitcoin blockchain is a public ledger that records bitcoin transactions.[105] It is implemented as a chain of blocks, each block containing a hash of the previous block up to the genesis block[c] of the chain. A network of communicating nodes running bitcoin software maintains the blockchain.[35]:215–219 Transactions of the form payer X sends Y bitcoins to payee Z are broadcast to this network using readily available software applications.\\n' +\n '
Network nodes can validate transactions, add them to their copy of the ledger, and then broadcast these ledger additions to other nodes. To achieve independent verification of the chain of ownership each network node stores its own copy of the blockchain.[106] At varying intervals of time averaging to every 10 minutes, a new group of accepted transactions, called a block, is created, added to the blockchain, and quickly published to all nodes, without requiring central oversight. This allows bitcoin software to determine when a particular bitcoin was spent, which is needed to prevent double-spending. A conventional ledger records the transfers of actual bills or promissory notes that exist apart from it, but the blockchain is the only place that bitcoins can be said to exist in the form of unspent outputs of transactions.[6]:ch. 5\\n' +\n '
Individual blocks, public addresses and transactions within blocks can be examined using a blockchain explorer.[citation needed]\\n' +\n '
\\n' +\n 'Supply
\\n' +\n '![](\"https://en.wikipedia.org/wiki/File:Question_book-new.svg\") | This section needs additional citations for verification. Please help improve this article by adding citations to reliable sources. Unsourced material may be challenged and removed. (May 2021) (Learn how and when to remove this template message) |
![](\"https://en.wikipedia.org/wiki/File:Total-bitcoins.svg\")
Total bitcoins in circulation.[104]
The successful miner finding the new block is allowed by the rest of the network to reward themselves with newly created bitcoins and transaction fees.[107] As of 11 May 2020[update],[citation needed] the reward amounted to 6.25 newly created bitcoins per block added to the blockchain,[citation needed] plus any transaction fees from payments processed by the block. To mine half of the supply of bitcoins took four years but the remainder will take another 120 years, because of an artificial process called "bitcoin halving" according to which miners are compensated by fewer BTC as time goes on.[citation needed] To claim the reward, a special transaction called a coinbase is included with the processed payments.[6]:ch. 8 All bitcoins in existence have been created in such coinbase transactions. The bitcoin protocol specifies that the reward for adding a block will be halved every 210,000 blocks (approximately every four years). Eventually, the reward will decrease to zero, and the limit of 21 million bitcoins[d] will be reached c. 2140; the record keeping will then be rewarded solely by transaction fees.[108]\\n' +\n '
In other words, Nakamoto set a monetary policy based on artificial scarcity at bitcoin's inception that the total number of bitcoins could never exceed 21 million. New bitcoins are created roughly every ten minutes and the rate at which they are generated drops by half about every four years until all will be in circulation.[109]\\n' +\n '
\\n' +\n 'Transactions
\\n' +\n 'See also: Bitcoin network
\\n' +\n 'Transactions are defined using a Forth-like scripting language.[6]:ch. 5 Transactions consist of one or more inputs and one or more outputs. When a user sends bitcoins, the user designates each address and the amount of bitcoin being sent to that address in an output. To prevent double spending, each input must refer to a previous unspent output in the blockchain.[110] The use of multiple inputs corresponds to the use of multiple coins in a cash transaction. Since transactions can have multiple outputs, users can send bitcoins to multiple recipients in one transaction. As in a cash transaction, the sum of inputs (coins used to pay) can exceed the intended sum of payments. In such a case, an additional output is used, returning the change back to the payer.[110] Any input satoshis not accounted for in the transaction outputs become the transaction fee.[110]\\n' +\n '
Though transaction fees are optional, miners can choose which transactions to process and prioritize those that pay higher fees.[110] Miners may choose transactions based on the fee paid relative to their storage size, not the absolute amount of money paid as a fee. These fees are generally measured in satoshis per byte (sat/b). The size of transactions is dependent on the number of inputs used to create the transaction, and the number of outputs.[6]:ch. 8\\n' +\n '
The blocks in the blockchain were originally limited to 32 megabytes in size. The block size limit of one megabyte was introduced by Satoshi Nakamoto in 2010. Eventually the block size limit of one megabyte created problems for transaction processing, such as increasing transaction fees and delayed processing of transactions.[111] Andreas Antonopoulos has stated Lightning Network is a potential scaling solution and referred to lightning as a second layer routing network.[6]:ch. 8\\n' +\n '
\\n' +\n 'Ownership
\\n' +\n '\\n' +\n '
![](\"https://en.wikipedia.org/wiki/File:Bitcoin_Transaction_Visual.svg\"){kind=spacer}
In the blockchain, bitcoins are registered to bitcoin addresses. Creating a bitcoin address requires nothing more than picking a random valid private key and computing the corresponding bitcoin address. This computation can be done in a split second. But the reverse, computing the private key of a given bitcoin address, is practically unfeasible.[6]:ch. 4 Users can tell others or make public a bitcoin address without compromising its corresponding private key. Moreover, the number of valid private keys is so vast that it is extremely unlikely someone will compute a key-pair that is already in use and has funds. The vast number of valid private keys makes it unfeasible that brute force could be used to compromise a private key. To be able to spend their bitcoins, the owner must know the corresponding private key and digitally sign the transaction. The network verifies the signature using the public key; the private key is never revealed.[6]:ch. 5\\n' +\n '
If the private key is lost, the bitcoin network will not recognize any other evidence of ownership;[35] the coins are then unusable, and effectively lost. For example, in 2013 one user claimed to have lost 7,500 bitcoins, worth $7.5 million at the time, when he accidentally discarded a hard drive containing his private key.[112] About 20% of all bitcoins are believed to be lost -they would have had a market value of about $20 billion at July 2018 prices.[113]\\n' +\n '
To ensure the security of bitcoins, the private key must be kept secret.[6]:ch. 10 If the private key is revealed to a third party, e.g. through a data breach, the third party can use it to steal any associated bitcoins.[114] As of December 2017[update], around 980,000 bitcoins have been stolen from cryptocurrency exchanges.[115]\\n' +\n '
Regarding ownership distribution, as of 16 March 2018, 0.5% of bitcoin wallets own 87% of all bitcoins ever mined.[116]\\n' +\n '
\\n' +\n 'Mining
\\n' +\n 'See also: Bitcoin network § Mining
\\n' +\n '![](\"https://en.wikipedia.org/wiki/File:Minage_de_crypto-monnaie_(2).jpg\")
Early bitcoin miners used GPUs for mining, as they were better suited to the proof-of-work algorithm than CPUs.[117]
![](\"https://en.wikipedia.org/wiki/File:USB_Erupter.jpg\")
![](\"https://en.wikipedia.org/wiki/File:Cryptocurrency_Mining_Farm.jpg\")
Today, bitcoin mining companies dedicate facilities to housing and operating large amounts of high-performance mining hardware.[118]
![](\"https://en.wikipedia.org/wiki/File:History_of_Bitcoin_difficulty.svg\")
Mining is a record-keeping service done through the use of computer processing power.[f] Miners keep the blockchain consistent, complete, and unalterable by repeatedly grouping newly broadcast transactions into a block, which is then broadcast to the network and verified by recipient nodes.[105] Each block contains a SHA-256 cryptographic hash of the previous block,[105] thus linking it to the previous block and giving the blockchain its name.[6]:ch. 7[105]\\n' +\n '
To be accepted by the rest of the network, a new block must contain a proof-of-work (PoW).[105] The system used is based on Adam Back's 1997 anti-spam scheme, Hashcash.[120][failed verification][4] The PoW requires miners to find a number called a nonce, such that when the block content is hashed along with the nonce, the result is numerically smaller than the network's difficulty target.[6]:ch. 8 This proof is easy for any node in the network to verify, but extremely time-consuming to generate, as for a secure cryptographic hash, miners must try many different nonce values (usually the sequence of tested values is the ascending natural numbers: 0, 1, 2, 3, ...[6]:ch. 8) before meeting the difficulty target.\\n' +\n '
Every 2,016 blocks (approximately 14 days at roughly 10 min per block), the difficulty target is adjusted based on the network's recent performance, with the aim of keeping the average time between new blocks at ten minutes. In this way the system automatically adapts to the total amount of mining power on the network.[6]:ch. 8 Between 1 March 2014 and 1 March 2015, the average number of nonces miners had to try before creating a new block increased from 16.4 quintillion to 200.5 quintillion.[121]\\n' +\n '
The proof-of-work system, alongside the chaining of blocks, makes modifications of the blockchain extremely hard, as an attacker must modify all subsequent blocks in order for the modifications of one block to be accepted.[122] As new blocks are mined all the time, the difficulty of modifying a block increases as time passes and the number of subsequent blocks (also called confirmations of the given block) increases.[105]\\n' +\n '
Computing power is often bundled together by a Mining pool to reduce variance in miner income. Individual mining rigs often have to wait for long periods to confirm a block of transactions and receive payment. In a pool, all participating miners get paid every time a participating server solves a block. This payment depends on the amount of work an individual miner contributed to help find that block.[123]\\n' +\n '
\\n' +\n 'Wallets
\\n' +\n 'For broader coverage of this topic, see Cryptocurrency wallet.
\\n' +\n '![](\"https://en.wikipedia.org/wiki/File:Screenshot_of_Bitcoin-qt-0.5.2.png\")
Bitcoin Core, a full client
![](\"https://en.wikipedia.org/wiki/File:Electrum_Bitcoin_Wallet.png\")
Electrum, a lightweight client
The first wallet program, simply named Bitcoin, and sometimes referred to as the Satoshi client, was released in 2009 by Satoshi Nakamoto as open-source software.[9] In version 0.5 the client moved from the wxWidgets user interface toolkit to Qt, and the whole bundle was referred to as Bitcoin-Qt.[124] After the release of version 0.9, the software bundle was renamed Bitcoin Core to distinguish itself from the underlying network.[125][126] Bitcoin Core is, perhaps, the best known implementation or client. Alternative clients (forks of Bitcoin Core) exist, such as Bitcoin XT, Bitcoin Unlimited,[34] and Parity Bitcoin.[127]\\n' +\n 'List of bitcoin forks\\n' +\n '
A wallet stores the information necessary to transact bitcoins. While wallets are often described as a place to hold[128] or store bitcoins, due to the nature of the system, bitcoins are inseparable from the blockchain transaction ledger. A wallet is more correctly defined as something that "stores the digital credentials for your bitcoin holdings" and allows one to access (and spend) them.[6]:ch. 1, glossary Bitcoin uses public-key cryptography, in which two cryptographic keys, one public and one private, are generated.[129] At its most basic, a wallet is a collection of these keys.\\n' +\n '
There are several modes which wallets can operate in. They have an inverse relationship with regards to trustlessness and computational requirements.\\n' +\n '
\\n' +\n '- Full clients verify transactions directly by downloading a full copy of the blockchain (over 150 GB as of January 2018[update]).[130] They are the most secure and reliable way of using the network, as trust in external parties is not required. Full clients check the validity of mined blocks, preventing them from transacting on a chain that breaks or alters network rules.[6]:ch. 1 Because of its size and complexity, downloading and verifying the entire blockchain is not suitable for all computing devices. \\n' +\n '
- Lightweight clients consult full nodes to send and receive transactions without requiring a local copy of the entire blockchain (see simplified payment verification – SPV). This makes lightweight clients much faster to set up and allows them to be used on low-power, low-bandwidth devices such as smartphones. When using a lightweight wallet, however, the user must trust full nodes, as it can report faulty values back to the user. Lightweight clients follow the longest blockchain and do not ensure it is valid, requiring trust in full nodes.[131]
Third-party internet services called online wallets offer similar functionality but may be easier to use. In this case, credentials to access funds are stored with the online wallet provider rather than on the user's hardware.[132] As a result, the user must have complete trust in the online wallet provider. A malicious provider or a breach in server security may cause entrusted bitcoins to be stolen. An example of such a security breach occurred with Mt. Gox in 2011.[133]\\n' +\n '
\\n' +\n '![](\"https://en.wikipedia.org/wiki/File:Bitcoin_paper_wallet_generated_at_bitaddress.jpg\")
A paper wallet with a banknote-like design. Both the private key and the address are visible in text form and as 2D barcodes.
![](\"https://en.wikipedia.org/wiki/File:Sample_Bitcoin_paper_wallet.png\")
A paper wallet with the address visible for adding or checking stored funds. The part of the page containing the private key is folded over and sealed.
![](\"https://en.wikipedia.org/wiki/File:Casascius_coin.jpg\")
A brass token with a private key hidden beneath a tamper-evident security hologram. A part of the address is visible through a transparent part of the hologram.
![](\"https://en.wikipedia.org/wiki/File:10elqpi.jpg\")
A hardware wallet peripheral which processes bitcoin payments without exposing any credentials to the computer.
Physical wallets store the credentials necessary to spend bitcoins offline and can be as simple as a paper printout of the private key:[6]:ch. 10 a paper wallet or more advanced such as a hardware wallet. A paper wallet is created with a keypair generated on a computer with no internet connection; the private key is written or printed onto the paper[g] and then erased from the computer. The paper wallet can then be stored in a safe physical location for later retrieval. Bitcoins stored using a paper wallet are said to be in cold storage.[134]:39\\n' +\n '
Cameron and Tyler Winklevoss, the founders of the Gemini Trust Co. exchange, reported that they had cut their paper wallets into pieces and stored them in envelopes distributed to safe deposit boxes across the United States.[135] Through this system, the theft of one envelope would neither allow the thief to steal any bitcoins nor deprive the rightful owners of their access to them.[136]\\n' +\n '
Physical wallets can also take the form of metal token coins[137] with a private key accessible under a security hologram in a recess struck on the reverse side.[138]:38 The security hologram self-destructs when removed from the token, showing that the private key has been accessed.[139] Originally, these tokens were struck in brass and other base metals, but later used precious metals as bitcoin grew in value and popularity.[138]:80 Coins with stored face value as high as ₿1000 have been struck in gold.[138]:102–104 The British Museum's coin collection includes four specimens from the earliest series[138]:83 of funded bitcoin tokens; one is currently on display in the museum's money gallery.[140] In 2013, a Utahn manufacturer of these tokens was ordered by the Financial Crimes Enforcement Network (FinCEN) to register as a money services business before producing any more funded bitcoin tokens.[137][138]:80\\n' +\n '
Another type of physical wallet called a hardware wallet keeps credentials offline while facilitating transactions.[141] The hardware wallet acts as a computer peripheral and signs transactions as requested by the user, who must press a button on the wallet to confirm that they intended to make the transaction. Hardware wallets never expose their private keys, keeping bitcoins in cold storage even when used with computers that may be compromised by malware.[134]:42–45\\n' +\n '
\\n' +\n 'Decentralization
\\n' +\n 'Bitcoin is decentralized thus:[7]\\n' +\n '
\\n' +\n '- Bitcoin does not have a central authority.[7] \\n' +\n '
- There is no central server; the bitcoin network is peer-to-peer.[9] \\n' +\n '
- There is no central storage; the bitcoin ledger is distributed.[142] \\n' +\n '
- The ledger is public; anybody can store it on their computer.[6]:ch. 1 \\n' +\n '
- There is no single administrator;[7] the ledger is maintained by a network of equally privileged miners.[6]:ch. 1 \\n' +\n '
- Anybody can become a miner.[6]:ch. 1 \\n' +\n '
- The additions to the ledger are maintained through competition. Until a new block is added to the ledger, it is not known which miner will create the block.[6]:ch. 1 \\n' +\n '
- The issuance of bitcoins is decentralized. They are issued as a reward for the creation of a new block.[107] \\n' +\n '
- Anybody can create a new bitcoin address (a bitcoin counterpart of a bank account) without needing any approval.[6]:ch. 1 \\n' +\n '
- Anybody can send a transaction to the network without needing any approval; the network merely confirms that the transaction is legitimate.[143]:32
Conversely, researchers have pointed out at a "trend towards centralization". Although bitcoin can be sent directly from user to user, in practice intermediaries are widely used.[35]:220–222 Bitcoin miners join large mining pools to minimize the variance of their income.[35]:215, 219–222[144]:3[145] Because transactions on the network are confirmed by miners, decentralization of the network requires that no single miner or mining pool obtains 51% of the hashing power, which would allow them to double-spend coins, prevent certain transactions from being verified and prevent other miners from earning income.[146] As of 2013[update] just six mining pools controlled 75% of overall bitcoin hashing power.[146] In 2014 mining pool Ghash.io obtained 51% hashing power which raised significant controversies about the safety of the network. The pool has voluntarily capped their hashing power at 39.99% and requested other pools to act responsibly for the benefit of the whole network.[147] Around the year 2017, over 70% of the hashing power and 90% of transactions were operating from China.[148]\\n' +\n '
According to researchers, other parts of the ecosystem are also "controlled by a small set of entities", notably the maintenance of the client software, online wallets and simplified payment verification (SPV) clients.[146]\\n' +\n '
\\n' +\n 'Privacy & Fungibility
\\n' +\n 'Bitcoin is pseudonymous, meaning that funds are not tied to real-world entities but rather bitcoin addresses. Owners of bitcoin addresses are not explicitly identified, but all transactions on the blockchain are public. In addition, transactions can be linked to individuals and companies through "idioms of use" (e.g., transactions that spend coins from multiple inputs indicate that the inputs may have a common owner) and corroborating public transaction data with known information on owners of certain addresses.[149] Additionally, bitcoin exchanges, where bitcoins are traded for traditional currencies, may be required by law to collect personal information.[150] To heighten financial privacy, a new bitcoin address can be generated for each transaction.[151]\\n' +\n '
Wallets and similar software technically handle all bitcoins as equivalent, establishing the basic level of fungibility. Researchers have pointed out that the history of each bitcoin is registered and publicly available in the blockchain ledger, and that some users may refuse to accept bitcoins coming from controversial transactions, which would harm bitcoin's fungibility.[152] For example, in 2012, Mt. Gox froze accounts of users who deposited bitcoins that were known to have just been stolen.[153]\\n' +\n '
\\n' +\n 'Ideology
\\n' +\n 'Satoshi Nakamoto stated in his white paper that: "The root problem with conventional currencies is all the trust that's required to make it work. The central bank must be trusted not to debase the currency, but the history of fiat currencies is full of breaches of that trust."[154]\\n' +\n '
\\n' +\n 'Austrian economics roots
\\n' +\n 'According to the European Central Bank, the decentralization of money offered by bitcoin has its theoretical roots in the Austrian school of economics, especially with Friedrich von Hayek in his book Denationalisation of Money: The Argument Refined,[155] in which Hayek advocates a complete free market in the production, distribution and management of money to end the monopoly of central banks.[156]:22\\n' +\n '
\\n' +\n 'Anarchism and libertarianism
\\n' +\n 'Further information: Crypto-anarchism
\\n' +\n 'According to The New York Times, libertarians and anarchists were attracted to the philosophical idea behind bitcoin. Early bitcoin supporter Roger Ver said: "At first, almost everyone who got involved did so for philosophical reasons. We saw bitcoin as a great idea, as a way to separate money from the state."[154] The Economist describes bitcoin as "a techno-anarchist project to create an online version of cash, a way for people to transact without the possibility of interference from malicious governments or banks".[157] Economist Paul Krugman argues that cryptocurrencies like bitcoin are "something of a cult" based in "paranoid fantasies" of government power.[158]\\n' +\n '
\\n' +\n '![\"video](\"https://upload.wikimedia.org/wikipedia/commons/thumb/1/1b/Nuvola_apps_kaboodle.svg/16px-Nuvola_apps_kaboodle.svg.png\")
Nigel Dodd argues in The Social Life of Bitcoin that the essence of the bitcoin ideology is to remove money from social, as well as governmental, control.[160] Dodd quotes a YouTube video, with Roger Ver, Jeff Berwick, Charlie Shrem, Andreas Antonopoulos, Gavin Wood, Trace Meyer and other proponents of bitcoin reading The Declaration of Bitcoin's Independence. The declaration includes a message of crypto-anarchism with the words: "Bitcoin is inherently anti-establishment, anti-system, and anti-state. Bitcoin undermines governments and disrupts institutions because bitcoin is fundamentally humanitarian."[160][159]\\n' +\n '
David Golumbia says that the ideas influencing bitcoin advocates emerge from right-wing extremist movements such as the Liberty Lobby and the John Birch Society and their anti-Central Bank rhetoric, or, more recently, Ron Paul and Tea Party-style libertarianism.[161] Steve Bannon, who owns a "good stake" in bitcoin, considers it to be "disruptive populism. It takes control back from central authorities. It's revolutionary."[162]\\n' +\n '
A 2014 study of Google Trends data found correlations between bitcoin-related searches and ones related to computer programming and illegal activity, but not libertarianism or investment topics.[163]\\n' +\n '
\\n' +\n 'Economics
\\n' +\n 'Main article: Economics of bitcoin
\\n' +\n '\\n' +\n '![](\"https://en.wikipedia.org/wiki/File:Estimated-transaction-volume-usd.svg\"){kind=spacer}
Bitcoin is a digital asset designed to work in peer-to-peer transactions as a currency.[4][164] Bitcoins have three qualities useful in a currency, according to The Economist in January 2015: they are "hard to earn, limited in supply and easy to verify."[165] Per some researchers, as of 2015[update], bitcoin functions more as a payment system than as a currency.[35]\\n' +\n '
Economists define money as serving the following three purposes: a store of value, a medium of exchange, and a unit of account.[166] According to The Economist in 2014, bitcoin functions best as a medium of exchange.[166] However, this is debated, and a 2018 assessment by The Economist stated that cryptocurrencies met none of these three criteria.[157]\\n' +\n 'Yale economist Robert J. Shiller writes that bitcoin has potential as a unit of account for measuring the relative value of goods, as with Chile's Unidad de Fomento, but that "Bitcoin in its present form [...] doesn't really solve any sensible economic problem".[167]\\n' +\n '
According to research by Cambridge University, between 2.9 million and 5.8 million unique users used a cryptocurrency wallet in 2017, most of them for bitcoin. The number of users has grown significantly since 2013, when there were 300,000–1.3 million users.[12]\\n' +\n '
\\n' +\n 'Acceptance by merchants
\\n' +\n 'The overwhelming majority of bitcoin transactions take place on a cryptocurrency exchange, rather than being used in transactions with merchants.[168] Delays processing payments through the blockchain of about ten minutes make bitcoin use very difficult in a retail setting. Prices are not usually quoted in units of bitcoin and many trades involve one, or sometimes two, conversions into conventional currencies.[35] Merchants that do accept bitcoin payments may use payment service providers to perform the conversions.[169]\\n' +\n '
In 2017 and 2018 bitcoin's acceptance among major online retailers included only three of the top 500 U.S. online merchants, down from five in 2016.[168] Reasons for this decline include high transaction fees due to bitcoin's scalability issues and long transaction times.[170]\\n' +\n '
Bloomberg reported that the largest 17 crypto merchant-processing services handled $69 million in June 2018, down from $411 million in September 2017. Bitcoin is "not actually usable" for retail transactions because of high costs and the inability to process chargebacks, according to Nicholas Weaver, a researcher quoted by Bloomberg. High price volatility and transaction fees make paying for small retail purchases with bitcoin impractical, according to economist Kim Grauer. However, bitcoin continues to be used for large-item purchases on sites such as Overstock.com, and for cross-border payments to freelancers and other vendors.[171]\\n' +\n '
\\n' +\n 'Financial institutions
\\n' +\n 'Bitcoins can be bought on digital currency exchanges.\\n' +\n '
Per researchers, "there is little sign of bitcoin use" in international remittances despite high fees charged by banks and Western Union who compete in this market.[35] The South China Morning Post, however, mentions the use of bitcoin by Hong Kong workers to transfer money home.[172]\\n' +\n '
In 2014, the National Australia Bank closed accounts of businesses with ties to bitcoin,[173] and HSBC refused to serve a hedge fund with links to bitcoin.[174] Australian banks in general have been reported as closing down bank accounts of operators of businesses involving the currency.[175]\\n' +\n '
On 10 December 2017, the Chicago Board Options Exchange started trading bitcoin futures,[176] followed by the Chicago Mercantile Exchange, which started trading bitcoin futures on 17 December 2017.[177]\\n' +\n '
In September 2019 the Central Bank of Venezuela, at the request of PDVSA, ran tests to determine if bitcoin and ether could be held in central bank's reserves. The request was motivated by oil company's goal to pay its suppliers.[178]\\n' +\n '
\\n' +\n 'As an investment
\\n' +\n 'The Winklevoss twins have purchased bitcoin. In 2013, The Washington Post reported a claim that they owned 1% of all the bitcoins in existence at the time.[179]\\n' +\n '
Other methods of investment are bitcoin funds. The first regulated bitcoin fund was established in Jersey in July 2014 and approved by the Jersey Financial Services Commission.[180]\\n' +\n '
Forbes named bitcoin the best investment of 2013.[181] In 2014, Bloomberg named bitcoin one of its worst investments of the year.[182] In 2015, bitcoin topped Bloomberg's currency tables.[183]\\n' +\n '
According to bitinfocharts.com, in 2017 there are 9,272 bitcoin wallets with more than $1 million worth of bitcoins.[184] The exact number of bitcoin millionaires is uncertain as a single person can have more than one bitcoin wallet.\\n' +\n '
In August 2020, MicroStrategy invested in Bitcoin.[185][186]\\n' +\n '
In May 2021, the Bitcoin's market share on exchanges dropped from 70% to 45% as investors pursued altcoins.[187]\\n' +\n '
\\n' +\n 'Venture capital
\\n' +\n 'Peter Thiel's Founders Fund invested US$3 million in BitPay.[188] In 2012, an incubator for bitcoin-focused start-ups was founded by Adam Draper, with financing help from his father, venture capitalist Tim Draper, one of the largest bitcoin holders after winning an auction of 30,000 bitcoins,[189] at the time called "mystery buyer".[190] The company's goal is to fund 100 bitcoin businesses within 2–3 years with $10,000 to $20,000 for a 6% stake.[189] Investors also invest in bitcoin mining.[191] According to a 2015 study by Paolo Tasca, bitcoin startups raised almost $1 billion in three years (Q1 2012 – Q1 2015).[192]\\n' +\n '
\\n' +\n 'Price and volatility
\\n' +\n '\\n' +\n '![](\"https://en.wikipedia.org/wiki/File:Bitcoin_price_and_volatility.svg\")
![](\"https://en.wikipedia.org/wiki/File:BTCvolatility.svg\")
The price of bitcoins has gone through cycles of appreciation and depreciation referred to by some as bubbles and busts.[193] In 2011, the value of one bitcoin rapidly rose from about US$0.30 to US$32 before returning to US$2.[194] In the latter half of 2012 and during the 2012–13 Cypriot financial crisis, the bitcoin price began to rise,[195] reaching a high of US$266 on 10 April 2013, before crashing to around US$50. On 29 November 2013, the cost of one bitcoin rose to a peak of US$1,242.[196] In 2014, the price fell sharply, and as of April remained depressed at little more than half 2013 prices. As of August 2014[update] it was under US$600.[197]\\n' +\n '
According to Mark T. Williams, as of 30 September 2014[update], bitcoin has volatility seven times greater than gold, eight times greater than the S&P 500, and 18 times greater than the US dollar.[198] Hodl is a meme created in reference to holding (as opposed to selling) during periods of volatility. Unusual for an asset, bitcoin weekend trading during December 2020 was higher than for weekdays.[199] Hedge funds (using high leverage and derivates)[200] have attempted to use the volatility to profit from downward price movements. At the end of January 2021, such positions were over $1 billion, their highest of all time.[201][202]\\n' +\n 'As of 8 February 2021[update], the closing price of bitcoin equals US$44,797.[203]\\n' +\n '
\\n' +\n 'Legal status, tax and regulation
\\n' +\n 'Further information: Legality of bitcoin by country or territory
\\n' +\n 'Because of bitcoin's decentralized nature and its trading on online exchanges located in many countries, regulation of bitcoin has been difficult. However, the use of bitcoin can be criminalized, and shutting down exchanges and the peer-to-peer economy in a given country would constitute a de facto ban.[204] The legal status of bitcoin varies substantially from country to country and is still undefined or changing in many of them. Regulations and bans that apply to bitcoin probably extend to similar cryptocurrency systems.[192]\\n' +\n '
According to the Library of Congress, an "absolute ban" on trading or using cryptocurrencies applies in nine countries: Algeria, Bolivia, Egypt, Iraq, Morocco, Nepal, Pakistan, Vietnam, and the United Arab Emirates. An "implicit ban" applies in another 15 countries, which include Bahrain, Bangladesh, China, Colombia, the Dominican Republic, Indonesia, Kuwait, Lesotho, Lithuania, Macau, Oman, Qatar, Saudi Arabia and Taiwan.[205]\\n' +\n '
In October 2020, the Islamic Republic News Agency announced pending regulations that would require bitcoin miners in Iran to sell bitcoin to the Central Bank of Iran, and the central bank would use it for imports.[206] Iran, as of October 2020, had issued over 1,000 bitcoin mining licenses.[206] The Iranian government initially took a stance against cryptocurrency, but later changed it after seeing that digital currency could be used to circumvent sanctions.[207] The US Office of Foreign Assets Control listed two Iranians and their bitcoin addresses as part of its Specially Designated Nationals and Blocked Persons List for their role in the 2018 Atlanta cyberattack whose ransom was paid in bitcoin.[208]\\n' +\n '
\\n' +\n 'Regulatory warnings
\\n' +\n 'The U.S. Commodity Futures Trading Commission has issued four "Customer Advisories" for bitcoin and related investments.[13] A July 2018 warning emphasized that trading in any cryptocurrency is often speculative, and there is a risk of theft from hacking, and fraud.[209] In May 2014 the U.S. Securities and Exchange Commission warned that investments involving bitcoin might have high rates of fraud, and that investors might be solicited on social media sites.[210] An earlier "Investor Alert" warned about the use of bitcoin in Ponzi schemes.[211]\\n' +\n '
The European Banking Authority issued a warning in 2013 focusing on the lack of regulation of bitcoin, the chance that exchanges would be hacked, the volatility of bitcoin's price, and general fraud.[212] FINRA and the North American Securities Administrators Association have both issued investor alerts about bitcoin.[213][214]\\n' +\n '
\\n' +\n 'Price manipulation investigation
\\n' +\n 'An official investigation into bitcoin traders was reported in May 2018.[215] The U.S. Justice Department launched an investigation into possible price manipulation, including the techniques of spoofing and wash trades.[216][217][218]\\n' +\n '
The U.S. federal investigation was prompted by concerns of possible manipulation during futures settlement dates. The final settlement price of CME bitcoin futures is determined by prices on four exchanges, Bitstamp, Coinbase, itBit and Kraken. Following the first delivery date in January 2018, the CME requested extensive detailed trading information but several of the exchanges refused to provide it and later provided only limited data. The Commodity Futures Trading Commission then subpoenaed the data from the exchanges.[219][220]\\n' +\n '
State and provincial securities regulators, coordinated through the North American Securities Administrators Association, are investigating "bitcoin scams" and ICOs in 40 jurisdictions.[221]\\n' +\n '
Academic research published in the Journal of Monetary Economics concluded that price manipulation occurred during the Mt Gox bitcoin theft and that the market remains vulnerable to manipulation.[222] The history of hacks, fraud and theft involving bitcoin dates back to at least 2011.[223]\\n' +\n '
Research by John M. Griffin and Amin Shams in 2018 suggests that trading associated with increases in the amount of the Tether cryptocurrency and associated trading at the Bitfinex exchange account for about half of the price increase in bitcoin in late 2017.[224][225]\\n' +\n '
J.L. van der Velde, CEO of both Bitfinex and Tether, denied the claims of price manipulation: "Bitfinex nor Tether is, or has ever, engaged in any sort of market or price manipulation. Tether issuances cannot be used to prop up the price of bitcoin or any other coin/token on Bitfinex."[226]\\n' +\n '
\\n' +\n 'Analysis
\\n' +\n 'The Bank for International Settlements summarized several criticisms of bitcoin in Chapter V of their 2018 annual report. The criticisms include the lack of stability in bitcoin's price, the high energy consumption, high and variable transactions costs, the poor security and fraud at cryptocurrency exchanges, vulnerability to debasement (from forking), and the influence of miners.[227][228][229]\\n' +\n '
François R. Velde, Senior Economist at the Chicago Fed, described bitcoin as "an elegant solution to the problem of creating a digital currency".[230] David Andolfatto, Vice President at the Federal Reserve Bank of St. Louis, stated that bitcoin is a threat to the establishment, which he argues is a good thing for the Federal Reserve System and other central banks, because it prompts these institutions to operate sound policies.[119]:33[231][232]\\n' +\n '
\\n' +\n 'Economic concerns
\\n' +\n 'Further information: Cryptocurrency bubble and Economics of bitcoin
\\n' +\n '\\n' +\n '![](\"https://en.wikipedia.org/wiki/File:Bitcoin-bubble-chart-history-2017.png\")
Bitcoin, along with other cryptocurrencies, has been described as an economic bubble by at least eight Nobel Memorial Prize in Economic Sciences laureates at various times, including Robert Shiller on 1 March 2014,[167] Joseph Stiglitz on 29 November 2017,[233] and Richard Thaler on 21 December 2017.[234][235] On 29 January 2018, a noted Keynesian economist Paul Krugman has described bitcoin as "a bubble wrapped in techno-mysticism inside a cocoon of libertarian ideology",[158] on 2 February 2018, professor Nouriel Roubini of New York University has called bitcoin the "mother of all bubbles",[236] and on 27 April 2018, a University of Chicago economist James Heckman has compared it to the 17th-century tulip mania.[235]\\n' +\n '
Journalists, economists, investors, and the central bank of Estonia have voiced concerns that bitcoin is a Ponzi scheme.[237][238][239][240] In April 2013, Eric Posner, a law professor at the University of Chicago, stated that "a real Ponzi scheme takes fraud; bitcoin, by contrast, seems more like a collective delusion."[241] A July 2014 report by the World Bank concluded that bitcoin was not a deliberate Ponzi scheme.[242]:7 In June 2014, the Swiss Federal Council examined concerns that bitcoin might be a pyramid scheme, and concluded that "since in the case of bitcoin the typical promises of profits are lacking, it cannot be assumed that bitcoin is a pyramid scheme."[243]:21\\n' +\n '
\\n' +\n 'Energy consumption and carbon footprint
\\n' +\n '![\"Bitcoin](\"https://en.wikipedia.org/wiki/File:Bitcoin_electricity_consumption.png\")
Electricity consumption of the bitcoin network since 2016 (annualized) and comparison with the electricity consumption of various countries in 2019. The upper and lower bounds (grey traces) are based on worst-case and best-case scenario assumptions, respectively. The red trace indicates an intermediate best-guess estimate. (data sources: Cambridge Bitcoin Electricity Consumption Index, US Energy Information Administration; for details, see methodology)
Bitcoin has been criticized for the amount of electricity consumed by mining.\\n' +\n '
As of 2015[update], estimated combined electricity consumption attributed to mining was 166.7 megawatts and by 2017, was estimated to be between one and four gigawatts of electricity.[244][165] In 2018, bitcoin was estimated by to use 2.55 to 3.572 GW, or around 6% of the total power consumed by the global banking sector.[245][246][247] In July 2019 BBC reported bitcoin consumes about 7 gigawatts, 0.2% of the global total, or equivalent to that of Switzerland.[248] A 2021 estimate from the University of Cambridge suggests bitcoin consumes more than 178 (TWh) annually, ranking it in the top 30 energy consumers if it were a country.[249]\\n' +\n '
Bitcoin is mined in places like Iceland where geothermal energy is cheap and cooling Arctic air is free.[250] Bitcoin miners are known to use hydroelectric power in Tibet, Quebec, Washington (state), and Austria to reduce electricity costs.[245][251] Miners are attracted to suppliers such as Hydro Quebec that have energy surpluses.[252] \\n' +\n '
According to a University of Cambridge study, much of bitcoin mining is done in China, where electricity is subsidized by the government.[253][254] A significant part of Bitcoin mining is powered by cheap electricity in Xinjiang, which mostly comes from coal power.[255][256] In April 2021 a coal mine explosion in the province coincided with a 35% drop in hashing power and a flash crash in price.[257][255] In other provinces, such as Hunan and Sichuan, mining farms use more hydropower, however these account for at most 4% of hash power. According to Alex de Vries, renewable energy is not a good match for Bitcoin mining as 24/7 operations are best for ROI on mining devices.[257] In 2021, a US company purchased the Greenidge coal power plant and converted it to burn natural gas for the sole purpose of mining bitcoin, which has proven to be highly profitable, in spite of protests of local residents against air pollution and thermal pollution.[258]\\n' +\n '
Concerns about bitcoin's environmental impact relate bitcoin's energy consumption to carbon emissions.[259][260] The difficulty of translating the energy consumption into carbon emissions lies in the decentralized nature of bitcoin impeding the localization of miners to examine the electricity mix used. The results of recent studies analyzing bitcoin's carbon footprint vary.[261][262][263][264] A study published in Nature Climate Change in 2018 claims that bitcoin "could alone produce enough CO
2 emissions to push warming above 2 °C within less than three decades."[263] However, other researchers criticized this analysis, arguing the underlying scenarios were inadequate, leading to overestimations.[265][266][267] According to studies published in Joule and American Chemical Society in 2019, bitcoin's annual energy consumption results in annual carbon emission ranging from 17[247] to 22.9 MtCO
2 which is comparable to the level of emissions of countries as Jordan and Sri Lanka or Kansas City.[264] George Kamiya, writing for the International Energy Agency, says that "predictions about bitcoin consuming the entire world's electricity" are sensational, but that the area "requires careful monitoring and rigorous analysis".[268]\\n' +\n '
Use in illegal transactions
\\n' +\n 'Further information: Cryptocurrency and crime and Bitcoin network § Alleged criminal activity
\\n' +\n 'Bitcoin held at exchanges are vulnerable to theft through phishing, scamming, and hacking. As of December 2017[update], around 980,000 bitcoins have been stolen from cryptocurrency exchanges.[115]\\n' +\n '
The use of bitcoin by criminals has attracted the attention of financial regulators, legislative bodies, law enforcement, and the media.[269] Bitcoin gained early notoriety for its use on the Silk Road. The U.S. Senate held a hearing on virtual currencies in November 2013.[270] The U.S. government claimed that bitcoin was used to facilitate payments related to Russian interference in the 2016 United States elections.[271] However, a 2021 study led by former CIA director Michael Morell showed that broad generalizations about the use of bitcoin in illicit finance are significantly overstated and that blockchain analysis is an effective crime fighting and intelligence gathering tool.[272]\\n' +\n '
Several news outlets have asserted that the popularity of bitcoins hinges on the ability to use them to purchase illegal goods.[164][273] Nobel-prize winning economist Joseph Stiglitz says that bitcoin's anonymity encourages money laundering and other crimes.[274][275]\\n' +\n '
In 2014, researchers at the University of Kentucky found "robust evidence that computer programming enthusiasts and illegal activity drive interest in bitcoin, and find limited or no support for political and investment motives".[163] Australian researchers have estimated that 25% of all bitcoin users and 44% of all bitcoin transactions are associated with illegal activity as of April 2017[update]. There were an estimated 24 million bitcoin users primarily using bitcoin for illegal activity. They held $8 billion worth of bitcoin, and made 36 million transactions valued at $72 billion.[276][277]\\n' +\n '
\\n' +\n 'Software implementation
\\n' +\n '![\"Bitcoin-core-v0.10.0.png\"](\"https://upload.wikimedia.org/wikipedia/commons/thumb/7/7c/Bitcoin-core-v0.10.0.png/300px-Bitcoin-core-v0.10.0.png\")
The start screen under Fedora
Bitcoin Core is free and open-source software that serves as a bitcoin node (the set of which form the bitcoin network) and provides a bitcoin wallet which fully verifies payments. It is considered to be bitcoin's reference implementation.[278] Initially, the software was published by Satoshi Nakamoto under the name "Bitcoin", and later renamed to "Bitcoin Core" to distinguish it from the network.[279] It is also known as the Satoshi client.[280]\\n' +\n '
The MIT Digital Currency Initiative funds some of the development of Bitcoin Core.[281] The project also maintains the cryptography library libsecp256k1.[282]\\n' +\n '
Bitcoin Core includes a transaction verification engine and connects to the bitcoin network as a full node.[280] Moreover, a cryptocurrency wallet, which can be used to transfer funds, is included by default.[282] The wallet allows for the sending and receiving of bitcoins. It does not facilitate the buying or selling of bitcoin. It allows users to generate QR codes to receive payment.\\n' +\n '
The software validates the entire blockchain, which includes all bitcoin transactions ever. This distributed ledger which has reached more than 235 gigabytes in size as of Jan 2019, must be downloaded or synchronized before full participation of the client may occur.[280] Although the complete blockchain is not needed all at once since it is possible to run in pruning mode. A command line-based daemon with a JSON-RPC interface, bitcoind, is bundled with Bitcoin Core. It also provides access to testnet, a global testing environment that imitates the bitcoin main network using an alternative blockchain where valueless "test bitcoins" are used. Regtest or Regression Test Mode creates a private blockchain which is used as a local testing environment.[283] Finally, bitcoin-cli, a simple program which allows users to send RPC commands to bitcoind, is also included.\\n' +\n '
Checkpoints which have been hard coded into the client are used only to prevent Denial of Service attacks against nodes which are initially syncing the chain. For this reason the checkpoints included are only as of several years ago.[284][285][failed verification] A one megabyte block size limit was added in 2010 by Satoshi Nakamoto. This limited the maximum network capacity to about three transactions per second.[286] Since then, network capacity has been improved incrementally both through block size increases and improved wallet behavior. A network alert system was included by Satoshi Nakamoto as a way of informing users of important news regarding bitcoin.[287] In November 2016 it was retired. It had become obsolete as news on bitcoin is now widely disseminated.\\n' +\n '
Bitcoin Core includes a scripting language inspired by Forth that can define transactions and specify parameters.[288] ScriptPubKey is used to "lock" transactions based on a set of future conditions. scriptSig is used to meet these conditions or "unlock" a transaction. Operations on the data are performed by various OP_Codes. Two stacks are used - main and alt. Looping is forbidden.\\n' +\n '
Bitcoin Core uses OpenTimestamps to timestamp merge commits.[289]\\n' +\n '
The original creator of the bitcoin client has described their approach to the software's authorship as it being written first to prove to themselves that the concept of purely peer-to-peer electronic cash was valid and that a paper with solutions could be written. The lead developer is Wladimir J. van der Laan, who took over the role on 8 April 2014.[290] Gavin Andresen was the former lead maintainer for the software client. Andresen left the role of lead developer for bitcoin to work on the strategic development of its technology.[290] Bitcoin Core in 2015 was central to a dispute with Bitcoin XT, a competing client that sought to increase the blocksize.[291] Over a dozen different companies and industry groups fund the development of Bitcoin Core.\\n' +\n '
\\n' +\n 'In popular culture
\\n' +\n 'Term "HODL"
\\n' +\n 'Hodl (/ˈhɒdəl/ HOD-əl; often written HODL) is slang in the cryptocurrency community for holding a cryptocurrency rather than selling it.[292] A person who does this is known as a Hodler. It originated in a December 2013 post on the Bitcoin Forum message board by an apparently inebriated user who posted with a typo in the subject, "I AM HODLING."[293] It is often humorously suggested to be a backronym to "hold on for dear life".[294] In 2017, Quartz listed it as one of the essential slang terms in Bitcoin culture, and described it as a stance, "to stay invested in bitcoin and not to capitulate in the face of plunging prices."[295] TheStreet.com referred to it as the "favorite mantra" of Bitcoin holders.[296] Bloomberg News referred to it as a "mantra" for holders during market routs.[297]\\n' +\n '
\\n' +\n 'Literature
\\n' +\n 'In Charles Stross' 2013 science fiction novel, Neptune's Brood, the universal interstellar payment system is known as "bitcoin" and operates using cryptography.[298] Stross later blogged that the reference was intentional, saying "I wrote Neptune's Brood in 2011. Bitcoin was obscure back then, and I figured had just enough name recognition to be a useful term for an interstellar currency: it'd clue people in that it was a networked digital currency."[299]\\n' +\n '
\\n' +\n 'Film
\\n' +\n 'The 2014 documentary The Rise and Rise of Bitcoin portrays the diversity of motives behind the use of bitcoin by interviewing people who use it. These include a computer programmer and a drug dealer.[300] The 2016 documentary Banking on Bitcoin is an introduction to the beginnings of bitcoin and the ideas behind cryptocurrency today.[301]\\n' +\n '
\\n' +\n 'Academia
\\n' +\n 'In September 2015, the establishment of the peer-reviewed academic journal Ledger (ISSN 2379-5980) was announced. It covers studies of cryptocurrencies and related technologies, and is published by the University of Pittsburgh.[302] The journal encourages authors to digitally sign a file hash of submitted papers, which will then be timestamped into the bitcoin blockchain. Authors are also asked to include a personal bitcoin address in the first page of their papers.[303][304]\\n' +\n '
\\n' +\n 'See also
\\n' +\n '\\n' +\n '
\\n' +\n '\\n' +\n '- Alternative currency \\n' +\n '
- Base58 \\n' +\n '
- Crypto-anarchism \\n' +\n '
- List of bitcoin companies \\n' +\n '
- List of bitcoin organizations \\n' +\n '
- SHA-256 crypto currencies \\n' +\n '
- Virtual currency law in the United States
Notes
\\n' +\n '\\n' +\n '
\\n' +\n '- \\n' +\n '
- ^ As of 2014[update], BTC is a commonly used code. It does not conform to ISO 4217 as BT is the country code of Bhutan, and ISO 4217 requires the first letter used in global commodities to be 'X'.\\n' +\n ' \\n' +\n '
- ^ As of 2014[update], XBT, a code that conforms to ISO 4217 though is not officially part of it, is used by Bloomberg L.P.,[98] CNNMoney,[99] and xe.com.[100]\\n' +\n ' \\n' +\n '
- ^ The genesis block is the block number 0. The timestamp of the block is 2009-01-03 18:15:05. This block is unlike all other blocks in that it does not have a previous block to reference.\\n' +\n ' \\n' +\n '
- ^ The exact number is 20,999,999.9769 bitcoins.[6]:ch. 8\\n' +\n ' \\n' +\n '
- ^ Relative mining difficulty is defined as the ratio of the difficulty target on 9 January 2009 to the current difficulty target.\\n' +\n ' \\n' +\n '
- ^ It is misleading to think that there is an analogy between gold mining and bitcoin mining. The fact is that gold miners are rewarded for producing gold, while bitcoin miners are not rewarded for producing bitcoins; they are rewarded for their record-keeping services.[119]\\n' +\n ' \\n' +\n '
- ^ The private key can be printed as a series of letters and numbers, a seed phrase, or a 2D barcode. Usually, the public key or bitcoin address is also printed, so that a holder of a paper wallet can check or add funds without exposing the private key to a device.\\n' +\n ' \\n' +\n '
- ^ Liquidity is estimated by a 365-day running sum of transaction outputs in USD.\\n' +\n ' \\n' +\n '
References
\\n' +\n '\\n' +\n '
\\n' +\n '- \\n' +\n '
- ^ a b "Unicode 10.0.0". Unicode Consortium. 20 June 2017. Archived from the original on 20 June 2017. Retrieved 20 June 2017.\\n' +\n ' \\n' +\n '
- ^ a b Mick, Jason (12 June 2011). "Cracking the Bitcoin: Digging Into a $131M USD Virtual Currency". Daily Tech. Archived from the original on 20 January 2013. Retrieved 30 September 2012.\\n' +\n ' \\n' +\n '
- ^ "Releases - bitcoin/bitcoin". Retrieved 9 May 2021 – via GitHub.\\n' +\n ' \\n' +\n '
- ^ a b c d e f Nakamoto, Satoshi (31 October 2008). "Bitcoin: A Peer-to-Peer Electronic Cash System" (PDF). bitcoin.org. Archived (PDF) from the original on 20 March 2014. Retrieved 28 April 2014.\\n' +\n ' \\n' +\n '
- ^ Nakamoto; et al. (1 April 2016). "Bitcoin source code - amount constraints". Archived from the original on 1 July 2018.\\n' +\n ' \\n' +\n '
- ^ a b c d e f g h i j k l m n o p q r s t u v w Antonopoulos, Andreas M. (April 2014). Mastering Bitcoin: Unlocking Digital Crypto-Currencies. O'Reilly Media. ISBN 978-1-4493-7404-4.\\n' +\n ' \\n' +\n '
- ^ a b c d e "Statement of Jennifer Shasky Calvery, Director Financial Crimes Enforcement Network United States Department of the Treasury Before the United States Senate Committee on Banking, Housing, and Urban Affairs Subcommittee on National Security and International Trade and Finance Subcommittee on Economic Policy" (PDF). fincen.gov. Financial Crimes Enforcement Network. 19 November 2013. Archived (PDF) from the original on 9 October 2016. Retrieved 1 June 2014.\\n' +\n ' \\n' +\n '
- ^ a b S., L. (2 November 2015). "Who is Satoshi Nakamoto?". The Economist. The Economist Newspaper Limited. Archived from the original on 21 August 2016. Retrieved 23 September 2016.\\n' +\n ' \\n' +\n '
- ^ a b c d e Davis, Joshua (10 October 2011). "The Crypto-Currency: Bitcoin and its mysterious inventor". The New Yorker. Archived from the original on 1 November 2014. Retrieved 31 October 2014.\\n' +\n ' \\n' +\n '
- ^ "What is Bitcoin?". CNN Money. Archived from the original on 31 October 2015. Retrieved 16 November 2015.\\n' +\n ' \\n' +\n '
- ^ a b GmbH, finanzen net. "Bitcoin's limited real-world use and extreme volatility show its recent surge is still a speculative bubble, UBS Global Wealth Management says". markets.businessinsider.com. Retrieved 28 March 2021.\\n' +\n ' \\n' +\n '
- ^ a b Hileman, Garrick; Rauchs, Michel. "Global Cryptocurrency Benchmarking Study" (PDF). Cambridge University. Archived (PDF) from the original on 10 April 2017. Retrieved 14 April 2017.\\n' +\n ' \\n' +\n '
- ^ a b "Bitcoin". U.S. Commodity Futures Trading Commission. Archived from the original on 1 July 2018. Retrieved 17 July 2018.\\n' +\n ' \\n' +\n '
- ^ "SEC.gov | INVESTOR ALERT: BITCOIN AND OTHER VIRTUAL CURRENCY-RELATED INVESTMENTS". www.sec.gov. Archived from the original on 3 June 2019. Retrieved 1 June 2019.\\n' +\n ' \\n' +\n '
- ^ Vigna, Paul; Casey, Michael J. (January 2015). The Age of Cryptocurrency: How Bitcoin and Digital Money Are Challenging the Global Economic Order (1 ed.). New York: St. Martin's Press. ISBN 978-1-250-06563-6.\\n' +\n ' \\n' +\n '
- ^ a b "bitcoin". OxfordDictionaries.com. Archived from the original on 2 January 2015. Retrieved 28 December 2014.\\n' +\n ' \\n' +\n '
- ^ Bustillos, Maria (2 April 2013). "The Bitcoin Boom". The New Yorker. Condé Nast. Archived from the original on 27 July 2014. Retrieved 22 December 2013.
Standards vary, but there seems to be a consensus forming around Bitcoin, capitalized, for the system, the software, and the network it runs on, and bitcoin, lowercase, for the currency itself.
\\n' +\n ' \\n' +\n ' - ^ Vigna, Paul (3 March 2014). "BitBeat: Is It Bitcoin, or bitcoin? The Orthography of the Cryptography". WSJ. Archived from the original on 19 April 2014. Retrieved 21 April 2014.\\n' +\n ' \\n' +\n '
- ^ Metcalf, Allan (14 April 2014). "The latest style". Lingua Franca blog. The Chronicle of Higher Education (chronicle.com). Archived from the original on 16 April 2014. Retrieved 19 April 2014.\\n' +\n ' \\n' +\n '
- ^ Bernard, Zoë (2 December 2017). "Everything you need to know about Bitcoin, its mysterious origins, and the many alleged identities of its creator". Business Insider. Archived from the original on 15 June 2018. Retrieved 15 June 2018.\\n' +\n ' \\n' +\n '
- ^ Finley, Klint (31 October 2018). "After 10 Years, Bitcoin Has Changed Everything—And Nothing". Wired. Archived from the original on 5 November 2018. Retrieved 9 November 2018.\\n' +\n ' \\n' +\n '
- ^ Nakamoto, Satoshi (3 January 2009). "Bitcoin". Archived from the original on 21 July 2017.\\n' +\n ' \\n' +\n '
- ^ Nakamoto, Satoshi (9 January 2009). "Bitcoin v0.1 released". Archived from the original on 26 March 2014.\\n' +\n ' \\n' +\n '
- ^ a b Wallace, Benjamin (23 November 2011). "The Rise and Fall of Bitcoin". Wired. Archived from the original on 31 October 2013. Retrieved 13 October 2012.\\n' +\n ' \\n' +\n '
- ^ "Block 0 – Bitcoin Block Explorer". Archived from the original on 15 October 2013.\\n' +\n ' \\n' +\n '
- ^ Pagliery, Jose (2014). Bitcoin: And the Future of Money. Triumph Books. ISBN 9781629370361. Archived from the original on 21 January 2018. Retrieved 20 January 2018.\\n' +\n ' \\n' +\n '
- ^ "Here's The Problem with the New Theory That A Japanese Math Professor Is The Inventor of Bitcoin". San Francisco Chronicle. 19 May 2013. Archived from the original on 4 January 2015. Retrieved 24 February 2015.\\n' +\n ' \\n' +\n '
- ^ Peterson, Andrea (3 January 2014). "Hal Finney received the first Bitcoin transaction. Here's how he describes it". The Washington Post. Archived from the original on 27 February 2015.\\n' +\n ' \\n' +\n '
- ^ Popper, Nathaniel (30 August 2014). "Hal Finney, Cryptographer and Bitcoin Pioneer, Dies at 58". NYTimes. Archived from the original on 3 September 2014. Retrieved 2 September 2014.\\n' +\n ' \\n' +\n '
- ^ Kharpal, Arjun (18 June 2018). "Everything you need to know about the blockchain". CNBC. Archived from the original on 13 September 2018. Retrieved 13 September 2018.\\n' +\n ' \\n' +\n '
- ^ McMillan, Robert. "Who Owns the World's Biggest Bitcoin Wallet? The FBI". Wired. Condé Nast. Archived from the original on 21 October 2016. Retrieved 7 October 2016.\\n' +\n ' \\n' +\n '
- ^ Simonite, Tom. "Meet Gavin Andresen, the most powerful person in the world of Bitcoin". MIT Technology Review. Retrieved 6 December 2017.\\n' +\n ' \\n' +\n '
- ^ a b Odell, Matt (21 September 2015). "A Solution To Bitcoin's Governance Problem". TechCrunch. Archived from the original on 26 January 2016. Retrieved 24 January 2016.\\n' +\n ' \\n' +\n '
- ^ a b Vigna, Paul (17 January 2016). "Is Bitcoin Breaking Up?". The Wall Street Journal. Archived from the original on 20 August 2016. Retrieved 8 November 2016.\\n' +\n ' \\n' +\n '
- ^ a b c d e f g h Rainer Böhme; Nicolas Christin; Benjamin Edelman; Tyler Moore (2015). "Bitcoin: Economics, Technology, and Governance". Journal of Economic Perspectives. 29 (2): 213–238. doi:10.1257/jep.29.2.213.\\n' +\n ' \\n' +\n '
- ^ a b c d e f "Bitcoin Historical Prices". OfficialData.org. Archived from the original on 4 July 2018. Retrieved 3 July 2018.\\n' +\n ' \\n' +\n '
- ^ a b c d French, Sally (9 February 2017). "Here's proof that this bitcoin crash is far from the worst the cryptocurrency has seen". Market Watch. Archived from the original on 3 July 2018. Retrieved 3 July 2018.\\n' +\n ' \\n' +\n '
- ^ Bustillos, Maria (1 April 2013). "The Bitcoin Boom". The New Yorker. Archived from the original on 2 July 2018. Retrieved 30 July 2018.\\n' +\n ' \\n' +\n '
- ^ "Bitcoin-Qt version 0.5.0 released". Bitcoin Project. 1 November 2011. Retrieved 13 November 2016.\\n' +\n ' \\n' +\n '
- ^ a b Lee, Timothy (11 March 2013). "Major glitch in Bitcoin network sparks sell-off; price temporarily falls 23%". arstechnica.com. Archived from the original on 22 April 2013. Retrieved 15 February 2015.\\n' +\n ' \\n' +\n '
- ^ Blagdon, Jeff (12 March 2013). "Technical problems cause Bitcoin to plummet from record high, Mt. Gox suspends deposits". The Verge. Archived from the original on 22 April 2013. Retrieved 12 March 2013.\\n' +\n ' \\n' +\n '
- ^ "Bitcoin Charts". Archived from the original on 9 May 2014.\\n' +\n ' \\n' +\n '
- ^ Lee, Timothy (20 March 2013). "US regulator Bitcoin Exchanges Must Comply With Money Laundering Laws". Arstechnica. Archived from the original on 21 October 2013. Retrieved 28 July 2017.
Bitcoin miners must also register if they trade in their earnings for dollars.
\\n' +\n ' \\n' +\n ' - ^ "US govt clarifies virtual currency regulatory position". Finextra. 19 March 2013. Archived from the original on 26 March 2014.\\n' +\n ' \\n' +\n '
- ^ "Application of FinCEN's Regulations to Persons Administering, Exchanging, or Using Virtual Currencies" (PDF). Department of the Treasury Financial Crimes Enforcement Network. Archived from the original (PDF) on 28 March 2013. Retrieved 19 March 2013.\\n' +\n ' \\n' +\n '
- ^ Roose, Kevin (8 April 2013) "Inside the Bitcoin Bubble: BitInstant's CEO – Daily Intelligencer". Archived from the original on 9 April 2014.. Nymag.com. Retrieved on 20 April 2013.\\n' +\n ' \\n' +\n '
- ^ "Bitcoin Exchange Rate". Bitcoinscharts.com. Archived from the original on 24 June 2012. Retrieved 15 August 2013.\\n' +\n ' \\n' +\n '
- ^ Dillet, Romain. "Feds Seize Assets From Mt. Gox's Dwolla Account, Accuse It Of Violating Money Transfer Regulations". Archived from the original on 9 October 2013. Retrieved 15 May 2013.\\n' +\n ' \\n' +\n '
- ^ Berson, Susan A. (2013). "Some basic rules for using 'bitcoin' as virtual money". American Bar Association. Archived from the original on 29 October 2013. Retrieved 26 June 2013.\\n' +\n ' \\n' +\n '
- ^ Sampson, Tim (2013). "U.S. government makes its first-ever Bitcoin seizure". The Daily Dot. Archived from the original on 30 June 2013. Retrieved 15 October 2013.\\n' +\n ' \\n' +\n '
- ^ a b Ember, Sydney (2 July 2014). "Winner of Bitcoin Auction, Tim Draper, Plans to Expand Currency's Use". The New York Times DealBook. Archived from the original on 28 August 2019. Retrieved 13 June 2019.\\n' +\n ' \\n' +\n '
- ^ "After Silk Road seizure, FBI Bitcoin wallet identified and pranked". Archived from the original on 5 April 2014.\\n' +\n ' \\n' +\n '
- ^ "Silkroad Seized Coins". Archived from the original on 9 January 2014. Retrieved 2 November 2013.\\n' +\n ' \\n' +\n '
- ^ Hill, Kashmir. "The FBI's Plan For The Millions Worth Of Bitcoins Seized From Silk Road". Forbes. Archived from the original on 2 May 2014.\\n' +\n ' \\n' +\n '
- ^ Kelion, Leo (18 December 2013). "Bitcoin sinks after China restricts yuan exchanges". bbc.com. BBC. Archived from the original on 19 December 2013. Retrieved 20 December 2013.\\n' +\n ' \\n' +\n '
- ^ "China bans banks from bitcoin transactions". The Sydney Morning Herald. Reuters. 6 December 2013. Archived from the original on 23 March 2014. Retrieved 31 October 2014.\\n' +\n ' \\n' +\n '
- ^ "Baidu Stops Accepting Bitcoins After China Ban". Bloomberg. New York. 7 December 2013. Archived from the original on 10 December 2013. Retrieved 11 December 2013.\\n' +\n ' \\n' +\n '
- ^ "China bars use of virtual money for trading in real goods". English.mofcom.gov.cn. 29 June 2009. Archived from the original on 29 November 2013. Retrieved 10 January 2014.\\n' +\n ' \\n' +\n '
- ^ Rayman, Noah (30 July 2014). "You Can Now Donate to Wikipedia in Bitcoin". TIME. Archived from the original on 30 July 2014. Retrieved 27 April 2019.\\n' +\n ' \\n' +\n '
- ^ "Bitcoin Core version 0.11.2 released". Bitcoin Project. 13 November 2015. Retrieved 14 November 2016.\\n' +\n ' \\n' +\n '
- ^ Kyle Torpey (15 April 2016). "Bitcoin Core 0.12.1 Released, Major Step Forward for Scalability". Bitcoin Magazine. NASDAQ.com. Retrieved 7 November 2016.\\n' +\n ' \\n' +\n '
- ^ Antonopoulos, Andreas (2017). Mastering Bitcoin: Programming the Open Blockchain (2nd ed.). O'Reilly Media. ISBN 978-1491954386.
BIP-68 and BIP-112 were activated in May 2016 as a soft fork upgrade to the consensus rules.
\\n' +\n ' \\n' +\n ' - ^ "Bitcoin Core 0.13.1". Bitcoin Core. Retrieved 25 October 2016.\\n' +\n ' \\n' +\n '
- ^ "Segregated Witness Benefits". Bitcoin Core. 26 January 2016. Retrieved 20 October 2018.\\n' +\n ' \\n' +\n '
- ^ a b c Vigna, Paul (21 July 2017). "Bitcoin Rallies Sharply After Vote Resolves Bitter Scaling Debate". The Wall Street Journal. Archived from the original on 26 January 2020. Retrieved 26 January 2020.\\n' +\n ' \\n' +\n '
- ^ Selena Larson (1 August 2017). "Bitcoin split in two, here's what that means". CNN Tech. Cable News Network. Archived from the original on 27 February 2018. Retrieved 2 April 2018.\\n' +\n ' \\n' +\n '
- ^ "Bitcoin Hits a New Record High, But Stops Short of $20,000". Fortune. Archived from the original on 14 November 2018. Retrieved 16 April 2019.\\n' +\n ' \\n' +\n '
- ^ "RMB Bitcoin trading falls below 1 pct of world total". Xinhuanet. Xinhua. 7 July 2018. Archived from the original on 10 July 2018. Retrieved 10 July 2018.\\n' +\n ' \\n' +\n '
- ^ a b "Bitcoin USD". Yahoo Finance!. Archived from the original on 28 January 2019. Retrieved 27 January 2019.\\n' +\n ' \\n' +\n '
- ^ Dawkins, David (10 July 2018). "Has CHINA burst the bitcoin BUBBLE? Trading in RMB drops from 90% to 1%". Express. Archived from the original on 10 July 2018. Retrieved 10 July 2018.\\n' +\n ' \\n' +\n '
- ^ "Bitcoin turns 10: The obscure technology that became a household name". CNBC. 4 January 2019. Archived from the original on 19 January 2019. Retrieved 18 January 2019.\\n' +\n ' \\n' +\n '
- ^ "CVE-2018-17144 Full Disclosure". Bitcoin Core. Retrieved 23 September 2018.\\n' +\n ' \\n' +\n '
- ^ Chavez-Dreyfuss, Gertrude (3 July 2018). "Cryptocurrency exchange theft surges in first half of 2018: report". Reuters. Archived from the original on 4 July 2018. Retrieved 10 July 2018.\\n' +\n ' \\n' +\n '
- ^ "Cryptocurrencies Tumble After $32 Million South Korea Exchange Hack". Fortune. Bloomberg. 20 July 2018. Archived from the original on 11 July 2018. Retrieved 10 July 2018.\\n' +\n ' \\n' +\n '
- ^ Shane, Daniel (11 June 2018). "Billions in cryptocurrency wealth wiped out after hack". CNN. Archived from the original on 11 July 2018. Retrieved 10 July 2018.\\n' +\n ' \\n' +\n '
- ^ Russell, Jon (10 July 2018). "The crypto world's latest hack sees Israel's Bancor lose $23.5M". TechCrunch. Archived from the original on 10 July 2018. Retrieved 10 July 2018.\\n' +\n ' \\n' +\n '
- ^ Osipovich, Alexander (22 September 2019). "NYSE Owner Launches Long-Awaited Bitcoin Futures". The Wall Street Journal. Archived from the original on 24 September 2019. Retrieved 24 September 2019.\\n' +\n ' \\n' +\n '
- ^ Olga Kharif (24 October 2019). "Bakkt Plans First Regulated Options Contracts on Bitcoin Futures". bloomberg.com. Bloomberg. Archived from the original on 24 October 2019. Retrieved 5 November 2019.\\n' +\n ' \\n' +\n '
- ^ "YouTube admits error over Bitcoin video purge". bbc.com. BBC. 28 December 2019. Archived from the original on 28 December 2019. Retrieved 28 December 2019.\\n' +\n ' \\n' +\n '
- ^ Alexander, Doug (4 February 2019). "Crypto CEO Dies Holding Only Passwords That Can Unlock Millions in Customer Coins". bloomberg.com. Bloomberg. Archived from the original on 16 December 2019. Retrieved 27 January 2020.\\n' +\n ' \\n' +\n '
- ^ a b c del Castillo, Michael (19 March 2020). "Bitcoin's Magic Is Fading, And That's A Good Thing". Forbes.com. Archived from the original on 20 March 2020. Retrieved 21 March 2020.\\n' +\n ' \\n' +\n '
- ^ "Bitcoin loses half of its value in two-day plunge". CNBC. 13 March 2020. Retrieved 9 December 2020.\\n' +\n ' \\n' +\n '
- ^ "MicroStrategy buys $250M in Bitcoin as CEO says it's superior to cash". Washington Business Journal. 11 August 2020. Retrieved 11 August 2020.\\n' +\n ' \\n' +\n '
- ^ Business, Oliver Effron, CNN. "Square just bought $50 million in bitcoin". CNN. Retrieved 22 October 2020.\\n' +\n ' \\n' +\n '
- ^ "PayPal says all users in US can now buy, hold and sell cryptocurrencies". Techcrunch. 13 November 2020. Retrieved 26 November 2020.\\n' +\n ' \\n' +\n '
- ^ "Bitcoin hits an all-time high of just under $20,000". CNN. 30 November 2020. Retrieved 1 December 2020.\\n' +\n ' \\n' +\n '
- ^ Catalin Cimpanu (7 December 2020). "BTC-e founder sentenced to five years in prison for laundering ransomware funds". ZDNet. Retrieved 9 December 2020.\\n' +\n ' \\n' +\n '
- ^ Olga Kharif (11 December 2020). "169-Year-Old MassMutual Invests $100 Million in Bitcoin". Bloomberg. Retrieved 26 December 2020.\\n' +\n ' \\n' +\n '
- ^ Ryan Browne (29 January 2021). "Bitcoin spikes 20% after Elon Musk adds #bitcoin to his Twitter bio". CNBC. Retrieved 2 February 2021.\\n' +\n ' \\n' +\n '
- ^ Will Daniel (26 January 2021). "Crypto miner Marathon Patent Group pours $150 million into bitcoin as the token pulls back from record highs". Business Insider. Retrieved 1 February 2021.\\n' +\n ' \\n' +\n '
- ^ Yun Li (8 February 2021). "Bitcoin surges above $44,000 to record after Elon Musk's Tesla buys $1.5 billion worth". CNBC. Retrieved 9 February 2021.\\n' +\n ' \\n' +\n '
- ^ "Elon Musk says bitcoin is slightly better than holding cash". The Economic Times. Retrieved 19 February 2021.\\n' +\n ' \\n' +\n '
- ^ "Canton Zug to accept cryptocurrencies for tax payment beginning in 2021". Canton of Zug. 3 September 2020. Retrieved 24 January 2021.\\n' +\n ' \\n' +\n '
- ^ "Kanton Zug akzeptiert Kryptowährungen bei Steuern" (in German). Schweizerischen Radio- und Fernsehgesellschaft. 3 September 2020. Retrieved 24 January 2021.\\n' +\n ' \\n' +\n '
- ^ "Secp256k1". Bitcoin Wiki. 24 April 2019. Retrieved 4 February 2021.\\n' +\n ' \\n' +\n '
- ^ Knutson, Hans (6 April 2018). "What is the math behind elliptic curve cryptography?". Hacker Noon.\\n' +\n ' \\n' +\n '
- ^ Van Hijfte, Stijn (2020). Blockchain Platforms: A Look at the Underbelly of Distributed Platforms. Morgan & Claypool Publishers. ISBN 9781681738925.\\n' +\n ' \\n' +\n '
- ^ Romain Dillet (9 August 2013). "Bitcoin Ticker Available On Bloomberg Terminal For Employees". TechCrunch. Archived from the original on 1 November 2014. Retrieved 2 November 2014.\\n' +\n ' \\n' +\n '
- ^ "Bitcoin Composite Quote (XBT)". CNN Money. CNN. Archived from the original on 27 October 2014. Retrieved 2 November 2014.\\n' +\n ' \\n' +\n '
- ^ "XBT – Bitcoin". xe.com. Archived from the original on 2 November 2014. Retrieved 2 November 2014.\\n' +\n ' \\n' +\n '
- ^ "Regulation of Bitcoin in Selected Jurisdictions" (PDF). The Law Library of Congress, Global Legal Research Center. January 2014. Archived (PDF) from the original on 14 October 2014. Retrieved 26 August 2014.\\n' +\n ' \\n' +\n '
- ^ Katie Pisa & Natasha Maguder (9 July 2014). "Bitcoin your way to a double espresso". cnn.com. CNN. Archived from the original on 18 June 2015. Retrieved 23 April 2015.\\n' +\n ' \\n' +\n '
- ^ a b "Blockchair". Blockchair.com. Archived from the original on 13 October 2019. Retrieved 13 October 2019.\\n' +\n ' \\n' +\n '
- ^ a b c d e "Charts". Blockchain.info. Archived from the original on 3 November 2014. Retrieved 2 November 2014.\\n' +\n ' \\n' +\n '
- ^ a b c d e f "The great chain of being sure about things". The Economist. The Economist Newspaper Limited. 31 October 2015. Archived from the original on 3 July 2016. Retrieved 3 July 2016.\\n' +\n ' \\n' +\n '
- ^ Sparkes, Matthew (9 June 2014). "The coming digital anarchy". The Daily Telegraph. London. Archived from the original on 23 January 2015. Retrieved 7 January 2015.\\n' +\n ' \\n' +\n '
- ^ a b Ashlee Vance (14 November 2013). "2014 Outlook: Bitcoin Mining Chips, a High-Tech Arms Race". Businessweek. Archived from the original on 21 November 2013. Retrieved 24 November 2013.\\n' +\n ' \\n' +\n '
- ^ Ritchie S. King; Sam Williams; David Yanofsky (17 December 2013). "By reading this article, you're mining bitcoins". qz.com. Atlantic Media Co. Archived from the original on 17 December 2013. Retrieved 17 December 2013.\\n' +\n ' \\n' +\n '
- ^ Shin, Laura (24 May 2016). "Bitcoin Production Will Drop By Half In July, How Will That Affect The Price?". Forbes. Archived from the original on 24 May 2016. Retrieved 13 July 2016.\\n' +\n ' \\n' +\n '
- ^ a b c d e Joshua A. Kroll; Ian C. Davey; Edward W. Felten (11–12 June 2013). "The Economics of Bitcoin Mining, or Bitcoin in the Presence of Adversaries" (PDF). The Twelfth Workshop on the Economics of Information Security (WEIS 2013). Archived (PDF) from the original on 9 May 2016. Retrieved 26 April 2016.
A transaction fee is like a tip or gratuity left for the miner.
\\n' +\n ' \\n' +\n ' - ^ Orcutt, Mike (19 May 2015). "Leaderless Bitcoin Struggles to Make Its Most Crucial Decision". MIT Technology Review. Archived from the original on 18 October 2017. Retrieved 22 June 2017.\\n' +\n ' \\n' +\n '
- ^ "Man Throws Away 7,500 Bitcoins, Now Worth $7.5 Million". CBS DC. 29 November 2013. Archived from the original on 15 January 2014. Retrieved 23 January 2014.\\n' +\n ' \\n' +\n '
- ^ Krause, Elliott (5 July 2018). "A Fifth of All Bitcoin Is Missing. These Crypto Hunters Can Help". The Wall Street Journal. Archived from the original on 9 July 2018. Retrieved 8 July 2018.\\n' +\n ' \\n' +\n '
- ^ Jeffries, Adrianne (19 December 2013). "How to steal Bitcoin in three easy steps". The Verge. Archived from the original on 27 July 2019. Retrieved 17 January 2014.\\n' +\n ' \\n' +\n '
- ^ a b Harney, Alexandra; Stecklow, Steve (16 November 2017). "Twice burned - How Mt. Gox's bitcoin customers could lose again". Reuters. Archived from the original on 29 August 2019. Retrieved 6 September 2018.\\n' +\n ' \\n' +\n '
- ^ Martindale, Jon (16 March 2018). "Who owns all the Bitcoin? A few billionaire whales in a small pond". Digital Trends. Archived from the original on 30 June 2019. Retrieved 1 July 2019.\\n' +\n ' \\n' +\n '
- ^ "Bitcoin mania is hurting PC gamers by pushing up GPU prices". Archived from the original on 2 February 2018. Retrieved 2 February 2018.\\n' +\n ' \\n' +\n '
- ^ "Cryptocurrency mining operation launched by Iron Bridge Resources". World Oil. 26 January 2018. Archived from the original on 30 January 2018.\\n' +\n ' \\n' +\n '
- ^ a b Andolfatto, David (31 March 2014). "Bitcoin and Beyond: The Possibilities and Pitfalls of Virtual Currencies" (PDF). Dialogue with the Fed. Federal Reserve Bank of St. Louis. Archived (PDF) from the original on 9 April 2014. Retrieved 16 April 2014.\\n' +\n ' \\n' +\n '
- ^ Sherman, Alan; Javani, Farid; Golaszewski, Enis (25 March 2019). "On the Origins and Variations of Blockchain Technologies". IEEE Security and Policy. 17 (1): 72–77. arXiv:1810.06130. doi:10.1109/MSEC.2019.2893730. S2CID 53114747.\\n' +\n ' \\n' +\n '
- ^ "Difficulty History" (The ratio of all hashes over valid hashes is D x 4,295,032,833, where D is the published "Difficulty" figure.). Blockchain.info. Archived from the original on 8 April 2015. Retrieved 26 March 2015.\\n' +\n ' \\n' +\n '
- ^ Hampton, Nikolai (5 September 2016). "Understanding the blockchain hype: Why much of it is nothing more than snake oil and spin". Computerworld. IDG. Archived from the original on 6 September 2016. Retrieved 5 September 2016.\\n' +\n ' \\n' +\n '
- ^ Biggs, John (8 April 2013). "How To Mine Bitcoins". Techcrunch. Archived from the original on 6 July 2017.\\n' +\n ' \\n' +\n '
- ^ Skudnov, Rostislav (2012). Bitcoin Clients (PDF) (Bachelor's Thesis). Turku University of Applied Sciences. Archived (PDF) from the original on 18 January 2014. Retrieved 16 January 2014.\\n' +\n ' \\n' +\n '
- ^ "Bitcoin Core version 0.9.0 released". bitcoin.org. Archived from the original on 27 February 2015. Retrieved 8 January 2015.\\n' +\n ' \\n' +\n '
- ^ Metz, Cade (19 August 2015). "The Bitcoin Schism Shows the Genius of Open Source". Wired. Condé Nast. Archived from the original on 30 June 2016. Retrieved 3 July 2016.\\n' +\n ' \\n' +\n '
- ^ Allison, Ian (28 April 2017). "Ethereum co-founder Dr Gavin Wood and company release Parity Bitcoin". International Business Times. Archived from the original on 28 April 2017. Retrieved 28 April 2017.\\n' +\n ' \\n' +\n '
- ^ Adam Serwer & Dana Liebelson (10 April 2013). "Bitcoin, Explained". motherjones.com. Mother Jones. Archived from the original on 27 April 2014. Retrieved 26 April 2014.\\n' +\n ' \\n' +\n '
- ^ "Bitcoin: Bitcoin under pressure". The Economist. 30 November 2013. Archived from the original on 30 November 2013. Retrieved 30 November 2013.\\n' +\n ' \\n' +\n '
- ^ "Blockchain Size". Blockchain.info. Archived from the original on 27 May 2017. Retrieved 16 January 2018.\\n' +\n ' \\n' +\n '
- ^ Gervais, Arthur; O. Karame, Ghassan; Gruber, Damian; Capkun, Srdjan. "On the Privacy Provisions of Bloom Filters in Lightweight Bitcoin Clients" (PDF). Archived (PDF) from the original on 5 October 2016. Retrieved 3 September 2016.\\n' +\n ' \\n' +\n '
- ^ Bill Barhydt (4 June 2014). "3 reasons Wall Street can't stay away from bitcoin". NBCUniversal. Archived from the original on 3 April 2015. Retrieved 2 April 2015.\\n' +\n ' \\n' +\n '
- ^ "MtGox gives bankruptcy details". bbc.com. BBC. 4 March 2014. Archived from the original on 12 March 2014. Retrieved 13 March 2014.\\n' +\n ' \\n' +\n '
- ^ a b Barski, Conrad; Wilmer, Chris (2015). Bitcoin for the Befuddled. No Starch Press. ISBN 978-1-59327-573-0.\\n' +\n ' \\n' +\n '
- ^ Popper, Nathaniel (19 December 2017). "How the Winklevoss Twins Found Vindication in a Bitcoin Fortune". The New York Times. Archived from the original on 20 June 2019. Retrieved 19 June 2019.\\n' +\n ' \\n' +\n '
- ^ Alexander, Doug (15 February 2019). "Quadriga's late founder used to store clients' Bitcoin passwords on paper so they wouldn't get lost". Bloomberg News. Financial Post. Archived from the original on 20 June 2019. Retrieved 19 June 2019.\\n' +\n ' \\n' +\n '
- ^ a b Staff, Verge (13 December 2013). "Casascius, maker of shiny physical bitcoins, shut down by Treasury Department". The Verge. Archived from the original on 10 January 2014. Retrieved 10 January 2014.\\n' +\n ' \\n' +\n '
- ^ a b c d e Ahonen, Elias; Rippon, Matthew J.; Kesselman, Howard (15 April 2016). Encyclopedia of Physical Bitcoins and Crypto-Currencies. ISBN 978-0-9950-8990-7.\\n' +\n ' \\n' +\n '
- ^ Mack, Eric (25 October 2011). "Are physical Bitcoins legal?". CNET. Archived from the original on 26 June 2019. Retrieved 19 May 2019.\\n' +\n ' \\n' +\n '
- ^ British Museum (2012). "Bitcoin token with digital code for bitcoin currency". Retrieved 17 May 2019.\\n' +\n ' \\n' +\n '
- ^ Roberts, Daniel (15 December 2017). "How to send bitcoin to a hardware wallet". Yahoo Finance. Archived from the original on 17 February 2018. Retrieved 17 February 2018.\\n' +\n ' \\n' +\n '
- ^ Meola, Andrew (5 October 2017). "How distributed ledger technology will change the way the world works". Business Insider. Archived from the original on 27 April 2018. Retrieved 26 July 2018.\\n' +\n ' \\n' +\n '
- ^ Jerry Brito & Andrea Castillo (2013). "Bitcoin: A Primer for Policymakers" (PDF). Mercatus Center. George Mason University. Archived (PDF) from the original on 21 September 2013. Retrieved 22 October 2013.\\n' +\n ' \\n' +\n '
- ^ Tschorsch, Florian; Scheuermann, Björn (2016). "Bitcoin and Beyond: A Technical Survey on Decentralized Digital Currencies". IEEE Communications Surveys & Tutorials. 18 (3): 2084–2123. doi:10.1109/comst.2016.2535718. S2CID 5115101.\\n' +\n ' \\n' +\n '
- ^ Beikverdi, A.; Song, J. (June 2015). Trend of centralization in Bitcoin's distributed network. 2015 IEEE/ACIS 16th International Conference on Software Engineering, Artificial Intelligence, Networking and Parallel/Distributed Computing (SNPD). pp. 1–6. doi:10.1109/SNPD.2015.7176229. ISBN 978-1-4799-8676-7. S2CID 15516195.\\n' +\n ' \\n' +\n '
- ^ a b c Gervais, Arthur; Karame, Ghassan O.; Capkun, Vedran; Capkun, Srdjan. "Is Bitcoin a Decentralized Currency?". InfoQ. InfoQ & IEEE Computer Society. Archived from the original on 10 October 2016. Retrieved 11 October 2016.\\n' +\n ' \\n' +\n '
- ^ Wilhelm, Alex. "Popular Bitcoin Mining Pool Promises To Restrict Its Compute Power To Prevent Feared '51%' Fiasco". TechCrunch. Archived from the original on 5 December 2017. Retrieved 25 January 2018.\\n' +\n ' \\n' +\n '
- ^ Chan, Edwin. "China Plans to Ban Cryptocurrency Mining in Renewed Clampdown". www.bloomberg.com. Archived from the original on 18 December 2019. Retrieved 10 April 2019.
While China was once home to about 70 percent of Bitcoin mining and 90 percent of trades, authorities have waged a nearly two-year campaign to shrink the crypto industry amid concerns over speculative bubbles, fraud and wasteful energy consumption.
\\n' +\n ' \\n' +\n ' - ^ Simonite, Tom (5 September 2013). "Mapping the Bitcoin Economy Could Reveal Users' Identities". MIT Technology Review. Retrieved 2 April 2014.\\n' +\n ' \\n' +\n '
- ^ Lee, Timothy (21 August 2013). "Five surprising facts about Bitcoin". The Washington Post. Archived from the original on 12 October 2013. Retrieved 2 April 2014.\\n' +\n ' \\n' +\n '
- ^ McMillan, Robert (6 June 2013). "How Bitcoin lets you spy on careless companies". wired.co.uk. Conde Nast. Archived from the original on 9 February 2014. Retrieved 3 April 2020.\\n' +\n ' \\n' +\n '
- ^ Ben-Sasson, Eli; Chiesa, Alessandro; Garman, Christina; Green, Matthew; Miers, Ian; Tromer, Eran; Virza, Madars (2014). "Zerocash: Decentralized Anonymous Payments from Bitcoin" (PDF). 2014 IEEE Symposium on Security and Privacy. IEEE computer society. Archived (PDF) from the original on 14 October 2014. Retrieved 31 October 2014.\\n' +\n ' \\n' +\n '
- ^ Möser, Malte; Böhme, Rainer; Breuker, Dominic (2013). An Inquiry into Money Laundering Tools in the Bitcoin Ecosystem (PDF). 2013 APWG eCrime Researchers Summit. IEEE. ISBN 978-1-4799-1158-5. Archived (PDF) from the original on 26 June 2018. Retrieved 19 June 2019.\\n' +\n ' \\n' +\n '
- ^ a b Feuer, Alan (14 December 2013). "The Bitcoin Ideology". The New York Times. Archived from the original on 1 July 2018. Retrieved 1 July 2018.\\n' +\n ' \\n' +\n '
- ^ Friedrich von Hayek (October 1976). Denationalisation of Money: The Argument Refined. 2 Lord North Street, Westminster, London SWIP 3LB: The institute of economic affairs. ISBN 978-0-255-36239-9. Archived from the original on 11 January 2020. Retrieved 10 September 2015.CS1 maint: location (link)\\n' +\n ' \\n' +\n '
- ^ European Central Bank (October 2012). Virtual Currency Schemes (PDF). Frankfurt am Main: European Central Bank. ISBN 978-92-899-0862-7. Archived (PDF) from the original on 6 November 2012.\\n' +\n ' \\n' +\n '
- ^ a b "Bitcoin and other cryptocurrencies are useless". The Economist. 30 August 2018. Archived from the original on 4 September 2018. Retrieved 4 September 2018.
Lack of adoption and loads of volatility mean that cryptocurrencies satisfy none of those criteria.
\\n' +\n ' \\n' +\n ' - ^ a b Krugman, Paul (29 January 2018). "Bubble, Bubble, Fraud and Trouble". The New York Times. Archived from the original on 4 June 2018.\\n' +\n ' \\n' +\n '
- ^ a b Tourianski, Julia. "The Declaration Of Bitcoin's Independence". Archive.org. Archived from the original on 23 March 2019. Retrieved 1 July 2018.\\n' +\n ' \\n' +\n '
- ^ a b Dodd, Nigel (2017). "The social life of Bitcoin" (PDF). LSE Research Online. Archived (PDF) from the original on 1 July 2018. Retrieved 1 July 2018.\\n' +\n ' \\n' +\n '
- ^ Golumbia, David (2015). Lovink, Geert (ed.). Bitcoin as Politics: Distributed Right-Wing Extremism. Institute of Network Cultures, Amsterdam. pp. 117–131. ISBN 978-90-822345-5-8. SSRN 2589890.\\n' +\n ' \\n' +\n '
- ^ Peters, Jeremy W.; Popper, Nathaniel (14 June 2018). "Stephen Bannon Buys Into Bitcoin". The New York Times. Archived from the original on 1 July 2018. Retrieved 1 July 2018.\\n' +\n ' \\n' +\n '
- ^ a b Matthew Graham Wilson & Aaron Yelowitz (November 2014). "Characteristics of Bitcoin Users: An Analysis of Google Search Data". Social Science Research Network. Working Papers Series. SSRN 2518603.\\n' +\n ' \\n' +\n '
- ^ a b "Monetarists Anonymous". The Economist. The Economist Newspaper Limited. 29 September 2012. Archived from the original on 20 October 2013. Retrieved 21 October 2013.\\n' +\n ' \\n' +\n '
- ^ a b "The magic of mining". The Economist. 13 January 2015. Archived from the original on 12 January 2015. Retrieved 13 January 2015.\\n' +\n ' \\n' +\n '
- ^ a b "Free Exchange. Money from nothing. Chronic deflation may keep Bitcoin from displacing its rivals". The Economist. 15 March 2014. Archived from the original on 25 March 2014. Retrieved 25 March 2014.\\n' +\n ' \\n' +\n '
- ^ a b Shiller, Robert (1 March 2014). "In Search of a Stable Electronic Currency". The New York Times. Archived from the original on 24 October 2014.\\n' +\n ' \\n' +\n '
- ^ a b Murphy, Hannah (8 June 2018). "Who really owns bitcoin now?". Financial Times. Archived from the original on 10 June 2018. Retrieved 10 June 2018.\\n' +\n ' \\n' +\n '
- ^ Karkaria, Urvaksh (23 September 2014). "Atlanta-based BitPay hooks up with PayPal to expand bitcoin adoption". Atlanta Business Chronicle. Archived from the original on 26 October 2014.\\n' +\n ' \\n' +\n '
- ^ Katz, Lily (12 July 2017). "Bitcoin Acceptance Among Retailers Is Low and Getting Lower". Bloomberg. Archived from the original on 25 January 2018. Retrieved 25 January 2018.\\n' +\n ' \\n' +\n '
- ^ Kharif, Olga (1 August 2018). "Bitcoin's Use in Commerce Keeps Falling Even as Volatility Eases". Bloomberg. Archived from the original on 2 August 2018. Retrieved 2 August 2018.\\n' +\n ' \\n' +\n '
- ^ Chan, Bernice (16 January 2015). "Bitcoin transactions cut the cost of international money transfers". South China Morning Post. Archived from the original on 31 May 2019. Retrieved 31 May 2019.\\n' +\n ' \\n' +\n '
- ^ "Bitcoin firms dumped by National Australia Bank as 'too risky'". The Guardian. Australian Associated Press. 10 April 2014. Archived from the original on 23 February 2015. Retrieved 23 February 2015.\\n' +\n ' \\n' +\n '
- ^ Weir, Mike (1 December 2014). "HSBC severs links with firm behind Bitcoin fund". bbc.com. BBC. Archived from the original on 3 February 2015. Retrieved 9 January 2015.\\n' +\n ' \\n' +\n '
- ^ "ACCC investigating why banks are closing bitcoin companies' accounts". Financial Review. Archived from the original on 11 February 2016. Retrieved 28 January 2016.\\n' +\n ' \\n' +\n '
- ^ "Bitcoin futures surge in first day of trading". CBS News. 11 December 2017. Archived from the original on 31 May 2019. Retrieved 31 May 2019.\\n' +\n ' \\n' +\n '
- ^ "Chicago Mercantile Exchange jumps into bitcoin futures". CBS News. 18 December 2017. Archived from the original on 31 May 2019. Retrieved 31 May 2019.\\n' +\n ' \\n' +\n '
- ^ "Venezuela Has Bitcoin Stash and Doesn't Know What to Do With It". Bloomberg. 26 September 2019. Archived from the original on 26 September 2019. Retrieved 26 September 2019.\\n' +\n ' \\n' +\n '
- ^ Lee, Timothy B. "The $11 million in bitcoins the Winklevoss brothers bought is now worth $32 million". The Switch. The Washington Post. Archived from the original on 6 July 2017. Retrieved 11 August 2017.\\n' +\n ' \\n' +\n '
- ^ "Jersey approve Bitcoin fund launch on island". BBC news. 10 July 2014. Archived from the original on 10 July 2014. Retrieved 10 July 2014.\\n' +\n ' \\n' +\n '
- ^ Hill, Kashmir. "How You Should Have Spent $100 In 2013 (Hint: Bitcoin)". Forbes. Archived from the original on 19 February 2015. Retrieved 16 February 2015.\\n' +\n ' \\n' +\n '
- ^ Steverman, Ben (23 December 2014). "The Best and Worst Investments of 2014". bloomberg.com. Bloomberg LP. Archived from the original on 9 January 2015. Retrieved 9 January 2015.\\n' +\n ' \\n' +\n '
- ^ Gilbert, Mark (29 December 2015). "Bitcoin Won 2015. Apple ... Did Not". Bloomberg. Archived from the original on 29 December 2015. Retrieved 29 December 2015.\\n' +\n ' \\n' +\n '
- ^ "Top 100 Richest Bitcoin Addresses and Bitcoin distribution". bitinfocharts.com. Archived from the original on 15 October 2017. Retrieved 14 October 2017.\\n' +\n ' \\n' +\n '
- ^ "MicroStrategy Buys $50 Million Worth Of Bitcoin, Topping Up Holdings To $766M".\\n' +\n ' \\n' +\n '
- ^ "MicroStrategy buys $250M in Bitcoin as CEO says it's superior to cash". Washington Business Journal. 11 August 2020. Retrieved 11 August 2020.\\n' +\n ' \\n' +\n '
- ^ Wilson, Tom (18 May 2021). "Buyers beware as "altcoin" frenzy bruises bitcoin". Reuters. Retrieved 19 May 2021.\\n' +\n ' \\n' +\n '
- ^ Simonite, Tom (12 June 2013). "Bitcoin Millionaires Become Investing Angels". Computing News. MIT Technology Review. Retrieved 13 June 2013.\\n' +\n ' \\n' +\n '
- ^ a b Robin Sidel (1 December 2014). "Ten-hut! Bitcoin Recruits Snap To". The Wall Street Journal. Dow Jones & Company. Retrieved 9 December 2014.[dead link]\\n' +\n ' \\n' +\n '
- ^ Alex Hern (1 July 2014). "Silk Road's legacy 30,000 bitcoin sold at auction to mystery buyers". The Guardian. Archived from the original on 23 October 2014. Retrieved 31 October 2014.\\n' +\n ' \\n' +\n '
- ^ "CoinSeed raises $7.5m, invests $5m in Bitcoin mining hardware – Investment Round Up". Red Herring. 24 January 2014. Archived from the original on 9 March 2014. Retrieved 9 March 2014.\\n' +\n ' \\n' +\n '
- ^ a b Tasca, Paolo (7 September 2015), Digital Currencies: Principles, Trends, Opportunities, and Risks, Social Science Research Network, SSRN 2657598\\n' +\n ' \\n' +\n '
- ^ Moore, Heidi (3 April 2013). "Confused about Bitcoin? It's 'the Harlem Shake of currency'". The Guardian. Archived from the original on 1 March 2014. Retrieved 2 May 2014.\\n' +\n ' \\n' +\n '
- ^ Lee, Timothy (5 November 2013). "When will the people who called Bitcoin a bubble admit they were wrong". The Washington Post. Archived from the original on 11 January 2014. Retrieved 10 January 2014.\\n' +\n ' \\n' +\n '
- ^ Liu, Alec (19 March 2013). "When Governments Take Your Money, Bitcoin Looks Really Good". Motherboard. Archived from the original on 7 February 2014. Retrieved 7 January 2014.\\n' +\n ' \\n' +\n '
- ^ Ben Rooney (29 November 2013). "Bitcoin worth almost as much as gold". CNN. Archived from the original on 26 October 2014. Retrieved 31 October 2014.\\n' +\n ' \\n' +\n '
- ^ "Bitcoin prices remain below $600 amid bearish chart signals". nasdaq.com. August 2014. Archived from the original on 14 October 2014. Retrieved 31 October 2014..\\n' +\n ' \\n' +\n '
- ^ Williams, Mark T. (21 October 2014). "Virtual Currencies – Bitcoin Risk" (PDF). World Bank Conference Washington DC. Boston University. Archived (PDF) from the original on 11 November 2014. Retrieved 11 November 2014.\\n' +\n ' \\n' +\n '
- ^ Irrera, Tom Wilson, Anna (11 January 2021). "Analysis: Cancel your weekends! Bitcoin doesn't rest, and neither can you". Reuters. Archived from the original on 6 February 2021.
Trading volumes across six major cryptocurrency exchanges have been 10% higher at weekends than weekdays in that period
\\n' +\n ' \\n' +\n ' - ^ Zaki, Myret (14 January 2021). "Bitcoin: The Derivative Bomb". The Market (in German). Archived from the original on 15 January 2021.
the lion’s share of institutional trading in bitcoin is being done without owning any single bitcoin. The bitcoin derivative boom was encouraged by the fact that you can get 2 to 3 times leverage on the CME, and more than 100 x leverage on native crypto derivative exchanges. In 2020, the ratio between bitcoin futures and spot volumes has increased from 2,3 to 4,6 in 2019
\\n' +\n ' \\n' +\n ' - ^ Bambrough, Billy (30 January 2021). "Data Reveals Bitcoin Could Be About To Become The New GameStop After Huge Price Spike". Forbes. Archived from the original on 9 February 2021. Retrieved 9 February 2021.
The net short position in bitcoin futures is now the biggest it has ever been, according to the CFTC's latest Traders in Financial Futures report. .. hedge funds increasingly bet against the bitcoin price
\\n' +\n ' \\n' +\n ' - ^ "CFTC Commitments of Traders Short Report - Financial Traders in Markets (Futures Only)". cftc.gov. Commodity Futures Trading Commission (CFTC). 2–5 February 2021. Archived from the original on 8 February 2021.
BITCOIN - CHICAGO MERCANTILE EXCHANGE, CFTC Code #133741
\\n' +\n ' \\n' +\n ' - ^ "WSJ Markets Bitcoin USD". Retrieved 8 February 2021.\\n' +\n ' \\n' +\n '
- ^ "China May Be Gearing Up to Ban Bitcoin". pastemagazine.com. Archived from the original on 3 October 2017. Retrieved 6 October 2017.
The decentralized nature of bitcoin is such that it is impossible to "ban" the cryptocurrency, but if you shut down exchanges and the peer-to-peer economy running on bitcoin, it's a de facto ban.
\\n' +\n ' \\n' +\n ' - ^ "Regulation of Cryptocurrency Around the World" (PDF). Library of Congress. The Law Library of Congress, Global Legal Research Center. June 2018. pp. 4–5. Archived (PDF) from the original on 14 August 2018. Retrieved 15 August 2018.\\n' +\n ' \\n' +\n '
- ^ a b "Iran: New Crypto Law Requires Selling Bitcoin Directly to Central Bank to Fund Imports". aawsat.com. 31 October 2020. Retrieved 1 November 2020.\\n' +\n ' \\n' +\n '
- ^ "Iran Is Pivoting to Bitcoin". vice.com. 3 November 2020. Retrieved 10 November 2020.\\n' +\n ' \\n' +\n '
- ^ "Iran Has a Bitcoin Strategy to Beat Trump". foreignpolicy.com. 24 January 2020. Retrieved 10 November 2020.\\n' +\n ' \\n' +\n '
- ^ "Customer Advisory: Use Caution When Buying Digital Coins or Tokens" (PDF). U.S.Commodity Futures Trading Commission. Archived (PDF) from the original on 17 July 2018. Retrieved 17 July 2018.\\n' +\n ' \\n' +\n '
- ^ "Investor Alert: Bitcoin and Other Virtual Currency-related Investments". Investor.gov. U.S. Securities and Exchange Commission. 7 May 2014. Archived from the original on 30 June 2018. Retrieved 17 July 2018.\\n' +\n ' \\n' +\n '
- ^ "Ponzi schemes Using virtual Currencies" (PDF). sec.gov. U.S. Securities and Exchange Commission. Archived (PDF) from the original on 16 June 2018. Retrieved 17 July 2018.\\n' +\n ' \\n' +\n '
- ^ "Warning to consumers on virtual currencies" (PDF). European Banking Authority. 12 December 2013. Archived from the original (PDF) on 28 December 2013. Retrieved 23 December 2013.\\n' +\n ' \\n' +\n '
- ^ "Investor Alerts Don't Fall for Cryptocurrency-Related Stock Scams". FINRA.org. Financial Industry Regulatory Authority. 21 December 2017. Archived from the original on 1 July 2018. Retrieved 23 July 2018.\\n' +\n ' \\n' +\n '
- ^ "Informed Investor Advisory: Cryptocurrencies". North American Securities Administrators Association. April 2018. Archived from the original on 23 July 2018. Retrieved 23 July 2018.\\n' +\n ' \\n' +\n '
- ^ Dean, James (25 May 2018). "Bitcoin investigation to focus on British traders, US officials examine manipulation of cryptocurrency prices". The Times. Archived from the original on 25 May 2018. Retrieved 25 May 2018.\\n' +\n ' \\n' +\n '
- ^ Cornish, Chloe (24 May 2018). "Bitcoin slips again on reports of US DoJ investigation". Financial Times. Archived from the original on 24 May 2018. Retrieved 24 May 2018.\\n' +\n ' \\n' +\n '
- ^ Robinson, Matt; Schoenberg, Tom (24 May 2018). "U.S. Launches Criminal Probe into Bitcoin Price Manipulation". Bloomberg. Archived from the original on 24 May 2018. Retrieved 24 May 2018.\\n' +\n ' \\n' +\n '
- ^ McCoy, Kevin (24 May 2018). "Bitcoin value gyrates amid report of Department of Justice manipulation investigation". USA Today. Archived from the original on 24 May 2018. Retrieved 25 May 2018.\\n' +\n ' \\n' +\n '
- ^ Rubin, Gabriel T.; Michaels, Dave; Osipovich, Alexander (8 June 2018). "U.S. regulators demand trading data from bitcoin exchanges in manipulation probe". MarketWatch. Archived from the original on 8 June 2018. Retrieved 9 June 2018. Note:this is a short open access version of a Wall Street Journal article\\n' +\n ' \\n' +\n '
- ^ Rubin, Gabriel T.; Michaels, Dave; Osipovich, Alexander (8 June 2018). "U.S. regulators demand trading data from bitcoin exchanges in manipulation probe". The Wall Street Journal. Archived from the original on 8 June 2018. Retrieved 9 June 2018. (paywalled)\\n' +\n ' \\n' +\n '
- ^ Fung, Brian (21 May 2018). "State regulators unveil nationwide crackdown on suspicious cryptocurrency investment schemes". The Washington Post. Archived from the original on 27 May 2018. Retrieved 27 May 2018.\\n' +\n ' \\n' +\n '
- ^ Gandal, Neil; Hamrick, J.T.; Moore, Tyler; Oberman, Tali (May 2018). "Price manipulation in the Bitcoin ecosystem". Journal of Monetary Economics. 95: 86–96. doi:10.1016/j.jmoneco.2017.12.004. S2CID 26358036.\\n' +\n ' \\n' +\n '
- ^ Lee, Tim (12 December 2017). "A brief history of Bitcoin hacks and frauds". Ars Technica. Archived from the original on 28 May 2018. Retrieved 27 May 2018.\\n' +\n ' \\n' +\n '
- ^ Griffin, John M.; Shams, Amin (13 June 2018). "Is Bitcoin Really Un-Tethered?". Social Science Research Network. SSRN 3195066.\\n' +\n ' \\n' +\n '
- ^ Popper, Nathaniel (13 June 2018). "Bitcoin's Price Was Artificially Inflated Last Year, Researchers Say". The New York Times. Archived from the original on 13 June 2018. Retrieved 13 June 2018.\\n' +\n ' \\n' +\n '
- ^ Shaban, Hamza (14 June 2018). "Bitcoin's astronomical rise last year was buoyed by market manipulation, researchers say". The Washington Post. Archived from the original on 15 June 2018. Retrieved 14 June 2018.\\n' +\n ' \\n' +\n '
- ^ a b Janda, Michael (18 June 2018). "Cryptocurrencies like bitcoin cannot replace money, says Bank for International Settlements". ABC (Australia). Archived from the original on 18 June 2018. Retrieved 18 June 2018.\\n' +\n ' \\n' +\n '
- ^ Hyun Song Shin (June 2018). "Chapter V. Cryptocurrencies: looking beyond the hype" (PDF). BIS 2018 Annual Economic Report. Bank for International Settlements. Archived (PDF) from the original on 18 June 2018. Retrieved 19 June 2018.
Put in the simplest terms, the quest for decentralised trust has quickly become an environmental disaster.
\\n' +\n ' \\n' +\n ' - ^ Hiltzik, Michael (18 June 2018). "Is this scathing report the death knell for bitcoin?". Los Angeles Times. Archived from the original on 18 June 2018. Retrieved 19 June 2018.\\n' +\n ' \\n' +\n '
- ^ Velde, François (December 2013). "Bitcoin: A primer" (PDF). Chicago Fed letter. Federal Reserve Bank of Chicago. p. 4. Archived (PDF) from the original on 26 October 2014. Retrieved 3 September 2016.\\n' +\n ' \\n' +\n '
- ^ Wile, Rob (6 April 2014). "St. Louis Fed Economist: Bitcoin Could Be A Good Threat To Central Banks". businessinsider.com. Business Insider. Archived from the original on 24 September 2015. Retrieved 16 April 2014.\\n' +\n ' \\n' +\n '
- ^ Andolfatto, David (24 December 2013). "In gold we trust?". MacroMania. David Andolfatto. Archived from the original on 12 April 2017. Retrieved 17 April 2014.
Also, note that I am not against gold or bitcoin (or whatever) as a currency. In fact, I think that the threat that they pose as alternate currency can serve as a useful check on a central bank.
\\n' +\n ' \\n' +\n ' - ^ Costelloe, Kevin (29 November 2017). "Bitcoin 'Ought to Be Outlawed,' Nobel Prize Winner Stiglitz Says". Bloomberg. Archived from the original on 12 June 2018. Retrieved 5 June 2018.
It doesn't serve any socially useful function.
\\n' +\n ' \\n' +\n ' - ^ "Economics Nobel prize winner, Richard Thaler: "The market that looks most like a bubble to me is Bitcoin and its brethren"". ECO Portuguese Economy. 22 January 2018. Archived from the original on 12 June 2018. Retrieved 7 June 2018.\\n' +\n ' \\n' +\n '
- ^ a b Wolff-Mann, Ethan (27 April 2018). "'Only good for drug dealers': More Nobel prize winners snub bitcoin". Yahoo Finance. Archived from the original on 12 June 2018. Retrieved 7 June 2018.\\n' +\n ' \\n' +\n '
- ^ "Bitcoin biggest bubble in history, says economist who predicted 2008 crash". Archived from the original on 12 June 2018.\\n' +\n ' \\n' +\n '
- ^ Braue, David (11 March 2014). "Bitcoin confidence game is a Ponzi scheme for the 21st century". ZDNet. Archived from the original on 6 October 2016. Retrieved 5 October 2016.\\n' +\n ' \\n' +\n '
- ^ Clinch, Matt (10 March 2014). "Roubini launches stinging attack on bitcoin". CNBC. Archived from the original on 6 October 2014. Retrieved 2 July 2014.\\n' +\n ' \\n' +\n '
- ^ "This Billionaire Just Called Bitcoin a 'Pyramid Scheme'". Archived from the original on 24 September 2017. Retrieved 23 September 2017.\\n' +\n ' \\n' +\n '
- ^ Ott Ummelas & Milda Seputyte (31 January 2014). "Bitcoin 'Ponzi' Concern Sparks Warning From Estonia Bank". bloomberg.com. Bloomberg. Archived from the original on 29 March 2014. Retrieved 1 April 2014.\\n' +\n ' \\n' +\n '
- ^ Posner, Eric (11 April 2013). "Fool's Gold: Bitcoin is a Ponzi scheme—the Internet's favorite currency will collapse". Slate. Archived from the original on 26 March 2014. Retrieved 1 April 2014.\\n' +\n ' \\n' +\n '
- ^ Kaushik Basu (July 2014). "Ponzis: The Science and Mystique of a Class of Financial Frauds" (PDF). World Bank Group. Archived (PDF) from the original on 31 October 2014. Retrieved 30 October 2014.\\n' +\n ' \\n' +\n '
- ^ "Federal Council report on virtual currencies in response to the Schwaab (13.3687) and Weibel (13.4070) postulates" (PDF). Federal Council (Switzerland). Swiss Confederation. 25 June 2014. Archived (PDF) from the original on 5 December 2014. Retrieved 28 November 2014.\\n' +\n ' \\n' +\n '
- ^ Mooney, Chris; Mufson, Steven (19 December 2017). "Why the bitcoin craze is using up so much energy". The Washington Post. Archived from the original on 9 January 2018. Retrieved 11 January 2018.
several experts told The Washington Post that bitcoin probably uses as much as 1 to 4 gigawatts, or billion watts, of electricity, roughly the output of one to three nuclear reactors.
\\n' +\n ' \\n' +\n ' - ^ a b Roberts, Paul (9 March 2018). "This Is What Happens When Bitcoin Miners Take Over Your Town - Eastern Washington had cheap power and tons of space. Then the suitcases of cash started arriving". Politico. Archived from the original on 9 March 2018. Retrieved 16 March 2018.\\n' +\n ' \\n' +\n '
- ^ de Vries, Alex (May 2018). "Bitcoin's Growing Energy Problem". Joule. 2 (5): 801–805. doi:10.1016/j.joule.2018.04.016.\\n' +\n ' \\n' +\n '
- ^ a b Köhler, Susanne; Pizzol, Massimo (20 November 2019). "Life Cycle Assessment of Bitcoin Mining". Environmental Science & Technology. 53 (23): 13598–13606. Bibcode:2019EnST...5313598K. doi:10.1021/acs.est.9b05687. PMID 31746188.\\n' +\n ' \\n' +\n '
- ^ Baraniuk, Chris (3 July 2019). "Bitcoin's global energy use 'equals Switzerland'". BBC News. Archived from the original on 16 January 2020. Retrieved 2 February 2020.\\n' +\n ' \\n' +\n '
- ^ "How bad is Bitcoin for the environment really?". Independent. 12 February 2021. Retrieved 15 February 2021.
requires nearly as much energy as the entire country of Argentina
\\n' +\n ' \\n' +\n ' - ^ O'Brien, Matt (13 June 2015). "The scam called Bitcoin". Daily Herald. Archived from the original on 16 June 2015. Retrieved 20 September 2016.\\n' +\n ' \\n' +\n '
- ^ Potenza, Alessandra (21 December 2017). "Can renewable power offset bitcoin's massive energy demands?". TheVerge News. Archived from the original on 12 January 2018. Retrieved 12 January 2018.\\n' +\n ' \\n' +\n '
- ^ Lampert, Allison (12 January 2018). "Chinese bitcoin miners eye sites in energy-rich Canada". Reuters. Archived from the original on 14 January 2018. Retrieved 14 January 2018.\\n' +\n ' \\n' +\n '
- ^ "Bitcoin is literally ruining the earth, claim experts". The Independent. 6 December 2017. Archived from the original on 19 January 2018. Retrieved 23 January 2018.\\n' +\n ' \\n' +\n '
- ^ "The Hard Math Behind Bitcoin's Global Warming Problem". WIRED. 15 December 2017. Archived from the original on 21 January 2018. Retrieved 23 January 2018.\\n' +\n ' \\n' +\n '
- ^ a b Ponciano, Jonathan (18 April 2021). "Crypto Flash Crash Wiped Out $300 Billion In Less Than 24 Hours, Spurring Massive Bitcoin Liquidations". Forbes. Retrieved 24 April 2021.\\n' +\n ' \\n' +\n '
- ^ Murtaugh, Dan (9 February 2021). "The Possible Xinjiang Coal Link in Tesla's Bitcoin Binge". Bloomberg.com. Retrieved 24 April 2021.\\n' +\n ' \\n' +\n '
- ^ a b Tully, Shawn (20 April 2021). "Commentary: How much Bitcoin comes from dirty coal? A flooded mine in China just spotlighted the issue". Fortune. Retrieved 23 April 2021.\\n' +\n ' \\n' +\n '
- ^ Chant, Tim De (10 May 2021). "Private-equity firm revives zombie fossil-fuel power plant to mine bitcoin". Ars Technica. Retrieved 10 May 2021.\\n' +\n ' \\n' +\n '
- ^ Hern, Alex (17 January 2018). "Bitcoin's energy usage is huge – we can't afford to ignore it". The Guardian. Archived from the original on 23 January 2018. Retrieved 18 September 2019.\\n' +\n ' \\n' +\n '
- ^ Ethan, Lou (17 January 2019). "Bitcoin as big oil: the next big environmental fight?". The Guardian. Archived from the original on 29 August 2019. Retrieved 18 September 2019.\\n' +\n ' \\n' +\n '
- ^ Foteinis, Spyros (2018). "Bitcoin's alarming carbon footprint". Nature. 554 (7691): 169. Bibcode:2018Natur.554..169F. doi:10.1038/d41586-018-01625-x.\\n' +\n ' \\n' +\n '
- ^ Krause, Max J.; Tolaymat, Thabet (2018). "Quantification of energy and carbon costs for mining cryptocurrencies". Nature Sustainability. 1 (11): 711–718. doi:10.1038/s41893-018-0152-7. S2CID 169170289.\\n' +\n ' \\n' +\n '
- ^ a b Mora, Camilo; et al. (2018). "Bitcoin emissions alone could push global warming above 2°C". Nature Climate Change. 8 (11): 931–933. Bibcode:2018NatCC...8..931M. doi:10.1038/s41558-018-0321-8. S2CID 91491182.\\n' +\n ' \\n' +\n '
- ^ a b Stoll, Christian; Klaaßen, Lena; Gallersdörfer, Ulrich (2019). "The Carbon Footprint of Bitcoin". Joule. 3 (7): 1647–1661. doi:10.1016/j.joule.2019.05.012.\\n' +\n ' \\n' +\n '
- ^ Masanet, Eric; et al. (2019). "Implausible projections overestimate near-term Bitcoin CO
2 emissions". Nature Climate Change. 9 (9): 653–654. Bibcode:2019NatCC...9..653M. doi:10.1038/s41558-019-0535-4. hdl:2066/207817. OSTI 1561950.\\n' +\n ' \\n' +\n ' - ^ Dittmar, Lars; Praktiknjo, Aaron (2019). "Could Bitcoin emissions push global warming above 2°C?". Nature Climate Change. 9 (9): 656–657. Bibcode:2019NatCC...9..656D. doi:10.1038/s41558-019-0534-5.\\n' +\n ' \\n' +\n '
- ^ Houy, Nicolas (2019). "Rational mining limits Bitcoin emissions". Nature Climate Change. 9 (9): 655. Bibcode:2019NatCC...9..655H. doi:10.1038/s41558-019-0533-6.\\n' +\n ' \\n' +\n '
- ^ Kamiya, George. "Commentary: Bitcoin energy use - mined the gap". iea.org. Archived from the original on 3 March 2020. Retrieved 5 December 2019.\\n' +\n ' \\n' +\n '
- ^ Lavin, Tim (8 August 2013). "The SEC Shows Why Bitcoin Is Doomed". bloomberg.com. Bloomberg LP. Archived from the original on 25 March 2014. Retrieved 20 October 2013.\\n' +\n ' \\n' +\n '
- ^ Lee, Timothy B. (21 November 2013). "Here's how Bitcoin charmed Washington". The Washington Post. Archived from the original on 1 January 2017. Retrieved 10 October 2016.\\n' +\n ' \\n' +\n '
- ^ Popper, Nathaniel (13 July 2018). "How Russian Spies Hid Behind Bitcoin in Hacking Campaign". NYT. Archived from the original on 14 July 2018. Retrieved 14 July 2018.\\n' +\n ' \\n' +\n '
- ^ Ehrlich, Steven. "Janet Yellen, Bitcoin And Crypto Fearmongers Get Pushback From Former CIA Director". Forbes.\\n' +\n ' \\n' +\n '
- ^ Ball, James (22 March 2013). "Silk Road: the online drug marketplace that officials seem powerless to stop". theguardian.com. Guardian News and Media Limited. Archived from the original on 12 October 2013. Retrieved 20 October 2013.\\n' +\n ' \\n' +\n '
- ^ Montag, Ali (9 July 2018). "Nobel-winning economist: Authorities will bring down 'hammer' on bitcoin". CNBC. Archived from the original on 11 July 2018. Retrieved 11 July 2018.\\n' +\n ' \\n' +\n '
- ^ Newlands, Chris (9 July 2018). "Stiglitz, Roubini and Rogoff lead joint attack on bitcoin". Financial News. Archived from the original on 11 July 2018. Retrieved 11 July 2018.\\n' +\n ' \\n' +\n '
- ^ Foley, Sean; Karlsen, Jonathan R.; Putniņš, Tālis J. (19 February 2018). "Sex, drugs, and bitcoin: How much illegal activity is financed through cryptocurrencies?". University of Oxford Faculty of Law. Oxford Business Law Blog. Archived from the original on 10 June 2018. Retrieved 11 June 2018.\\n' +\n ' \\n' +\n '
- ^ Foley, Sean; Karlsen, Jonathan R.; Putniņš, Tālis J. (30 January 2018). "Sex, Drugs, and Bitcoin: How Much Illegal Activity Is Financed Through Cryptocurrencies?". Social Science Research Network. SSRN 3102645.\\n' +\n ' \\n' +\n '
- ^ Antonopoulos, Andreas (2017). "3". Mastering Bitcoin: Programming the Open Blockchain (2nd ed.). O'Reilly Media. ISBN 978-1491954386.
Bitcoin Core is the reference implementation of the bitcoin system, meaning that it is the authoritative reference on how each part of the technology should be implemented. Bitcoin Core implements all aspects of bitcoin, including wallets, a transaction and block validation engine, and a full network node in the peer-to-peer bitcoin network.
\\n' +\n ' \\n' +\n ' - ^ "Bitcoin Core version 0.9.0 released". Bitcoin Core. 19 March 2014. Retrieved 21 October 2018.\\n' +\n ' \\n' +\n '
- ^ a b c Antonopoulos, Andreas M. (2014). Mastering Bitcoin: Unlocking Digital Cryptocurrencies. O'Reilly Media, Inc. pp. 31–32. ISBN 978-1491902646. Retrieved 6 November 2016.\\n' +\n ' \\n' +\n '
- ^ "MIT Announces $900,000 Bitcoin Developer Fund". Inc. 29 March 2016. Retrieved 21 October 2018.\\n' +\n ' \\n' +\n '
- ^ a b "About". Bitcoin Core. Retrieved 21 October 2018.\\n' +\n ' \\n' +\n '
- ^ "Bitcoin Developer Examples". Bitcoin. Retrieved 21 October 2018.\\n' +\n ' \\n' +\n '
- ^ "checkpoints.cpp". Repository source code. GitHub, Inc. Retrieved 13 November 2016.\\n' +\n ' \\n' +\n '
- ^ "bitcoin/chainparams.cpp". GitHub. Retrieved 21 October 2018.\\n' +\n ' \\n' +\n '
- ^ Mike Orcutt (19 May 2015). "Leaderless Bitcoin Struggles to Make Its Most Crucial Decision". MIT Technology Review. Retrieved 15 November 2016.\\n' +\n ' \\n' +\n '
- ^ "Alert System Retirement". Bitcoin Project. 1 November 2016. Retrieved 16 November 2016.\\n' +\n ' \\n' +\n '
- ^ Antonopoulos, Andreas (29 May 2013). "Bitcoin is a money platform with many APIs". Radar. O'Reilly. Retrieved 19 November 2016.\\n' +\n ' \\n' +\n '
- ^ "Bitcoin Core devtools README - Create and verify timestamps of merge commits". GitHub. Retrieved 5 May 2018.\\n' +\n ' \\n' +\n '
- ^ a b Preukschat, Alex; Josep Busquet (2015). Bitcoin: The Hunt of Satoshi Nakamoto. Europe Comics. p. 87. ISBN 9791032800201. Retrieved 16 November 2016.\\n' +\n ' \\n' +\n '
- ^ Maria Bustillos (25 August 2015). "Inside the Fight Over Bitcoin's Future". New Yorker. Retrieved 29 June 2020.\\n' +\n ' \\n' +\n '
- ^ Shin, Laura. "Bitcoin And Taxes: If Not HODLing, Consider Donating". Forbes. Archived from the original on 22 December 2017. Retrieved 22 December 2017.\\n' +\n ' \\n' +\n '
- ^ Kaminska, Izabella (22 December 2017). "The HODL". Financial Times. Retrieved 21 November 2018.\\n' +\n ' \\n' +\n '
- ^ Montag, Ali (26 August 2018). "'HODL,' 'whale' and 5 other cryptocurrency slang terms explained". CNBC. Retrieved 12 November 2020.\\n' +\n ' \\n' +\n '
- ^ Wong, Joon Ian. "Buy and hodl, just don't get #rekt: The slang that gets you taken seriously as a bitcoin trader". Quartz. Archived from the original on 22 December 2017. Retrieved 22 December 2017.\\n' +\n ' \\n' +\n '
- ^ Akhtar, Tanzeel (22 December 2017). "As Bitcoin plunges, cryptocurrency fans chant 'HODL' for comfort". TheStreet. Archived from the original on 23 December 2017. Retrieved 22 December 2017.\\n' +\n ' \\n' +\n '
- ^ Hajric, Vildana (19 November 2020). "All the Bitcoin Lingo You Need to Know as Crypto Heats Up". Bloomberg. Retrieved 1 December 2020.\\n' +\n ' \\n' +\n '
- ^ Stross, Charles (2013). Neptune's Brood (First ed.). New York: Penguin Group USA. ISBN 978-0-425-25677-0.
It's theft-proof too – for each bitcoin is cryptographically signed by the mind of its owner.
\\n' +\n ' \\n' +\n ' - ^ "Crib Sheet: Neptune's Brood – Charlie's Diary". www.antipope.org. Archived from the original on 14 June 2017. Retrieved 5 December 2017.
I wrote Neptune's Brood in 2011. Bitcoin was obscure back then, and I figured had just enough name recognition to be a useful term for an interstellar currency: it'd clue people in that it was a networked digital currency.
\\n' +\n ' \\n' +\n ' - ^ Kenigsberg, Ben (2 October 2014). "Financial Wild West". The New York Times. Archived from the original on 18 May 2015. Retrieved 8 May 2015.\\n' +\n ' \\n' +\n '
- ^ Michel, Lincoln (16 December 2017). "What the Hell Is Bitcoin? Let This Documentary on Netflix Explain". GQ. Archived from the original on 18 November 2018. Retrieved 10 October 2018.\\n' +\n ' \\n' +\n '
- ^ "Introducing Ledger, the First Bitcoin-Only Academic Journal". Motherboard. Archived from the original on 10 January 2017.\\n' +\n ' \\n' +\n '
- ^ "Editorial Policies". ledgerjournal.org. Archived from the original on 23 December 2016. Retrieved 10 January 2017.\\n' +\n ' \\n' +\n '
- ^ "How to Write and Format an Article for Ledger" (PDF). Ledger. 2015. doi:10.5195/LEDGER.2015.1 (inactive 19 January 2021). Archived (PDF) from the original on 22 September 2015.CS1 maint: DOI inactive as of January 2021 (link)\\n' +\n ' \\n' +\n '
External links
\\n' +\n '![](\"https://upload.wikimedia.org/wikipedia/en/thumb/4/4a/Commons-logo.svg/30px-Commons-logo.svg.png\"){kind=logo} | \\n' +\n 'Wikimedia Commons has media related to Bitcoin. |
- Bitcoin.org website \\n' +\n '
- Bitcoin at Curlie
Page 2
For the taxonomic method, see DNA barcoding. For a code of conduct for barristers, see legal ethics.
\\n' +\n 'Optical machine-readable representation of data
\\n' +\n '\\n' +\n '![](\"https://en.wikipedia.org/wiki/File:UPC-A-036000291452.svg\")
A UPC-A barcode
A barcode or bar code is a method of representing data in a visual, machine-readable form. Initially, barcodes represented data by varying the widths and spacings of parallel lines. These barcodes, now commonly referred to as linear or one-dimensional (1D), can be scanned by special optical scanners, called barcode readers, of which there are several types. Later, two-dimensional (2D) variants were developed, using rectangles, dots, hexagons and other patterns, called matrix codes or 2D barcodes, although they do not use bars as such. 2D barcodes can be read using purpose-built 2D optical scanners, which exist in a few different forms. 2D barcodes can also be read by a digital camera connected to a microcomputer running software that takes a photographic image of the barcode and analyzes the image to deconstruct and decode the 2D barcode. A mobile device with an inbuilt camera, such as smartphone, can function as the latter type of 2D barcode reader using specialized application software. (The same sort of mobile device could also read 1D barcodes, depending on the application software.)\\n' +\n '
The barcode was invented by Norman Joseph Woodland and Bernard Silver and patented in the US in 1951.[1] The invention was based on Morse code[2] that was extended to thin and thick bars. However, it took over twenty years before this invention became commercially successful. An early use of one type of barcode in an industrial context was sponsored by the Association of American Railroads in the late 1960s. Developed by General Telephone and Electronics (GTE) and called KarTrak ACI (Automatic Car Identification), this scheme involved placing colored stripes in various combinations on steel plates which were affixed to the sides of railroad rolling stock. Two plates were used per car, one on each side, with the arrangement of the colored stripes encoding information such as ownership, type of equipment, and identification number.[3] The plates were read by a trackside scanner, located for instance, at the entrance to a classification yard, while the car was moving past.[4] The project was abandoned after about ten years because the system proved unreliable after long-term use.[3]\\n' +\n '
Barcodes became commercially successful when they were used to automate supermarket checkout systems, a task for which they have become almost universal. The Uniform Grocery Product Code Council had chosen, in 1973, the barcode design developed by George Laurer. Laurer's barcode, with vertical bars, printed better than the circular barcode developed by Woodland and Silver.[5] Their use has spread to many other tasks that are generically referred to as automatic identification and data capture (AIDC). The first scanning of the now-ubiquitous Universal Product Code (UPC) barcode was on a pack of Wrigley Company chewing gum in June 1974 at a Marsh supermarket in Troy, Ohio, using scanner produced by Photographic Sciences Corporation.[6][5] QR codes, a specific type of 2D barcode, have recently become very popular due to the growth in smartphone ownership.[7]\\n' +\n '
Other systems have made inroads in the AIDC market, but the simplicity, universality and low cost of barcodes has limited the role of these other systems, particularly before technologies such as radio-frequency identification (RFID) became available after 1995.\\n' +\n '
\\n' +\n '\\n' +\n '\\n' +\n 'History
\\n' +\n '![](\"https://upload.wikimedia.org/wikipedia/en/thumb/f/f2/Edit-clear.svg/40px-Edit-clear.svg.png\"){kind=spacer} | This article duplicates the scope of other articles, specifically, Universal Product Code#History. Please discuss this issue on the talk page and edit it to conform with Wikipedia's Manual of Style. (December 2013) |
In 1948 Bernard Silver, a graduate student at Drexel Institute of Technology in Philadelphia, Pennsylvania, US overheard the president of the local food chain, Food Fair, asking one of the deans to research a system to automatically read product information during checkout.[8] Silver told his friend Norman Joseph Woodland about the request, and they started working on a variety of systems. Their first working system used ultraviolet ink, but the ink faded too easily and was expensive.[9]\\n' +\n '
Convinced that the system was workable with further development, Woodland left Drexel, moved into his father's apartment in Florida, and continued working on the system. His next inspiration came from Morse code, and he formed his first barcode from sand on the beach. "I just extended the dots and dashes downwards and made narrow lines and wide lines out of them."[9] To read them, he adapted technology from optical soundtracks in movies, using a 500-watt incandescent light bulb shining through the paper onto an RCA935 photomultiplier tube (from a movie projector) on the far side. He later decided that the system would work better if it were printed as a circle instead of a line, allowing it to be scanned in any direction.\\n' +\n '
On 20 October 1949, Woodland and Silver filed a patent application for "Classifying Apparatus and Method", in which they described both the linear and bull's eye printing patterns, as well as the mechanical and electronic systems needed to read the code. The patent was issued on 7 October 1952 as US Patent 2,612,994.[1] In 1951, Woodland moved to IBM and continually tried to interest IBM in developing the system. The company eventually commissioned a report on the idea, which concluded that it was both feasible and interesting, but that processing the resulting information would require equipment that was some time off in the future.\\n' +\n '
IBM offered to buy the patent, but the offer was not accepted. Philco purchased the patent in 1962 and then sold it to RCA sometime later.[9]\\n' +\n '
\\n' +\n 'Collins at Sylvania
\\n' +\n 'During his time as an undergraduate, David Jarrett Collins worked at the Pennsylvania Railroad and became aware of the need to automatically identify railroad cars. Immediately after receiving his master's degree from MIT in 1959, he started work at GTE Sylvania and began addressing the problem. He developed a system called KarTrak using blue and red reflective stripes attached to the side of the cars, encoding a six-digit company identifier and a four-digit car number.[9] Light reflected off the colored stripes was read by photomultiplier vacuum tubes.[10]\\n' +\n '
The Boston and Maine Railroad tested the KarTrak system on their gravel cars in 1961. The tests continued until 1967, when the Association of American Railroads (AAR) selected it as a standard, Automatic Car Identification, across the entire North American fleet. The installations began on 10 October 1967. However, the economic downturn and rash of bankruptcies in the industry in the early 1970s greatly slowed the rollout, and it was not until 1974 that 95% of the fleet was labeled. To add to its woes, the system was found to be easily fooled by dirt in certain applications, which greatly affected accuracy. The AAR abandoned the system in the late 1970s, and it was not until the mid-1980s that they introduced a similar system, this time based on radio tags.[11]\\n' +\n '
The railway project had failed, but a toll bridge in New Jersey requested a similar system so that it could quickly scan for cars that had purchased a monthly pass. Then the U.S. Post Office requested a system to track trucks entering and leaving their facilities. These applications required special retroreflector labels. Finally, Kal Kan asked the Sylvania team for a simpler (and cheaper) version which they could put on cases of pet food for inventory control.\\n' +\n '
\\n' +\n 'Computer Identics Corporation
\\n' +\n 'In 1967, with the railway system maturing, Collins went to management looking for funding for a project to develop a black-and-white version of the code for other industries. They declined, saying that the railway project was large enough, and they saw no need to branch out so quickly.\\n' +\n '
Collins then quit Sylvania and formed the Computer Identics Corporation.[9] As its first innovations, Computer Identics moved from using incandescent light bulbs in its systems, replacing them with helium–neon lasers, and incorporated a mirror as well, making it capable of locating a barcode up to several feet in front of the scanner. This made the entire process much simpler and more reliable, and typically enabled these devices to deal with damaged labels, as well, by recognizing and reading the intact portions.\\n' +\n '
Computer Identics Corporation installed one of its first two scanning systems in the spring of 1969 at a General Motors (Buick) factory in Flint, Michigan.[9] The system was used to identify a dozen types of transmissions moving on an overhead conveyor from production to shipping. The other scanning system was installed at General Trading Company's distribution center in Carlstadt, New Jersey to direct shipments to the proper loading bay.\\n' +\n '
\\n' +\n 'Universal Product Code
\\n' +\n 'Main article: Universal Product Code
\\n' +\n 'In 1966, the National Association of Food Chains (NAFC) held a meeting on the idea of automated checkout systems. RCA, who had purchased the rights to the original Woodland patent, attended the meeting and initiated an internal project to develop a system based on the bullseye code. The Kroger grocery chain volunteered to test it.\\n' +\n '
In the mid-1970s, the NAFC established the Ad-Hoc Committee for U.S. Supermarkets on a Uniform Grocery-Product Code to set guidelines for barcode development. In addition, it created a symbol-selection subcommittee to help standardize the approach. In cooperation with consulting firm, McKinsey & Co., they developed a standardized 11-digit code for identifying products. The committee then sent out a contract tender to develop a barcode system to print and read the code. The request went to Singer, National Cash Register (NCR), Litton Industries, RCA, Pitney-Bowes, IBM and many others.[12] A wide variety of barcode approaches was studied, including linear codes, RCA's bullseye concentric circle code, starburst patterns and others.\\n' +\n '
In the spring of 1971, RCA demonstrated their bullseye code at another industry meeting. IBM executives at the meeting noticed the crowds at the RCA booth and immediately developed their own system. IBM marketing specialist Alec Jablonover remembered that the company still employed Woodland, and he[who?] established a new facility in Raleigh-Durham Research Triangle Park to lead development.\\n' +\n '
In July 1972, RCA began an 18-month test in a Kroger store in Cincinnati. Barcodes were printed on small pieces of adhesive paper, and attached by hand by store employees when they were adding price tags. The code proved to have a serious problem; the printers would sometimes smear ink, rendering the code unreadable in most orientations. However, a linear code, like the one being developed by Woodland at IBM, was printed in the direction of the stripes, so extra ink would simply make the code "taller" while remaining readable. So on 3 April 1973, the IBM UPC was selected as the NAFC standard. IBM had designed five versions of UPC symbology for future industry requirements: UPC A, B, C, D, and E.[13]\\n' +\n '
NCR installed a testbed system at Marsh's Supermarket in Troy, Ohio, near the factory that was producing the equipment. On 26 June 1974, Clyde Dawson pulled a 10-pack of Wrigley's Juicy Fruit gum out of his basket and it was scanned by Sharon Buchanan at 8:01 am. The pack of gum and the receipt are now on display in the Smithsonian Institution. It was the first commercial appearance of the UPC.[14]\\n' +\n '
In 1971, an IBM team was assembled for an intensive planning session, threshing out, 12 to 18 hours a day, how the technology would be deployed and operate cohesively across the system, and scheduling a roll-out plan. By 1973, the team were meeting with grocery manufacturers to introduce the symbol that would need to be printed on the packaging or labels of all of their products. There were no cost savings for a grocery to use it, unless at least 70% of the grocery's products had the barcode printed on the product by the manufacturer. IBM projected that 75% would be needed in 1975. Yet, although this was achieved, there were still scanning machines in fewer than 200 grocery stores by 1977.[15]\\n' +\n '
Economic studies conducted for the grocery industry committee projected over $40 million in savings to the industry from scanning by the mid-1970s. Those numbers were not achieved in that time-frame and some predicted the demise of barcode scanning. The usefulness of the barcode required the adoption of expensive scanners by a critical mass of retailers while manufacturers simultaneously adopted barcode labels. Neither wanted to move first and results were not promising for the first couple of years, with Business Week proclaiming "The Supermarket Scanner That Failed" in a 1976 article.[14][16]\\n' +\n '
On the other hand, experience with barcode scanning in those stores revealed additional benefits. The detailed sales information acquired by the new systems allowed greater responsiveness to customer habits, needs and preferences. This was reflected in the fact that about 5 weeks after installing barcode scanners, sales in grocery stores typically started climbing and eventually leveled off at a 10–12% increase in sales that never dropped off. There was also a 1–2% decrease in operating cost for those stores, and this enabled them to lower prices and thereby to increase market share. It was shown in the field that the return on investment for a barcode scanner was 41.5%. By 1980, 8,000 stores per year were converting.[15]\\n' +\n '
Sims Supermarkets were the first location in Australia to use barcodes, starting in 1979.[17]\\n' +\n '
\\n' +\n 'Industrial adoption
\\n' +\n 'In 1981, the United States Department of Defense adopted the use of Code 39 for marking all products sold to the United States military. This system, Logistics Applications of Automated Marking and Reading Symbols (LOGMARS), is still used by DoD and is widely viewed as the catalyst for widespread adoption of barcoding in industrial uses.[18]\\n' +\n '
\\n' +\n 'Use
\\n' +\n '\\n' +\n '\\n' +\n '\\n' +\n '![](\"https://en.wikipedia.org/wiki/File:EAN-13-ISBN-13.svg\")
![](\"https://en.wikipedia.org/wiki/File:LB2-ADULT-L3_Assembled.jpg\")
![](\"https://en.wikipedia.org/wiki/File:Barcodedmail.JPG\")
Barcodes are widely used around the world in many contexts. In stores, UPC barcodes are pre-printed on most items other than fresh produce from a grocery store. This speeds up processing at check-outs and helps track items and also reduces instances of shoplifting involving price tag swapping, although shoplifters can now print their own barcodes.[19] Barcodes that encode a book's ISBN are also widely pre-printed on books, journals and other printed materials. In addition, retail chain membership cards use barcodes to identify customers, allowing for customized marketing and greater understanding of individual consumer shopping patterns. At the point of sale, shoppers can get product discounts or special marketing offers through the address or e-mail address provided at registration.\\n' +\n '
Barcodes are widely used in the healthcare and hospital settings, ranging from patient identification (to access patient data, including medical history, drug allergies, etc.) to creating SOAP Notes[20] with barcodes to medication management. They are also used to facilitate the separation and indexing of documents that have been imaged in batch scanning applications, track the organization of species in biology,[21] and integrate with in-motion checkweighers to identify the item being weighed in a conveyor line for data collection.\\n' +\n '
They can also be used to keep track of objects and people; they are used to keep track of rental cars, airline luggage, nuclear waste, registered mail, express mail and parcels. Barcoded tickets (which may be printed by the customer on their home printer, or stored on their mobile device) allow the holder to enter sports arenas, cinemas, theatres, fairgrounds, and transportation, and are used to record the arrival and departure of vehicles from rental facilities etc. This can allow proprietors to identify duplicate or fraudulent tickets more easily. Barcodes are widely used in shop floor control applications software where employees can scan work orders and track the time spent on a job.\\n' +\n '
Barcodes are also used in some kinds of non-contact 1D and 2D position sensors. A series of barcodes are used in some kinds of absolute 1D linear encoder. The barcodes are packed close enough together that the reader always has one or two barcodes in its field of view. As a kind of fiducial marker, the relative position of the barcode in the field of view of the reader gives incremental precise positioning, in some cases with sub-pixel resolution. The data decoded from the barcode gives the absolute coarse position. An "address carpet", such as Howell's binary pattern and the Anoto dot pattern, is a 2D barcode designed so that a reader, even though only a tiny portion of the complete carpet is in the field of view of the reader, can find its absolute X,Y position and rotation in the carpet.[22][23]\\n' +\n '
2D barcodes can embed a hyperlink to a web page. A mobile device with an inbuilt camera might be used to read the pattern and browse the linked website, which can help a shopper find the best price for an item in the vicinity. Since 2005, airlines use an IATA-standard 2D barcode on boarding passes (Bar Coded Boarding Pass (BCBP)), and since 2008 2D barcodes sent to mobile phones enable electronic boarding passes.[24]\\n' +\n '
Some applications for barcodes have fallen out of use. In the 1970s and 1980s, software source code was occasionally encoded in a barcode and printed on paper (Cauzin Softstrip and Paperbyte[25] are barcode symbologies specifically designed for this application), and the 1991 Barcode Battler computer game system used any standard barcode to generate combat statistics.\\n' +\n '
Artists have used barcodes in art, such as Scott Blake's Barcode Jesus, as part of the post-modernism movement.\\n' +\n '
\\n' +\n 'Symbologies
\\n' +\n 'The mapping between messages and barcodes is called a symbology. The specification of a symbology includes the encoding of the message into bars and spaces, any required start and stop markers, the size of the quiet zone required to be before and after the barcode, and the computation of a checksum.\\n' +\n '
Linear symbologies can be classified mainly by two properties:\\n' +\n '
\\n' +\n '- Continuous vs. discrete
- Characters in discrete symbologies are composed of n bars and n − 1 spaces. There is an additional space between characters, but it does not convey information, and may have any width as long as it is not confused with the end of the code. \\n' +\n '
- Characters in continuous symbologies are composed of n bars and n spaces, and usually abut, with one character ending with a space and the next beginning with a bar, or vice versa. A special end pattern that has bars on both ends is required to end the code.
- Two-width vs. many-width
- A two-width, also called a binary bar code, contains bars and spaces of two widths, "wide" and "narrow". The precise width of the wide bars and spaces is not critical; typically it is permitted to be anywhere between 2 and 3 times the width of the narrow equivalents. \\n' +\n '
- Some other symbologies use bars of two different heights (POSTNET), or the presence or absence of bars (CPC Binary Barcode). These are normally also considered binary bar codes. \\n' +\n '
- Bars and spaces in many-width symbologies are all multiples of a basic width called the module; most such codes use four widths of 1, 2, 3 and 4 modules.
Some symbologies use interleaving. The first character is encoded using black bars of varying width. The second character is then encoded by varying the width of the white spaces between these bars. Thus characters are encoded in pairs over the same section of the barcode. Interleaved 2 of 5 is an example of this.\\n' +\n '
Stacked symbologies repeat a given linear symbology vertically.\\n' +\n '
The most common among the many 2D symbologies are matrix codes, which feature square or dot-shaped modules arranged on a grid pattern. 2D symbologies also come in circular and other patterns and may employ steganography, hiding modules within an image (for example, DataGlyphs).\\n' +\n '
Linear symbologies are optimized for laser scanners, which sweep a light beam across the barcode in a straight line, reading a slice of the barcode light-dark patterns. Scanning at an angle makes the modules appear wider, but does not change the width ratios. Stacked symbologies are also optimized for laser scanning, with the laser making multiple passes across the barcode.\\n' +\n '
In the 1990s development of charge-coupled device (CCD) imagers to read barcodes was pioneered by Welch Allyn. Imaging does not require moving parts, as a laser scanner does. In 2007, linear imaging had begun to supplant laser scanning as the preferred scan engine for its performance and durability.\\n' +\n '
2D symbologies cannot be read by a laser, as there is typically no sweep pattern that can encompass the entire symbol. They must be scanned by an image-based scanner employing a CCD or other digital camera sensor technology.\\n' +\n '
\\n' +\n 'Barcode readers
\\n' +\n 'Main article: Barcode reader
\\n' +\n '\\n' +\n '
![](\"https://en.wikipedia.org/wiki/File:GTIN_Barcodes_of_coke_bottles_-_what_you_see_and_what_the_barcode_scanner_see_2_IMG_2908_2913_2919.JPG\")
The earliest, and still the cheapest, barcode scanners are built from a fixed light and a single photosensor that is manually moved across the barcode. Barcode scanners can be classified into three categories based on their connection to the computer. The older type is the RS-232 barcode scanner. This type requires special programming for transferring the input data to the application program. Keyboard interface scanners connect to a computer using a PS/2 or AT keyboard–compatible adaptor cable (a "keyboard wedge"). The barcode's data is sent to the computer as if it had been typed on the keyboard.\\n' +\n '
Like the keyboard interface scanner, USB scanners do not need custom code for transferring input data to the application program. On PCs running Windows the human interface device emulates the data merging action of a hardware "keyboard wedge", and the scanner automatically behaves like an additional keyboard.\\n' +\n '
Most modern smartphones are able to decode barcode using their built-in camera. Google's mobile Android operating system can use their own Google Lens application to scan QR codes, or third party apps like Barcode Scanner to read both one-dimensional barcodes and QR codes. Nokia's Symbian operating system featured a barcode scanner,[26] while mbarcode[27] is a QR code reader for the Maemo operating system. In Apple iOS 11, the native camera app can decode QR codes and can link to URLs, join wireless networks, or perform other operations depending on the QR Code contents.[28] Other paid and free apps are available with scanning capabilities for other symbologies or for earlier iOS versions.[29] With BlackBerry devices, the App World application can natively scan barcodes and load any recognized Web URLs on the device's Web browser. Windows Phone 7.5 is able to scan barcodes through the Bing search app. However, these devices are not designed specifically for the capturing of barcodes. As a result, they do not decode nearly as quickly or accurately as a dedicated barcode scanner or portable data terminal.[citation needed]\\n' +\n '
\\n' +\n 'Quality control and verification
\\n' +\n 'It is common for producers and users of bar codes to have a quality management system which includes verification and validation of bar codes.[30] Barcode verification examines scanability and the quality of the barcode in comparison to industry standards and specifications.[31] Barcode verifiers are primarily used by businesses that print and use barcodes. Any trading partner in the supply chain can test barcode quality. It is important to verify a barcode to ensure that any reader in the supply chain can successfully interpret a barcode with a low error rate. Retailers levy large penalties for non-compliant barcodes. These chargebacks can reduce a manufacturer's revenue by 2% to 10%.[32]\\n' +\n '
A barcode verifier works the way a reader does, but instead of simply decoding a barcode, a verifier performs a series of tests. For linear barcodes these tests are:\\n' +\n '
\\n' +\n '- Edge contrast (EC)[33]\\n' +\n '
- The difference between the space reflectance (Rs) and adjoining bar reflectance (Rb). EC=Rs-Rb
\\n' +\n ' - Minimum bar reflectance (Rb)[33]\\n' +\n '
- The smallest reflectance value in a bar.
\\n' +\n ' - Minimum space reflectance (Rs)[33]\\n' +\n '
- The smallest reflectance value in a space.
\\n' +\n ' - Symbol contrast (SC)[33]\\n' +\n '
- Symbol Contrast is the difference in reflectance values of the lightest space (including the quiet zone) and the darkest bar of the symbol. The greater the difference, the higher the grade. The parameter is graded as either A, B, C, D, or F. SC=Rmax-Rmin
\\n' +\n ' - Minimum edge contrast (ECmin)[33]\\n' +\n '
- The difference between the space reflectance (Rs) and adjoining bar reflectance (Rb). EC=Rs-Rb
\\n' +\n ' - Modulation (MOD)[33]\\n' +\n '
- The parameter is graded either A, B, C, D, or F. This grade is based on the relationship between minimum edge contrast (ECmin) and symbol contrast (SC). MOD=ECmin/SC The greater the difference between minimum edge contrast and symbol contrast, the lower the grade. Scanners and verifiers perceive the narrower bars and spaces to have less intensity than wider bars and spaces; the comparison of the lesser intensity of narrow elements to the wide elements is called modulation. This condition is affected by aperture size.
\\n' +\n ' - Inter-character gap[33]\\n' +\n '
- In discrete barcodes, the space that disconnects the two contiguous characters. When present, inter-character gaps are considered spaces (elements) for purposes of edge determination and reflectance parameter grades.
\\n' +\n ' - Defects \\n' +\n '
- Decode[33]\\n' +\n '
- Extracting the information which has been encoded in a bar code symbol.
\\n' +\n ' - Decodability[33]\\n' +\n '
- Can be graded as A, B, C, D, or F. The Decodability grade indicates the amount of error in the width of the most deviant element in the symbol. The less deviation in the symbology, the higher the grade. Decodability is a measure of print accuracy using the symbology reference decode algorithm.
2D matrix symbols look at the parameters:\\n' +\n '
\\n' +\n '- Symbol contrast[33] \\n' +\n '
- Modulation[33] \\n' +\n '
- Decode[33] \\n' +\n '
- Unused error correction \\n' +\n '
- Fixed (finder) pattern damage \\n' +\n '
- Grid non-uniformity \\n' +\n '
- Axial non-uniformity[34]
Depending on the parameter, each ANSI test is graded from 0.0 to 4.0 (F to A), or given a pass or fail mark. Each grade is determined by analyzing the scan reflectance profile (SRP), an analog graph of a single scan line across the entire symbol. The lowest of the 8 grades is the scan grade, and the overall ISO symbol grade is the average of the individual scan grades. For most applications a 2.5 (C) is the minimal acceptable symbol grade.[35]\\n' +\n '
Compared with a reader, a verifier measures a barcode's optical characteristics to international and industry standards. The measurement must be repeatable and consistent. Doing so requires constant conditions such as distance, illumination angle, sensor angle and verifier aperture. Based on the verification results, the production process can be adjusted to print higher quality barcodes that will scan down the supply chain.\\n' +\n '
Bar code validation may include evaluations after use (and abuse) testing such as sunlight, abrasion, impact, moisture, etc.[36]\\n' +\n '
\\n' +\n 'Barcode verifier standards
\\n' +\n 'Barcode verifier standards are defined by the International Organization for Standardization (ISO), in ISO/IEC 15426-1 (linear) or ISO/IEC 15426-2 (2D).[citation needed] The current international barcode quality specification is ISO/IEC 15416 (linear) and ISO/IEC 15415 (2D).[citation needed] The European Standard EN 1635 has been withdrawn and replaced by ISO/IEC 15416. The original U.S. barcode quality specification was ANSI X3.182. (UPCs used in the US – ANSI/UCC5).[citation needed] As of 2011 the ISO workgroup JTC1 SC31 was developing a Direct Part Marking (DPM) quality standard: ISO/IEC TR 29158.[37]\\n' +\n '
\\n' +\n 'Benefits
\\n' +\n 'In point-of-sale management, barcode systems can provide detailed up-to-date information on the business, accelerating decisions and with more confidence. For example:\\n' +\n '
\\n' +\n '- Fast-selling items can be identified quickly and automatically reordered. \\n' +\n '
- Slow-selling items can be identified, preventing inventory build-up. \\n' +\n '
- The effects of merchandising changes can be monitored, allowing fast-moving, more profitable items to occupy the best space. \\n' +\n '
- Historical data can be used to predict seasonal fluctuations very accurately. \\n' +\n '
- Items may be repriced on the shelf to reflect both sale prices and price increases. \\n' +\n '
- This technology also enables the profiling of individual consumers, typically through a voluntary registration of discount cards. While pitched as a benefit to the consumer, this practice is considered to be potentially dangerous by privacy advocates.[which?]
Besides sales and inventory tracking, barcodes are very useful in logistics and supply chain management.\\n' +\n '
\\n' +\n '- When a manufacturer packs a box for shipment, a Unique Identifying Number (UID) can be assigned to the box. \\n' +\n '
- A database can link the UID to relevant information about the box; such as order number, items packed, quantity packed, destination, etc. \\n' +\n '
- The information can be transmitted through a communication system such as Electronic Data Interchange (EDI) so the retailer has the information about a shipment before it arrives. \\n' +\n '
- Shipments that are sent to a Distribution Center (DC) are tracked before forwarding. When the shipment reaches its final destination, the UID gets scanned, so the store knows the shipment's source, contents, and cost.
Barcode scanners are relatively low cost and extremely accurate compared to key-entry, with only about 1 substitution error in 15,000 to 36 trillion characters entered.[38][unreliable source?] The exact error rate depends on the type of barcode.\\n' +\n '
\\n' +\n 'Types of barcodes
\\n' +\n 'Linear barcodes
\\n' +\n 'A first generation, "one dimensional" barcode that is made up of lines and spaces of various widths that create specific patterns.\\n' +\n '
\\n' +\n '| Example | \\n' +\n 'Symbology | \\n' +\n 'Continuous or discrete | \\n' +\n 'Bar widths | \\n' +\n 'Uses\\n' +\n ' |
|---|---|---|---|---|
![\"Australia](\"https://en.wikipedia.org/wiki/File:Australia_Post_4-state_barcode.png\") | \\n' +\n 'Australia Post barcode | \\n' +\n 'Discrete | \\n' +\n '4 bar heights | \\n' +\n 'An Australia Post barcode as used on a business reply paid envelope and applied by automated sorting machines to other mail when initially processed in fluorescent ink .\\n' +\n ' |
![\"Codabar.svg\"](\"https://en.wikipedia.org/wiki/File:Codabar.svg\") | \\n' +\n 'Codabar | \\n' +\n 'Discrete | \\n' +\n 'Two | \\n' +\n 'Old format used in libraries and blood banks and on airbills (out of date, but still widely used in libraries)\\n' +\n ' |
| \\n' +\n ' | Code 25 – Non-interleaved 2 of 5 | \\n' +\n 'Continuous | \\n' +\n 'Two | \\n' +\n 'Industrial\\n' +\n ' |
![\"Barcode2of5example.svg\"](\"https://en.wikipedia.org/wiki/File:Barcode2of5example.svg\") | \\n' +\n 'Code 25 – Interleaved 2 of 5 | \\n' +\n 'Continuous | \\n' +\n 'Two | \\n' +\n 'Wholesale, libraries International standard ISO/IEC 16390\\n' +\n ' |
![\"Code11](\"https://en.wikipedia.org/wiki/File:Code11_barcode.png\") | \\n' +\n 'Code 11 | \\n' +\n 'Discrete | \\n' +\n 'Two | \\n' +\n 'Telephones (out of date)\\n' +\n ' |
![\"Code32](\"https://en.wikipedia.org/wiki/File:Code32_01234567.png\") | \\n' +\n 'Farmacode or Code 32 | \\n' +\n 'Discrete | \\n' +\n 'Two | \\n' +\n 'Italian pharmacode – use Code 39 (no international standard available)\\n' +\n ' |
![\"Code](\"https://en.wikipedia.org/wiki/File:Code_3_of_9.svg\") | \\n' +\n 'Code 39 | \\n' +\n 'Discrete | \\n' +\n 'Two | \\n' +\n 'Various – international standard ISO/IEC 16388\\n' +\n ' |
![\"Code](\"https://en.wikipedia.org/wiki/File:Code_49_wikipedia.png\") | \\n' +\n 'Code 49 | \\n' +\n 'Continuous | \\n' +\n 'Many | \\n' +\n 'Various\\n' +\n ' |
![\"Code](\"https://en.wikipedia.org/wiki/File:Code_93_wikipedia.png\") | \\n' +\n 'Code 93 | \\n' +\n 'Continuous | \\n' +\n 'Many | \\n' +\n 'Various\\n' +\n ' |
![\"Code](\"https://en.wikipedia.org/wiki/File:Code_128B-2009-06-02.svg\") | \\n' +\n 'Code 128 | \\n' +\n 'Continuous | \\n' +\n 'Many | \\n' +\n 'Various – International Standard ISO/IEC 15417\\n' +\n ' |
| \\n' +\n ' | CPC Binary | \\n' +\n 'Discrete | \\n' +\n 'Two | \\n' +\n '\\n' +\n ' |
![\"Dx-film-edge-barcode.jpg\"](\"https://en.wikipedia.org/wiki/File:Dx-film-edge-barcode.jpg\") | \\n' +\n 'DX film edge barcode | \\n' +\n 'Neither | \\n' +\n 'Tall/short | \\n' +\n 'Color print film\\n' +\n ' |
![\"Issn](\"https://en.wikipedia.org/wiki/File:Issn_barcode.png\") | \\n' +\n 'EAN 2 | \\n' +\n 'Continuous | \\n' +\n 'Many | \\n' +\n 'Addon code (magazines), GS1-approved – not an own symbology – to be used only with an EAN/UPC according to ISO/IEC 15420\\n' +\n ' |
![\"Isbn](\"https://en.wikipedia.org/wiki/File:Isbn_add5.png\") | \\n' +\n 'EAN 5 | \\n' +\n 'Continuous | \\n' +\n 'Many | \\n' +\n 'Addon code (books), GS1-approved – not an own symbology – to be used only with an EAN/UPC according to ISO/IEC 15420\\n' +\n ' |
![\"EAN8.svg\"](\"https://en.wikipedia.org/wiki/File:EAN8.svg\") | \\n' +\n 'EAN-8, EAN-13 | \\n' +\n 'Continuous | \\n' +\n 'Many | \\n' +\n 'Worldwide retail, GS1-approved – International Standard ISO/IEC 15420\\n' +\n ' |
| \\n' +\n ' | Facing Identification Mark | \\n' +\n 'Discrete | \\n' +\n 'Two | \\n' +\n 'USPS business reply mail\\n' +\n ' |
![\"Gs1-128](\"https://en.wikipedia.org/wiki/File:Gs1-128_example.svg\") | \\n' +\n 'GS1-128 (formerly named UCC/EAN-128), incorrectly referenced as EAN 128 and UCC 128 | \\n' +\n 'Continuous | \\n' +\n 'Many | \\n' +\n 'Various, GS1-approved – just an application of the Code 128 (ISO/IEC 15417) using the ANS MH10.8.2 AI Datastructures. It is not a separate symbology.\\n' +\n ' |
![\"Databar](\"https://en.wikipedia.org/wiki/File:Databar_14_00075678164125.png\") | \\n' +\n 'GS1 DataBar, formerly Reduced Space Symbology (RSS) | \\n' +\n 'Continuous | \\n' +\n 'Many | \\n' +\n 'Various, GS1-approved\\n' +\n ' |
![\"Intelligent](\"https://en.wikipedia.org/wiki/File:Intelligent_Mail_Barcode_Wiki22.png\") | \\n' +\n 'Intelligent Mail barcode | \\n' +\n 'Discrete | \\n' +\n '4 bar heights | \\n' +\n 'United States Postal Service, replaces both POSTNET and PLANET symbols (formerly named OneCode)\\n' +\n ' |
![\"ITF-14.svg\"](\"https://en.wikipedia.org/wiki/File:ITF-14.svg\") | \\n' +\n 'ITF-14 | \\n' +\n 'Continuous | \\n' +\n 'Two | \\n' +\n 'Non-retail packaging levels, GS1-approved – is just an Interleaved 2/5 Code (ISO/IEC 16390) with a few additional specifications, according to the GS1 General Specifications\\n' +\n ' |
![\"ITF-6](\"https://en.wikipedia.org/wiki/File:ITF-6_barcode.svg\") | \\n' +\n 'ITF-6 | \\n' +\n 'Continuous | \\n' +\n 'Two | \\n' +\n 'Interleaved 2 of 5 barcode to encode an addon to ITF-14 and ITF-16 barcodes. The code is used to encode additional data such as items quantity or container weight\\n' +\n ' |
![\"EAN-13-5901234123457.svg\"](\"https://en.wikipedia.org/wiki/File:EAN-13-5901234123457.svg\") | \\n' +\n 'JAN | \\n' +\n 'Continuous | \\n' +\n 'Many | \\n' +\n 'Used in Japan, similar to and compatible with EAN-13 (ISO/IEC 15420)\\n' +\n ' |
![\"Japan](\"https://en.wikipedia.org/wiki/File:Japan_Post_barcode.png\") | \\n' +\n 'Japan Post barcode | \\n' +\n 'Discrete | \\n' +\n '4 bar heights | \\n' +\n 'Japan Post\\n' +\n ' |
![\"KarTrak](\"https://en.wikipedia.org/wiki/File:KarTrak_ACI_codes.svg\") | \\n' +\n 'KarTrak ACI | \\n' +\n 'Discrete | \\n' +\n 'Coloured bars | \\n' +\n 'Used in North America on railroad rolling equipment\\n' +\n ' |
![\"MSI-barcode.png\"](\"https://en.wikipedia.org/wiki/File:MSI-barcode.png\") | \\n' +\n 'MSI | \\n' +\n 'Continuous | \\n' +\n 'Two | \\n' +\n 'Used for warehouse shelves and inventory\\n' +\n ' |
![\"Pharmacode](\"https://en.wikipedia.org/wiki/File:Pharmacode_example.svg\") | \\n' +\n 'Pharmacode | \\n' +\n 'Discrete | \\n' +\n 'Two | \\n' +\n 'Pharmaceutical packaging (no international standard available)\\n' +\n ' |
![\"Planet](\"https://en.wikipedia.org/wiki/File:Planet_Barcode_Format.png\") | \\n' +\n 'PLANET | \\n' +\n 'Continuous | \\n' +\n 'Tall/short | \\n' +\n 'United States Postal Service (no international standard available)\\n' +\n ' |
![\"Plessey](\"https://en.wikipedia.org/wiki/File:Plessey_barcode.svg\") | \\n' +\n 'Plessey | \\n' +\n 'Continuous | \\n' +\n 'Two | \\n' +\n 'Catalogs, store shelves, inventory (no international standard available)\\n' +\n ' |
![\"Canada](\"https://en.wikipedia.org/wiki/File:Canada_Post_d52.01_domestic_barcode.png\") | \\n' +\n 'PostBar | \\n' +\n 'Discrete | \\n' +\n '4 bar heights | \\n' +\n 'Canadian Post office\\n' +\n ' |
![\"POSTNET](\"https://en.wikipedia.org/wiki/File:POSTNET_BAR.svg\") ![\"POSTNET](\"https://en.wikipedia.org/wiki/File:POSTNET_1.svg\") ![\"POSTNET](\"https://en.wikipedia.org/wiki/File:POSTNET_2.svg\") ![\"POSTNET](\"https://en.wikipedia.org/wiki/File:POSTNET_3.svg\") ![\"POSTNET](\"https://en.wikipedia.org/wiki/File:POSTNET_BAR.png\") | \\n' +\n 'POSTNET | \\n' +\n 'Discrete | \\n' +\n 'Tall/short | \\n' +\n 'United States Postal Service (no international standard available)\\n' +\n ' |
![\"Address](\"https://en.wikipedia.org/wiki/File:Address_with_RM4SCC_barcode.svg\") | \\n' +\n 'RM4SCC / KIX | \\n' +\n 'Discrete | \\n' +\n '4 bar heights | \\n' +\n 'Royal Mail / PostNL\\n' +\n ' |
![\"Royal](\"https://en.wikipedia.org/wiki/File:Royal_Mail_mailmark_C_barcode.png\") | \\n' +\n 'RM Mailmark C | \\n' +\n 'Discrete | \\n' +\n '4 bar heights | \\n' +\n 'Royal Mail\\n' +\n ' |
![\"Royal](\"https://en.wikipedia.org/wiki/File:Royal_Mail_mailmark_L_barcode.png\") | \\n' +\n 'RM Mailmark L | \\n' +\n 'Discrete | \\n' +\n '4 bar heights | \\n' +\n 'Royal Mail\\n' +\n ' |
![\"Telepen](\"https://en.wikipedia.org/wiki/File:Telepen_barcode.png\") | \\n' +\n 'Telepen | \\n' +\n 'Continuous | \\n' +\n 'Two | \\n' +\n 'Libraries (UK)\\n' +\n ' |
![\"UPC](\"https://en.wikipedia.org/wiki/File:UPC_A.svg\") | \\n' +\n 'Universal Product Code (UPC-A and UPC-E) | \\n' +\n 'Continuous | \\n' +\n 'Many | \\n' +\n 'Worldwide retail, GS1-approved – International Standard ISO/IEC 15420\\n' +\n ' |
Matrix (2D) barcodes
\\n' +\n 'A matrix code, also termed a 2D barcode or simply a 2D code, is a two-dimensional way to represent information. It is similar to a linear (1-dimensional) barcode, but can represent more data per unit area.\\n' +\n '
\\n' +\n '| Example | \\n' +\n 'Name | \\n' +\n 'Notes\\n' +\n ' |
|---|---|---|
![\"Ar](\"https://en.wikipedia.org/wiki/File:Ar_code.png\") | \\n' +\n 'AR Code | \\n' +\n 'A type of marker used for placing content inside augmented reality applications. Some AR Codes can contain QR codes inside, so that content AR content can be linked to.[39] See also ARTag.\\n' +\n ' |
![\"Azteccodeexample.svg\"](\"https://en.wikipedia.org/wiki/File:Azteccodeexample.svg\") | \\n' +\n 'Aztec Code | \\n' +\n 'Designed by Andrew Longacre at Welch Allyn (now Honeywell Scanning and Mobility). Public domain. – International Standard: ISO/IEC 24778\\n' +\n ' |
![\"A](\"https://en.wikipedia.org/wiki/File:BCode_barcode_1683.png\") \\n' +\n ' | \\n' +\n 'bCode\\n' +\n ' | \\n' +\n 'A barcode designed for the study of insect behavior.[40] Encodes an 11 bit identifier and 16 bits of read error detection and error correction information. Predominately used for marking honey bees, but can also be applied to other animals.\\n' +\n ' |
| \\n' +\n ' | \\n' +\n 'BEEtag\\n' +\n ' | \\n' +\n 'A 25 bit (5x5) code matrix of black and white pixels that is unique to each tag surrounded by a white pixel border and a black pixel border. The 25-bit matrix consists of a 15-bit identity code, and a 10-bit error check.[41] It is designed to be a low-cost, image-based tracking system for the study of animal behavior and locomotion.\\n' +\n ' |
| \\n' +\n ' | \\n' +\n 'BeeTagg\\n' +\n ' | \\n' +\n 'A 2D barcode with honeycomb structures suitable for mobile tagging and was developed by the Swiss company connvision AG.\\n' +\n ' |
| \\n' +\n ' | \\n' +\n 'Bokode\\n' +\n ' | \\n' +\n 'A type of data tag which holds much more information than a barcode over the same area. They were developed by a team led by Ramesh Raskar at the MIT Media Lab. The bokode pattern is a tiled series of Data Matrix codes.\\n' +\n ' |
![\"Boxing](\"https://en.wikipedia.org/wiki/File:Boxing_4kv6_0.png\") \\n' +\n ' | \\n' +\n 'Boxing\\n' +\n ' | \\n' +\n 'A high-capacity 2D barcode is used on piqlFilm by Piql AS[42]\\n' +\n ' |
| \\n' +\n ' | Code 1 | \\n' +\n 'Public domain. Code 1 is currently used in the health care industry for medicine labels and the recycling industry to encode container content for sorting.[43]\\n' +\n ' |
![\"Code](\"https://en.wikipedia.org/wiki/File:Code_16K_wikipedia.png\") \\n' +\n ' | \\n' +\n 'Code 16K\\n' +\n ' | \\n' +\n 'The Code 16K (1988) is a multi-row bar code developed by Ted Williams at Laserlight Systems (USA) in 1992. In the US and France, the code is used in the electronics industry to identify chips and printed circuit boards. Medical applications in the USA are well known. Williams also developed Code 128, and the structure of 16K is based on Code 128. Not coincidentally, 128 squared happened to equal 16,000 or 16K for short. Code 16K resolved an inherent problem with Code 49. Code 49's structure requires a large amount of memory for encoding and decoding tables and algorithms. 16K is a stacked symbology.[44][45]\\n' +\n ' |
| \\n' +\n ' | ColorCode | \\n' +\n 'ColorZip[46] developed colour barcodes that can be read by camera phones from TV screens; mainly used in Korea.[47]\\n' +\n ' |
| \\n' +\n ' | Color Construct Code | \\n' +\n 'Color Construct Code is one of the few barcode symbologies designed to take advantage of multiple colors.[48][49]\\n' +\n ' |
![\"PhotoTAN](\"https://en.wikipedia.org/wiki/File:PhotoTAN_mit_Orientierungsmarkierungen.svg\") | \\n' +\n 'Cronto Visual Cryptogram\\n' +\n ' | \\n' +\n 'The Cronto Visual Cryptogram (also called photoTAN) is a specialized color barcode, spun out from research at the University of Cambridge by Igor Drokov, Steven Murdoch, and Elena Punskaya.[50] It is used for transaction signing in e-banking; the barcode contains encrypted transaction data which is then used as a challenge to compute a transaction authentication number using a security token.[51]\\n' +\n ' |
| \\n' +\n ' | CyberCode | \\n' +\n 'From Sony.\\n' +\n ' |
| \\n' +\n ' | d-touch | \\n' +\n 'readable when printed on deformable gloves and stretched and distorted[52][53]\\n' +\n ' |
| \\n' +\n ' | DataGlyphs | \\n' +\n 'From Palo Alto Research Center (also termed Xerox PARC).[54]\\n' +\n ' Patented.[55]\\n' +\n 'DataGlyphs can be embedded into a half-tone image or background shading pattern in a way that is almost perceptually invisible, similar to steganography.[56][57]\\n' +\n ' \\n' +\n ' |
![\"Datamatrix.svg\"](\"https://en.wikipedia.org/wiki/File:Datamatrix.svg\") | \\n' +\n 'Data Matrix | \\n' +\n 'From Microscan Systems, formerly RVSI Acuity CiMatrix/Siemens. Public domain. Increasingly used throughout the United States. Single segment Data Matrix is also termed Semacode. – International Standard: ISO/IEC 16022.\\n' +\n ' |
| \\n' +\n ' | Datastrip Code | \\n' +\n 'From Datastrip, Inc.\\n' +\n ' |
| \\n' +\n ' | \\n' +\n 'Digimarc Barcode\\n' +\n ' | \\n' +\n 'The Digimarc Barcode is a unique identifier, or code, based on imperceptible patterns that can be applied to marketing materials, including packaging, displays, ads in magazines, circulars, radio and television[58]\\n' +\n ' |
| \\n' +\n ' | digital paper | \\n' +\n 'patterned paper used in conjunction with a digital pen to create handwritten digital documents. The printed dot pattern uniquely identifies the position coordinates on the paper.\\n' +\n ' |
![\"DotCode](\"https://en.wikipedia.org/wiki/File:DotCode_Wikipedia.png\") | \\n' +\n 'DotCode | \\n' +\n 'Standardized as AIM Dotcode Rev 3.0. Public domain. Used to track individual cigarette and pharmaceutical packages.\\n' +\n ' |
| \\n' +\n ' | Dot Code A | \\n' +\n 'Also known as Philips Dot Code.[59] Patented in 1988.[60]\\n' +\n ' |
| \\n' +\n ' | \\n' +\n 'DWCode\\n' +\n ' | \\n' +\n 'Introduced by GS1 US and GS1 Germany, the DWCode is a unique, imperceptible data carrier that is repeated across the entire graphics design of a package[61]\\n' +\n ' |
![\"Example](\"https://en.wikipedia.org/wiki/File:EZcode_Example.png\") | \\n' +\n 'EZcode | \\n' +\n 'Designed for decoding by cameraphones;[62] from ScanLife.[63]\\n' +\n ' |
![\"Han](\"https://en.wikipedia.org/wiki/File:Han_Xin_2D_Barcode.svg\") | \\n' +\n 'Han Xin Barcode | \\n' +\n 'Barcode designed to encode Chinese characters introduced by Association for Automatic Identification and Mobility in 2011.\\n' +\n ' |
![\"High](\"https://en.wikipedia.org/wiki/File:High_Capacity_Color_Barcode_Tag.svg\") | \\n' +\n 'High Capacity Color Barcode | \\n' +\n 'HCCB was developed by Microsoft; licensed by ISAN-IA.\\n' +\n ' |
| \\n' +\n ' | HueCode | \\n' +\n 'From Robot Design Associates. Uses greyscale or colour.[64]\\n' +\n ' |
| \\n' +\n ' | InterCode | \\n' +\n 'From Iconlab, Inc. The standard 2D barcode in South Korea. All 3 South Korean mobile carriers put the scanner program of this code into their handsets to access mobile internet, as a default embedded program.\\n' +\n ' |
| \\n' +\n '
| \\n' +\n 'JAB Code\\n' +\n ' | \\n' +\n 'Just Another Bar Code is a colored 2D barcode. Square or rectangle. License free\\n' +\n ' |
![\"MaxiCode.svg\"](\"https://en.wikipedia.org/wiki/File:MaxiCode.svg\") | \\n' +\n 'MaxiCode | \\n' +\n 'Used by United Parcel Service. Now public domain.\\n' +\n ' |
| \\n' +\n ' | \\n' +\n 'mCode\\n' +\n ' | \\n' +\n 'Designed by NextCode Corporation, specifically to work with mobile phones and mobile services.[65] It is implementing an independent error detection technique preventing false decoding, it uses a variable-size error correction polynomial, which depends on the exact size of the code.[66]\\n' +\n ' |
| \\n' +\n ' | MMCC | \\n' +\n 'Designed to disseminate high capacity mobile phone content via existing colour print and electronic media, without the need for network connectivity\\n' +\n ' |
![\"NexCode.png\"](\"https://en.wikipedia.org/wiki/File:NexCode.png\") | \\n' +\n 'NexCode | \\n' +\n 'NexCode is developed and patented by S5 Systems.\\n' +\n ' |
| \\n' +\n ' | Nintendo e-Reader#Dot code | \\n' +\n 'Developed by Olympus Corporation to store songs, images, and mini-games for Game Boy Advance on Pokémon trading cards.\\n' +\n ' |
![\"Better](\"https://en.wikipedia.org/wiki/File:Better_Sample_PDF417.png\") | \\n' +\n 'PDF417 | \\n' +\n 'Originated by Symbol Technologies. Public domain. – International standard: ISO/IEC 15438\\n' +\n ' |
![\"Qode](\"https://en.wikipedia.org/wiki/File:Qode.png\") | \\n' +\n 'Qode | \\n' +\n 'American proprietary and patented 2D barcode from NeoMedia Technologies, Inc.[63]\\n' +\n ' |
![\"QR](\"https://en.wikipedia.org/wiki/File:QR_code_for_mobile_English_Wikipedia.svg\") | \\n' +\n 'QR code | \\n' +\n 'Initially developed, patented and owned by Denso Wave for automotive components management; they have chosen not to exercise their patent rights. Can encode Latin and Japanese Kanji and Kana characters, music, images, URLs, emails. De facto standard for Japanese cell phones. Used with BlackBerry Messenger to pick up contacts rather than using a PIN code. The most frequently used type of code to scan with smartphones. Public Domain. – International Standard: ISO/IEC 18004\\n' +\n ' |
| \\n' +\n ' | Screencode | \\n' +\n 'Developed and patented[67][68] by Hewlett-Packard Labs. A time-varying 2D pattern using to encode data via brightness fluctuations in an image, for the purpose of high bandwidth data transfer from computer displays to smartphones via smartphone camera input. Inventors Timothy Kindberg and John Collomosse, publicly disclosed at ACM HotMobile 2008.[69]\\n' +\n ' |
![\"Shotcode.png\"](\"https://en.wikipedia.org/wiki/File:Shotcode.png\") | \\n' +\n 'ShotCode | \\n' +\n 'Circular barcodes for camera phones. Originally from High Energy Magic Ltd in name Spotcode. Before that most likely termed TRIPCode.\\n' +\n ' |
| \\n' +\n ' | Snapcode, also called Boo-R code | \\n' +\n 'used by Snapchat, Spectacles, etc. US9111164B1[70][71][72]\\n' +\n ' |
| \\n' +\n ' | \\n' +\n 'Snowflake Code\\n' +\n ' | \\n' +\n 'A proprietary code developed by Electronic Automation Ltd. in 1981. It is possible to encode more than 100 numeric digits in a space of only 5mm x 5mm. User selectable error correction allows up to 40% of the code to be destroyed and still remain readable. The code is used in the pharmaceutical industry and has an advantage that it can be applied to products and materials in a wide variety of ways, including printed labels, ink-jet printing, laser-etching, indenting or hole punching.[44][73][74]\\n' +\n ' |
![\"SPARQCode-sample.gif\"](\"https://en.wikipedia.org/wiki/File:SPARQCode-sample.gif\") | \\n' +\n 'SPARQCode | \\n' +\n 'QR code encoding standard from MSKYNET, Inc.\\n' +\n ' |
| \\n' +\n ' | \\n' +\n 'Trillcode\\n' +\n ' | \\n' +\n 'Designed for mobile phone scanning.[75] Developed by Lark Computer, a Romanian company.[66]\\n' +\n ' |
| \\n' +\n ' | VOICEYE | \\n' +\n 'Developed and patented by VOICEYE, Inc. in South Korea, it aims to allow blind and visually impaired people to access printed information. It also claims to be the 2D barcode that has the world's largest storage capacity.\\n' +\n ' |
![\"JAB-code.png\"](\"https://en.wikipedia.org/wiki/File:JAB-code.png\")
Example images
\\n' +\n '- \\n' +\n '\\t
- First, Second and Third Generation Barcodes \\n' +\n '\\t\\t
- \\n' +\n '\\t\\t\\t\\n' +\n '\\t\\t\\t
![](\"https://upload.wikimedia.org/wikipedia/commons/thumb/5/5d/UPC-A-036000291452.png/120px-UPC-A-036000291452.png\")
\\n' +\n '\\n' +\n '\\t\\tGTIN-12 number encoded in UPC-A barcode symbol. First and last digit are always placed outside the symbol to indicate Quiet Zones that are necessary for barcode scanners to work properly\\n' +\n '
\\n' +\n '\\t\\t\\t \\n' +\n '\\t\\t - \\n' +\n '\\t\\t\\t\\n' +\n '\\t\\t\\t
![](\"https://upload.wikimedia.org/wikipedia/commons/thumb/a/a2/EAN-13-5901234123457.svg/120px-EAN-13-5901234123457.svg.png\")
\\n' +\n '\\n' +\n '\\t\\tEAN-13 (GTIN-13) number encoded in EAN-13 barcode symbol. First digit is always placed outside the symbol, additionally right quiet zone indicator (>) is used to indicate Quiet Zones that are necessary for barcode scanners to work properly\\n' +\n '
\\n' +\n '\\t\\t\\t \\n' +\n '\\t\\t - \\n' +\n '\\t\\t\\t\\n' +\n '\\t\\t\\t
![](\"https://upload.wikimedia.org/wikipedia/commons/thumb/8/86/Code93.png/120px-Code93.png\")
\\n' +\n '\\n' +\n '\\t\\t"Wikipedia" encoded in Code 93\\n' +\n '
\\n' +\n '\\t\\t\\t \\n' +\n '\\t\\t - \\n' +\n '\\t\\t\\t\\n' +\n '\\t\\t\\t
![](\"https://upload.wikimedia.org/wikipedia/commons/thumb/4/4f/Code39.png/120px-Code39.png\")
\\n' +\n '\\n' +\n '\\t\\t"*WIKI39*" encoded in Code 39\\n' +\n '
\\n' +\n '\\t\\t\\t \\n' +\n '\\t\\t - \\n' +\n '\\t\\t\\t\\n' +\n '\\t\\t\\t
![](\"https://upload.wikimedia.org/wikipedia/commons/thumb/f/f7/Wikipedia_barcode_128.svg/120px-Wikipedia_barcode_128.svg.png\")
\\n' +\n '\\n' +\n '\\t\\t'Wikipedia" encoded in Code 128\\n' +\n '
\\n' +\n '\\t\\t\\t \\n' +\n '\\t\\t - \\n' +\n '\\t\\t\\t\\n' +\n '\\t\\t\\t
![](\"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b9/Codablock-F_Example.png/120px-Codablock-F_Example.png\")
\\n' +\n '\\n' +\n '\\t\\tAn example of a stacked barcode. Specifically a "Codablock" barcode.\\n' +\n '
\\n' +\n '\\t\\t\\t \\n' +\n '\\t\\t - \\n' +\n '\\t\\t\\t\\n' +\n '\\t\\t\\t
![](\"https://upload.wikimedia.org/wikipedia/commons/thumb/0/07/Better_Sample_PDF417.png/120px-Better_Sample_PDF417.png\")
\\n' +\n '\\n' +\n '\\t\\tPDF417 sample\\n' +\n '
\\n' +\n '\\t\\t\\t \\n' +\n '\\t\\t - \\n' +\n '\\t\\t\\t\\n' +\n '\\t\\t\\t
![](\"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b6/Lorem_Ipsum.png/120px-Lorem_Ipsum.png\")
\\n' +\n '\\n' +\n '\\t\\tLorem ipsum boilerplate text as four segment Data Matrix 2D\\n' +\n '
\\n' +\n '\\t\\t\\t \\n' +\n '\\t\\t - \\n' +\n '\\t\\t\\t\\n' +\n '\\t\\t\\t
![](\"https://upload.wikimedia.org/wikipedia/commons/thumb/2/20/Azteccodeexample.svg/120px-Azteccodeexample.svg.png\")
\\n' +\n '\\n' +\n '\\t\\t"This is an example Aztec symbol for Wikipedia" encoded in Aztec Code\\n' +\n '
\\n' +\n '\\t\\t\\t \\n' +\n '\\t\\t - \\n' +\n '\\t\\t\\t\\n' +\n '\\t\\t\\t
![](\"https://upload.wikimedia.org/wikipedia/commons/9/99/EZcode.png\")
\\n' +\n '\\n' +\n '\\t\\tText 'EZcode'\\n' +\n '
\\n' +\n '\\t\\t\\t \\n' +\n '\\t\\t - \\n' +\n '\\t\\t\\t\\n' +\n '\\t\\t\\t
![](\"https://upload.wikimedia.org/wikipedia/commons/thumb/1/16/High_Capacity_Color_Barcode.png/120px-High_Capacity_Color_Barcode.png\")
\\n' +\n '\\n' +\n '\\t\\tHigh Capacity Color Barcode of the URL for Wikipedia's article on High Capacity Color Barcode\\n' +\n '
\\n' +\n '\\t\\t\\t \\n' +\n '\\t\\t - \\n' +\n '\\t\\t\\t\\n' +\n '\\t\\t\\t
![](\"https://upload.wikimedia.org/wikipedia/commons/thumb/9/92/Dataglyph511140.png/120px-Dataglyph511140.png\")
\\n' +\n '\\n' +\n '\\t\\t"Wikipedia, The Free Encyclopedia" in several languages encoded in DataGlyphs\\n' +\n '
\\n' +\n '\\t\\t\\t \\n' +\n '\\t\\t - \\n' +\n '\\t\\t\\t\\n' +\n '\\t\\t\\t
![](\"https://upload.wikimedia.org/wikipedia/commons/thumb/1/1d/35mm_film_audio_macro.jpg/120px-35mm_film_audio_macro.jpg\")
\\n' +\n '\\n' +\n '\\t\\tTwo different 2D barcodes used in film: Dolby Digital between the sprocket holes with the "Double-D" logo in the middle, and Sony Dynamic Digital Sound in the blue area to the left of the sprocket holes\\n' +\n '
\\n' +\n '\\t\\t\\t \\n' +\n '\\t\\t - \\n' +\n '\\t\\t
- \\n' +\n '\\t\\t\\t\\n' +\n '\\t\\t\\t
![](\"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b4/MaxiCode.svg/120px-MaxiCode.svg.png\")
\\n' +\n '\\n' +\n '\\t\\tMaxiCode example. This encodes the string "Wikipedia, The Free Encyclopedia"\\n' +\n '
\\n' +\n '\\t\\t\\t \\n' +\n '\\t\\t - \\n' +\n '\\t\\t\\t\\n' +\n '\\t\\t\\t
![](\"https://upload.wikimedia.org/wikipedia/commons/thumb/7/7d/Shotcode.png/120px-Shotcode.png\")
\\n' +\n '\\n' +\n '\\t\\tShotCode sample\\n' +\n '
\\n' +\n '\\t\\t\\t \\n' +\n '\\t\\t - \\n' +\n '\\t\\t\\t\\n' +\n '\\t\\t\\t
![](\"https://upload.wikimedia.org/wikipedia/commons/thumb/d/d9/Twibright_Optar_Detail_Scanned.png/120px-Twibright_Optar_Detail_Scanned.png\")
\\n' +\n '\\n' +\n '\\t\\tdetail of Twibright Optar scan from laser printed paper, carrying 32 kbit/s Ogg Vorbis digital music (48 seconds per A4 page)\\n' +\n '
\\n' +\n '\\t\\t\\t \\n' +\n '\\t\\t - \\n' +\n '\\t\\t\\t\\n' +\n '\\t\\t\\t
![](\"https://upload.wikimedia.org/wikipedia/commons/thumb/b/b3/KarTrak_code.jpg/120px-KarTrak_code.jpg\")
\\n' +\n '\\n' +\n '\\t\\tA KarTrak railroad Automatic Equipment Identification label on a caboose in Florida\\n' +\n '
\\n' +\n '\\t\\t\\t \\n' +\n '
![](\"https://en.wikipedia.org/wiki/File:UPC-A-036000291452.png\")
![](\"https://en.wikipedia.org/wiki/File:Code93.png\")
![](\"https://en.wikipedia.org/wiki/File:Code39.png\")
![](\"https://en.wikipedia.org/wiki/File:Wikipedia_barcode_128.svg\")
![](\"https://en.wikipedia.org/wiki/File:Codablock-F_Example.png\")
![](\"https://en.wikipedia.org/wiki/File:Lorem_Ipsum.png\")
![](\"https://en.wikipedia.org/wiki/File:EZcode.png\")
![](\"https://en.wikipedia.org/wiki/File:High_Capacity_Color_Barcode.png\")
![](\"https://en.wikipedia.org/wiki/File:Dataglyph511140.png\")
![](\"https://en.wikipedia.org/wiki/File:35mm_film_audio_macro.jpg\")
![](\"https://en.wikipedia.org/wiki/File:WikiQRCode.png\")
![](\"https://en.wikipedia.org/wiki/File:Twibright_Optar_Detail_Scanned.png\")
![](\"https://en.wikipedia.org/wiki/File:KarTrak_code.jpg\")
In popular culture
\\n' +\n 'In architecture, a building in Lingang New City by German architects Gerkan, Marg and Partners incorporates a barcode design,[77] as does a shopping mall called Shtrikh-kod (Russian for barcode) in Narodnaya ulitsa ("People's Street") in the Nevskiy district of St. Petersburg, Russia.[78]\\n' +\n '
In media, in 2011, the National Film Board of Canada and ARTE France launched a web documentary entitled Barcode.tv, which allows users to view films about everyday objects by scanning the product's barcode with their iPhone camera.[79][80]\\n' +\n '
In professional wrestling, the WWE stable D-Generation X incorporated a barcode into their entrance video, as well as on a T-shirt.[81][82]\\n' +\n '
In the TV series Dark Angel, the protagonist and the other transgenics in the Manticore X-series have barcodes on the back of their necks.\\n' +\n '
In video games, the protagonist of the Hitman video game series has a barcode tattoo on the back of his head. Also, QR codes can be scanned for an extra mission on Watch Dogs.\\n' +\n '
In the films Back to the Future Part II and The Handmaid's Tale, cars in the future are depicted with barcode licence plates.\\n' +\n '
In the Terminator films, Skynet burns barcodes onto the inside surface of the wrists of captive humans (in a similar location to the WW2 concentration camp tattoos) as a unique identifier.\\n' +\n '
In music, Dave Davies of The Kinks released a solo album in 1980, AFL1-3603, which featured a giant barcode on the front cover in place of the musician's head. The album's name was also the barcode number.\\n' +\n '
The April 1978 issue of Mad Magazine featured a giant barcode on the cover, with the blurb "[Mad] Hopes this issue jams up every computer in the country...for forcing us to deface our covers with this yecchy UPC symbol from now on!"\\n' +\n '
The 2018 videogame Judgment features QR Codes that protagonist Takayuki Yagami can photograph with his phone camera. These are mostly to unlock parts for Yagami's Drone.[83]\\n' +\n '
Interactive Textbooks were first published by Harcourt College Publishers to Expand Education Technology with Interactive Textbooks.[84]\\n' +\n '
\\n' +\n 'Designed barcodes
\\n' +\n 'Some brands integrate custom designs into barcodes (while keeping them readable) on their consumer products.\\n' +\n '
\\n' +\n '- \\n' +\n '\\t\\t
- \\n' +\n '\\t\\t\\t\\n' +\n '\\t\\t\\t
![\"Design](\"https://upload.wikimedia.org/wikipedia/commons/thumb/4/42/Design_Barcode_Grasvodka_IMG_5574.JPG/116px-Design_Barcode_Grasvodka_IMG_5574.JPG\")
\\n' +\n '\\t\\t\\t\\n' +\n '\\t\\t \\n' +\n '\\t\\t - \\n' +\n '\\t\\t\\t\\n' +\n '\\t\\t\\t
![\"Barcode](\"https://upload.wikimedia.org/wikipedia/commons/thumb/4/45/Barcode_Tall_Horse1.jpg/120px-Barcode_Tall_Horse1.jpg\")
\\n' +\n '\\t\\t\\t\\n' +\n '\\t\\t \\n' +\n '\\t\\t - \\n' +\n '\\t\\t\\t\\n' +\n '\\t\\t\\t
![\"Hühner-Bouillon](\"https://upload.wikimedia.org/wikipedia/commons/thumb/a/ad/H%C3%BChner-Bouillon_K_Designbarcode_4337185009907_IMG_8716.jpg/115px-H%C3%BChner-Bouillon_K_Designbarcode_4337185009907_IMG_8716.jpg\")
\\n' +\n '\\t\\t\\t\\n' +\n '\\t\\t \\n' +\n '\\t\\t - \\n' +\n '\\t\\t\\t\\n' +\n '\\t\\t\\t
![\"Sardinendose](\"https://upload.wikimedia.org/wikipedia/commons/thumb/9/98/Sardinendose_K_Barcode_Art_valid_IMG11829.jpg/120px-Sardinendose_K_Barcode_Art_valid_IMG11829.jpg\")
\\n' +\n '\\t\\t\\t\\n' +\n '\\t\\t \\n' +\n '\\t\\t - \\n' +\n '\\t\\t\\t\\n' +\n '\\t\\t\\t
![\"Barcode](\"https://upload.wikimedia.org/wikipedia/commons/thumb/6/63/Barcode_peanut.jpg/120px-Barcode_peanut.jpg\")
\\n' +\n '\\t\\t\\t\\n' +\n '\\t\\t \\n' +\n '
![\"Design](\"https://en.wikipedia.org/wiki/File:Design_Barcode_Grasvodka_IMG_5574.JPG\")
![\"Barcode](\"https://en.wikipedia.org/wiki/File:Barcode_Tall_Horse1.jpg\")
![\"Hühner-Bouillon](\"https://en.wikipedia.org/wiki/File:H%C3%BChner-Bouillon_K_Designbarcode_4337185009907_IMG_8716.jpg\")
![\"Sardinendose](\"https://en.wikipedia.org/wiki/File:Sardinendose_K_Barcode_Art_valid_IMG11829.jpg\")
![\"Barcode](\"https://en.wikipedia.org/wiki/File:Barcode_peanut.jpg\")
![](\"https://en.wikipedia.org/wiki/File:Bitcoin_logo.svg\"){kind=link}
![](\"https://en.wikipedia.org/wiki/File:Bitcoin-core-v0.10.0.png\"){kind=link}
![Shtrikh-kod](\"https://web.archive.org/web/20111026031424/http://www.marlen-dress.ru/img/schtrih-kod.jpg\"){kind=link}
Hoaxes about barcodes
\\n' +\n 'There was minor skepticism from conspiracy theorists, who considered barcodes to be an intrusive surveillance technology, and from some Christians, pioneered by a 1982 book The New Money System 666 by Mary Stewart Relfe, who thought the codes hid the number 666, representing the "Number of the Beast".[85] Old Believers, a separation of the Russian Orthodox Church, believe barcodes are the stamp of the Antichrist.[86] Television host Phil Donahue described barcodes as a "corporate plot against consumers".[87]\\n' +\n '
\\n' +\n 'See also
\\n' +\n '- Automated identification and data capture (AIDC) \\n' +\n '
- Barcode printer \\n' +\n '
- European Article Numbering-Uniform Code Council \\n' +\n '
- Global Trade Item Number \\n' +\n '
- Identifier \\n' +\n '
- Inventory control system \\n' +\n '
- Object hyperlinking \\n' +\n '
- Semacode \\n' +\n '
- SMS barcode \\n' +\n '
- SPARQCode (QR code) \\n' +\n '
- List of GS1 country codes
References
\\n' +\n '\\n' +\n '
\\n' +\n '- \\n' +\n '
- ^ a b US patent 2612994 \\n' +\n ' \\n' +\n '
- ^ "How Barcodes Work". Stuff You Should Know. 4 June 2019. Retrieved 5 June 2019.\\n' +\n ' \\n' +\n '
- ^ a b Cranstone, Ian. "A guide to ACI (Automatic Car Identification)/KarTrak". Canadian Freight Cars A resource page for the Canadian Freight Car Enthusiast. Retrieved 26 May 2013.\\n' +\n ' \\n' +\n '
- ^ Keyes, John (22 August 2003). "KarTrak". John Keyes Boston photoblogger. Images from Boston, New England, and beyond. John Keyes. Archived from the original on 10 March 2014. Retrieved 26 May 2013.\\n' +\n ' \\n' +\n '
- ^ a b Roberts, Sam (11 December 2019). "George Laurer, Who Developed the Bar Code, Is Dead at 94". New York Times. Retrieved 13 December 2019.\\n' +\n ' \\n' +\n '
- ^ Fox, Margalit (15 June 2011). "Alan Haberman, Who Ushered in the Bar Code, Dies at 81". New York Times.\\n' +\n ' \\n' +\n '
- ^ G. F. (2 November 2017). "Why QR codes are on the rise". The Economist. Retrieved 5 February 2018.\\n' +\n ' \\n' +\n '
- ^ Fishman, Charles (1 August 2001). "The Killer App – Bar None". American Way. Archived from the original on 12 January 2010. Retrieved 19 April 2010.\\n' +\n ' \\n' +\n '
- ^ a b c d e f Seideman, Tony (Spring 1993), "Barcodes Sweep the World", Wonders of Modern Technology, archived from the original on 16 October 2016\\n' +\n ' \\n' +\n '
- ^ Dunn, Peter (20 October 2015). "David Collins, SM '59: Making his mark on the world with bar codes". technologyreview.com. MIT. Retrieved 2 December 2019.\\n' +\n ' \\n' +\n '
- ^ Graham-White, Sean (August 1999). "Do You Know Where Your Boxcar Is?". Trains. 59 (8): 48–53.\\n' +\n ' \\n' +\n '
- ^ Laurer, George. "Development of the U.P.C. Symbol". Archived from the original on 25 September 2008.\\n' +\n ' \\n' +\n '
- ^ Nelson, Benjamin (1997). Punched Cards To Bar Codes: A 200-year journey. Peterborough, N.H.: Helmers. ISBN 9780911261127.\\n' +\n ' \\n' +\n '
- ^ a b Varchaver, Nicholas (31 May 2004). "Scanning the Globe". Fortune. Archived from the original on 14 November 2006. Retrieved 27 November 2006.\\n' +\n ' \\n' +\n '
- ^ a b Selmeier, Bill (2009). Spreading the Barcode. Lulu. pp. 26, 214, 236, 238, 244, 245, 236, 238, 244, 245. ISBN 978-0-578-02417-2.\\n' +\n ' \\n' +\n '
- ^ Rawsthorn, Alice (23 February 2010). "Scan Artists". New York Times. Retrieved 31 July 2015.\\n' +\n ' \\n' +\n '
- ^ "World hails barcode on important birthday". ATN. 1 July 2014.\\n' +\n ' \\n' +\n '
- ^ "A Short History of Bar Code". BarCode 1. Adams Communications. Retrieved 28 November 2011.\\n' +\n ' \\n' +\n '
- ^ "Barcode". iWatch Systems. 2 May 2011. Retrieved 28 November 2011.\\n' +\n ' \\n' +\n '
- ^ Oberfield, Craig. "QNotes Barcode System". US Patented #5296688. Quick Notes Inc. Retrieved 15 December 2012.\\n' +\n ' \\n' +\n '
- ^ National Geographic, May 2010, page 30\\n' +\n ' \\n' +\n '
- ^ Hecht, David L. (March 2001). "Printed Embedded Data Graphical User Interfaces" (PDF). IEEE Computer. Xerox Palo Alto Research Center. 34 (3): 47–55. doi:10.1109/2.910893. Archived from the original (PDF) on 3 June 2013.\\n' +\n ' \\n' +\n '
- ^ Howell, Jon; Kotay, Keith (March 2000). "Landmarks for absolute localization". Dartmouth Computer Science Technical Report TR2000-364.\\n' +\n ' \\n' +\n '
- ^ "IATA.org". IATA.org. 21 November 2011. Retrieved 28 November 2011.\\n' +\n ' \\n' +\n '
- ^ "Paperbyte Bar Codes for Waduzitdo". Byte magazine. September 1978. p. 172.\\n' +\n ' \\n' +\n '
- ^ "Nokia N80 Support". Nokia Europe. Archived from the original on 14 July 2011.\\n' +\n ' \\n' +\n '
- ^ "package overview for mbarcode". Maemo.org. Retrieved 28 July 2010.\\n' +\n ' \\n' +\n '
- ^ Sargent, Mikah (24 September 2017). "How to use QR codes in iOS 11". iMore. Retrieved 1 October 2017.\\n' +\n ' \\n' +\n '
- ^ "15+ Best Barcode Scanner iPhone Applications". iPhoneness. 3 March 2017. Retrieved 1 October 2017.\\n' +\n ' \\n' +\n '
- ^ David, H (28 November 2018), "Barcodes – Validation vs Verification in GS1", Labeling News, retrieved 6 June 2020\\n' +\n ' \\n' +\n '
- ^ "Layman's Guide to ANSI, CEN, and ISO Barcode Print Quality Documents" (PDF). Association for Automatic Identification and Data Capture Technologies (AIM). 2002. Retrieved 23 November 2017.\\n' +\n ' \\n' +\n '
- ^ Zieger, Anne (October 2003). "Retailer chargebacks: is there an upside? Retailer compliance initiatives can lead to efficiency". Frontline Solutions. Archived from the original on 8 July 2012.\\n' +\n ' \\n' +\n '
- ^ a b c d e f g h i j k l Corp, Express. "Barcode Glossary | Express". Express Corp. Retrieved 11 December 2019.\\n' +\n ' \\n' +\n '
- ^ Bar Code Verification Best Practice work team (May 2010). "GS1 DataMatrix: An introduction and technical overview of the most advanced GS1 Application Identifiers compliant symbology" (PDF). Global Standards 1. 1 (17): 34–36. Archived (PDF) from the original on 20 July 2011. Retrieved 2 August 2011.\\n' +\n ' \\n' +\n '
- ^ GS1 Bar Code Verification Best Practice work team (May 2009). "GS1 Bar Code Verification for Linear Symbols" (PDF). Global Standards 1. 4 (3): 23–32. Retrieved 2 August 2011.\\n' +\n ' \\n' +\n '
- ^ Garner, J (2019), Results of Data Matrix Barcode Testing for Field Applications, Oak Ridge National Laboratory, retrieved 6 June 2020\\n' +\n ' \\n' +\n '
- ^ "Technical committees – JTC 1/SC 31 – Automatic identification and data capture techniques". ISO. Retrieved 28 November 2011.\\n' +\n ' \\n' +\n '
- ^ Harmon, Craig K.; Adams, Russ (1989). Reading Between The Lines:An Introduction to Bar Code Technology. Peterborough, NH: Helmers. p. 13. ISBN 0-911261-00-1.\\n' +\n ' \\n' +\n '
- ^ "AR Code Generator"\\n' +\n ' \\n' +\n '
- ^ Gernat, Tim; Rao, Vikyath D.; Middendorf, Martin; Dankowicz, Harry; Goldenfeld, Nigel; Robinson, Gene E. (13 February 2018). "Automated monitoring of behavior reveals bursty interaction patterns and rapid spreading dynamics in honeybee social networks". Proceedings of the National Academy of Sciences. 115 (7): 1433–1438. doi:10.1073/pnas.1713568115. ISSN 0027-8424. PMC 5816157. PMID 29378954.\\n' +\n ' \\n' +\n '
- ^ Combes, Stacey A.; Mountcastle, Andrew M.; Gravish, Nick; Crall, James D. (2 September 2015). "BEEtag: A Low-Cost, Image-Based Tracking System for the Study of Animal Behavior and Locomotion". PLOS ONE. 10 (9): e0136487. Bibcode:2015PLoSO..1036487C. doi:10.1371/journal.pone.0136487. ISSN 1932-6203. PMC 4558030. PMID 26332211.\\n' +\n ' \\n' +\n '
- ^ https://github.com/piql/boxing\\n' +\n ' \\n' +\n '
- ^ Adams, Russ (15 June 2009). "2-Dimensional Bar Code Page". Archived from the original on 7 July 2011. Retrieved 6 June 2011.\\n' +\n ' \\n' +\n '
- ^ a b "2-Dimensional Bar Code Page". www.adams1.com. Retrieved 12 January 2019.\\n' +\n ' \\n' +\n '
- ^ "Code 16K Specs" (PDF). www.gomaro.ch. Retrieved 12 January 2019.\\n' +\n ' \\n' +\n '
- ^ "Colorzip.com". Colorzip.com. Retrieved 28 November 2011.\\n' +\n ' \\n' +\n '
- ^ "Barcodes for TV Commercials". Adverlab. 31 January 2006. Retrieved 10 June 2009.\\n' +\n ' \\n' +\n '
- ^ "About". Colour Code Technologies. Archived from the original on 29 August 2012. Retrieved 4 November 2012.\\n' +\n ' \\n' +\n '
- ^ "Frequently Asked Questions". ColorCCode. Archived from the original on 21 February 2013. Retrieved 4 November 2012.\\n' +\n ' \\n' +\n '
- ^ "New system to combat online banking fraud". University of Cambridge. 18 April 2013. Retrieved 21 January 2020.\\n' +\n ' \\n' +\n '
- ^ Cronto Visual Transaction Signing, OneSpan, retrieved 6 December 2019\\n' +\n ' \\n' +\n '
- ^ d-touch topological fiducial recognition, MIT, archived from the original on 2 March 2008.\\n' +\n ' \\n' +\n '
- ^ d-touch markers are applied to deformable gloves, MIT, archived from the original on 21 June 2008.\\n' +\n ' \\n' +\n '
- ^ See Xerox.com for details.\\n' +\n ' \\n' +\n '
- ^ "DataGlyphs: Embedding Digital Data". Microglyphs. 3 May 2006. Retrieved 10 March 2014.\\n' +\n ' \\n' +\n '
- ^ ""DataGlyph" Embedded Digital Data". Tauzero. Retrieved 10 March 2014.\\n' +\n ' \\n' +\n '
- ^ "DataGlyphs". Xerox. Retrieved 10 March 2014.\\n' +\n ' \\n' +\n '
- ^ "Better Barcodes, Better Business" (PDF).\\n' +\n ' \\n' +\n '
- ^ Dot Code A at barcode.ro\\n' +\n ' \\n' +\n '
- ^ Dot Code A Patent\\n' +\n ' \\n' +\n '
- ^ "GS1 Germany and Digimarc Announce Collaboration to Bring DWCode to the German Market".\\n' +\n ' \\n' +\n '
- ^ "Scanbuy". Retrieved 28 November 2011.\\n' +\n ' \\n' +\n '
- ^ a b Steeman, Jeroen. "Online QR Code Decoder". Archived from the original on 9 January 2014. Retrieved 9 January 2014.\\n' +\n ' \\n' +\n '
- ^ "BarCode-1 2-Dimensional Bar Code Page". Adams. Archived from the original on 3 November 2008. Retrieved 10 June 2009.\\n' +\n ' \\n' +\n '
- ^ "Global Research Solutions – 2D Barcodes". grs.weebly.com. Retrieved 12 January 2019.\\n' +\n ' \\n' +\n '
- ^ a b Kato, Hiroko; Tan, Keng T.; Chai, Douglas (8 April 2010). Barcodes for Mobile Devices. Cambridge University Press. ISBN 9781139487511.\\n' +\n ' \\n' +\n '
- ^ \\n' +\n '"US Patent 9270846: Content encoded luminosity modulation"\\n' +\n ' \\n' +\n '
- ^ \\n' +\n '"US Patent 8180163: Encoder and decoder and methods of encoding and decoding sequence information with inserted monitor flags"\\n' +\n ' \\n' +\n '
- ^ \\n' +\n '"Screen Codes: Visual Hyperlinks for Displays"\\n' +\n ' \\n' +\n '
- ^ \\n' +\n '"Snapchat is changing the way you watch snaps and add friends"\\n' +\n ' \\n' +\n '
- ^ \\n' +\n '"Snapchat Lets You Add People Via QR Snaptags Thanks To Secret Scan.me Acquisition"\\n' +\n ' \\n' +\n '
- ^ \\n' +\n '"How Snapchat Made QR Codes Cool Again"\\n' +\n ' \\n' +\n '
- ^ 5825015, Chan, John Paul & GB, "United States Patent: 5825015 – Machine readable binary codes", issued 20 October 1998 \\n' +\n ' \\n' +\n '
- ^ "US Patent 5825015". pdfpiw.uspto.gov. 20 October 1998. Retrieved 12 January 2019.\\n' +\n ' \\n' +\n '
- ^ "Trillcode Barcode". Barcoding, Inc. 17 February 2009. Retrieved 12 January 2019.\\n' +\n ' \\n' +\n '
- ^ (株)デンソーウェーブ, denso-wave.com (in Japanese) Copyright\\n' +\n ' \\n' +\n '
- ^ Barcode Halls – gmp Archived 18 October 2011 at the Wayback Machine\\n' +\n ' \\n' +\n '
- ^ "image". Peterburg2.ru. Retrieved 28 November 2011.\\n' +\n ' \\n' +\n '
- ^ Lavigne, Anne-Marie (5 October 2011). "Introducing Barcode.tv, a new interactive doc about the objects that surround us". NFB Blog. National Film Board of Canada. Retrieved 7 October 2011.\\n' +\n ' \\n' +\n '
- ^ Anderson, Kelly (6 October 2011). "NFB, ARTE France launch 'Bar Code'". Reelscreen. Retrieved 7 October 2011.\\n' +\n ' \\n' +\n '
- ^ [1] Archived 16 March 2015 at the Wayback Machine\\n' +\n ' \\n' +\n '
- ^ "Dx theme song 2009–2010". YouTube. 19 December 2009. Retrieved 10 March 2014.\\n' +\n ' \\n' +\n '
- ^ Diego Agruello (27 June 2019). "Judgment QR code locations to upgrade Drone Parts explained • Eurogamer.net". Retrieved 3 August 2019.\\n' +\n ' \\n' +\n '
- ^ "CueCat History". CueCat History. Retrieved 12 November 2019.\\n' +\n ' \\n' +\n '
- ^ "What about barcodes and 666: The Mark of the Beast?". Av1611.org. 1999. Retrieved 14 March 2014.\\n' +\n ' \\n' +\n '
- ^ Serafino, Jay (26 July 2018). "The Russian Family That Cut Itself Off From Civilization for More Than 40 Years". Mental Floss. Retrieved 6 May 2020.\\n' +\n ' \\n' +\n '
- ^ Bishop, Tricia (5 July 2004). "UPC bar code has been in use 30 years". SFgate.com. Archived from the original on 23 August 2004. Retrieved 22 December 2009.\\n' +\n ' \\n' +\n '
Further reading
\\n' +\n '\\n' +\n '
\\n' +\n '- Automating Management Information Systems: Barcode Engineering and Implementation – Harry E. Burke, Thomson Learning, ISBN 0-442-20712-3 \\n' +\n '
- Automating Management Information Systems: Principles of Barcode Applications – Harry E. Burke, Thomson Learning, ISBN 0-442-20667-4 \\n' +\n '
- The Bar Code Book – Roger C. Palmer, Helmers Publishing, ISBN 0-911261-09-5, 386 pages \\n' +\n '
- The Bar Code Manual – Eugene F. Brighan, Thompson Learning, ISBN 0-03-016173-8 \\n' +\n '
- Handbook of Bar Coding Systems – Harry E. Burke, Van Nostrand Reinhold Company, ISBN 978-0-442-21430-2, 219 pages \\n' +\n '
- Information Technology for Retail:Automatic Identification & Data Capture Systems – Girdhar Joshi, Oxford University Press, ISBN 0-19-569796-0, 416 pages \\n' +\n '
- Lines of Communication – Craig K. Harmon, Helmers Publishing, ISBN 0-911261-07-9, 425 pages \\n' +\n '
- Punched Cards to Bar Codes – Benjamin Nelson, Helmers Publishing, ISBN 0-911261-12-5, 434 pages \\n' +\n '
- Revolution at the Checkout Counter: The Explosion of the Bar Code – Stephen A. Brown, Harvard University Press, ISBN 0-674-76720-9 \\n' +\n '
- Reading Between The Lines – Craig K. Harmon and Russ Adams, Helmers Publishing, ISBN 0-911261-00-1, 297 pages \\n' +\n '
- The Black and White Solution: Bar Code and the IBM PC – Russ Adams and Joyce Lane, Helmers Publishing, ISBN 0-911261-01-X, 169 pages \\n' +\n '
- Sourcebook of Automatic Identification and Data Collection – Russ Adams, Van Nostrand Reinhold, ISBN 0-442-31850-2, 298 pages \\n' +\n '
- Inside Out: The Wonders of Modern Technology – Carol J. Amato, Smithmark Pub, ISBN 0831746572, 1993
External links
\\n' +\n ' | \\n' +\n 'Wikimedia Commons has media related to Barcode. |
Bitcoin
Bitcoin is invented by satoshi nakomoto
it is powered by mining
\", \"https://google.com\")\n print(readablity)\n content_lines = trim_content(readablity[\"data\"][\"content\"])\n if content_lines[\"success\"] == True:\n print(content_lines[\"result\"])" }, { "path": "aquila/view/.dockerignore", "content": "node_modules\n.env*\n.next" }, { "path": "aquila/view/.eslintrc.json", "content": "{\n \"extends\": \"next/core-web-vitals\"\n}\n" }, { "path": "aquila/view/@types/next-auth.d.ts", "content": "import { DefaultSession } from \"next-auth\";\n\ndeclare module \"next-auth\" {\n interface User {\n customerId: string;\n firstName: string;\n lastName: string;\n createdAt: string;\n accountStatus: string;\n token: string;\n }\n\n interface Session {\n user: {\n customerId: string;\n firstName: string;\n lastName: string;\n createdAt: string;\n accountStatus: string;\n token: string;\n } & DefaultSession \n } \n}\n\ndeclare module \"next-auth/jwt\" {\n interface JWT {\n customerId: string;\n firstName: string;\n lastName: string;\n createdAt: string;\n accountStatus: string;\n token: string;\n }\n}" }, { "path": "aquila/view/Dockerfile", "content": "FROM node:16-alpine as builder\n\nARG NEXTAUTH_URL\nARG NEXTAUTH_SECRET\nARG NEXT_PUBLIC_AQUILA_API_URL\nARG NEXT_PUBLIC_BASE_URL\nARG NODE_ENV=production\n\nWORKDIR /app\n\nCOPY . .\n\nENV NEXTAUTH_URL=$NEXTAUTH_URL\nENV NEXTAUTH_SECRET=$NEXTAUTH_SECRET\nENV NEXT_PUBLIC_AQUILA_API_URL=$NEXT_PUBLIC_AQUILA_API_URL\nENV NEXT_PUBLIC_BASE_URL=$NEXT_PUBLIC_BASE_URL\n\nRUN yarn --frozen-lockfile\n\nRUN NODE_ENV=${NODE_ENV} yarn build\n\n\nFROM node:16-alpine\n\nWORKDIR /app\n\nCOPY --from=builder /app/next.config.js ./\nCOPY --from=builder /app/.next/standalone ./\nCOPY --from=builder /app/.next/static ./.next/static\n\nENV NEXT_TELEMETRY_DISABLED 1\n\nEXPOSE 3000\n\nCMD [\"node\", \"server.js\"]" }, { "path": "aquila/view/README.md", "content": "# Aquila-Network-UI\n\n\n# ⚠️ Server and other Credentials are in workflow file.\nNever Make this Repo Public\n\n## Getting Started\n\nFirst, run the development server:\n\n```bash\nnpm run dev\n# or\nyarn dev\n```\n\n## Docker Deploy\n\n```bash\ndocker build --build-arg NEXTAUTH_URL=http://localhost:3000 --build-arg NEXTAUTH_SECRET=secret --build-arg NEXT_PUBLIC_AQUILA_API_URL=https://aquila.api/url --build-arg NEXT_PUBLIC_BASE_URL=http://localhost:3000 -t aquila-network/aquila-network-ui .\n```\n" }, { "path": "aquila/view/components/hoc/InitComponent.tsx", "content": "import { signOut, useSession, getSession } from \"next-auth/react\";\nimport { FC, useEffect } from \"react\";\nimport { useAppDispatch } from \"../../store\";\nimport { signIn, signOut as signOutAction } from \"../../store/slices/auth\";\n\ninterface InitCompoentProps {\n children: React.ReactNode;\n}\n\nconst InitComponent: FC\n\t\t\t\t
\n\t\t\n\t\t\t\t\t
\n\t\t\t\n\t\t\t\t\t\t
\n\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t
\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
\n\t\t\t\t\t\n\t\t\t\t\t\t{props.children}\n\t\t\t\t\t
\n\t\t\t\t\n
\n \n
\n {name}
\nYour account
\n- \n
- \n \n Edit Profile\n \n \n {/*
- \n \n General\n \n */}\n
e.stopPropagation()}>\n onClose()} className={classes[\"add-link__close\"]}>\n
\n \n
\n \n Add Link
\n\n\t\t\t\t\n\t\t\t\t
\n\t\t\t}\n\t\t\t\n\t\t\n\t);\n}\n\nexport default Footer;"
},
{
"path": "aquila/view/components/layout/main/Header.module.scss",
"content": ".header {\n padding: 20px 0px;\n\n &__container {\n margin: auto;\n display: flex;\n justify-content: space-between;\n align-items: center;\n }\n\n &__brand-contaner {\n order: 1;\n }\n\n &__brand-link {\n display: flex;\n text-decoration: none;\n align-items: center;\n }\n\n &__brand-img-container {\n width: 50px;\n }\n\n &__brand-text {\n font-size: 16px;\n font-weight: 500;\n color: #202A38;\n }\n\n &__nav-container {\n order: 3;\n }\n\n &__nav-list-container {\n display: flex;\n list-style: none;\n align-items: center;\n gap: 10px;\n }\n\n &__nav-mobile-menu-close {\n display: none;\n border: none;\n outline: none;\n background: none;\n cursor: pointer;\n font-size: 24px;\n }\n\n &__nav-list-item {\n position: relative;\n }\n\n &__nav-list-item--mobile-menu {\n display: none;\n }\n\n &__nav-list-link {\n text-decoration: none;\n color: #202A38;\n transition: all .3;\n cursor: pointer;\n font-weight: 500\n }\n\n &__nav-list-link--active {\n color: #0FBD86;\n }\n\n &__nav-list-link:hover {\n color: #0FBD86;\n }\n\n &__nav-dropdown {\n position: absolute;\n list-style: none;\n padding: 0px;\n background: #fff;\n min-width: 150px;\n right: 0px;\n margin-top: 10px;\n box-shadow: rgba(0, 0, 0, 0.1) 0px 10px 50px;\n // box-shadow: rgba(50, 50, 93, 0.25) 0px 13px 27px -5px, rgba(0, 0, 0, 0.3) 0px 8px 16px -8px;\n }\n\n &__nav-dropdown::before {\n content: '';\n width: 0px;\n height: 0px;\n border: 10px solid #fff;\n border-left-color: transparent;\n border-right-color: transparent;\n border-top-color: transparent;\n position: absolute;\n top: -20px;\n right: 10px;\n }\n\n &__nav-dropdown-link {\n text-decoration: none;\n color: #202A38;\n font-size: 14px;\n display: block;\n padding: 10px 20px;\n }\n\n &__nav-dropdown-link:hover {\n background: #EFF2F6;\n }\n\n &__mobile-menu-btn-container {\n order: 2;\n display: none;\n }\n\n &__mobile-menu-btn {\n border: none;\n outline: none;\n background: none;\n cursor: pointer;\n font-size: 25px;\n }\n}\n\n@media only screen and (max-width: 768px) {\n .header {\n &__mobile-menu-btn-container {\n display: block;\n }\n\n &__nav-container {\n position:fixed;\n width: 100vw;\n height: 100vh;\n left: 0px;\n right: 0px;\n top: 0px;\n bottom: 0px;\n z-index: 200;\n background: #fff;\n display: none;\n }\n\n &__nav-container--show {\n display: block\n }\n\n &__nav-list-container {\n height: 100%;\n flex-direction: column;\n justify-content: center;\n }\n\n &__nav-mobile-menu-close {\n display: block;\n position: absolute;\n top: 20px;\n right: 20px;\n }\n\n &__nav-list-item {\n padding: 20px 0px;\n }\n\n &__nav-list-item--profile-item {\n display: none;\n }\n\n &__nav-list-item--mobile-menu {\n display: block;\n }\n\n &__mobile-menu-btn {\n\n }\n }\n}"
},
{
"path": "aquila/view/components/layout/main/Header.tsx",
"content": "import Image from \"next/image\";\nimport Link from \"next/link\";\nimport { FC, useState } from \"react\";\nimport Avatar from 'boring-avatars';\nimport { FiMenu, FiX } from 'react-icons/fi';\n\nimport Logo from '../../../public/img/logo.png';\nimport classes from './Header.module.scss';\nimport Container from \"../../ui/layout/Container\";\nimport Modal from \"../../ui/modal/Modal\";\nimport AddLink from \"./AddLink\";\nimport { useRouter } from \"next/router\";\nimport { AppState } from \"../../../store\";\n\ninterface HeaderProps {\n\tonSignOut: Function\n\tonSubmitAddLink: Function\n\tisAuth: boolean;\n\taddLinkState: AppState[\"addLink\"];\n\tsignedInUser: {\n\t\tfirstName: string;\n\t\tlastName: string;\n\t} | null;\n}\n\n\nconst Header: FC{`Your Account is temporary and will be deleted automatically on ${accountExpiryData}.`}Please Activate you account
\n\t\t\t\n\t\t\t\t\t\t
\n\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t
\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t
\n\t\t\t\t\t\t\t\t\tAQUILA NETWORK
\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
\n\t\t\t\t\t\n\t\t\t\t
\n\t)\n}\n\nexport default MainLayout;"
},
{
"path": "aquila/view/components/pages/account/editProfile/EditProfileForm.module.scss",
"content": ".edit-profile-form {\n &__form-group {\n margin-bottom: 15px;\n }\n\n &__form-label {\n display: block;\n margin-bottom: 5px;\n font-size: 18px;\n }\n\n &__form-control {\n width: 100%;\n padding: 8px 5px;\n box-sizing: border-box;\n }\n\n &__form-control-error {\n color: #F87272;\n margin-top: 5px;\n font-size: 12px;\n }\n\n &__form-btn {\n padding: 5px 10px;\n background: #fff;\n outline: none;\n border-radius: 3px;\n font-size: 16px;\n transition: all .3s;\n border: 1px solid #202A38;\n cursor: pointer;\n display: flex;\n align-items: center;\n } \n\n &__form-btn:hover {\n border-color: #36D399;\n color: #36D399;\n }\n\n &__form-btn:disabled {\n border-color: #6D87AC;\n color: #6D87AC;\n cursor:not-allowed;\n }\n}"
},
{
"path": "aquila/view/components/pages/account/editProfile/EditProfileForm.tsx",
"content": "import { FC, useEffect } from 'react';\nimport { useForm } from 'react-hook-form';\nimport { AppState } from '../../../../store';\n\nimport { Customer } from '../../../../store/slices/types/Customer';\nimport classes from './EditProfileForm.module.scss';\n\ninterface EditProfileFormProps {\n customer: Customer;\n accountStatus: string | null;\n onSubmit: Function;\n activateCustomerState: AppState[\"activateCustomer\"];\n updateCustomerState: AppState[\"updateCustomer\"];\n}\n\ninterface EditProfileFormData {\n firstName: string;\n lastName: string;\n email: string;\n desc: string;\n lightningAddress: string;\n}\n\nconst EditProfileForm: FC\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t \n\t\t\t\t\t{children} \n\t\t\t\t
\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t \n\t\t\t\t
\n\t\t\tEdit Profile
\n\n {props.authState.accountStatus === \"TEMPORARY\" &&\n
\n \n
\n }\n {props.currentLoggedInCustomerState.status === \"pending\" && \n \n \n \n \n \n {collection && customer && \n
\n \n
\n \n {bookmarksState.status === \"pending\" &&
\n \n\t\t\t\n\t\t
\n\t)\n}\n\nexport default SearchBar;"
},
{
"path": "aquila/view/components/pages/collection/bookmark/CollectionBookmarks/SearchPageProfile.module.scss",
"content": ".search-profile {\n\tpadding: 15px;\n\tmargin-top: 20px;\n\tborder: 1px solid #CED7E3;\n\tbackground: #fff;\n\tborder-radius: 3px;\n\n\t&__header {\n\t\tdisplay: flex;\n\t\tjustify-content: space-between;\n\t\tmargin-bottom: 10px;\n\t}\n\n\t&__header-subscribe-btn {\n\t\tmargin-top: 5px;\n\t\tbackground: transparent;\n\t\tborder: 1px solid #8DA2BE;\n\t\toutline: none;\n\t\tborder-radius: 3px;\n\t\tcolor: #2E3D51;\n\t\ttransition: all .3s;\n\t\tcursor: pointer;\n\t}\n\n\t&__header-subscribe-btn:hover {\n\t\tcolor: #0FBD86;\n\t\tborder-color: #0FBD86;\n\t}\n\n\t&__header-subscribe-btn:disabled {\n\t\tcolor: #CED7E3;\n\t\tborder-color: #CED7E3;\n\t}\n\n\t&__header-avatar {\n\t\twidth: 80px;\n\t}\n\n\t&__header-left {\n\t\tdisplay: flex;\n\t\tflex-direction: column;\n\t\tgap: 10px;\n\t}\n\n\t&__header-name {\n\t\tcolor: #202A38;\n\t\tfont-size: 25px;\n\t}\n\n\t&__body-desc {\n\t\tcolor: #415572;\n\t\tmargin: 0px;\n\t\tfont-size: 14px;\n\t\tmargin-bottom: 20px;\n\t}\n\n\t&__body-bookmark-title {\n\t\tfont-size: 14px;\n\t\tmargin-bottom: 5px;\n\t\tcolor: #415572;\n\t}\n\n\t&__body-share-bookmark-box {\n\t\toverflow: hidden;\n\t\tbackground: #EFF2F6;\n\t\tposition: relative;\n\t\tbox-sizing:border-box;\n\t\tmargin: 0px auto;\n\t\tpadding: 3px 4px;\n\t\tborder-radius: 3px;\n\t}\n\n\t&__body-share-bookmark-btn {\n\t\tposition: absolute;\n\t\tright: 0px;\n\t\ttop: 0px;\n\t\tbottom: 0px;\n\t\tfont-size: 12px;\n\t\tpadding: 5px;\n\t\tcolor: #fff;\n\t\tbackground: #3ABFF8;\n\t\tborder-radius: 3px;\n\t\tcursor: pointer;\n\t\ttransition: all .3s;\n\t}\n\n\t&__body-share-bookmark-btn:hover {\n\t\tbackground: #089DDE;\n\t}\n\n\t&__body-share-bookmark-link {\n\t\twidth: 100%;\n\t\tmargin: 0px;\n\t\tborder: none;\n\t\toutline: none;\n\t\tbackground: transparent;\n\t\tfont-size: 12px;\n\t\tcolor: #415572;\n\t}\n\n\t&__body-feedback-container {\n\t\tmargin-top: 20px;\n\t}\n\n\t&__body-feedback-txt {\n\t\tcolor: #097654;\n\t\ttext-decoration: none;\n\t\tfont-size: 14px;\n\t\ttransition: all .3s;\n\t}\n\n\t&__body-feedback-txt:hover {\n\t\tcolor: #0FBD86;\n\t}\n}\n\n@media only screen and (max-width: 992px) {\n\t.search-profile {\n\t\tpadding-top: 25px;\n\n\t\t&__header-left {\n\t\t\tdisplay: flex;\n\t\t\tflex-direction: row;\n\t\t\talign-items: center;\n\t\t\tgap: 10px;\n\t\t}\n\n\t\t&__header-avatar {\n\t\t\twidth: 40px;\n\t\t}\n\t}\n}"
},
{
"path": "aquila/view/components/pages/collection/bookmark/CollectionBookmarks/SearchPageProfile.tsx",
"content": "import { VscFeedback } from 'react-icons/vsc';\nimport { toast } from 'react-toastify';\nimport Avatar from \"boring-avatars\";\n\nimport classes from './SearchPageProfile.module.scss';\nimport { Customer } from '../../../../../store/slices/types/Customer';\nimport { FC, useRef, useState } from 'react';\nimport { Collection } from '../../../../../store/slices/types/Collection';\n\ninterface SearchPageProfileProps {\n\tcustomer: Customer;\n\tcollection: Collection;\n\tonSubscribe: Function;\n\tisSignedIn: boolean | null;\n\tisCurrentLoggedInCustProfile: boolean;\n\tisCollectionSubscribed: boolean | null;\n\tonUnsubscribe: Function\n}\n\nconst SearchPageProfile: FC\n\t\t\t
\n\t)\n}\n\nexport default SearchPageProfile;"
},
{
"path": "aquila/view/components/pages/collection/bookmark/CollectionBookmarks/SearchResultItem.module.scss",
"content": ".search-result-item {\n\tborder-bottom: 1px solid #CED7E3;\n\tpadding-bottom: 15px;\n\tmargin-bottom: 10px;\n\tword-wrap: break-word;\n\n\t&__title-link {\n\t\tfont-size: 22px;\n\t\ttext-decoration: none;\n\t\tmargin-bottom: 2px;\n\t\tcolor: #202A38;\n\t\ttransition: all .3s;\n\t\tcursor: pointer;\n\t}\n\n\t&__title-link:hover {\n\t\tcolor: #0FBD86;\n\t}\n\n\t&__meta-info {\n\t\tpadding-bottom: 0px;\n\t\tmargin-bottom: 0px;\n\t\tfont-size: 12px;\n\t\tcolor: #8DA2BE;\n\t}\n\n\t&__site-link {\n\t\tfont-size: 14px;\n\t\tcolor: #536E92;\n\t\ttransition: all .3s;\n\t}\n\n\t&__site-link:hover {\n\t\tcolor: #9B5094;\n\t}\n\n\t&__site-desc {\n\t\tcolor: #415572;\n\t\tmargin-top: 5px;\n\t\tmargin-bottom: 3px;\n\t\tpadding-bottom: 0px;\n\t}\n}"
},
{
"path": "aquila/view/components/pages/collection/bookmark/CollectionBookmarks/SearchResultItem.tsx",
"content": "import moment from 'moment';\nimport { FC } from 'react';\nimport classes from './SearchResultItem.module.scss';\n\ninterface SearchResultItemProps {\n\ttitle: string;\n\turl: string;\n\tsummary: string;\n\tcreatedAt: string;\n}\n\nconst SearchResultItem: FC\n\t\t\t\t
\n\t\t\t\n\t\t\t\t\t
\n\t\t\t\t\n\t\t\t\t\t\t
\n\t\t\t\t\t{`${customer.firstName} ${customer.lastName} ${isCurrentLoggedInCustProfile ? '(Me)' : ''}`}
\n\t\t\t\t\n\t\t\t\t\t{!(isSignedIn && isCollectionSubscribed) && }\n\t\t\t\t\t{isSignedIn && isCollectionSubscribed && }\n\t\t\t\t
\n\t\t\t\n\t\t\t\t
\n\t\t{collection.desc}
\n\t\t\t\t\n\t\t\t\t\t
\n\t\t\t\tShare this bookmark
\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\tCopy\n\t\t\t\t\t
\n\t\t\t\t\n\t\t\t\t\tsend us your feedback
\n\t\t\t\n\t\t\t
\n\t);\n}\n\nexport default SearchResultItem;"
},
{
"path": "aquila/view/components/pages/collection/bookmark/CollectionBookmarks/SearchResults.module.scss",
"content": ".search-result {\n\n\t&__results {\n\t\tmargin-top: 20px;\n\t}\n\n\t&__item {\n\t\tmargin-bottom: 25px;\n\t}\n\n\t&__header-info-desc {\n\t\tcolor: #536E92;\n\t}\n\n\t&__pagination {\n\t\tmargin-top: 15px;\n\t\tdisplay: flex;\n\t\tgap: 10px;\n\t}\n\n\t&__pagination-link {\n\t\tfont-size: 14px;\n\t\ttext-decoration: none;\n\t\tbackground: #EFF2F6;\n\t\tcolor: #202A38;\n\t\tpadding: 5px;\n\t\ttransition: all .3s;\n\t\tborder-radius: 3px;\n\t}\n\n\t&__pagination-link:hover {\n\t\tbackground: #CED7E3;\n\t}\n}"
},
{
"path": "aquila/view/components/pages/collection/bookmark/CollectionBookmarks/SearchResults.tsx",
"content": "import { FC } from \"react\";\nimport { Bookmark } from \"../../../../../store/slices/types/Bookmark\";\nimport SearchResultItem from \"./SearchResultItem\";\nimport classes from './SearchResults.module.scss';\n\ninterface SearchResultsProps {\n\tbookmarks: Bookmark[];\n\thasNext: boolean;\n\thasPrev: boolean;\n\tonClickNextPage: Function;\n\tonClickPrevPage: Function;\n\ttotalRecords: number | null;\n}\n\nconst SearchResults: FC{title}
\n\t\t\tUpdated {moment(createdAt).fromNow()}
\n\t\t\t{summary.length > 255 ? summary.substring(0, 255)+ '...' : summary}
\n\t\t\t{url}\n\t\t\n\t\t\t
\n\t);\n}\n\nexport default SearchResults;"
},
{
"path": "aquila/view/components/pages/explore/Explore.module.scss",
"content": ".explore {\n\t// width: 250px;\n\tpadding: 20px 15px;\n\tborder-radius: 3px;\n\tborder: 1px solid #ddd;\n\n\t&__header {\n\t\tdisplay: flex;\n\t\talign-items: center;\n\t\tmargin-bottom: 20px;\n\t\tpadding-bottom: 20px;\n\t\tborder-bottom: 2px solid #ddd;\n\t}\n\n\t&__header-title {\n\t\tcolor: #202A38;\n\t\tfont-size: 22px;\n\t\tfont-weight: 500;\n\t\ttext-decoration: none;\n\t\tmargin: 0px;\n\t}\n\n\n\t&__header-title:hover {\n\t\tcolor: #0FBD86;\n\t}\n\n\t&__header-avatar {\n\t\tmargin-right: 10px;\n\t}\n\n\t&__content-desc {\n\t\tcolor: #415572;\n\t\tfont-size: 14px;\n\t}\n\n}\n\n// @media only screen and (max-width: 1200px) {\n// \t.explore {\n// \t\twidth: 200px;\n// \t}\t\n// }\n\n// @media only screen and (max-width: 992px) {\n// \t.explore {\n// \t\twidth: 225px;\n// \t}\t\n// }\n\n// @media only screen and (max-width: 992px) {\n// \t.explore {\n// \t\twidth: 250px;\n// \t}\t\n// }"
},
{
"path": "aquila/view/components/pages/explore/Explore.tsx",
"content": "import Avatar from \"boring-avatars\";\nimport Link from \"next/link\";\nimport { FC } from \"react\";\nimport { Collection } from \"../../../store/slices/types/Collection\";\n\nimport classes from \"./Explore.module.scss\";\n\ninterface ExploreProps {\n\tcollection: Collection\n}\n\nconst Explore: FC\n\t\t\t\t{totalRecords !== null ?
\n\t\t\tReceived {totalRecords} results
: null}\n\t\t\t\n\t\t\t\t{bookmarks.map((bookmark, index) => (\n\t\t\t\t
\n\t\t\t\n\t\t\n\t\t\t\t\t\n\t\t\t\t
\n\t\t\t\t))}\n\t\t\t\n\t\t\t
\n\t)\n}\n\nexport default Explore;"
},
{
"path": "aquila/view/components/pages/explore/ExploreCategoryItem.module.scss",
"content": ".explore-category-item {\n\tmargin-top: 15px;\n\n\t&__title {\n\t\tmargin-bottom: 20px;\n\t\tfont-size: 24px;\n\t}\n\n\t&__explore-list {\n\t\tdisplay: grid;\n\t\tgrid-template-columns: repeat(4, 1fr);\n\t\tjustify-items: center;\n\t\tgap: 30px;\n\t}\n}\n\n@media only screen and (max-width: 992px) {\n\t.explore-category-item {\n\t\t&__explore-list {\n\t\t\tgrid-template-columns: repeat(3, 1fr);\n\t\t}\n\t}\n}\n\n\n@media only screen and (max-width: 768px) {\n\t.explore-category-item {\n\t\t&__explore-list {\n\t\t\tgrid-template-columns: repeat(2, 1fr);\n\t\t}\n\t}\n}\n\n@media only screen and (max-width: 576px) {\n\t.explore-category-item {\n\t\t&__explore-list {\n\t\t\tgrid-template-columns: 1fr;\n\t\t}\n\t}\n}"
},
{
"path": "aquila/view/components/pages/explore/ExploreCategoryItem.tsx",
"content": "import { FC } from \"react\";\nimport { Collection } from \"../../../store/slices/types/Collection\";\nimport Explore from \"./Explore\";\n\nimport classes from './ExploreCategoryItem.module.scss';\n\ninterface ExploreItemProps {\n\tcollections: Collection[];\n\ttitle: string;\n}\n\nconst ExploreItem: FC\n\t\t\t\t
\n\t\t\t\n\t\t\t\t\t
\n\t\t\t\t\n\t\t\t\t\t{`${props.collection.customer?.firstName} ${props.collection.customer?.lastName}`}\n\t\t\t\t\n\t\t\t\n\t\t\t\t
\n\t\t{props.collection.desc}
\n\t\t\t\n\t\t\t
\n\t)\n}\n\nexport default ExploreItem;"
},
{
"path": "aquila/view/components/pages/explore/ExploreCategoryList.module.scss",
"content": ".explore-category-list {\n\t&__item {\n\t\tmargin-bottom: 50px;\n\t}\n}"
},
{
"path": "aquila/view/components/pages/explore/ExploreCategoryList.tsx",
"content": "import { FC } from \"react\";\nimport { AppState } from \"../../../store\";\nimport ExploreCategoryItem from \"./ExploreCategoryItem\";\n\nimport classes from './ExploreCategoryList.module.scss';\n\ninterface ExploreCategoryListProps {\n\tfeaturedCollectionsState: AppState[\"getFeaturedCollections\"];\n\tpublicCollectionsState: AppState[\"getAllPublicCollections\"];\n}\n\nconst ExploreCategoryList: FC{props.title}
\n\t\t\t\n\t\t\t\t{props.collections.map((item, index) => {\n\t\t\t\t\treturn (\n\t\t\t\t\t\t
\n\t\t\n\t\t\t\t\t\t\t
\n\t\t\t\t\t)\n\t\t\t\t})}\n\t\t\t\n\t\t\t{props.featuredCollectionsState.collections &&\n\t\t\t
\n\t);\n}\n\nexport default ExploreCategoryList;"
},
{
"path": "aquila/view/components/pages/explore/ExplorePageWrapper.tsx",
"content": "import { FC } from \"react\";\nimport { AppState } from \"../../../store\";\nimport MainLayout from \"../../layout/main/MainLayout\";\nimport Container from \"../../ui/layout/Container\";\nimport ExploreCategoryList from \"./ExploreCategoryList\";\n\ninterface ExplorePageWrapperProps {\n featuredCollectionsState: AppState[\"getFeaturedCollections\"];\n publicCollectionsState: AppState[\"getAllPublicCollections\"];\n}\n\nconst ExplorePageWrapper: FC\n\t\t\t\t
\n\t\t\t}\n\t\t\t{props.publicCollectionsState.collections &&\n\t\t\t\n\t\t\t\t
\n\t\t\t}\n\t\t\t{/* \n\t\t\t\t
*/}\n\t\t\n \n \n \n\t\t\t \n {collection && customer && \n
\n \n
\n \n {bookmarksState.status === \"pending\" &&
\n \n\t\t\t\n\t\t
\n\t)\n}\n\nexport default SearchBar;"
},
{
"path": "aquila/view/components/pages/home/SearchPageProfile.module.scss",
"content": ".search-profile {\n\tpadding: 15px;\n\tmargin-top: 20px;\n\tborder: 1px solid #CED7E3;\n\tborder-radius: 3px;\n\tbackground: #fff;\n\n\t&__header {\n\t\tdisplay: flex;\n\t\tjustify-content: space-between;\n\t\tmargin-bottom: 10px;\n\t}\n\n\t&__header-subscribe-btn {\n\t\tmargin-top: 5px;\n\t\tbackground: transparent;\n\t\tborder: 1px solid #8DA2BE;\n\t\toutline: none;\n\t\tborder-radius: 3px;\n\t\tcolor: #2E3D51;\n\t\ttransition: all .3s;\n\t\tcursor: pointer;\n\t}\n\n\t&__header-subscribe-btn:hover {\n\t\tcolor: #0FBD86;\n\t\tborder-color: #0FBD86;\n\t}\n\n\t&__header-avatar {\n\t\twidth: 80px;\n\t}\n\n\t&__header-left {\n\t\tdisplay: flex;\n\t\tflex-direction: column;\n\t\tgap: 10px;\n\t}\n\n\t&__header-name {\n\t\tcolor: #202A38;\n\t\tfont-size: 25px;\n\t}\n\n\t&__body-desc {\n\t\tcolor: #415572;\n\t\tmargin: 0px;\n\t\tfont-size: 14px;\n\t\tmargin-bottom: 20px;\n\t}\n\n\t&__body-bookmark-title {\n\t\tfont-size: 14px;\n\t\tmargin-bottom: 5px;\n\t\tcolor: #415572;\n\t}\n\n\t&__body-share-bookmark-box {\n\t\toverflow: hidden;\n\t\tbackground: #EFF2F6;\n\t\tposition: relative;\n\t\tbox-sizing:border-box;\n\t\tmargin: 0px auto;\n\t\tpadding: 3px 4px;\n\t\tborder-radius: 3px;\n\t}\n\n\t&__body-share-bookmark-btn {\n\t\tposition: absolute;\n\t\tright: 0px;\n\t\ttop: 0px;\n\t\tbottom: 0px;\n\t\tfont-size: 12px;\n\t\tpadding: 5px;\n\t\tcolor: #fff;\n\t\tbackground: #3ABFF8;\n\t\tborder-radius: 3px;\n\t\tcursor: pointer;\n\t\ttransition: all .3s;\n\t}\n\n\t&__body-share-bookmark-btn:hover {\n\t\tbackground: #089DDE;\n\t}\n\n\t&__body-share-bookmark-link {\n\t\twidth: 100%;\n\t\tmargin: 0px;\n\t\tborder: none;\n\t\toutline: none;\n\t\tbackground: transparent;\n\t\tfont-size: 12px;\n\t\tcolor: #415572;\n\t}\n\n\t&__body-feedback-container {\n\t\tmargin-top: 20px;\n\t}\n\n\t&__body-feedback-txt {\n\t\tcolor: #097654;\n\t\ttext-decoration: none;\n\t\tfont-size: 14px;\n\t\ttransition: all .3s;\n\t}\n\n\t&__body-feedback-txt:hover {\n\t\tcolor: #0FBD86;\n\t}\n}\n\n@media only screen and (max-width: 992px) {\n\t.search-profile {\n\t\tpadding-top: 25px;\n\n\t\t&__header-left {\n\t\t\tdisplay: flex;\n\t\t\tflex-direction: row;\n\t\t\talign-items: center;\n\t\t\tgap: 10px;\n\t\t}\n\n\t\t&__header-avatar {\n\t\t\twidth: 40px;\n\t\t}\n\t}\n}"
},
{
"path": "aquila/view/components/pages/home/SearchPageProfile.tsx",
"content": "import { VscFeedback } from 'react-icons/vsc';\nimport { toast } from 'react-toastify';\nimport Avatar from \"boring-avatars\";\n\nimport classes from './SearchPageProfile.module.scss';\nimport { Customer } from '../../../store/slices/types/Customer';\nimport { FC, useRef, useState } from 'react';\nimport { Collection } from '../../../store/slices/types/Collection';\n\ninterface SearchPageProfileProps {\n\tcustomer: Customer;\n\tcollection: Collection;\n\tonSubscribe: Function;\n\tonUnsubscribe: Function;\n\tisCollectionSubscribed: boolean | null;\n}\n\nconst SearchPageProfile: FC\n\t\t\t
\n\t)\n}\n\nexport default SearchPageProfile;"
},
{
"path": "aquila/view/components/pages/home/SearchResultItem.module.scss",
"content": ".search-result-item {\n\tborder-bottom: 1px solid #CED7E3;\n\tpadding-bottom: 15px;\n\tmargin-bottom: 10px;\n\tword-wrap: break-word;\n\n\t&__title {\n\t\tmargin-bottom: 2px;\n\t}\n\n\t&__title-link {\n\t\tfont-size: 22px;\n\t\tcolor: #202A38;\n\t\ttransition: all .3s;\n\t\tcursor: pointer;\n\t\ttext-decoration: none;\n\t}\n\n\t&__title-link:hover {\n\t\tcolor: #0FBD86;\n\t}\n\n\t&__meta-info {\n\t\tpadding-bottom: 0px;\n\t\tmargin-bottom: 0px;\n\t\tfont-size: 12px;\n\t\tcolor: #8DA2BE;\n\t}\n\n\t&__site-link {\n\t\tfont-size: 14px;\n\t\tcolor: #536E92;\n\t\ttransition: all .3s;\n\t}\n\n\t&__site-link:hover {\n\t\tcolor: #9B5094;\n\t}\n\n\t&__site-desc {\n\t\tcolor: #415572;\n\t\tmargin-top: 5px;\n\t\tmargin-bottom: 3px;\n\t\tpadding-bottom: 0px;\n\t}\n}"
},
{
"path": "aquila/view/components/pages/home/SearchResultItem.tsx",
"content": "import { FC } from 'react';\nimport moment from 'moment';\n\nimport classes from './SearchResultItem.module.scss';\n\ninterface SearchResultItemProps {\n\ttitle: string;\n\turl: string;\n\tsummary: string;\n\tcreatedAt: string;\n}\n\nconst SearchResultItem: FC\n\t\t\t\t
\n\t\t\t\n\t\t\t\t\t
\n\t\t\t\t\n\t\t\t\t\t\t
\n\t\t\t\t\t{`${customer.firstName} ${customer.lastName} (Me)`}
\n\t\t\t\t\n\t\t\t\t\t{!isCollectionSubscribed && }\n\t\t\t\t\t{isCollectionSubscribed && }\n\t\t\t\t
\n\t\t\t\n\t\t\t\t
\n\t\t{collection.desc}
\n\t\t\t\t\n\t\t\t\t\t
\n\t\t\t\tShare this bookmark
\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\tCopy\n\t\t\t\t\t
\n\t\t\t\t\n\t\t\t\t\tsend us your feedback
\n\t\t\t\n\t\t\t
\n\t);\n}\n\nexport default SearchResultItem;"
},
{
"path": "aquila/view/components/pages/home/SearchResults.module.scss",
"content": ".search-result {\n\n\t&__results {\n\t\tmargin-top: 20px;\n\t}\n\n\t&__item {\n\t\tmargin-bottom: 25px;\n\t}\n\n\t&__header-info-desc {\n\t\tcolor: #536E92;\n\t}\n\n\t&__pagination {\n\t\tmargin-top: 15px;\n\t\tdisplay: flex;\n\t\tgap: 10px;\n\t}\n\n\t&__pagination-link {\n\t\tfont-size: 14px;\n\t\ttext-decoration: none;\n\t\tbackground: #EFF2F6;\n\t\tcolor: #202A38;\n\t\tpadding: 5px;\n\t\ttransition: all .3s;\n\t\tborder-radius: 3px;\n\t}\n\n\t&__pagination-link:hover {\n\t\tbackground: #CED7E3;\n\t}\n}"
},
{
"path": "aquila/view/components/pages/home/SearchResults.tsx",
"content": "import { FC } from \"react\";\nimport { Bookmark } from \"../../../store/slices/types/Bookmark\";\nimport SearchResultItem from \"./SearchResultItem\";\nimport classes from './SearchResults.module.scss';\n\ninterface SearchResultsProps {\n\tbookmarks: Bookmark[];\n\thasNext: boolean;\n\thasPrev: boolean;\n\tonClickNextPage: Function;\n\tonClickPrevPage: Function;\n\ttotalRecords: number | null;\n}\n\nconst SearchResults: FC{title}
\n\t\t\tUpdated {moment(createdAt).fromNow()}
\n\t\t\t{summary.length > 255 ? summary.substring(0, 255)+'...' : summary}
\n\t\t\t{url}\n\t\t\n\t\t\t
\n\t);\n}\n\nexport default SearchResults;"
},
{
"path": "aquila/view/components/pages/index/AllControl.module.scss",
"content": ".all-control {\n display: flex;\n margin: auto;\n max-width: 1280;\n\n &__img-area {\n flex-basis: 50%;\n padding: 50px;\n box-sizing: border-box;\n }\n\n &__text-area {\n flex-basis: 50%;\n display: flex;\n flex-direction: column;\n justify-content: center;\n gap: 20px;\n padding: 50px;\n box-sizing: border-box;\n }\n\n &__title {\n color: #202A38;\n font-size: 25px;\n }\n\n &__desc {\n color: #415572;\n font-size: 20px;\n }\n\n &__desc-link {\n color: #0FBD86;\n text-decoration: none;\n }\n}\n\n@media only screen and (max-width: 768px) {\n .all-control {\n flex-direction: column-reverse;\n padding-left: 10px;\n padding-right: 10px;\n text-align: center;\n\n &__title {\n font-size: 18px;\n }\n \n &__desc {\n font-size: 16px;\n }\n\n &__img-area {\n width: 80%;\n margin-left: auto;\n margin-right: auto;\n }\n }\n}"
},
{
"path": "aquila/view/components/pages/index/AllControl.tsx",
"content": "import Image from \"next/image\";\n\nimport classes from \"./AllControl.module.scss\";\nimport AllControlImg from \"../../../public/img/aquila-control.png\";\n\nconst AllControl = () => {\n return (\n \n\t\t\t\t{totalRecords !== null ?
\n\t\t\tReceived {totalRecords} results
: null}\n\t\t\t\n\t\t\t\t{bookmarks.map((bookmark, index) => (\n\t\t\t\t
\n\t\t\t\n\t\t\n\t\t\t\t\t\n\t\t\t\t
\n\t\t\t\t))}\n\t\t\t\n
\n )\n}\n\nexport default AllControl;"
},
{
"path": "aquila/view/components/pages/index/Discover.module.scss",
"content": ".discover {\n margin: auto;\n margin-top: 80px;\n display: flex;\n max-width: 1280px;\n &__text-area {\n flex-basis: 50%;\n padding: 50px;\n box-sizing: border-box;\n display: flex;\n flex-direction: column;\n justify-content: center;\n gap: 20px;\n }\n\n &__title {\n font-size: 25px;\n color: #202A38;\n }\n\n &__desc {\n font-size: 20px;\n color: #415572;\n }\n\n &__img-area {\n flex-basis: 50%;\n } \n}\n\n\n@media only screen and (max-width: 768px) {\n .discover {\n flex-direction: column;\n padding-left: 10px;\n padding-right: 10px;\n text-align: center;\n\n &__title {\n font-size: 18px;\n }\n \n &__desc {\n font-size: 16px;\n }\n\n &__img-area {\n width: 80%;\n margin-left: auto;\n margin-right: auto;\n }\n }\n}"
},
{
"path": "aquila/view/components/pages/index/Discover.tsx",
"content": "import Image from 'next/image';\nimport classes from './Discover.module.scss';\n\nimport DiscoverImg from '../../../public/img/aquila-discover.png';\n\nconst Discover = () => {\n return (\n \n \n
\n \n
\n You’ve got all the control
\nnstall a browser extension and you're ready to go.\nWe've made our software Open Source for public scrutiny & trust
\n\n
\n )\n}\n\nexport default Discover;"
},
{
"path": "aquila/view/components/pages/index/Hero.module.scss",
"content": ".hero {\n text-align: center;\n\n &__text-area {\n margin-top: 50px;\n }\n\n &__text-main-title {\n font-size: 70px;\n color: #202A38;\n }\n\n &__text-main-desc {\n font-size: 20px;\n margin: auto;\n margin-top: 30px;\n max-width: 600px;\n color: #536E92;\n }\n\n &__btn-area {\n margin-top: 50px;\n display: flex;\n justify-content: center;\n gap: 10px;\n }\n \n &__img-area {\n margin: auto;\n margin-top: 60px;\n max-width: 900px;\n }\n\n &__btn {\n border: none;\n background: #CED7E3;\n padding: 10px;\n border-radius: 3px;\n color: #fff;\n }\n\n &__btn--red {\n background: #F87272;\n }\n\n &__btn--blue {\n background: #3ABFF8;\n }\n\n &__footer-text {\n margin: auto;\n margin-top: 50px;\n max-width: 600px;\n border-top: 1px solid #ddd;\n border-bottom: 1px solid #ddd;\n padding: 40px 0px;\n font-size: 20px;\n color: #2E3D51;\n }\n}\n\n@media only screen and (max-width: 768px) {\n .hero {\n &__text-main-title {\n font-size: 45px;\n }\n\n &__text-main-desc {\n font-size: 18px;\n line-height: 30px;\n }\n }\n}\n\n@media only screen and (max-width: 576px) {\n .hero {\n padding-left: 10px;\n padding-right: 10px;\n\n &__text-main-title {\n font-size: 35px;\n }\n\n &__text-main-desc {\n font-size: 16px;\n line-height: 24px;\n }\n\n &__footer-text {\n font-size: 18px;\n }\n }\n}"
},
{
"path": "aquila/view/components/pages/index/Hero.tsx",
"content": "import Image from 'next/image';\nimport classes from './Hero.module.scss';\n\nimport HeroImg from '../../../public/img/aquila-hero.png';\n\nconst Hero = () => {\n return (\n \n
\n Discover new topics and people
\nBecome a fan of your favorite curators.\nMaintain a pool of specialists and create a search engine out of it.
\n\n
\n \n
\n )\n}\n\nexport default Hero;"
},
{
"path": "aquila/view/components/pages/index/IndexPageWrapper.tsx",
"content": "import MainLayout from \"../../layout/main/MainLayout\";\nimport AllControl from \"./AllControl\";\nimport Discover from \"./Discover\";\nimport Hero from \"./Hero\";\nimport Story from \"./Story\";\n\nconst IndexPageWrapper = () => {\n\treturn (\n\t\t\n
\n Human curated search engine
\nBuild a curated list of websites, aggregate into searchable pool of ideas.\nWorks with paywall-protected websites.
\n\n \n \n
\n \n
\n \n
\n Aquila offers you a familiar search experience.\nEasily organize and share your curated list with anybody.
\n\n
\n )\n}\n\nexport default Story;"
},
{
"path": "aquila/view/components/pages/signIn/SignInForm.module.scss",
"content": ".login-box {\n\n\t&__header {\n\t\tmargin: 25px 0px;\n\t}\n\n\t&__title {\n\t\tfont-size: 20px;\n\t\tcolor: #415572;\n\t\ttext-align: center;\n\t}\n\n\t&__form-item {\n\t\tmargin-bottom: 12px;\n\t}\n\n\t&__form-item--btn-container {\n\t\tmargin-top: 20px;\n\t}\n\n\t&__form-label {\n\t\tdisplay: block;\n\t\tcolor: hsl(214, 28%, 45%);\n\t\tmargin-bottom: 4px;\n\t}\n\n\t&__form-control {\n\t\tcolor: #415572;\n\t\twidth: 100%;\n\t\tpadding: 8px 5px;\n\t\tborder: 1px solid #536E92;\n\t\tborder-radius: 3px;\n\t\tbox-sizing: border-box;\n\t}\n\n\t&__form-btn {\n\t\twidth: 100%;\n\t\tbackground: none;\n\t\toutline: none;\n\t\tborder: 1px solid #415572;\n\t\tcolor: #415572;\n\t\tpadding: 6px 0px;\n\t\tborder-radius: 3px;\n\t\ttransition: all .3s;\n\t}\n\n\t&__form-btn:hover {\n\t\tcolor: #0FBD86;\n\t\tborder: 1px solid #0FBD86;\n\t}\n\n\t&__form-btn:disabled {\n\t\tcolor: #CED7E3;\n\t\tborder-color: #CED7E3;\n\t}\n\n\t&__footer-text {\n\t\tfont-size: 12px;\n\t}\n\n\t&__footer-link {\n\t\tcolor: #0FBD86;\n\t\ttext-decoration: none;\n\t}\n\n\t&__footer-link:hover {\n\t\tcolor: #0DA575;\n\t}\n\n}"
},
{
"path": "aquila/view/components/pages/signIn/SignInForm.tsx",
"content": "import Link from 'next/link';\nimport { useRef, useState } from 'react';\nimport classes from './SignInForm.module.scss';\n\nconst SignInForm = (props:any) => {\n\tconst secretKeyRef = useRefInterested to read the story of Aquila Network?
\n\n\t\t\t\n\t\t
\n\t)\n}\n\nexport default SignInForm;"
},
{
"path": "aquila/view/components/pages/signIn/SignInPageWrapper.tsx",
"content": "import { FC } from \"react\";\nimport BoxCenterLayout from \"../../layout/boxCenter/BoxCenterLayout\";\nimport SignInForm from \"./SignInForm\";\n\ninterface SignInPageWrapperProps {\n\tonSignIn: Function\n}\n\nconst SignInPageWrapper: FC\n
\n )\n}\n\nexport default SecretKey;"
},
{
"path": "aquila/view/components/pages/signUp/SignUpForm.module.scss",
"content": ".signup-box {\n\n\t&__header {\n\t\tmargin: 25px 0px;\n\t}\n\n\t&__title {\n\t\tfont-size: 20px;\n\t\tcolor: #415572;\n\t\ttext-align: center;\n\t}\n\n\t&__form-item {\n\t\tmargin-bottom: 12px;\n\t}\n\n\t&__form-item--btn-container {\n\t\tmargin-top: 30px;\n\t}\n\n\t&__form-label {\n\t\tdisplay: block;\n\t\tcolor: hsl(214, 28%, 45%);\n\t\tmargin-bottom: 4px;\n\t}\n\n\t&__form-control {\n\t\tcolor: #415572;\n\t\twidth: 100%;\n\t\tpadding: 8px 5px;\n\t\tborder: 1px solid #536E92;\n\t\tborder-radius: 3px;\n\t\tbox-sizing: border-box;\n\t}\n\n\t&__form-error {\n\t\tmargin-top: 5px;\n\t\tcolor: #F87272;\n\t\tfont-size: 12px;\n\t}\n\n\t&__form-btn {\n\t\twidth: 100%;\n\t\tbackground: none;\n\t\toutline: none;\n\t\tborder: 1px solid #415572;\n\t\tcolor: #415572;\n\t\tpadding: 6px 0px;\n\t\tborder-radius: 3px;\n\t\ttransition: all .3s;\n\t\tcursor: pointer;\n\t}\n\n\t&__form-btn:hover {\n\t\tcolor: #0FBD86;\n\t\tborder: 1px solid #0FBD86;\n\t}\n\n\t&__form-btn:disabled {\n\t\tcolor: #CED7E3;\n\t\tborder: 1px solid #CED7E3;\n\t\tcursor: not-allowed\n\t}\n\n\t&__footer-text {\n\t\tfont-size: 12px;\n\t}\n\n\t&__footer-link {\n\t\tcolor: #0FBD86;\n\t\ttext-decoration: none;\n\t}\n\n\t&__footer-link:hover {\n\t\tcolor: #0DA575;\n\t}\n\n}"
},
{
"path": "aquila/view/components/pages/signUp/SignUpForm.tsx",
"content": "import Link from 'next/link';\nimport { FC, useEffect, useState } from 'react';\nimport { useForm } from 'react-hook-form';\n\nimport { AppState } from '../../../store';\n\nimport classes from './SignUpForm.module.scss';\n\ninterface SignUpFormProps {\n\tonSignUp: Function;\n\tname: {\n\t\tfirstName: string | null;\n\t\tlastName: string | null;\n\t},\n\tsignUpState: AppState[\"signUp\"]\n}\n\ntype FormData = {\n\tfirstName: string;\n\tlastName: string;\n}\n\nconst SignUpForm: FC\n
\n Your Account has been generated
\n\n
\n Your Secret key
\n\n {signUpState.customer?.secretKey}\n
Make sure to copy your secret key. Secret key is required to login next time
\n\n \n Continue\n \n
\n \n\t\t\t\n\t\t
\n\t)\n}\n\nexport default SignUpForm;"
},
{
"path": "aquila/view/components/pages/signUp/SignUpPageWrapper.tsx",
"content": "import { FC } from \"react\";\n\nimport { AppState } from '../../../store/';\nimport BoxCenterLayout from \"../../layout/boxCenter/BoxCenterLayout\";\nimport SecretKey from \"./SecretKey\";\nimport SignUpForm from \"./SignUpForm\";\n\ninterface SignUpPageWrapperProps {\n\tonSignUp: Function,\n\tname: {\n\t\tfirstName: string | null;\n\t\tlastName: string | null;\n\t},\n\tsignUpState: AppState[\"signUp\"];\n\taccountCreated: boolean;\n}\n\nconst SignUpPageWrapper: FC\n
\n )\n}\n\nexport default Collection;"
},
{
"path": "aquila/view/components/pages/subscription/HomePageWrapper.tsx",
"content": "import { FC, useEffect, useState } from \"react\";\nimport { Oval } from 'react-loader-spinner';\n\nimport { AppState } from \"../../../store\";\nimport { Collection } from \"../../../store/slices/types/Collection\";\nimport { Customer } from \"../../../store/slices/types/Customer\";\nimport MainLayout from \"../../layout/main/MainLayout\"\nimport Container from \"../../ui/layout/Container\";\nimport classes from \"./HomePageWrapper.module.scss\";\nimport SearchBar from \"./SearchBar\";\nimport SearchPageProfile from \"./SearchPageProfile\";\nimport SearchResults from \"./SearchResults\";\n\ninterface HomePageWrapperProps {\n customer: Customer | null;\n collection: Collection | null;\n bookmarksState: AppState[\"getLoggedInCustBookmarksByCollectionId\"];\n onSearch: Function;\n onClickNextPage: Function;\n onClickPrevPage: Function;\n}\n\nconst HomePageWrapper: FC{name}
\n \n\n \n \n \n {collection && customer && \n
\n \n
\n \n {bookmarksState.status === \"pending\" &&
\n \n\t\t\t\n\t\t
\n\t)\n}\n\nexport default SearchBar;"
},
{
"path": "aquila/view/components/pages/subscription/SearchPageProfile.module.scss",
"content": ".search-profile {\n\tpadding: 15px;\n\tmargin-top: 20px;\n\tborder: 1px solid #CED7E3;\n\tborder-radius: 3px;\n\n\t&__header {\n\t\tdisplay: flex;\n\t\tjustify-content: space-between;\n\t\tmargin-bottom: 10px;\n\t}\n\n\t&__header-subscribe-btn {\n\t\tmargin-top: 5px;\n\t\tbackground: transparent;\n\t\tborder: 1px solid #8DA2BE;\n\t\toutline: none;\n\t\tborder-radius: 3px;\n\t\tcolor: #2E3D51;\n\t\ttransition: all .3s;\n\t\tcursor: pointer;\n\t}\n\n\t&__header-subscribe-btn:hover {\n\t\tcolor: #0FBD86;\n\t\tborder-color: #0FBD86;\n\t}\n\n\t&__header-left {\n\t\tdisplay: flex;\n\t\tflex-direction: column;\n\t\tgap: 10px;\n\t}\n\n\t&__header-name {\n\t\tcolor: #202A38;\n\t\tfont-size: 25px;\n\t}\n\n\t&__body-desc {\n\t\tcolor: #415572;\n\t\tmargin: 0px;\n\t\tfont-size: 14px;\n\t\tmargin-bottom: 20px;\n\t}\n\n\t&__body-bookmark-title {\n\t\tfont-size: 14px;\n\t\tmargin-bottom: 5px;\n\t\tcolor: #415572;\n\t}\n\n\t&__body-share-bookmark-box {\n\t\toverflow: hidden;\n\t\tbackground: #EFF2F6;\n\t\tposition: relative;\n\t\tbox-sizing:border-box;\n\t\tmargin: 0px auto;\n\t\tpadding: 3px 4px;\n\t\tborder-radius: 3px;\n\t}\n\n\t&__body-share-bookmark-btn {\n\t\tposition: absolute;\n\t\tright: 0px;\n\t\ttop: 0px;\n\t\tbottom: 0px;\n\t\tfont-size: 12px;\n\t\tpadding: 5px;\n\t\tcolor: #fff;\n\t\tbackground: #3ABFF8;\n\t\tborder-radius: 3px;\n\t\tcursor: pointer;\n\t\ttransition: all .3s;\n\t}\n\n\t&__body-share-bookmark-btn:hover {\n\t\tbackground: #089DDE;\n\t}\n\n\t&__body-share-bookmark-link {\n\t\twidth: 100%;\n\t\tmargin: 0px;\n\t\tborder: none;\n\t\toutline: none;\n\t\tbackground: transparent;\n\t\tfont-size: 12px;\n\t\tcolor: #415572;\n\t}\n\n\t&__body-feedback-container {\n\t\tmargin-top: 20px;\n\t}\n\n\t&__body-feedback-txt {\n\t\tcolor: #097654;\n\t\ttext-decoration: none;\n\t\tfont-size: 14px;\n\t\ttransition: all .3s;\n\t}\n\n\t&__body-feedback-txt:hover {\n\t\tcolor: #0FBD86;\n\t}\n}"
},
{
"path": "aquila/view/components/pages/subscription/SearchPageProfile.tsx",
"content": "import { VscFeedback } from 'react-icons/vsc';\nimport { toast } from 'react-toastify';\nimport Avatar from \"boring-avatars\";\n\nimport classes from './SearchPageProfile.module.scss';\nimport { Customer } from '../../../store/slices/types/Customer';\nimport { FC, useRef } from 'react';\nimport { Collection } from '../../../store/slices/types/Collection';\n\ninterface SearchPageProfileProps {\n\tcustomer: Customer;\n\tcollection: Collection;\n}\n\nconst SearchPageProfile: FC\n\t\t\t
\n\t)\n}\n\nexport default SearchPageProfile;"
},
{
"path": "aquila/view/components/pages/subscription/SearchResultItem.module.scss",
"content": ".search-result-item {\n\tborder-bottom: 1px solid #CED7E3;\n\tpadding-bottom: 15px;\n\tmargin-bottom: 10px;\n\tword-wrap: break-word;\n\n\t&__title {\n\t\tmargin-bottom: 2px;\n\t\tfont-size: 22px;\n\t}\n\n\t&__title-link {\n\t\tfont-size: 22px;\n\t\tcolor: #202A38;\n\t\ttransition: all .3s;\n\t\tcursor: pointer;\n\t\ttext-decoration: none;\n\t}\n\n\t&__title-link:hover {\n\t\tcolor: #0FBD86;\n\t}\n\n\t&__meta-info {\n\t\tpadding-bottom: 0px;\n\t\tmargin-bottom: 0px;\n\t\tfont-size: 12px;\n\t\tcolor: #8DA2BE;\n\t}\n\n\t&__site-link {\n\t\tfont-size: 14px;\n\t\tcolor: #536E92;\n\t\ttransition: all .3s;\n\t}\n\n\t&__site-link:hover {\n\t\tcolor: #9B5094;\n\t}\n\n\t&__site-desc {\n\t\tcolor: #415572;\n\t\tmargin-top: 5px;\n\t\tmargin-bottom: 3px;\n\t\tpadding-bottom: 0px;\n\t}\n}"
},
{
"path": "aquila/view/components/pages/subscription/SearchResultItem.tsx",
"content": "import { FC } from 'react';\nimport moment from 'moment';\n\nimport classes from './SearchResultItem.module.scss';\n\ninterface SearchResultItemProps {\n\ttitle: string;\n\turl: string;\n\tsummary: string;\n\tcreatedAt: string;\n}\n\nconst SearchResultItem: FC\n\t\t\t\t
\n\t\t\t\n\t\t\t\t\t
\n\t\t\t\t\n\t\t\t\t\t\t
\n\t\t\t\t\t{`${customer.firstName} ${customer.lastName}`}
\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t
\n\t\t\t\n\t\t\t\t
\n\t\t{collection.desc}
\n\t\t\t\t\n\t\t\t\t\t
\n\t\t\t\tShare this bookmark
\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\tCopy\n\t\t\t\t\t
\n\t\t\t\t\n\t\t\t\t\tsend us your feedback
\n\t\t\t\n\t\t\t
\n\t);\n}\n\nexport default SearchResultItem;"
},
{
"path": "aquila/view/components/pages/subscription/SearchResults.module.scss",
"content": ".search-result {\n\n\t&__results {\n\t\tmargin-top: 20px;\n\t}\n\n\t&__item {\n\t\tmargin-bottom: 25px;\n\t}\n\n\t&__header-info-desc {\n\t\tcolor: #536E92;\n\t}\n\n\t&__pagination {\n\t\tmargin-top: 15px;\n\t\tdisplay: flex;\n\t\tgap: 10px;\n\t}\n\n\t&__pagination-link {\n\t\tfont-size: 14px;\n\t\ttext-decoration: none;\n\t\tbackground: #EFF2F6;\n\t\tcolor: #202A38;\n\t\tpadding: 5px;\n\t\ttransition: all .3s;\n\t\tborder-radius: 3px;\n\t}\n\n\t&__pagination-link:hover {\n\t\tbackground: #CED7E3;\n\t}\n}"
},
{
"path": "aquila/view/components/pages/subscription/SearchResults.tsx",
"content": "import { FC } from \"react\";\nimport { Bookmark } from \"../../../store/slices/types/Bookmark\";\nimport SearchResultItem from \"./SearchResultItem\";\nimport classes from './SearchResults.module.scss';\n\ninterface SearchResultsProps {\n\tbookmarks: Bookmark[];\n\thasNext: boolean;\n\thasPrev: boolean;\n\tonClickNextPage: Function;\n\tonClickPrevPage: Function;\n\ttotalRecords: number | null;\n}\n\nconst SearchResults: FC{title}
\n\t\t\tUpdated {moment(createdAt).fromNow()}
\n\t\t\t{summary.length > 255 ? summary.substring(0, 255)+'...' : summary}
\n\t\t\t{url}\n\t\t\n\t\t\t
\n\t);\n}\n\nexport default SearchResults;"
},
{
"path": "aquila/view/components/pages/subscription/SubscribedCollections.module.scss",
"content": ".subscribed-collections {\n border: 1px solid #CED7E3;\n border-radius: 3px;\n\n &__header {\n padding: 20px;\n }\n\n &__header-title {\n font-size: 20px;\n color: #202A38;\n }\n\n &__body {\n padding: 20px;\n }\n\n &__list {\n list-style: none;\n display: flex;\n flex-direction: column;\n gap: 20px\n }\n\n}"
},
{
"path": "aquila/view/components/pages/subscription/SubscribedCollections.tsx",
"content": "import { FC } from \"react\";\nimport { Collection } from \"../../../store/slices/types/Collection\";\nimport { default as CollectionComponent } from \"./Collection\"\n\nimport classes from './SubscribedCollections.module.scss';\n\ninterface SubscribedCollectionsProps {\n collections: Collection[]\n}\n\nconst SubscribedCollections: FC\n\t\t\t\t{totalRecords !== null ?
\n\t\t\tReceived {totalRecords} results
: null}\n\t\t\t\n\t\t\t\t{bookmarks.map((bookmark, index) => (\n\t\t\t\t
\n\t\t\t\n\t\t\n\t\t\t\t\t\n\t\t\t\t
\n\t\t\t\t))}\n\t\t\t\n
\n )\n}\n\nexport default SubscribedCollections;\n"
},
{
"path": "aquila/view/components/pages/subscription/SubscriptionPageWrapper.module.scss",
"content": ".subscription-page {\n display: flex;\n gap: 50px;\n\n &__search-area {\n flex-basis: 900px; \n }\n\n &__search-bar {\n margin-top: 20px;\n width: 600px;\n }\n\n &__search-results {\n margin-top: 30px;\n }\n\n &__sidebar {\n padding-top: 20vh;\n flex: 1 1 0;\n }\n}\n\n@media only screen and (max-width: 992px) {\n .subscription-page {\n gap: 0px;\n flex-direction: column;\n \n &__search-area {\n flex-basis: auto;\n }\n\n &__search-bar {\n width: 80%;\n }\n\n &__sidebar {\n display: none;\n }\n } \n}"
},
{
"path": "aquila/view/components/pages/subscription/SubscriptionPageWrapper.tsx",
"content": "import { FC, useEffect, useState } from \"react\";\nimport { Oval } from 'react-loader-spinner';\n\nimport { AppState } from \"../../../store\";\nimport { Collection } from \"../../../store/slices/types/Collection\";\nimport { Customer } from \"../../../store/slices/types/Customer\";\nimport MainLayout from \"../../layout/main/MainLayout\"\nimport Container from \"../../ui/layout/Container\";\nimport classes from \"./SubscriptionPageWrapper.module.scss\";\nimport SearchBar from \"./SearchBar\";\nimport SearchResults from \"./SearchResults\";\nimport SubscribedCollections from \"./SubscribedCollections\";\n\ninterface SubscriptionPageWrapperProps {\n subscribedCollections: Collection[] | null;\n bookmarksState: AppState[\"getCustomerSubscriptions\"];\n onSearch: Function;\n onClickNextPage: Function;\n onClickPrevPage: Function;\n}\n\nconst SubscriptionPageWrapper: FC\n
\n Subscriptions
\n\n
\n - \n {collections.map((collection) => (
\n \n \n \n {Array.isArray(subscribedCollections) && \n
\n \n
\n \n {bookmarksState.status === \"pending\" &&
\n \n
\n )\n}\n\nexport default Alert;"
},
{
"path": "aquila/view/components/ui/layout/Container.module.scss",
"content": ".container {\n max-width: 1200px;\n margin: 0px auto;\n}\n\n@media only screen and (max-width: 1200px) {\n .container {\n padding: 0px 10px;\n }\n}"
},
{
"path": "aquila/view/components/ui/layout/Container.tsx",
"content": "import { FC } from \"react\";\n\nimport classes from './Container.module.scss';\n\ninterface ContainerProps {\n children: React.ReactNode;\n}\n\nconst Container: FC{message}
\n{props.children}
\n}\n\nexport default Container;"
},
{
"path": "aquila/view/components/ui/modal/Modal.module.scss",
"content": ".modal {\n width: 100%;\n height: 100%;\n position: fixed;\n top: 0px;\n left: 0px;\n background: rgb(32, 42, 56, 0.7);\n}"
},
{
"path": "aquila/view/components/ui/modal/Modal.tsx",
"content": "import { FC, useEffect, useState } from \"react\";\nimport ReactDOM from 'react-dom';\n\nimport classes from './Modal.module.scss';\n\ninterface ModelProps {\n children: React.ReactNode;\n onClose: Function\n}\n\nconst Modal: FC\n {props.children}\n
,\n document.getElementById(\"modal\") as HTMLElement\n ): null;\n}\n\nexport default Modal;"
},
{
"path": "aquila/view/components/ui/progressLoader/ProgressLoader.module.scss",
"content": ".progress-loader {\n position: fixed;\n top: 0px;\n height: 4px;\n display: block;\n width: 100%;\n background-color: rgb(15, 189, 134, 0.2);\n border-radius: 2px;\n overflow: hidden;\n z-index: 3000;\n\n &__item {\n background-color: #0FBD86;\n }\n \n &__item:before{\n content: '';\n position: absolute;\n background-color: inherit;\n top: 0;\n left: 0;\n bottom: 0;\n will-change: left, right;\n animation: progress 1.1s cubic-bezier(0.65, 0.815, 0.735, 0.395) infinite;\n }\n}\n\n@keyframes progress {\n 0% {\n left: -35%;\n right: 100%;\n }\n 60% {\n left: 100%;\n right: -90%;\n }\n 100% {\n left: 100%;\n right: -90%;\n }\n }"
},
{
"path": "aquila/view/components/ui/progressLoader/ProgressLoader.tsx",
"content": "import React, { FC, useContext, useState } from 'react';\nimport classes from './ProgressLoader.module.scss';\n\ninterface ProgressLoaderCtxValue { status: boolean, setLoader: (status: boolean) => void};\n\nconst ProgressLoaderCtx = React.createContext\n \n
\n )\n}\n\nexport const ProgressLoaderProvider: FC