Releases: pokt-network/gateway-server
0.4.0
What's Changed
- Enhance migration script to support specific and complete migrations/rollbacks by @Maxitosh in #38
- Issue-43 Add Node Health Prom Metrics per Chain by @Maxitosh in #44
- Update application registry when chains change. by @nodiesBlade in #42
- [CHORE] Update Memory Usage requirement by @nodiesBlade in #39
Full Changelog: 0.3.0...0.4.0
0.4.0-BETA
What's Changed
- Enhance migration script to support specific and complete migrations/rollbacks by @Maxitosh in #38
- Issue-43 Add Node Health Prom Metrics per Chain by @Maxitosh in #44
- Update application registry when chains change. by @nodiesBlade in #42
- [CHORE] Update Memory Usage requirement by @nodiesBlade in #39
Full Changelog: 0.3.0...0.4.0-BETA
RC 0.3.0
What's Changed
- Adds Height and Data Integrity Qos Checks for Solana mainnet, POKT Morse Mainnet, and verified Moonbeam mainnet support
- Emit Service URL prom metrics (emits the host service url for each relay) if env variable is enabled. This is disabled by default to prevent cardianlity explosion, but good resource to debug how each service domain is performing in comparsion to others
- Use latency compression variable instead of a magic number
- Update documentation on all QoS checks
- Add new environment variable
CHAIN_NETWORK
which represents the current network that gateway server is running on. This is initially to help with identifying chains dependent on network (i.e solana is 0006 on Mainnet and 0008 in testnet), however it can be used for backwards compatiability for isolating logic between morse and shannon as well. Default value ismorse_mainnet
What's Changed
- Updated .env.sample to correctly match docker-compose file by @0xThresh in #33
- [FEATURE] Add solana, pokt, moonbeam, and add emit prom metrics by @nodiesBlade in #34
New Contributors
Full Changelog: 0.2.0...0.3.0
0.3.0-BETA
What's Changed
- Adds Height and Data Integrity Qos Checks for Solana mainnet, POKT Morse Mainnet, and verified Moonbeam mainnet support
- Emit Service URL prom metrics (emits the host service url for each relay) if env variable is enabled. This is disabled by default to prevent cardianlity explosion, but good resource to debug how each service domain is performing in comparsion to others
- Use latency compression variable instead of a magic number
- Update documentation on all QoS checks
- Add new environment variable
CHAIN_NETWORK
which represents the current network that gateway server is running on. This is initially to help with identifying chains dependent on network (i.e solana is 0006 on Mainnet and 0008 in testnet), however it can be used for backwards compatiability for isolating logic between morse and shannon as well. Default value ismorse_mainnet
Full Changelog: 0.2.0...0.3.0-BETA
0.2.0
What's Changed
- Fix incorrect timeout setting and clarify env var docs by @Maxitosh in #29
- RC 0.2.0 by @nodiesBlade in #31
- Fixes typo in
is_heathy
->is_healthy
inqosnodes
endpoint (reason for the minor version upgrade) - Adds
node_public_key
toqosnodes
endpoint to enable Poktscan to scrape data and provide QoS data publically - Adds more tags to relayer prometheus metrics (chain id) and for histogram latency (chain id, altruist, and success) for increased observability oversight.
- Add
pocket_relay_latency
prom metric to keep track of latency for simply sending a relay to the network (no qos/node selection) - Improve QoS data integrity check by checking if the selected source of truth returns an actual block hash (otherwise skip and try again)
- Change module to
github.com/pokt-network/gateway-server
to match github repoistory now that we've transitioned it over to the Foundation. This allows others to import the v0 client pkg and other pkgs in the future. - Includes updated benchmarking doc with RC 0.2.0
- Fixes typo in
New Contributors
Full Changelog: 0.1.1...0.2.0
0.1.1
0.1.1 Notes
What's Changed
- Enhancement/unassigned/custom payload marshaller by @nodiesBlade in #27
Note: This is a non breaking change but users are recommended to upgrade to 0.1.1.
0.1.0 Notes
(Note, this is a non breaking change so gateway operators can upgrade safely)
Features:
- New Endpoint:
- Added
/qosnodes
endpoint to expose QoS node states with redacted information. This enhances visibility for node operators, aiding in identifying issues leading to network health improvements.
- Added
Enhancements:
-
Timeout Errors Handling:
- Improved timeout errors handling post-benchmarking, providing node operators with more comprehensive feedback alongside benchmarking results.
-
Session Handling Optimization:
- Optimized session handling by caching, reducing latency by pre-fetching sessions for each application. This optimization sets the foundation for the final Node Selector implementation, including the QoS check framework.
- Explicitly return an error in Pocket Client whenever dispatcher returns the wrong session, allowing for proper caching.
Miscellaneous Changes:
-
Logging Enhancement:
- Enhanced logs on session primer and refined logic for priming, improving system understanding and performance.
-
CI/CD Pipeline Integration:
- Added Continuous Integration/Continuous Deployment pipeline for streamlined development workflows.
-
Documentation Updates:
- Updated documentation to reflect changes regarding QoS improvements.
-
Chain Configuration Addition:
- Introduced per-chain configuration options for settings such as altruist.
-
Application registry updater fixes
- Previously whenever a user inserts the wrong RPC url, the gateway server would crash. Now it will simply return a graceful error that applications stakes could not be retrieved.
For more details, refer to the Node Selection Doc, and Chain Configuration Doc
What's Changed
- Release: RC-BETA 0.1.0 by @nodiesBlade in #24
- [TRIVIAL] Fix Broken Links for qos docs by @nodiesBlade in #25
- Enhancement: Session Error handling and caching by @nodiesBlade in #26
Full Changelog: 0.0.1...0.1.0
0.1.0
0.1.0 Release Notes
(Note, this is a non breaking change so gateway operators can upgrade safely)
Features:
- New Endpoint:
- Added
/qosnodes
endpoint to expose QoS node states with redacted information. This enhances visibility for node operators, aiding in identifying issues leading to network health improvements.
- Added
Enhancements:
-
Timeout Errors Handling:
- Improved timeout errors handling post-benchmarking, providing node operators with more comprehensive feedback alongside benchmarking results.
-
Session Handling Optimization:
- Optimized session handling by caching, reducing latency by pre-fetching sessions for each application. This optimization sets the foundation for the final Node Selector implementation, including the QoS check framework.
- Explicitly return an error in Pocket Client whenever dispatcher returns the wrong session, allowing for proper caching.
Miscellaneous Changes:
-
Logging Enhancement:
- Enhanced logs on session primer and refined logic for priming, improving system understanding and performance.
-
CI/CD Pipeline Integration:
- Added Continuous Integration/Continuous Deployment pipeline for streamlined development workflows.
-
Documentation Updates:
- Updated documentation to reflect changes regarding QoS improvements.
-
Chain Configuration Addition:
- Introduced per-chain configuration options for settings such as altruist.
-
Application registry updater fixes
- Previously whenever a user inserts the wrong RPC url, the gateway server would crash. Now it will simply return a graceful error that applications stakes could not be retrieved.
For more details, refer to the Node Selection Doc, and Chain Configuration Doc
What's Changed
- Release: RC-BETA 0.1.0 by @nodiesBlade in #24
- [TRIVIAL] Fix Broken Links for qos docs by @nodiesBlade in #25
- Enhancement: Session Error handling and caching by @nodiesBlade in #26
Full Changelog: 0.0.1...0.1.0
0.1.0-BETA
0.1.0-BETA Release Notes
(Note, this is a non breaking change so gateway operators can upgrade safely)
Features:
- New Endpoint:
- Added
/qosnodes
endpoint to expose QoS node states with redacted information. This enhances visibility for node operators, aiding in identifying issues leading to network health improvements.
- Added
Enhancements:
-
Timeout Errors Handling:
- Improved timeout errors handling post-benchmarking, providing node operators with more comprehensive feedback alongside benchmarking results.
-
Session Handling Optimization:
- Optimized session handling by caching, reducing latency by pre-fetching sessions for each application. This optimization sets the foundation for the final Node Selector implementation, including the QoS check framework.
Miscellaneous Changes:
-
Logging Enhancement:
- Enhanced logs on session primer and refined logic for priming, improving system understanding and performance.
-
CI/CD Pipeline Integration:
- Added Continuous Integration/Continuous Deployment pipeline for streamlined development workflows.
-
Documentation Updates:
- Updated documentation to reflect changes regarding QoS improvements.
-
Chain Configuration Addition:
- Introduced per-chain configuration options for settings such as altruist.
-
Application registry updater fixes
- Previously whenever a user inserts the wrong RPC url, the gateway server would crash. Now it will simply return a graceful error that applications stakes could not be retrieved.
For more details, refer to the Node Selection Doc, and Chain Configuration Doc
RC 0.0.1
What is POKT Gateway Server?
The POKT Gateway Server is a comprehensive solution designed to simplify the integration of applications with the POKT Network. Our goal is to reduce the complexities associated with directly interfacing with the protocol, making it accessible to a wide range of users, including application developers, existing centralized RPC platforms, and future gateway operators.
Learn more about the vision and overall architecture overview
Gateway Operator Quick Getting Started
To onboard the gateway server without having to dig deep, you can follow the Quick Onboarding Guide