Revert "docs:added readme and setup files"
This reverts commit 8dc4c93a14.
This commit is contained in:
Abhijeet Singh Rathor
BIN
Archive.zip
BIN
Archive.zip
Binary file not shown.
201
CLAUDE.md
201
CLAUDE.md
@@ -1,201 +0,0 @@
|
|||||||
# CLAUDE.md
|
|
||||||
|
|
||||||
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
|
||||||
|
|
||||||
## Project Overview
|
|
||||||
|
|
||||||
Beckn-ONIX is a middleware adapter system for the Beckn protocol, designed for any Beckn-enabled network. It acts as a bridge between BAP (Beckn Application Platform) and BPP (Beckn Provider Platform) systems, providing a plugin-based architecture for handling HTTP requests, routing, validation, signing, and integration with external services.
|
|
||||||
|
|
||||||
## Technology Stack
|
|
||||||
|
|
||||||
- **Language**: Go 1.23 (with Go 1.23.4 toolchain)
|
|
||||||
- **Architecture**: Plugin-based middleware system
|
|
||||||
- **Key Dependencies**:
|
|
||||||
- Redis (caching)
|
|
||||||
- RabbitMQ (messaging via amqp091-go)
|
|
||||||
- HashiCorp Vault (secrets management)
|
|
||||||
- JSON Schema validation (jsonschema/v6)
|
|
||||||
- **Containerization**: Docker with Dockerfile.adapter
|
|
||||||
- **Frontend**: Node.js-based GUI component (onix-gui/)
|
|
||||||
|
|
||||||
## Build and Development Commands
|
|
||||||
|
|
||||||
### Build locally
|
|
||||||
```bash
|
|
||||||
go build -o server cmd/adapter/main.go
|
|
||||||
```
|
|
||||||
|
|
||||||
### Run with configuration
|
|
||||||
```bash
|
|
||||||
./server --config=config/onix/adapter.yaml
|
|
||||||
```
|
|
||||||
|
|
||||||
### Docker build
|
|
||||||
```bash
|
|
||||||
docker build -f Dockerfile.adapter -t beckn-onix-adapter .
|
|
||||||
```
|
|
||||||
|
|
||||||
### Run tests
|
|
||||||
```bash
|
|
||||||
go test ./...
|
|
||||||
```
|
|
||||||
|
|
||||||
### Run specific test
|
|
||||||
```bash
|
|
||||||
go test ./pkg/plugin/implementation/cache -v
|
|
||||||
```
|
|
||||||
|
|
||||||
### Run tests with coverage
|
|
||||||
```bash
|
|
||||||
go test -coverprofile=coverage.out ./...
|
|
||||||
go tool cover -html=coverage.out # View coverage in browser
|
|
||||||
go tool cover -func=coverage.out # View coverage summary
|
|
||||||
```
|
|
||||||
|
|
||||||
### Run tests with race detection
|
|
||||||
```bash
|
|
||||||
go test -race ./...
|
|
||||||
```
|
|
||||||
|
|
||||||
### Format and lint code
|
|
||||||
```bash
|
|
||||||
go fmt ./...
|
|
||||||
go vet ./...
|
|
||||||
golangci-lint run # Requires golangci-lint installation
|
|
||||||
```
|
|
||||||
|
|
||||||
### Clean build artifacts
|
|
||||||
```bash
|
|
||||||
rm -f server
|
|
||||||
rm -rf plugins/*.so
|
|
||||||
```
|
|
||||||
|
|
||||||
### Module maintenance
|
|
||||||
```bash
|
|
||||||
go mod tidy # Clean up dependencies
|
|
||||||
go mod download # Download dependencies
|
|
||||||
go mod verify # Verify dependencies
|
|
||||||
```
|
|
||||||
|
|
||||||
### Local Development Setup
|
|
||||||
|
|
||||||
For local development without Docker:
|
|
||||||
|
|
||||||
1. **Build plugins** (required for the plugin-based architecture):
|
|
||||||
```bash
|
|
||||||
./build-plugins.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
2. **Create required directories**:
|
|
||||||
```bash
|
|
||||||
mkdir -p schemas
|
|
||||||
```
|
|
||||||
|
|
||||||
3. **Run with local config**:
|
|
||||||
```bash
|
|
||||||
go run cmd/adapter/main.go --config=config/local-dev.yaml
|
|
||||||
```
|
|
||||||
|
|
||||||
Note: The application requires:
|
|
||||||
- Redis running on localhost:6379 for caching
|
|
||||||
- Plugins built as .so files in the ./plugins directory
|
|
||||||
- Schema files in ./schemas for validation (optional)
|
|
||||||
- HashiCorp Vault for key management (optional, can be disabled in config)
|
|
||||||
|
|
||||||
## Architecture Overview
|
|
||||||
|
|
||||||
### Core Components
|
|
||||||
|
|
||||||
1. **cmd/adapter/main.go**: Main application entry point that:
|
|
||||||
- Loads YAML configuration
|
|
||||||
- Initializes plugin manager
|
|
||||||
- Sets up HTTP server with configurable timeouts
|
|
||||||
- Registers modules and their handlers
|
|
||||||
|
|
||||||
2. **core/module/**: Core business logic and module system
|
|
||||||
- `module.go`: Module registration and management
|
|
||||||
- `handler/`: HTTP request handlers and processing steps
|
|
||||||
- `client/`: Client registry for external service connections
|
|
||||||
|
|
||||||
3. **pkg/plugin/**: Extensible plugin system with:
|
|
||||||
- `definition/`: Plugin interfaces (cache, router, signer, validator, etc.)
|
|
||||||
- `implementation/`: Concrete implementations of each plugin type
|
|
||||||
- `manager.go`: Plugin lifecycle management
|
|
||||||
|
|
||||||
### Plugin Types
|
|
||||||
|
|
||||||
The system supports these plugin types:
|
|
||||||
- **cache**: Redis-based caching
|
|
||||||
- **router**: Request routing based on YAML configuration
|
|
||||||
- **signer/signvalidator**: Request signing and validation
|
|
||||||
- **schemavalidator**: JSON schema validation
|
|
||||||
- **keymanager**: HashiCorp Vault integration for secrets
|
|
||||||
- **publisher**: RabbitMQ message publishing
|
|
||||||
- **encrypter/decrypter**: AES encryption/decryption
|
|
||||||
- **reqpreprocessor**: Request preprocessing middleware (UUID generation, etc.)
|
|
||||||
|
|
||||||
### Configuration Structure
|
|
||||||
|
|
||||||
The system uses YAML configuration files in `config/` directory:
|
|
||||||
- `config/local-dev.yaml`: Simplified configuration for local development
|
|
||||||
- `config/local-routing.yaml`: Routing rules for local development
|
|
||||||
- `config/onix/`: Combined BAP+BPP configuration for production
|
|
||||||
- `config/onix-bap/`: BAP-only deployment configuration
|
|
||||||
- `config/onix-bpp/`: BPP-only deployment configuration
|
|
||||||
|
|
||||||
Each configuration defines:
|
|
||||||
- HTTP server settings (port, timeouts)
|
|
||||||
- Plugin manager settings
|
|
||||||
- Modules with their handlers, plugins, and processing steps
|
|
||||||
|
|
||||||
### Request Flow
|
|
||||||
|
|
||||||
1. HTTP request received by server
|
|
||||||
2. Routed to appropriate module (bapTxnReceiver, bapTxnCaller, bppTxnReceiver, bppTxnCaller)
|
|
||||||
3. Processed through configured steps (validateSign, addRoute, validateSchema, sign)
|
|
||||||
4. Each step uses configured plugins to perform its function
|
|
||||||
5. Response returned or forwarded based on routing configuration
|
|
||||||
|
|
||||||
## Module Types and Responsibilities
|
|
||||||
|
|
||||||
- **bapTxnReceiver**: Receives incoming requests at BAP (buyer platform)
|
|
||||||
- **bapTxnCaller**: Makes outgoing calls from BAP to BPP
|
|
||||||
- **bppTxnReceiver**: Receives incoming requests at BPP (provider platform)
|
|
||||||
- **bppTxnCaller**: Makes outgoing calls from BPP to BAP
|
|
||||||
|
|
||||||
## Module Configuration Patterns
|
|
||||||
|
|
||||||
Modules follow this structure:
|
|
||||||
- **name**: Module identifier
|
|
||||||
- **path**: HTTP endpoint path
|
|
||||||
- **handler**: Processing configuration including:
|
|
||||||
- **role**: "bap" or "bpp"
|
|
||||||
- **plugins**: Plugin instances with their configurations
|
|
||||||
- **steps**: Ordered list of processing steps
|
|
||||||
|
|
||||||
## Processing Steps
|
|
||||||
|
|
||||||
Available processing steps that can be configured:
|
|
||||||
- **validateSign**: Validates digital signatures on incoming requests
|
|
||||||
- **addRoute**: Determines routing based on configuration
|
|
||||||
- **validateSchema**: Validates against JSON schemas
|
|
||||||
- **sign**: Signs outgoing requests
|
|
||||||
- **cache**: Caches requests/responses
|
|
||||||
- **publish**: Publishes messages to queue
|
|
||||||
|
|
||||||
## Environment Variables
|
|
||||||
|
|
||||||
The configuration supports environment variable substitution using `${variable}` syntax, commonly used for:
|
|
||||||
- `${projectID}`: GCP project ID for Vault and Pub/Sub
|
|
||||||
- Connection strings and service endpoints
|
|
||||||
|
|
||||||
## Testing
|
|
||||||
|
|
||||||
Tests are colocated with source files using `_test.go` suffix. Each plugin implementation has comprehensive test coverage including mock data in `testdata/` directories.
|
|
||||||
|
|
||||||
## CI/CD Pipeline
|
|
||||||
|
|
||||||
The project uses GitHub Actions for CI with the following checks:
|
|
||||||
- Unit tests with minimum 90% coverage requirement
|
|
||||||
- golangci-lint for code quality
|
|
||||||
- Coverage reports uploaded to Codecov
|
|
||||||
352
README.md
352
README.md
@@ -1,353 +1 @@
|
|||||||
# Beckn-ONIX
|
|
||||||
|
|
||||||
<div align="center">
|
|
||||||
|
|
||||||
[](https://golang.org)
|
|
||||||
[](LICENSE)
|
|
||||||
[](https://github.com/beckn/beckn-onix/actions)
|
|
||||||
[](https://codecov.io/gh/beckn/beckn-onix)
|
|
||||||
|
|
||||||
**A production-ready, plugin-based middleware adapter for the Beckn Protocol**
|
|
||||||
|
|
||||||
[Overview](#overview) • [Features](#features) • [Architecture](#architecture) • [Quick Start](#quick-start) • [Documentation](#documentation) • [Contributing](#contributing)
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
Beckn-ONIX is an enterprise-grade middleware adapter system designed to facilitate seamless communication in any Beckn-enabled network. It acts as a protocol adapter between Beckn Application Platforms (BAPs - buyer applications) and Beckn Provider Platforms (BPPs - seller platforms), ensuring secure, validated, and compliant message exchange across various commerce networks.
|
|
||||||
|
|
||||||
### What is Beckn Protocol?
|
|
||||||
|
|
||||||
The **Beckn Protocol** is an open protocol that enables location-aware, local commerce across any platform and any domain. It allows creation of open, decentralized networks where:
|
|
||||||
|
|
||||||
- **Platform Independence**: Buyers and sellers can transact regardless of the platforms they use
|
|
||||||
- **Interoperability**: Seamless communication between different systems using standardized protocols
|
|
||||||
- **Domain Agnostic**: Works across retail, mobility, healthcare, logistics, and other domains
|
|
||||||
- **Network Neutral**: Can be deployed in any Beckn-compliant network globally
|
|
||||||
|
|
||||||
### Key Concepts
|
|
||||||
|
|
||||||
- **BAP (Beckn Application Platform)**: Buyer-side applications that help users search for and purchase products/services (e.g., consumer apps, aggregators)
|
|
||||||
- **BPP (Beckn Provider Platform)**: Seller-side platforms that provide products/services (e.g., merchant platforms, service providers)
|
|
||||||
- **Beckn Network**: Any network implementing the Beckn Protocol for enabling open commerce
|
|
||||||
|
|
||||||
## Features
|
|
||||||
|
|
||||||
### 🔌 **Plugin-Based Architecture**
|
|
||||||
- **Dynamic Plugin Loading**: Load and configure plugins at runtime without code changes
|
|
||||||
- **Extensible Design**: Easy to add new functionality through custom plugins
|
|
||||||
- **Hot-Swappable Components**: Update plugins without application restart (in development)
|
|
||||||
|
|
||||||
### 🔐 **Enterprise Security**
|
|
||||||
- **Ed25519 Digital Signatures**: Cryptographically secure message signing and validation
|
|
||||||
- **HashiCorp Vault Integration**: Centralized secrets and key management
|
|
||||||
- **Request Authentication**: Every message is authenticated and validated
|
|
||||||
- **TLS/SSL Support**: Encrypted communication channels
|
|
||||||
|
|
||||||
### ✅ **Protocol Compliance**
|
|
||||||
- **JSON Schema Validation**: Ensures all messages comply with Beckn protocol specifications
|
|
||||||
- **Version Management**: Support for multiple protocol versions simultaneously
|
|
||||||
- **Domain-Specific Schemas**: Tailored validation for different business domains
|
|
||||||
|
|
||||||
### 🚀 **High Performance**
|
|
||||||
- **Redis Caching**: Response caching for improved performance
|
|
||||||
- **RabbitMQ Integration**: Asynchronous message processing via message queues
|
|
||||||
- **Connection Pooling**: Efficient resource utilization
|
|
||||||
- **Configurable Timeouts**: Fine-tuned performance controls
|
|
||||||
|
|
||||||
### 📊 **Observability**
|
|
||||||
- **Structured Logging**: JSON-formatted logs with contextual information
|
|
||||||
- **Transaction Tracking**: End-to-end request tracing with unique IDs
|
|
||||||
- **Metrics Support**: Performance and business metrics collection
|
|
||||||
- **Health Checks**: Liveness and readiness probes for Kubernetes
|
|
||||||
|
|
||||||
### 🌐 **Multi-Domain Support**
|
|
||||||
- **Retail & E-commerce**: Product search, order management, fulfillment tracking
|
|
||||||
- **Mobility Services**: Ride-hailing, public transport, vehicle rentals
|
|
||||||
- **Logistics**: Shipping, last-mile delivery, returns management
|
|
||||||
- **Healthcare**: Appointments, telemedicine, pharmacy services
|
|
||||||
- **Financial Services**: Loans, insurance, payments
|
|
||||||
|
|
||||||
## Architecture
|
|
||||||
|
|
||||||
```
|
|
||||||
┌─────────────────────────────────────────────────────────┐
|
|
||||||
│ HTTP Request │
|
|
||||||
└────────────────────────┬────────────────────────────────┘
|
|
||||||
│
|
|
||||||
┌────────────────────────▼────────────────────────────────┐
|
|
||||||
│ Module Handler │
|
|
||||||
│ (bapTxnReceiver/Caller or bppTxnReceiver/Caller) │
|
|
||||||
└────────────────────────┬────────────────────────────────┘
|
|
||||||
│
|
|
||||||
┌────────────────────────▼────────────────────────────────┐
|
|
||||||
│ Processing Pipeline │
|
|
||||||
│ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ │
|
|
||||||
│ │ Middleware │→ │ Steps │→ │ Plugins │ │
|
|
||||||
│ │(preprocess) │ │(validate, │ │(cache,router│ │
|
|
||||||
│ └─────────────┘ │route, sign) │ │validator...)│ │
|
|
||||||
│ └─────────────┘ └─────────────┘ │
|
|
||||||
└────────────────────────┬────────────────────────────────┘
|
|
||||||
│
|
|
||||||
┌────────────────────────▼────────────────────────────────┐
|
|
||||||
│ External Services/Response │
|
|
||||||
└─────────────────────────────────────────────────────────┘
|
|
||||||
```
|
|
||||||
|
|
||||||
### Core Components
|
|
||||||
|
|
||||||
#### 1. **Transaction Modules**
|
|
||||||
- `bapTxnReceiver`: Receives callback responses at BAP
|
|
||||||
- `bapTxnCaller`: Sends requests from BAP to BPP
|
|
||||||
- `bppTxnReceiver`: Receives requests at BPP
|
|
||||||
- `bppTxnCaller`: Sends responses from BPP to BAP
|
|
||||||
|
|
||||||
#### 2. **Processing Steps**
|
|
||||||
- `validateSign`: Validates digital signatures on incoming requests
|
|
||||||
- `addRoute`: Determines routing based on configuration
|
|
||||||
- `validateSchema`: Validates against JSON schemas
|
|
||||||
- `sign`: Signs outgoing requests
|
|
||||||
- `cache`: Caches requests/responses
|
|
||||||
- `publish`: Publishes messages to queue
|
|
||||||
|
|
||||||
#### 3. **Plugin Types**
|
|
||||||
- **Cache**: Redis-based response caching
|
|
||||||
- **Router**: YAML-based routing rules engine
|
|
||||||
- **Signer/SignValidator**: Ed25519 signature handling
|
|
||||||
- **SchemaValidator**: JSON schema validation
|
|
||||||
- **KeyManager**: HashiCorp Vault integration
|
|
||||||
- **Publisher**: RabbitMQ message publishing
|
|
||||||
- **Encrypter/Decrypter**: AES encryption/decryption
|
|
||||||
- **ReqPreprocessor**: Request preprocessing (UUID generation, headers)
|
|
||||||
|
|
||||||
## Quick Start
|
|
||||||
|
|
||||||
### Prerequisites
|
|
||||||
|
|
||||||
- Go 1.23 or higher
|
|
||||||
- Redis (for caching)
|
|
||||||
- Docker (optional, for containerized deployment)
|
|
||||||
- HashiCorp Vault (optional, for production key management)
|
|
||||||
- RabbitMQ (optional, for async messaging)
|
|
||||||
|
|
||||||
### Installation
|
|
||||||
|
|
||||||
1. **Clone the repository**
|
|
||||||
```bash
|
|
||||||
git clone https://github.com/beckn/beckn-onix.git
|
|
||||||
cd beckn-onix
|
|
||||||
```
|
|
||||||
|
|
||||||
2. **Build the application**
|
|
||||||
```bash
|
|
||||||
go build -o server cmd/adapter/main.go
|
|
||||||
```
|
|
||||||
|
|
||||||
3. **Build plugins**
|
|
||||||
```bash
|
|
||||||
./build-plugins.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
4. **Start Redis** (if not running)
|
|
||||||
```bash
|
|
||||||
docker run -d -p 6379:6379 redis:alpine
|
|
||||||
```
|
|
||||||
|
|
||||||
5. **Run the application**
|
|
||||||
```bash
|
|
||||||
./server --config=config/local-dev.yaml
|
|
||||||
```
|
|
||||||
|
|
||||||
The server will start on `http://localhost:8081`
|
|
||||||
|
|
||||||
### Docker Deployment
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Build the Docker image
|
|
||||||
docker build -f Dockerfile.adapter -t beckn-onix:latest .
|
|
||||||
|
|
||||||
# Run the container
|
|
||||||
docker run -p 8080:8080 \
|
|
||||||
-v $(pwd)/config:/app/config \
|
|
||||||
-v $(pwd)/schemas:/app/schemas \
|
|
||||||
beckn-onix:latest
|
|
||||||
```
|
|
||||||
|
|
||||||
### Basic Usage Example
|
|
||||||
|
|
||||||
#### 1. Search for Products (BAP → BPP)
|
|
||||||
|
|
||||||
```bash
|
|
||||||
curl -X POST http://localhost:8081/bap/caller/search \
|
|
||||||
-H "Content-Type: application/json" \
|
|
||||||
-H "Authorization: Signature keyId=\"bap.example.com|key1|ed25519\",algorithm=\"ed25519\",created=\"1234567890\",expires=\"1234567990\",headers=\"(created) (expires) digest\",signature=\"base64signature\"" \
|
|
||||||
-d '{
|
|
||||||
"context": {
|
|
||||||
"domain": "nic2004:60221",
|
|
||||||
"country": "IND",
|
|
||||||
"city": "std:080",
|
|
||||||
"action": "search",
|
|
||||||
"core_version": "0.9.4",
|
|
||||||
"bap_id": "bap.example.com",
|
|
||||||
"bap_uri": "https://bap.example.com/beckn",
|
|
||||||
"transaction_id": "550e8400-e29b-41d4-a716-446655440000",
|
|
||||||
"message_id": "550e8400-e29b-41d4-a716-446655440001",
|
|
||||||
"timestamp": "2023-06-15T09:30:00.000Z",
|
|
||||||
"ttl": "PT30S"
|
|
||||||
},
|
|
||||||
"message": {
|
|
||||||
"intent": {
|
|
||||||
"fulfillment": {
|
|
||||||
"start": {
|
|
||||||
"location": {
|
|
||||||
"gps": "12.9715987,77.5945627"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"end": {
|
|
||||||
"location": {
|
|
||||||
"gps": "12.9715987,77.5945627"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}'
|
|
||||||
```
|
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
### Configuration Structure
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
appName: "beckn-onix"
|
|
||||||
log:
|
|
||||||
level: debug
|
|
||||||
destinations:
|
|
||||||
- type: stdout
|
|
||||||
http:
|
|
||||||
port: 8080
|
|
||||||
timeout:
|
|
||||||
read: 30
|
|
||||||
write: 30
|
|
||||||
idle: 30
|
|
||||||
pluginManager:
|
|
||||||
root: ./plugins
|
|
||||||
modules:
|
|
||||||
- name: bapTxnReceiver
|
|
||||||
path: /bap/receiver/
|
|
||||||
handler:
|
|
||||||
type: std
|
|
||||||
role: bap
|
|
||||||
plugins:
|
|
||||||
cache:
|
|
||||||
id: cache
|
|
||||||
config:
|
|
||||||
addr: localhost:6379
|
|
||||||
router:
|
|
||||||
id: router
|
|
||||||
config:
|
|
||||||
routingConfig: ./config/routing.yaml
|
|
||||||
schemaValidator:
|
|
||||||
id: schemavalidator
|
|
||||||
config:
|
|
||||||
schemaDir: ./schemas
|
|
||||||
steps:
|
|
||||||
- validateSign
|
|
||||||
- addRoute
|
|
||||||
- validateSchema
|
|
||||||
```
|
|
||||||
|
|
||||||
### Deployment Modes
|
|
||||||
|
|
||||||
1. **Combined Mode**: Single instance handling both BAP and BPP (`config/onix/`)
|
|
||||||
2. **BAP-Only Mode**: Dedicated buyer-side deployment (`config/onix-bap/`)
|
|
||||||
3. **BPP-Only Mode**: Dedicated seller-side deployment (`config/onix-bpp/`)
|
|
||||||
4. **Local Development**: Simplified configuration (`config/local-dev.yaml`)
|
|
||||||
|
|
||||||
## API Endpoints
|
|
||||||
|
|
||||||
### BAP Endpoints
|
|
||||||
|
|
||||||
| Method | Endpoint | Description |
|
|
||||||
|--------|----------|-------------|
|
|
||||||
| POST | `/bap/caller/search` | Search for products/services |
|
|
||||||
| POST | `/bap/caller/select` | Select specific items |
|
|
||||||
| POST | `/bap/caller/init` | Initialize order |
|
|
||||||
| POST | `/bap/caller/confirm` | Confirm order |
|
|
||||||
| POST | `/bap/caller/status` | Check order status |
|
|
||||||
| POST | `/bap/caller/track` | Track order/shipment |
|
|
||||||
| POST | `/bap/caller/cancel` | Cancel order |
|
|
||||||
| POST | `/bap/caller/update` | Update order |
|
|
||||||
| POST | `/bap/caller/rating` | Submit rating |
|
|
||||||
| POST | `/bap/caller/support` | Get support |
|
|
||||||
|
|
||||||
### BPP Endpoints
|
|
||||||
|
|
||||||
| Method | Endpoint | Description |
|
|
||||||
|--------|----------|-------------|
|
|
||||||
| POST | `/bpp/receiver/*` | Receives all BAP requests |
|
|
||||||
| POST | `/bpp/caller/on_*` | Sends responses back to BAP |
|
|
||||||
|
|
||||||
## Documentation
|
|
||||||
|
|
||||||
- **[Setup Guide](SETUP.md)**: Complete installation, configuration, and deployment instructions
|
|
||||||
- **[Contributing](CONTRIBUTING.md)**: Guidelines for contributors
|
|
||||||
- **[Governance](GOVERNANCE.md)**: Project governance model
|
|
||||||
- **[License](LICENSE)**: Apache 2.0 license details
|
|
||||||
|
|
||||||
## GUI Component
|
|
||||||
|
|
||||||
The project includes a Next.js-based GUI component located in `onix-gui/` that provides:
|
|
||||||
- Visual configuration management
|
|
||||||
- Request/response monitoring
|
|
||||||
- Plugin status dashboard
|
|
||||||
- Routing rules editor
|
|
||||||
|
|
||||||
## Testing
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Run all tests
|
|
||||||
go test ./...
|
|
||||||
|
|
||||||
# Run tests with coverage
|
|
||||||
go test -coverprofile=coverage.out ./...
|
|
||||||
go tool cover -html=coverage.out
|
|
||||||
|
|
||||||
# Run specific test
|
|
||||||
go test ./pkg/plugin/implementation/cache -v
|
|
||||||
|
|
||||||
# Run tests with race detection
|
|
||||||
go test -race ./...
|
|
||||||
```
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details on:
|
|
||||||
- Code of Conduct
|
|
||||||
- Development process
|
|
||||||
- Submitting pull requests
|
|
||||||
- Reporting issues
|
|
||||||
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- **Issues**: [GitHub Issues](https://github.com/beckn/beckn-onix/issues)
|
|
||||||
- **Discussions**: [GitHub Discussions](https://github.com/beckn/beckn-onix/discussions)
|
|
||||||
- **Documentation**: [Wiki](https://github.com/beckn/beckn-onix/wiki)
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
|
|
||||||
|
|
||||||
## Acknowledgments
|
|
||||||
|
|
||||||
- [Beckn Foundation](https://beckn.org) for the protocol specifications
|
|
||||||
- All contributors and community members
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
<div align="center">
|
|
||||||
Built with ❤️ for the open commerce ecosystem
|
|
||||||
</div>
|
|
||||||
@@ -1,32 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
|
|
||||||
# Create plugins directory
|
|
||||||
mkdir -p plugins
|
|
||||||
|
|
||||||
# Build each plugin as a shared library
|
|
||||||
echo "Building plugins..."
|
|
||||||
|
|
||||||
plugins=(
|
|
||||||
"cache"
|
|
||||||
"decrypter"
|
|
||||||
"encrypter"
|
|
||||||
"keymanager"
|
|
||||||
"publisher"
|
|
||||||
"reqpreprocessor"
|
|
||||||
"router"
|
|
||||||
"schemavalidator"
|
|
||||||
"signer"
|
|
||||||
"signvalidator"
|
|
||||||
)
|
|
||||||
|
|
||||||
for plugin in "${plugins[@]}"; do
|
|
||||||
echo "Building $plugin plugin..."
|
|
||||||
go build -buildmode=plugin -o "plugins/${plugin}.so" "./pkg/plugin/implementation/${plugin}/cmd/plugin.go"
|
|
||||||
if [ $? -eq 0 ]; then
|
|
||||||
echo "✓ Successfully built $plugin plugin"
|
|
||||||
else
|
|
||||||
echo "✗ Failed to build $plugin plugin"
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
echo "All plugins built in ./plugins directory"
|
|
||||||
Reference in New Issue
Block a user