various fixes

ergoplatform · Feb 12, 2024 · 09e82f5 · 09e82f5
1 parent 78b2f6d
commit 09e82f5
Show file tree

Hide file tree

Showing 17 changed files with 257 additions and 107 deletions.
diff --git a/.trunk/.gitignore b/.trunk/.gitignore
@@ -0,0 +1,9 @@
+*out
+*logs
+*actions
+*notifications
+*tools
+plugins
+user_trunk.yaml
+user.yaml
+tmp
diff --git a/.trunk/configs/.markdownlint.yaml b/.trunk/configs/.markdownlint.yaml
@@ -0,0 +1,10 @@
+# Autoformatter friendly markdownlint config (all formatting rules disabled)
+default: true
+blank_lines: false
+bullet: false
+html: false
+indentation: false
+line_length: false
+spaces: false
+url: false
+whitespace: false
diff --git a/.trunk/configs/.shellcheckrc b/.trunk/configs/.shellcheckrc
@@ -0,0 +1,7 @@
+enable=all
+source-path=SCRIPTDIR
+disable=SC2154
+
+# If you're having issues with shellcheck following source, disable the errors via:
+# disable=SC1090
+# disable=SC1091
diff --git a/.trunk/configs/.yamllint.yaml b/.trunk/configs/.yamllint.yaml
@@ -0,0 +1,10 @@
+rules:
+  quoted-strings:
+    required: only-when-needed
+    extra-allowed: ["{|}"]
+  empty-values:
+    forbid-in-block-mappings: true
+    forbid-in-flow-mappings: true
+  key-duplicates: {}
+  octal-values:
+    forbid-implicit-octal: true
diff --git a/.trunk/configs/svgo.config.js b/.trunk/configs/svgo.config.js
@@ -0,0 +1,14 @@
+module.exports = {
+  plugins: [
+    {
+      name: "preset-default",
+      params: {
+        overrides: {
+          removeViewBox: false, // https://github.com/svg/svgo/issues/1128
+          sortAttrs: true,
+          removeOffCanvasPaths: true,
+        },
+      },
+    },
+  ],
+};
diff --git a/.trunk/trunk.yaml b/.trunk/trunk.yaml
@@ -0,0 +1,36 @@
+version: 0.1
+cli:
+  version: 1.19.0
+plugins:
+  sources:
+    - id: trunk
+      ref: v1.4.2
+      uri: https://github.com/trunk-io/plugins
+runtimes:
+  enabled:
+    - [email protected]
+    - [email protected]
+    - [email protected]
+lint:
+  enabled:
+    - [email protected]
+    - [email protected]
+    - [email protected]
+    - git-diff-check
+    - [email protected]
+    - [email protected]
+    - [email protected]
+    - [email protected]
+    - [email protected]
+    - [email protected]
+    - [email protected]
+    - [email protected]
+    - [email protected]
+    - [email protected]
+actions:
+  disabled:
+    - trunk-announce
+    - trunk-check-pre-push
+    - trunk-fmt-pre-commit
+  enabled:
+    - trunk-upgrade-available
diff --git a/docs/contribute/standards/analytics.md b/docs/contribute/standards/analytics.md
@@ -1,19 +1,27 @@
 
 # Analytics
 
