Merge 25e54cf into 73baa3a

.github/workflows/pr.yaml

@@ -2,9 +2,12 @@ name: Pulll Request App Build
 
 # Controls when the action will run.
 on:
-  # Triggers the workflow pull request events but only for the main and develop branch
+  # Triggers the workflow pull request events
   pull_request:
-    branches: [main, develop, staging]
+    branches: ['**']
+  # Triggers the workflow push events but only for the main
+  push:
+    branches: [main]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -59,4 +62,9 @@ jobs:
       #   run: pnpm test:e2e
 
       - name: Build source code.
-        run: pnpm build
+        run: pnpm build
+
+      - name: Coveralls
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0
+Published by **[blockcoders](https://github.com/blockcoders)** on **2022/09/28**
+- [#1](https://github.com/blockcoders/ink-substrate-explorer-api/pull/1) Release v1.0.0 - Milestone 1 Ink Explorer API 

CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# Contributing
+
+1. [Fork it](https://help.github.com/articles/fork-a-repo/)
+2. Install dependencies (`pnpm i --frozen-lockfile`)
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Added some feature'`)
+5. Test your changes (`pnpm test`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. [Create new Pull Request](https://help.github.com/articles/creating-a-pull-request/)
+
+## Testing
+
+We use [Jest](https://github.com/facebook/jest) to write tests. Run our test suite with this command:
+
+```
+pnpm test
+```
+
+## Code Style
+
+We use [Prettier](https://prettier.io/) and tslint to maintain code style and best practices.
+Please make sure your PR adheres to the guides by running:
+
+```
+pnpm format
+```
+
+and
+```
+pnpm lint
+```

README-es.md

@@ -1,4 +1,9 @@
-# **Ink! Explorer**
+Ink! Explorer API
+=================
+
+[![App Build](https://github.com/blockcoders/ink-substrate-explorer-api/actions/workflows/pr.yaml/badge.svg)](https://github.com/blockcoders/ink-substrate-explorer-api/actions/workflows/pr.yaml)
+[![Coverage Status](https://coveralls.io/repos/github/blockcoders/ink-substrate-explorer-api/badge.svg?branch=main)](https://coveralls.io/github/blockcoders/ink-substrate-explorer-api?branch=main)
+[![Known Vulnerabilities](https://snyk.io/test/github/blockcoders/ink-substrate-explorer-api/badge.svg)](https://snyk.io/test/github/blockcoders/ink-substrate-explorer-api)
 
 ## **Acerca del explorador**
 
@@ -8,47 +13,6 @@ La idea de este proyecto es brindar una herramienta que permita a los desarrolla
 
 Este proyecto ofrece información útil que no está disponible en ningún otro lugar. Ya que el back end se encarga de obtener información relacionada con los saldos, transacciones y más, de los contratos que utilizan módulos Ink!. El explorador utiliza polkadot.js para comunicarse con las redes Substrate/Polkadot. Es seguro decir que este proyecto es imprescindible.
 
-Blockcoders es un equipo que siempre está contribuyendo a los proyectos de blockchain para ayudar al crecimiento del ecosistema.
-
-## **Sobre nosotros**
-
-### Miembros del equipo
-
-- Jose Ramirez
-- Fernando Sirni
-- Ruben Gutierrez
-
-### Contacto
-
-- **Nombre de contacto:** Jose Ramirez
-- **Email de contacto:** jose@blockcoders.io
-- **Sitio web:** http://blockcoders.io/
-
-### Experiencia del equipo
-
-Nuestro equipo ha estado contribuyendo con diferentes proyectos en blockchain durante algunos años, construyendo API, SDK y herramientas para desarrolladores. Nuestro objetivo es continuar impulsando el mundo crypto invirtiendo capital intelectual en proyectos, participando activamente para ayudar a dar forma a los ecosistemas en los que creemos.
-
-### Repositorios del equipo
-
-- https://github.com/blockcoders
-- https://github.com/blockcoders/nestjs-ethers
-- https://github.com/blockcoders/harmony-marketplace-sdk
-- https://github.com/blockcoders/near-rpc-providers
-- https://github.com/athenafarm/athena-vault-contracts
-- https://github.com/athenafarm/athena-sdk
-
-### Githubs de los miembros del equipo
-
-- https://github.com/0xslipk
-- https://github.com/fersirni
-- https://github.com/RubenGutierrezC
-
-### Perfiles de linkedIn de los miembros del equipo
-
-- https://www.linkedin.com/in/jarcodallo/
-- https://www.linkedin.com/in/fernando-sirni-1931ba122/
-- https://www.linkedin.com/in/rubengutierrezc/
-
 ## **Introduccion**
 
 ## Levantando el servicio localmente
@@ -62,49 +26,58 @@ Nuestro equipo ha estado contribuyendo con diferentes proyectos en blockchain du
 
 ### Instalar todas las dependencias
 
-```
+```sh
 pnpm i --frozen-lockfile
 ```
 
 ### Configurar las variables de entorno
 
 **Nota**: El archivo .env tiene la configuracion para GraphQL, la base de datos PostgreSQL, Node y la url del RPC de la blockchain basada en Substrate.
 
-```
+```sh
 cp .env.sample .env
 ```
 
-<span style="color:#2a98db"> **Configuraciones del servicio** </span>
+#### Configuraciones del servicio
 
-- **NODE_ENV**=development
-- **PORT**=8080
-- **LOG_NAME**=ink-substrate-explorer-api
-- **LOG_LEVEL**=debug
-
-<span style="color:#2a98db"> **Configuraciones de GraphQL** </span>
-
-- **GRAPHQL_DEBUG**=true
-- **GRAPHQL_PLAYGROUND**=true
-- **GRAPHQL_SORT_SCHEMA**=true
-- **GRAPHQL_INTROSPECTION**=true
+```sh
+NODE_ENV=development
+PORT=8080
+LOG_NAME=ink-substrate-explorer-api
+LOG_LEVEL=debug
+```
 
-<span style="color:#2a98db"> **Configuraciones de la base de datos** </span>
+#### Configuraciones de GraphQL
 
-- **DATABASE_HOST**=postgres
-- **DATABASE_NAME**=ink
-- **DATABASE_USERNAME**=root
-- **DATABASE_PASSWORD**=password
-- **DATABASE_RETRY_ATTEMPTS**=5
-- **DATABASE_RETRY_DELAY**=3000
+```sh
+GRAPHQL_DEBUG=true
+GRAPHQL_PLAYGROUND=true
+GRAPHQL_SORT_SCHEMA=true
+GRAPHQL_INTROSPECTION=true
+```
 
-<span style="color:#2a98db"> **Configuraciones de la blockchain y la sincronizacion de datos** </span>
+#### Configuraciones de la base de datos
 
-- **WS_PROVIDER**=wss://rococo-contracts-rpc.polkadot.io
-- **LOAD_ALL_BLOCKS**=false - <span style="color:#2a98db"> Asignar el valor _true_ para procesar cada bloque desde FIRST_BLOCK_TO_LOAD hasta el ultimo bloque de la cadena. Asignar el valor _false_ para solo comenzar a procesar los bloques desde el ultimo bloque existente en la base de datos.</span>
+```sh
+DATABASE_HOST=postgres
+DATABASE_NAME=ink
+DATABASE_USERNAME=root
+DATABASE_PASSWORD=password
+DATABASE_RETRY_ATTEMPTS=5
+DATABASE_RETRY_DELAY=3000
+```
 
-- **FIRST_BLOCK_TO_LOAD**=0 - <span style="color:#2a98db"> Número de bloque a partir del cual el servicio comenzará a procesar bloques. (Puede ser génesis o algún otro bloque. Por ejemplo, el primer bloque admite contratos) </span>
+#### Configuraciones de la blockchain y la sincronizacion de datos
 
-- **BLOCK_CONCURRENCY**=1000 - <span style="color:#2a98db"> Número de bloques a procesar simultáneamente. Esto puede acelerar o retrasar el proceso de sincronización.</span>
+```sh
+WS_PROVIDER=wss://rococo-contracts-rpc.polkadot.io
+# Asignar el valor _true_ para procesar cada bloque desde FIRST_BLOCK_TO_LOAD hasta el ultimo bloque de la cadena. Asignar el valor _false_ para solo comenzar a procesar los bloques desde el ultimo bloque existente en la base de datos.
+LOAD_ALL_BLOCKS=false
+# Número de bloque a partir del cual el servicio comenzará a procesar bloques. (Puede ser génesis o algún otro bloque. Por ejemplo, el primer bloque admite contratos)
+FIRST_BLOCK_TO_LOAD=0
+# Número de bloques a procesar simultáneamente. Esto puede acelerar o retrasar el proceso de sincronización.
+BLOCK_CONCURRENCY=1000
+```
 
 ## **Levantando el servicio (DEV)**
 
@@ -113,7 +86,7 @@ cp .env.sample .env
 Para levantar el servicio es necesario contar con una **BD PostgreSQL**. Para esto, el archivo **dev-docker-compose.yaml** ya tiene una imagen configurada lista para usar.
 Ejecutando el siguiente comando tambien instanciara un contenedor para pgAdmin:
 
-```
+```sh
 docker-compose -f dev-docker-compose.yaml up -d
 ```
 
@@ -145,7 +118,7 @@ Establezca las credenciales para la base de datos PostgreSQL (esto se puede enco
 El servicio necesita conectarse a una blockchain basada en Substrate. Para esto, el archivo **dev-docker-compose.yaml** ya tiene una imagen configurada lista para usar.
 Ejecute este comando:
 
-```
+```sh
 docker-compose -f dev-docker-compose.yaml up -d
 ```
 
@@ -155,7 +128,9 @@ Otra forma de ejecutar un nodo local es con [esta guía de paritytech](https://g
 
 ### Levantando el servicio
 
-- ### `pnpm start:dev`
+```sh
+pnpm start:dev
+```
 
 Ejecuta el servicio en el modo de desarrollo.
 El servicio se recargará si realiza ediciones.
@@ -168,23 +143,30 @@ El servicio se recargará si realiza ediciones.
 
 ### Descarga la imagen de DockerHub
 
-```
+```sh
 docker pull blockcoders/ink-substrate-explorer-api:latest
 ```
 
 ### Run
 
-- ### `docker run -it -p 5000:5000 --network ink-explorer-network --env-file {pathToEnvFile} blockcoders/ink-substrate-explorer-api:latest`
-
-Verifique que la imagen comenzó a ejecutarse
+```sh
+# Crear la red de docker
+docker network create ink-explorer-network
 
+# Correr servicio
+docker run -it -p 5000:5000 --network ink-explorer-network --env-file {pathToEnvFile} blockcoders/ink-substrate-explorer-api:latest
 ```
+
+
+#### Verifique que la imagen comenzó a ejecutarse
+
+```sh
 docker ps
 ```
 
 El resultado debería verse así:
 
-```
+```sh
 CONTAINER ID   IMAGE                                    COMMAND                  CREATED          STATUS          PORTS                                       NAMES
 f31a7d0fd6c8   blockcoders/ink-substrate-explorer-api   "docker-entrypoint.s…"   15 seconds ago   Up 14 seconds   0.0.0.0:5000->5000/tcp, :::5000->5000/tcp   funny_lumiere
 ```
@@ -193,23 +175,31 @@ Después de que se inició el servidor, los bloques deberían guardarse en la ba
 
 Para iniciar tanto el contenedor del servicio de back-end como el contenedor de la base de datos, ejecute:
 
-- ### `docker-compose up -d`
+```sh
+docker-compose up -d
+```
 
 El servicio se conectará al contenedor DB y comenzará a procesar bloques.
 
 ## **Testing**
 
 Ejecución de las pruebas unitarias.
 
-- ### `pnpm test`
+```sh
+pnpm test
+```
 
 Ejecución de la cobertura de pruebas.
 
-- ### `pnpm test:cov`
+```sh
+pnpm test:cov
+```
 
 Probando las consultas de GraphQL.
 
-- ### `{"level":30,"time":1664298430389,"pid":1388770,"hostname":"username","name":"ink-substrate-explorer-api","msg":"App listening on http://0.0.0.0:5000"}`
+```sh
+{"level":30,"time":1664298430389,"pid":1388770,"hostname":"username","name":"ink-substrate-explorer-api","msg":"App listening on http://0.0.0.0:5000"}
+```
 
 Una vez que el servicio back-end se está ejecutando, se puede acceder a GraphQL Playground en http://localhost:5000/graphql
 
@@ -659,3 +649,21 @@ En caso de un tiempo de inactividad del nodo, las suscripciones se reconectarán
 - 1000 bloques en ~ 5 segundos
 - 10000 bloques en ~ 3 minutos
 - 100000 bloques en ~ 24 minutos
+
+## Registro de cambios
+
+Consulte [Changelog](CHANGELOG.md) para más información.
+
+## Contribuye
+
+¡Las contribuciones son bienvenidas! Consulte [Contributing](CONTRIBUTING.md).
+
+## Colaboradores
+
+* [__Jose Ramirez__](https://github.com/0xslipk)
+* [__Fernando Sirni__](https://github.com/fersirni)
+* [__Ruben Gutierrez__](https://github.com/RubenGutierrezC)
+
+## Licencia
+
+Con licencia de Apache 2.0 - consulte el archivo [LICENSE](LICENSE) para obtener más información.