Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Syncing master with develop #317

Merged
merged 67 commits into from
Jul 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
67 commits
Select commit Hold shift + click to select a range
8893e81
Origin introduced bug
May 28, 2024
57ca763
Merge pull request #293 from porters-xyz/nil-check
wtfsayo May 28, 2024
df4c14c
Allowing for log level changes
May 29, 2024
09027a4
forge install: @pythnetwork
May 29, 2024
0d373a4
some design updates and tos page
wtfsayo May 29, 2024
3fd50b4
notification pop up
wtfsayo May 29, 2024
d211fdc
build stuff
wtfsayo May 29, 2024
c285841
Deploy pyth adapter for taiko
May 29, 2024
a21b02b
Update Redeem.tsx
wtfsayo May 29, 2024
50fe538
Merge pull request #294 from porters-xyz/design-things
wtfsayo May 30, 2024
53b9e4a
Merge pull request #295 from porters-xyz/taiko
wtfsayo May 30, 2024
0f4938e
added no data image
wtfsayo May 30, 2024
407f94c
fix app update
wtfsayo May 30, 2024
dee5cea
layout update
wtfsayo May 30, 2024
ae23d3f
route protection!
wtfsayo May 30, 2024
79c1b76
add form within iframe
wtfsayo May 30, 2024
4cc3d24
Merge pull request #296 from porters-xyz/more-design-stuff
wtfsayo May 30, 2024
f5ba75f
typos fix
wtfsayo May 30, 2024
a9c4920
relay change and notification to frontest
wtfsayo May 30, 2024
c2ccbab
Update Swap.tsx
wtfsayo May 30, 2024
f09d62d
Update utils.service.ts
wtfsayo May 30, 2024
e3069ec
added comment
wtfsayo May 30, 2024
e0e505c
Adds LOG_LEVEL env var and exposes function for changing log level
May 30, 2024
fc15ebf
Merge pull request #299 from porters-xyz/fix-floating-pt-burn
wtfsayo May 31, 2024
8eef91e
Merge pull request #300 from porters-xyz/change-log-level
wtfsayo May 31, 2024
b338da2
theme update
wtfsayo May 31, 2024
b7d8c02
taiko updates
wtfsayo May 31, 2024
386cfe1
Merge pull request #301 from porters-xyz/theme-update-connectkit
wtfsayo Jun 1, 2024
612bc1e
Update utils.service.ts
wtfsayo Jun 1, 2024
57a902a
Merge pull request #302 from porters-xyz/taiko-event-watcher
wtfsayo Jun 1, 2024
fc9d164
added pricing page
wtfsayo Jun 2, 2024
175e0e4
remove force env during build
wtfsayo Jun 2, 2024
e93d3ee
added prod actions
wtfsayo Jun 2, 2024
f122258
Merge pull request #305 from porters-xyz/pricing-page
plor Jun 2, 2024
8b9d350
fixed names and desc
wtfsayo Jun 2, 2024
461e48e
prod token
wtfsayo Jun 2, 2024
70428e0
Merge pull request #306 from porters-xyz/prod-actions
wtfsayo Jun 2, 2024
679c1e6
ran through AI
wtfsayo Jun 3, 2024
feb49eb
edited docs
wtfsayo Jun 3, 2024
d920d02
added mdx extension
wtfsayo Jun 3, 2024
b93ad9f
build fix
wtfsayo Jun 3, 2024
d8780dc
Added links for dependencies documentation
Jun 4, 2024
bb4c999
tinkering with docs
benedictvscriticus Feb 15, 2024
4ca88ca
started on documentation with p and sayo
benedictvscriticus May 31, 2024
1746ae3
updated during our call
benedictvscriticus Jun 4, 2024
42ce19b
Merge branch 'documentation-updates' into dev-benedictvs
Jun 4, 2024
b608a4c
Removing lock file
Jun 4, 2024
4ec929d
fix duplicate and title
wtfsayo Jun 5, 2024
c9b50a5
Merge pull request #308 from porters-xyz/documentation
benedictvscriticus Jun 5, 2024
db980e9
fix path for docs actions
wtfsayo Jun 5, 2024
548efc2
added todo flag
wtfsayo Jun 6, 2024
3ec1383
Changing justfile setups for dev documentation
Jun 9, 2024
8ff6e1e
Adds full documentation for golang and architecture.
Jun 10, 2024
5ef8357
Merge pull request #310 from porters-xyz/plor-docs
wtfsayo Jun 11, 2024
8c53353
redeploy
wtfsayo Jun 11, 2024
33f0d72
Adds env variables to readme
Jun 13, 2024
ba478b7
Adds some manual database instructions
Jun 13, 2024
403dbfe
Merge pull request #311 from porters-xyz/docs_handoff
plor Jun 18, 2024
5c69668
Create 1_Overview.mdx
boucherbox Jun 28, 2024
3e1eab0
Update 1_Overview.mdx
boucherbox Jun 28, 2024
bf0ab53
Add User Docs
boucherbox Jun 28, 2024
6d10993
Update 2_PORTR.md
scermat Jun 28, 2024
c42b0ad
Merge pull request #313 from porters-xyz/User_Docs_Creation
scermat Jun 28, 2024
8dbdad0
removed empty docs file, fixed application guide file, and updated he…
scermat Jun 28, 2024
739a036
Merge pull request #314 from porters-xyz/general-fixes-to-docs
scermat Jun 28, 2024
1bf4031
general upkeep and minor changes to indexing for Docs
scermat Jul 1, 2024
26b8322
Merge pull request #315 from porters-xyz/general-fixes-to-docs
scermat Jul 1, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/workflows/backend-prod.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Fly Deploy Prod Backend
on:
push:
branches:
- master
paths:
- "web-portal/backend/**"
jobs:
deploy:
name: Deploy Prod Backend
runs-on: ubuntu-latest
concurrency: deploy-group
steps:
- uses: actions/checkout@v4
- uses: superfly/flyctl-actions/setup-flyctl@master
- run: cd web-portal/backend && flyctl deploy -c fly.prod.toml --remote-only
env:
FLY_API_TOKEN: ${{ secrets.FLY_PROD_API_TOKEN }}
18 changes: 18 additions & 0 deletions .github/workflows/docs-prod.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Fly Deploy Prod Docs
on:
push:
branches:
- master
paths:
- "docs/**"
jobs:
deploy:
name: Deploy Prod Frontend
runs-on: ubuntu-latest
concurrency: deploy-group
steps:
- uses: actions/checkout@v4
- uses: superfly/flyctl-actions/setup-flyctl@master
- run: cd docs && flyctl deploy -c fly.prod.toml --remote-only
env:
FLY_API_TOKEN: ${{ secrets.FLY_PROD_API_TOKEN }}
2 changes: 1 addition & 1 deletion .github/workflows/docs-staging.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ jobs:
steps:
- uses: actions/checkout@v4
- uses: superfly/flyctl-actions/setup-flyctl@master
- run: flyctl deploy -c fly.toml --remote-only
- run: cd docs && flyctl deploy -c fly.toml --remote-only
env:
FLY_API_TOKEN: ${{ secrets.FLY_STAGING_API_TOKEN }}
18 changes: 18 additions & 0 deletions .github/workflows/frontend-prod.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Fly Deploy Prod Frontend
on:
push:
branches:
- master
paths:
- "web-portal/frontend/**"
jobs:
deploy:
name: Deploy Prod Frontend
runs-on: ubuntu-latest
concurrency: deploy-group
steps:
- uses: actions/checkout@v4
- uses: superfly/flyctl-actions/setup-flyctl@master
- run: cd web-portal/frontend && flyctl deploy -c fly.prod.toml --remote-only
env:
FLY_API_TOKEN: ${{ secrets.FLY_PROD_API_TOKEN }}
18 changes: 18 additions & 0 deletions .github/workflows/proxy-prod.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Fly Deploy Prod Proxy
on:
push:
branches:
- master
paths:
- "gateway/**"
jobs:
deploy:
name: Deploy Prod Proxy
runs-on: ubuntu-latest
concurrency: deploy-group
steps:
- uses: actions/checkout@v4
- uses: superfly/flyctl-actions/setup-flyctl@master
- run: cd gateway && flyctl deploy -c fly.prod.toml --remote-only
env:
FLY_API_TOKEN: ${{ secrets.FLY_PROD_API_TOKEN }}
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,6 @@
[submodule "contracts/lib/solmate"]
path = contracts/lib/solmate
url = https://github.com/transmissions11/solmate
[submodule "contracts/lib/@pythnetwork"]
path = contracts/lib/@pythnetwork
url = https://github.com/pyth-network/pyth-crosschain
138 changes: 138 additions & 0 deletions POP_proposal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
# POKT Gateway Demo