-- [ergo.watch](https://ergo.watch/)
+## On-chain Analytics
 
-### DeFiLlama
+For on-chain metrics such as P2PK count, you can refer to [ergo.watch](https://ergo.watch/).
 
-To be included on [defillama.com/chain/Ergo](https://defillama.com/chain/Ergo), you must create an adaptor. 
+### DeFiLlama Integration
 
-### Developers
+If you wish to be included on [defillama.com/chain/Ergo](https://defillama.com/chain/Ergo), it is necessary to create an adaptor.
 
-To be featured in the yearly report published by [developerreport.com](https://www.developerreport.com/ecosystems/ergo/) and the weekly-refreshed [Artemis](https://app.artemis.xyz/developer-activity?ecosystemValue=Ergo) dashboard, add your GitHub organisation or repositories to [this repository](https://github.com/electric-capital/crypto-ecosystems/blob/master/data/ecosystems/e/ergo.toml).
+### Developer Contributions
 
-<!--TODO
-### Wallet Statistics 
+To have your contributions recognized in the yearly report by [developerreport.com](https://www.developerreport.com/ecosystems/ergo/) and the weekly-updated [Artemis](https://app.artemis.xyz/developer-activity?ecosystemValue=Ergo) dashboard, please add your GitHub organization or repositories to [this repository](https://github.com/electric-capital/crypto-ecosystems/blob/master/data/ecosystems/e/ergo.toml).
 
-This graph shows the installs over time for both the Ergo Wallet (iOS/Android) and Nautilus. The Android figures are plagued with Airdrop hunters, leading to the large decreases. Focusing solely on the Nautilus/iOS stats, we can see a slow but steady rise. With the number of installs roughly doubling since January 2023. 
+### Developer Statistics
+
+- Total community developers: 350
+- Active contributors: 100
+- Monthly Active Developers: 58+
+
+### dApps/Projects Statistics
+
+- Sub-ecosystems: ~40+
+- Tradable tokens: Information can be found [here](https://sigmaverse.io/all-projects)
+- dApps in development: A dozen. A community roadmap is available [here](https://docs.google.com/spreadsheets/d/1d8bzPkZ__Ta5aFc388C7xkLiEaI-95IQcbgSRg8_wkw/edit?usp=sharing).
 
---!>
diff --git a/docs/dev/interact.md b/docs/dev/interact.md
@@ -0,0 +1,38 @@
+---
+tags:
+  - RPC
+  - Node
+---
+
+# Interacting with Ergo
+
+## Node
+
+- There is a public node available at [213.239.193.208:9053](http://213.239.193.208:9053). 
+- A redundancy can also be provided on request to [email protected]. 
+- A dynamic list of available public nodes can be found at [api.tokenjay.app/peers/list](http://api.tokenjay.app/peers/list)
+
+To set up your own node please see [this page](install.md)
+
+
+## Explorer
+
+The Ergo Explorer is a tool that serves as an interface with the Ergo blockchain. It helps users explore and monitor the activities happening on the Ergo blockchain.
+
+There are several public explorer available:
+
+- [explorer.ergoplatform.com](https://explorer.ergoplatform.com/)
+- [ergexplorer.com](https://ergexplorer.com/)
+- [sigmaspace.io](https://sigmaspace.io/)
+
+For mirrors, dev tooling and more information please see [this page](explorer.md)
+
+## APIs
+
+Ergo provides several APIs that offer different functionalities and services for developers and users. These APIs allow interaction with the Ergo blockchain, access to network data, and integration of Ergo into various applications.
+
+For mirrors, dev tooling and more information please see [this page](api.md)
+
+
+
+
diff --git a/docs/dev/stack/api-howto.md b/docs/dev/stack/api-howto.md
@@ -0,0 +1,26 @@
+
+## How to Use the APIs (For Beginners)
+
+If you are new to using APIs and want to get started with Ergo's APIs, here are some steps to help you get going:
+
+1. **Choose an API**: Determine which Ergo API suits your needs. Consider the specific functionalities and data you require for your application or project.
+
+2. **Read the Documentation**: Visit the API documentation for the chosen API. The documentation provides detailed information on the available endpoints, parameters, and response formats. Familiarize yourself with the API's capabilities and explore any example calls provided.
+
+3. **Understand the Endpoints**: Review the list of available endpoints and their purposes. Each endpoint serves a specific function and allows you to retrieve or interact with different data or services.
+
+4. **Authenticate (If Required)**: Some APIs may require authentication to access certain endpoints or perform specific actions. Refer to the API documentation to understand the authentication mechanisms and requirements. Obtain any necessary credentials or tokens to authenticate your requests.
+
+5. **Test Endpoints**: Use an API testing tool like Postman or cURL to send requests to the API endpoints. Start with simple requests to retrieve basic data, such as blockchain information or transaction details. Verify that you receive the expected responses.
+
+6. **Explore Data Retrieval**: Experiment with different endpoints to retrieve the data you need. For example, if you want to retrieve address-specific data, use the appropriate endpoint and provide the required parameters, such as the address. Study the response structure and extract the relevant information for your application.
+
+7. **Integrate into Your Application**: Once you are comfortable with retrieving data, integrate the API calls into your application or project. Use the retrieved data to power your application's features or display blockchain information to users.
+
+8. **Handle Errors**: Be prepared to handle potential errors or exceptions that may occur during API interactions. Refer to the API documentation to understand the possible error responses and implement appropriate error handling in your code.
+
+9. **Stay Updated**: Keep an eye on the API documentation and any announcements or updates related to the Ergo APIs. APIs may evolve over time, and new functionalities or improvements could be introduced. Stay informed to leverage the latest capabilities.
+
+10. **Seek Community Support**: If you encounter any difficulties or have questions while using the APIs, reach out to the Ergo community for support. Join forums, chat groups, or developer communities where you can connect with other developers working with Ergo. Sharing knowledge and experiences can be helpful in resolving any challenges you may face.
+
+Remember, APIs are powerful tools that allow you to interact with the Ergo blockchain and incorporate its features into your applications. Take your time to understand the API functionalities, experiment with different endpoints, and gradually build your integration to harness the full potential of Ergo's APIs.
diff --git a/docs/dev/stack/api.md b/docs/dev/stack/api.md
@@ -15,39 +15,3 @@ versions but may have updated features or improvements.
 
 These APIs provide various functionalities and data access points, allowing developers and users to leverage the power of Ergo blockchain in their applications, explore the blockchain network, interact with assets and tokens, and access decentralized exchange services.
 
-## Mirrors
-
-Some popular mirrors for the [explorer](explorer.md) and [graphql](graphql.md)
-
-- [Ergo Explorer API v0 (1.0)](https://api.ergo.aap.cornell.edu/api/v0/docs/): This is another version of the Explorer API that provides similar functionalities.
-- [Ergo Explorer API v1 (1.0)](https://api.ergo.aap.cornell.edu/api/v1/docs/): This version of the Explorer API offers functionalities similar to the previous 
-- [sigmaexplorer](https://api.sigmaexplorer.org/swagger/index.html): sigmaexplorer hosts a copy of the explorer using a GraphQL backend. 
-- [graphql.ergo.aap.cornell.edu](https://graphql.ergo.aap.cornell.edu/) is a GraphQL Server for the Ergo blockchain. It also has an explorer [ergo.aap.cornell.edu](https://ergo.aap.cornell.edu/).
-- [api.ergo.aap.cornell.edu](https://api.ergo.aap.cornell.edu/) provides an Explorer API and Web UI for the Ergo blockchain. It also hosts a node at this [address](http://128.253.41.49:9053/).
-
-
-## How to Use the APIs (For Beginners)
-
-If you are new to using APIs and want to get started with Ergo's APIs, here are some steps to help you get going:
-
-1. **Choose an API**: Determine which Ergo API suits your needs. Consider the specific functionalities and data you require for your application or project.
-
-2. **Read the Documentation**: Visit the API documentation for the chosen API. The documentation provides detailed information on the available endpoints, parameters, and response formats. Familiarize yourself with the API's capabilities and explore any example calls provided.
-
-3. **Understand the Endpoints**: Review the list of available endpoints and their purposes. Each endpoint serves a specific function and allows you to retrieve or interact with different data or services.
-
-4. **Authenticate (If Required)**: Some APIs may require authentication to access certain endpoints or perform specific actions. Refer to the API documentation to understand the authentication mechanisms and requirements. Obtain any necessary credentials or tokens to authenticate your requests.
-
-5. **Test Endpoints**: Use an API testing tool like Postman or cURL to send requests to the API endpoints. Start with simple requests to retrieve basic data, such as blockchain information or transaction details. Verify that you receive the expected responses.
-
-6. **Explore Data Retrieval**: Experiment with different endpoints to retrieve the data you need. For example, if you want to retrieve address-specific data, use the appropriate endpoint and provide the required parameters, such as the address. Study the response structure and extract the relevant information for your application.
-
-7. **Integrate into Your Application**: Once you are comfortable with retrieving data, integrate the API calls into your application or project. Use the retrieved data to power your application's features or display blockchain information to users.
-
-8. **Handle Errors**: Be prepared to handle potential errors or exceptions that may occur during API interactions. Refer to the API documentation to understand the possible error responses and implement appropriate error handling in your code.
-
-9. **Stay Updated**: Keep an eye on the API documentation and any announcements or updates related to the Ergo APIs. APIs may evolve over time, and new functionalities or improvements could be introduced. Stay informed to leverage the latest capabilities.
-
-10. **Seek Community Support**: If you encounter any difficulties or have questions while using the APIs, reach out to the Ergo community for support. Join forums, chat groups, or developer communities where you can connect with other developers working with Ergo. Sharing knowledge and experiences can be helpful in resolving any challenges you may face.
-
-Remember, APIs are powerful tools that allow you to interact with the Ergo blockchain and incorporate its features into your applications. Take your time to understand the API functionalities, experiment with different endpoints, and gradually build your integration to harness the full potential of Ergo's APIs.
diff --git a/docs/dev/stack/explorer.md b/docs/dev/stack/explorer.md
@@ -1,12 +1,12 @@
 # Explorers
 
+The Ergo Explorer is a tool that serves as an interface with the Ergo blockchain. It helps users explore and monitor the activities happening on the Ergo blockchain.
 
-/// details | Public Explorers
-    {type: info, open: true}
-There is a publicly available explorers at 
-- [explorer.ergoplatform.com](https://explorer.ergoplatform.com/) & [testnet.ergoplatform.com](https://testnet.ergoplatform.com/)
+There are several public explorer available:
+
+- [explorer.ergoplatform.com](https://explorer.ergoplatform.com/)
 - [ergexplorer.com](https://ergexplorer.com/)
-///
+- [sigmaspace.io](https://sigmaspace.io/)
 
 ## Toolkits
 
@@ -17,3 +17,14 @@ There is a publicly available explorers at
 ## uExplorer
 
 - [uExplorer](https://github.com/pragmaxim/ergo-uexplorer/) is a supplementary, lightweight Ergo explorer with CassandraDB backend :
+
+
+## Mirrors
+
+Some popular mirrors for the [explorer](explorer.md) and [graphql](graphql.md)
+
+- [api.ergo.aap.cornell.edu](https://api.ergo.aap.cornell.edu/) provides an Explorer API and Web UI for the Ergo blockchain. It also hosts a node at this [address](http://128.253.41.49:9053/).
+    - [api.ergo.aap.cornell.edu (1.0)](https://api.ergo.aap.cornell.edu/api/v0/docs/)
+    - [api.ergo.aap.cornell.edu v1 (1.0)](https://api.ergo.aap.cornell.edu/api/v1/docs/)
+    - [graphql.ergo.aap.cornell.edu](https://graphql.ergo.aap.cornell.edu/)
+- [sigmaexplorer](https://api.sigmaexplorer.org/swagger/index.html): sigmaexplorer hosts a copy of the explorer using a GraphQL backend.