docker-algorand-indexer

Algorand Indexer Docker Image

https://github.com/block-foundation/docker-algorand-indexer

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (6.9%) to scientific vocabulary

Keywords

algo algod algorand blockchain blockfoundation docker indexer postgres
Last synced: 6 months ago · JSON representation ·

Repository

Algorand Indexer Docker Image

Basic Info
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 1
  • Releases: 0
Topics
algo algod algorand blockchain blockfoundation docker indexer postgres
Created over 2 years ago · Last pushed almost 2 years ago
Metadata Files
Readme Contributing Funding License Code of conduct Citation Codeowners Security Authors

README.md

[![GitHub License](https://img.shields.io/github/license/block-foundation/blocktxt?style=flat-square&logo=readthedocs&logoColor=FFFFFF&label=&labelColor=%23041B26&color=%23041B26&link=LICENSE)](https://github.com/block-foundation/brand/blob/main/LICENSE) [![devContainer](https://img.shields.io/badge/Container-Remote?style=flat-square&logo=visualstudiocode&logoColor=%23FFFFFF&label=Remote&labelColor=%23041B26&color=%23041B26)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/block-foundation/brand) [![Docker Pulls](https://img.shields.io/docker/pulls/blockfoundation/algorand-indexer?style=flat-square&logo=docker&logoColor=%23FFFFFF&label=Pulls:&labelColor=%23041B26&color=%23041B26)](https://hub.docker.com/r/blockfoundation/algorand-indexer) [![Docker Stars](https://img.shields.io/docker/stars/blockfoundation/algorand-indexer?style=flat-square&logo=docker&logoColor=%23FFFFFF&label=Stars:&labelColor=%23041B26&color=%23041B26)](https://hub.docker.com/r/blockfoundation/algorand-indexer) [![Docker Image Version (latest semver)](https://img.shields.io/docker/v/blockfoundation/algorand-indexer?sort=semver&style=flat-square&logo=docker&logoColor=%23FFFFFF&label=Version:&labelColor=%23041B26&color=%23041B26)](https://hub.docker.com/r/blockfoundation/algorand-indexer/tags) [![Docker Size](https://img.shields.io/docker/image-size/blockfoundation/algorand-indexer/latest?style=flat-square&logo=docker&logoColor=%23FFFFFF&label=Size:&labelColor=%23041B26&color=%23041B26)](https://hub.docker.com/r/blockfoundation/algorand-indexer)

Block Foundation Logo

Algorand Indexer

Block Foundation Docker Containers


Block Foundation Containers

Contents



[![Report a Bug](https://img.shields.io/badge/Report%20a%20Bug-GitHub?style=flat-square&&logoColor=%23FFFFFF&color=%23E1E4E5)](https://github.com/block-foundation/docker-algorand-indexer/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=bug_report.yml) [![Request a Feature](https://img.shields.io/badge/Request%20a%20Feature-GitHub?style=flat-square&&logoColor=%23FFFFFF&color=%23E1E4E5)](https://github.com/block-foundation/docker-algorand-indexer/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=feature_request.yml) [![Ask a Question](https://img.shields.io/badge/Ask%20a%20Question-GitHub?style=flat-square&&logoColor=%23FFFFFF&color=%23E1E4E5)](https://github.com/block-foundation/docker-algorand-indexer/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=question.yml) [![Make a Suggestion](https://img.shields.io/badge/Make%20a%20Suggestion-GitHub?style=flat-square&&logoColor=%23FFFFFF&color=%23E1E4E5)](https://github.com/block-foundation/docker-algorand-indexer/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=suggestion.yml) [![Start a Discussion](https://img.shields.io/badge/Start%20a%20Discussion-GitHub?style=flat-square&&logoColor=%23FFFFFF&color=%23E1E4E5)](https://github.com/block-foundation/docker-algorand-indexer/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=discussion.yml)

The primary purpose of this Indexer is to provide a REST API interface of API calls to support searching the Algorand Blockchain. The Indexer REST APIs retrieve the blockchain data from a PostgreSQL compatible database that must be populated. This database is populated using the same indexer instance or a separate instance of the indexer which must connect to the algod process of a running Algorand node to read block data. This node must also be an Archival node to make searching the entire blockchain possible.

Introduction

In the context of the Algorand blockchain network, an Indexer is a tool that reads data from the Algorand blockchain and maintains a database of transactions and accounts that are searchable and indexed. On the other hand, Docker is a widely-used platform that simplifies the deployment, scaling, and management of applications. By merging these two technologies, we provide an easy-to-use and scalable way to interact with the Algorand network.

Our Docker image for the Algorand Indexer has been meticulously designed for accessibility, dependability, and security. It provides a preconfigured environment that's ready for use, thus reducing the hassle of manual setup. It is an ideal resource for developers keen on exploring the Algorand network, as well as those looking to contribute to the network by running an indexer.

Within this repository, you'll find comprehensive instructions on how to use the Docker image, alongside the source code of the image itself. We warmly encourage our community to utilize this Docker image, provide feedback, and join us in continually enhancing this resource.

As with all our projects, this Docker image stands as a testament to our commitment to transparency, collaboration, and democratization of technology. We are thrilled to share this resource with you and can't wait to see how it supports your endeavours in the blockchain space.

Network

mermaid stateDiagram Blockchain --> Node Node --> Blockchain Node --> Indexer state Indexer { Service --> Database Database --> Service } Indexer --> SDK state SDK { Python JavaScript Go Java }

Resources

  • https://hub.docker.com/r/algorand/indexer/tags

Algorand

Algorand SDK

Algorand Go

AlgoDjango

Algorand PyTeal

Algorand Sandbox


Colophon

Authors

This is an open-source project by the Block Foundation.

The Block Foundation mission is enabling architects to take back initiative and contribute in solving the mismatch in housing through blockchain technology. Therefore the Block Foundation seeks to unschackle the traditional constraints and construct middle ground between rent and the rigidity of traditional mortgages.

website: www.blockfoundation.io

Development Resources

Contributing

We'd love for you to contribute and to make this project even better than it is today! Please refer to the contribution guidelines for information.

Legal Information

Copyright

Copyright © 2023 Stichting Block Foundation. All Rights Reserved.

License

Except as otherwise noted, the content in this repository is licensed under the Creative Commons Attribution 4.0 International (CC BY 4.0) License, and code samples are licensed under the Apache 2.0 License.

Also see LICENSE and LICENSE-CODE.

Disclaimer

THIS SOFTWARE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.

Owner

  • Name: Block Foundation
  • Login: block-foundation
  • Kind: organization
  • Email: info@blockfoundation.io
  • Location: Netherlands

The Block Foundation mission is enabling architects to take back initiative and contribute in solving the mismatch in housing through blockchain technology.

Citation (CITATION.cff)

cff-version: 1.2.0
title: Block Foundation - Docker Images - Algorand Indexer
version: 0.0.1
date-released: 2023-07-01
url: "https://github.com/block-foundation/docker-algorand-indexer"
message: >-
  If you use this software, please cite it using
  the metadata from this file.
type: software
authors:
  - given-names: Lars Bastiaan
    family-names: van Vianen
    email: lars@blockfoundation.io
    affiliation: Block Foundation
    orcid: "https://orcid.org/0000-0002-8790-8630"

GitHub Events

Total
Last Year

Dependencies

.github/workflows/docker_publish.yml actions
  • actions/checkout v3 composite
  • azure/docker-login v1 composite
  • docker/bake-action v2 composite
  • docker/login-action v2 composite
  • docker/metadata-action v4 composite
  • docker/setup-buildx-action v2 composite
  • docker/setup-qemu-action v2 composite
.devcontainer/Dockerfile docker
  • ubuntu 22.04 build
.devcontainer/docker-compose.yml docker
bin/docker-compose.yml docker
src/algorand-indexer/Dockerfile docker
  • alpine latest build
  • golang $GO_VERSION-alpine build