Work related to https://forum.pokt.network/t/open-priority-gateway-demo/4874

## Proposal

### ⚔️ Raid Guild Proposal <> POKT OPEN PRIORITY: Gateway Demo ⚔️

> Building a User-facing Demo Gateway on top of the Nodies Gateway Kit

##### Scope of Work
This Raid Party proposed to handle all aspects of the rebuild of the POKT website. We are thrilled to present our comprehensive proposal for developing a state-of-the-art Software as a Service (SaaS) web portal that leverages the Gateway Kit as its robust backend. Our goal is to exceed expectations by incorporating essential features and considering some nice-to-have enhancements, resulting in a scalable portal that aligns perfectly with the needs of modern self-service SaaS platforms. We are committed to delivering an agile development process with active involvement from PNF and the Pocket community.

#### POKT POP- Gateway SaaS Kit

##### Detailed Modules Overview

###### 1. Project Website & Documentation
- **A. Public-Facing Website Development**
- **Framework**: Utilize React.js for a responsive, dynamic project website.
- **B. Comprehensive Documentation**
- **Tool**: Employ Docusaurus or similar for user-friendly documentation.
- **Content**: Include thorough API docs and user manuals.

###### 2. User Access Module
- **A. User Authentication System**
- **Authentication**: Implement OAuth2.0 or JWT for secure login.
- **User Management**: Full CRUD operations for user profiles.
- **B. App/Endpoint Management System**
- **App Settings**: Intuitive UI for configuration settings.
- **API Key Management**: Robust system for key generation and security.
- **Usage Reporting**: Detailed analytics and log dashboard for monitoring.

###### 3. Drop-in Payment Module
- **A. User-Payment Plan Setup**
- **Payment Integration**: Pay as you go crypto payments in multiple tokens.
- **Subscription Tiers**: Multiple tiers to cater to different user needs.
- **B. Invoicing & Reporting**
- **Usage Notifications**: Automated alerts for usage and billing.

###### 4. Gateway Admin Module - Frontend
- **A. Gateway Health & Monitoring**
- **Monitoring**: Real-time tracking and management of app stakes, utilizing Gateway Kit Prometheus metrics.
- **Visualization**: Dynamic, visual representation of stats and health indicators.
- **B. User Access & Monitoring**
- **Admin Panel**: Comprehensive user access management interface.
- **Audit Trails**: Detailed logging and auditing for security and compliance.

###### 5. Gateway Proxy/Backend Setup
- **A. Request Relaying via Gateway Kit**
- **Load Balancing**: Implement effective load distribution and routing.
- **B. Backend Tasks**
- **Data Processing**: Efficient handling and processing of backend data.
- **Caching Setup**: Implement caching for enhanced performance and speed.


#### Stack Details

##### Frontend
- **Framework**: Next.js
- Utilizes React.js, enabling server-side rendering and static site generation.
- Improved SEO, performance, easy routing, and Node.js integration.

##### Backend
- **Framework**: NestJS with Prisma ORM
- NestJS offers modular architecture, maintainable and scalable code.
- TypeScript support for reliability and maintainability.
- Prisma ORM integrated for strong typing, model validation, and efficient database management.
- Simplified database operations with an easy-to-use query builder.

- **Database**: PostgreSQL and Redis
- Advanced SQL database with strong consistency and reliability for multi-tenancy user and application data.
- Ideal for scalable applications and large datasets.
- Redis offers low latency writes necessary for collecting usage stats on the reverse proxy

- **Reverse Proxy**: Golang
- Interfaces with the gateway kit to offer the reverse proxy.
- Performs authorization via API keys created by management system.
- Tracks usage for billing purposes.


##### TEAM
###### [Raid Guild](https://www.raidguild.org/portfolio)
We are a selected Raiding Party custom built to tackle this unique POP. Raid Guild is a service DAO founded in late 2020 to provide clients access to a network of technical and creative Web3 builders. Our organization is flat and true to the ideals of the Ethereum ecosystem.

- **SAYONARA** - Lead Front End Dev
- **PLOR** - BackEnd Dev and Systems Engineer
- **BENEDICTVS** - Bis Dev
- **SASQUATCH** - Account/Project Management
---
#### Proposal from RaidGuild

##### Expected Deliverables
- **Design**
- Wireframes for the user portal
- Shared via figma for open use by community
- **Portal**
- User management
- Endpoint management
- Usage statistics and Rate limits
- Billing
- **Documentation**
- Gateway usage information
- Open source dev docs
- **Reverse Proxy**
- Routes to gateway kit
- Tracks per endpoint usage
- Rate limiting


##### **Milestones**
---
###### Sprint 1:
> - Design assets produced and reviewed
> - Backend components scaffolding and architecture design

###### Sprint 2:
> - Portal initial development
> - Landing page and login
> - Database initialization

###### Sprint 3:
> - Portal user creation
> - Reverse proxy development

###### Sprint 4:
> - Portal endpoint creation
> - Documentation setup
> - Per endpoint usage tracking

###### Sprint 5:
> - Portal usage and rate limiting
> - Payment accounting and processing

###### Sprint 6:
> - Portal accounting reporting and payments
> - Finalize documentation
> - Final backend deploys and configuration
Loading