mirror of
https://github.com/juspay/hyperswitch.git
synced 2025-10-25 18:34:29 +08:00
chore: rename orca to hyperswitch (#310)
This commit is contained in:
9
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
9
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
@ -7,8 +7,8 @@ body:
|
||||
attributes:
|
||||
value: |
|
||||
We value your time and effort to submit this bug report. Here are a few things to check before clicking the submit button :)
|
||||
1. Make sure you're on the latest version of the app. The current release can be found here: https://github.com/juspay/orca/releases/latest.
|
||||
2. Search through **both** open and closed issues for your bug: https://github.com/juspay/orca/issues?q=is%3Aissue+sort%3Aupdated-desc+.
|
||||
1. Make sure you're on the latest version of the app. The current release can be found here: https://github.com/juspay/hyperswitch/releases/latest.
|
||||
2. Search through **both** open and closed issues for your bug: https://github.com/juspay/hyperswitch/issues?q=is%3Aissue+sort%3Aupdated-desc+.
|
||||
3. Please try to fill this template completely to the best of your abilities. A bug report that is clear and has a reproducible example lets us get to work faster.
|
||||
|
||||
- type: textarea
|
||||
@ -66,7 +66,8 @@ body:
|
||||
label: Environment
|
||||
description: Provide information about the environment where you are running or trying to build the app.
|
||||
value: |
|
||||
Are you using Orca hosted version? Yes/No
|
||||
Are you using hyperswitch hosted version? Yes/No
|
||||
If yes, please provide the value of the `x-request-id` response header for helping us debug your issue.
|
||||
|
||||
If not (or if building/running locally), please provide the following details:
|
||||
1. Operating System or Linux distribution:
|
||||
@ -88,7 +89,7 @@ body:
|
||||
attributes:
|
||||
label: Have you read the Contributing Guidelines?
|
||||
options:
|
||||
- label: I have read the [Contributing Guidelines](https://github.com/juspay/orca/blob/main/contrib/CONTRIBUTING.md)
|
||||
- label: I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/contrib/CONTRIBUTING.md)
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
|
||||
8
.github/ISSUE_TEMPLATE/config.yml
vendored
8
.github/ISSUE_TEMPLATE/config.yml
vendored
@ -1,5 +1,11 @@
|
||||
blank_issues_enabled: true
|
||||
contact_links:
|
||||
- name: Discord server
|
||||
url: https://discord.gg/XbHNKqeAjE
|
||||
about: Please ask any questions you may have here.
|
||||
- name: Slack workspace
|
||||
url: https://join.slack.com/t/hyperswitch-io/shared_invite/zt-1k6cz4lee-SAJzhz6bjmpp4jZCDOtOIg
|
||||
about: Please ask any questions you may have here.
|
||||
- name: GitHub Discussions
|
||||
url: https://github.com/juspay/orca/discussions
|
||||
url: https://github.com/juspay/hyperswitch/discussions
|
||||
about: Please ask and answer questions here.
|
||||
|
||||
6
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
6
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
@ -7,8 +7,8 @@ body:
|
||||
attributes:
|
||||
value: |
|
||||
We value your time and efforts to submit this feature request form. Here are a few things to check before clicking the submit button :)
|
||||
1. Make sure you're on the latest version of the app. Features are being added all the time and it is entirely possible what you're requesting has already been added. The current release can be found here: https://github.com/juspay/orca/releases/latest.
|
||||
2. Check the changelog file to confirm that the feature hasn't been added for an upcoming release: https://github.com/juspay/orca/blob/main/CHANGELOG.md
|
||||
1. Make sure you're on the latest version of the app. Features are being added all the time and it is entirely possible what you're requesting has already been added. The current release can be found here: https://github.com/juspay/hyperswitch/releases/latest.
|
||||
2. Check the changelog file to confirm that the feature hasn't been added for an upcoming release: https://github.com/juspay/hyperswitch/blob/main/CHANGELOG.md
|
||||
3. Please try to fill this template completely to the best of your abilities. A feature request that is clear and explicit in its needs lets us get to work faster.
|
||||
|
||||
- type: textarea
|
||||
@ -42,7 +42,7 @@ body:
|
||||
attributes:
|
||||
label: Have you read the Contributing Guidelines?
|
||||
options:
|
||||
- label: I have read the [Contributing Guidelines](https://github.com/juspay/orca/blob/main/contrib/CONTRIBUTING.md)
|
||||
- label: I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/contrib/CONTRIBUTING.md)
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
|
||||
2
.gitignore
vendored
2
.gitignore
vendored
@ -238,7 +238,7 @@ $RECYCLE.BIN/
|
||||
|
||||
# End of https://www.toptal.com/developers/gitignore/api/rust,visualstudiocode,clion,dotenv,direnv,linux,macos,windows
|
||||
|
||||
# Orca Project specific excludes
|
||||
# hyperswitch Project specific excludes
|
||||
# code coverage report
|
||||
*.profraw
|
||||
html/
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# Description: One click install for ORCA Router
|
||||
# Description: One click install for hyperswitch router
|
||||
#
|
||||
#
|
||||
# Global config
|
||||
@ -10,7 +10,7 @@ if [[ "${TRACE-0}" == "1" ]]; then
|
||||
fi
|
||||
|
||||
RUST_MSRV=1.65.0
|
||||
_DB_NAME="orca_db"
|
||||
_DB_NAME="hyperswitch_db"
|
||||
_DB_USER="db_user"
|
||||
_DB_PASS="db_password"
|
||||
|
||||
|
||||
7
NOTICE
7
NOTICE
@ -1,5 +1,6 @@
|
||||
Orca
|
||||
Copyright 2022 Juspay Technologies Private Limited
|
||||
hyperswitch
|
||||
|
||||
Copyright 2022-2023 Juspay Technologies Private Limited
|
||||
|
||||
This product includes software developed at
|
||||
Juspay Technologies Private Limited (https://juspay.io/)
|
||||
Juspay Technologies Private Limited (https://hyperswitch.io/)
|
||||
|
||||
54
README.md
54
README.md
@ -1,16 +1,16 @@
|
||||
# ORCA
|
||||
# hyperswitch
|
||||
|
||||
[![Build Status][actions-badge]][actions-url]
|
||||
[![Apache 2.0 license][license-badge]][license-url]
|
||||
|
||||
[actions-badge]: https://github.com/juspay/orca/workflows/CI/badge.svg
|
||||
[actions-url]: https://github.com/juspay/orca/actions?query=workflow%3ACI+branch%3Amain
|
||||
[license-badge]: https://img.shields.io/github/license/juspay/orca
|
||||
[license-url]: https://github.com/juspay/orca/blob/main/LICENSE
|
||||
[actions-badge]: https://github.com/juspay/hyperswitch/workflows/CI/badge.svg
|
||||
[actions-url]: https://github.com/juspay/hyperswitch/actions?query=workflow%3ACI+branch%3Amain
|
||||
[license-badge]: https://img.shields.io/github/license/juspay/hyperswitch
|
||||
[license-url]: https://github.com/juspay/hyperswitch/blob/main/LICENSE
|
||||
|
||||
Orca is a **_Payment Switch_** that lets you connect with **multiple payment processors with a single API integration**.
|
||||
hyperswitch is a **_Payment Switch_** that lets you connect with **multiple payment processors with a single API integration**.
|
||||
Once integrated, you can add new payment processors and route traffic effortlessly.
|
||||
Using Orca, you can:
|
||||
Using hyperswitch, you can:
|
||||
|
||||
- Reduce dependency on a single processor like Stripe
|
||||
- Control & customize your payment flow with 100% visibility
|
||||
@ -19,10 +19,10 @@ Using Orca, you can:
|
||||
- Expand your business reach with new payment methods
|
||||
- Reduce development & testing efforts of adding new processors
|
||||
|
||||
_Orca is wire-compatible with top processors like Stripe making it easy to integrate._
|
||||
_hyperswitch is wire-compatible with top processors like Stripe making it easy to integrate._
|
||||
|
||||
<p align="center">
|
||||
<img src= "./docs/imgs/orca-product.png" alt="orca-product" width="40%" />
|
||||
<img src= "./docs/imgs/hyperswitch-product.png" alt="hyperswitch-product" width="40%" />
|
||||
</p>
|
||||
|
||||
## Table of Contents
|
||||
@ -30,7 +30,8 @@ _Orca is wire-compatible with top processors like Stripe making it easy to integ
|
||||
- [Quick Start Guide](#quick-start-guide)
|
||||
- [Supported Features](#supported-features)
|
||||
- [What's Included](#whats-included)
|
||||
- [Join us in building ORCA](#join-us-in-building-orca)
|
||||
- [Join us in building hyperswitch](#join-us-in-building-hyperswitch)
|
||||
- [Community](#community)
|
||||
- [Bugs and feature requests](#bugs-and-feature-requests)
|
||||
- [Versioning](#versioning)
|
||||
- [Copyright and License](#copyright-and-license)
|
||||
@ -39,17 +40,17 @@ _Orca is wire-compatible with top processors like Stripe making it easy to integ
|
||||
|
||||
### Try It Out
|
||||
|
||||
You have two options to try out Orca:
|
||||
You have two options to try out hyperswitch:
|
||||
|
||||
1. [Try out our sandbox environment](/docs/try_sandbox.md): Requires the least
|
||||
effort and does not involve setting up anything on your system.
|
||||
2. [Try out Orca on your local system](/docs/try_local_system.md): Requires
|
||||
comparatively more effort as it involves setting up dependencies on your
|
||||
system.
|
||||
2. [Try out hyperswitch on your local system](/docs/try_local_system.md):
|
||||
Requires comparatively more effort as it involves setting up dependencies on
|
||||
your system.
|
||||
|
||||
### Fast Integration for Stripe Users
|
||||
|
||||
If you are already using Stripe, integrating with Orca is fun, fast & easy.
|
||||
If you are already using Stripe, integrating with hyperswitch is fun, fast & easy.
|
||||
Try the steps below to get a feel for how quick the setup is:
|
||||
|
||||
1. Get API keys from our [dashboard](https://orca-dahboard.netlify.app).
|
||||
@ -135,15 +136,15 @@ The current setup contains a single repo, which contains the core payment router
|
||||
└── target : generated files
|
||||
```
|
||||
|
||||
## Join us in building ORCA
|
||||
## Join us in building hyperswitch
|
||||
|
||||
### Our Belief
|
||||
|
||||
**We believe payments should be open, fast and cheap.**
|
||||
|
||||
Orca would allow everyone to quickly customize and set up an open payment switch, while giving a unified experience to your users, abstracting away the ever shifting payments landscape.
|
||||
hyperswitch would allow everyone to quickly customize and set up an open payment switch, while giving a unified experience to your users, abstracting away the ever shifting payments landscape.
|
||||
|
||||
The Orca journey starts with a payment orchestrator.
|
||||
The hyperswitch journey starts with a payment orchestrator.
|
||||
It was born from our struggle to understand and integrate various payment options/payment processors/networks and banks, with varying degrees of documentation and inconsistent API semantics.
|
||||
|
||||
### Contributing
|
||||
@ -158,22 +159,19 @@ Important note for Rust developers: We aim for contributions from the community
|
||||
Hence, we have prioritized simplicity and code readability over purely idiomatic code.
|
||||
For example, some of the code in core functions (e.g. `payments_core`) is written to be more readable rather than being pure-idiomatic.
|
||||
|
||||
<!--
|
||||
## Community
|
||||
|
||||
Get updates on ORCA development and chat with the community:
|
||||
Get updates on hyperswitch development and chat with the community:
|
||||
|
||||
- Join our Slack channel [Link]
|
||||
- Join our Discord channel [Link]
|
||||
- Follow @orca_juspay on Twitter [Link]
|
||||
- Read and subscribe to The Official Orca Blog [Link]
|
||||
- Ask and explore our GitHub Discussion [Link]
|
||||
-->
|
||||
- Read and subscribe to [the official hyperswitch blog](https://blog.hyperswitch.io)
|
||||
- Join our [Discord server](https://discord.gg/XbHNKqeAjE)
|
||||
- Join our [Slack workspace](https://join.slack.com/t/hyperswitch-io/shared_invite/zt-1k6cz4lee-SAJzhz6bjmpp4jZCDOtOIg)
|
||||
- Ask and explore our [GitHub Discussions](https://github.com/juspay/hyperswitch/discussions)
|
||||
|
||||
## Bugs and feature requests
|
||||
|
||||
Please read the issue guidelines and search for [existing and closed issues](https://github.com/juspay/orca/issues).
|
||||
If your problem or idea is not addressed yet, please [open a new issue](https://github.com/juspay/orca/issues/new/choose).
|
||||
Please read the issue guidelines and search for [existing and closed issues](https://github.com/juspay/hyperswitch/issues).
|
||||
If your problem or idea is not addressed yet, please [open a new issue](https://github.com/juspay/hyperswitch/issues/new/choose).
|
||||
|
||||
## Versioning
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ username = "db_user"
|
||||
password = "db_pass"
|
||||
host = "localhost"
|
||||
port = 5432
|
||||
dbname = "orca_db"
|
||||
dbname = "hyperswitch_db"
|
||||
pool_size = 5
|
||||
|
||||
[proxy]
|
||||
@ -37,8 +37,8 @@ locker_decryption_key1 = ""
|
||||
locker_decryption_key2 = ""
|
||||
|
||||
[connectors.supported]
|
||||
wallets = ["klarna","braintree","applepay"]
|
||||
cards = ["stripe","adyen","authorizedotnet","checkout","braintree","aci","shift4","cybersource"]
|
||||
wallets = ["klarna", "braintree", "applepay"]
|
||||
cards = ["stripe", "adyen", "authorizedotnet", "checkout", "braintree", "aci", "shift4", "cybersource"]
|
||||
|
||||
[eph_key]
|
||||
validity = 1
|
||||
|
||||
@ -17,21 +17,21 @@ request_body_limit = 16_384
|
||||
|
||||
# Main SQL data store credentials
|
||||
[master_database]
|
||||
username = "db_user" # DB Username
|
||||
password = "db_pass" # DB Password
|
||||
host = "localhost" # DB Host
|
||||
port = 5432 # DB Port
|
||||
dbname = "orca_db" # Name of Database
|
||||
username = "db_user" # DB Username
|
||||
password = "db_pass" # DB Password
|
||||
host = "localhost" # DB Host
|
||||
port = 5432 # DB Port
|
||||
dbname = "hyperswitch_db" # Name of Database
|
||||
pool_size = 5 # Number of connections to keep open
|
||||
|
||||
# Replica SQL data store credentials
|
||||
[replica_database]
|
||||
username = "db_user" # DB Username
|
||||
password = "db_pass" # DB Password
|
||||
host = "localhost" # DB Host
|
||||
port = 5432 # DB Port
|
||||
dbname = "orca_db" # Name of Database
|
||||
pool_size = 5 # Number of connections to keep open
|
||||
username = "db_user" # DB Username
|
||||
password = "db_pass" # DB Password
|
||||
host = "localhost" # DB Host
|
||||
port = 5432 # DB Port
|
||||
dbname = "hyperswitch_db" # Name of Database
|
||||
pool_size = 5 # Number of connections to keep open
|
||||
|
||||
# Redis credentials
|
||||
[redis]
|
||||
@ -94,7 +94,7 @@ validity = 1
|
||||
# Connector configuration, provided attributes will be used to fulfill API requests.
|
||||
# Examples provided here are sandbox/test base urls, can be replaced by live or mock
|
||||
# base urls based on your need.
|
||||
# Note: These are not optional attributes. ORCA request can fail due to invalid/empty values.
|
||||
# Note: These are not optional attributes. hyperswitch request can fail due to invalid/empty values.
|
||||
[connectors.aci]
|
||||
base_url = "https://eu-test.oppwa.com/"
|
||||
|
||||
@ -127,8 +127,8 @@ base_url = "https://api.shift4.com/"
|
||||
|
||||
# This data is used to call respective connectors for wallets and cards
|
||||
[connectors.supported]
|
||||
wallets = ["klarna","braintree","applepay"]
|
||||
cards = ["stripe","adyen","authorizedotnet","checkout","braintree", "cybersource"]
|
||||
wallets = ["klarna", "braintree", "applepay"]
|
||||
cards = ["stripe", "adyen", "authorizedotnet", "checkout", "braintree", "cybersource"]
|
||||
|
||||
# Scheduler settings provides a point to modify the behaviour of scheduler flow.
|
||||
# It defines the the streams/queues name and configuration as well as event selection variables
|
||||
@ -137,15 +137,15 @@ stream = "SCHEDULER_STREAM"
|
||||
consumer_group = "SCHEDULER_GROUP"
|
||||
|
||||
[scheduler.producer]
|
||||
upper_fetch_limit = 0 # Upper limit for fetching entries from the redis queue (in seconds)
|
||||
lower_fetch_limit = 1800 # Lower limit for fetching entries from redis queue (in seconds)
|
||||
lock_key = "PRODUCER_LOCKING_KEY" # The following keys defines the producer lock that is created in redis with
|
||||
lock_ttl = 160 # the ttl being the expiry (in seconds)
|
||||
upper_fetch_limit = 0 # Upper limit for fetching entries from the redis queue (in seconds)
|
||||
lower_fetch_limit = 1800 # Lower limit for fetching entries from redis queue (in seconds)
|
||||
lock_key = "PRODUCER_LOCKING_KEY" # The following keys defines the producer lock that is created in redis with
|
||||
lock_ttl = 160 # the ttl being the expiry (in seconds)
|
||||
|
||||
batch_size = 200 # Specifies the batch size the producer will push under a single entry in the redis queue
|
||||
|
||||
# Drainer configuration, which handles draining raw SQL queries from Redis streams to the SQL database
|
||||
[drainer]
|
||||
stream_name = "DRAINER_STREAM" # Specifies the stream name to be used by the drainer
|
||||
num_partitions = 64 # Specifies the number of partitions the stream will be divided into
|
||||
max_read_count = 100 # Specifies the maximum number of entries that would be read from redis stream in one call
|
||||
stream_name = "DRAINER_STREAM" # Specifies the stream name to be used by the drainer
|
||||
num_partitions = 64 # Specifies the number of partitions the stream will be divided into
|
||||
max_read_count = 100 # Specifies the maximum number of entries that would be read from redis stream in one call
|
||||
|
||||
@ -4,10 +4,10 @@ host = "0.0.0.0"
|
||||
request_body_limit = 16_384 # Post request body is limited to 16k.
|
||||
|
||||
[log.file]
|
||||
enabled = false # Whether you want to store log in log files.
|
||||
enabled = false # Whether you want to store log in log files.
|
||||
path = "logs" # Where to store log files.
|
||||
level = "DEBUG" # What gets into log files.
|
||||
# rotation = "60" # mins # current framework doesn't support configuring rotation. set to hourly rotation.
|
||||
# rotation = "60" # mins # current framework doesn't support configuring rotation. set to hourly rotation.
|
||||
|
||||
[log.console]
|
||||
enabled = true # Whether you want to see log in your terminal.
|
||||
@ -21,7 +21,7 @@ username = "db_user"
|
||||
password = "db_pass"
|
||||
host = "pg"
|
||||
port = 5432
|
||||
dbname = "orca_db"
|
||||
dbname = "hyperswitch_db"
|
||||
pool_size = 5
|
||||
|
||||
[proxy]
|
||||
@ -81,5 +81,5 @@ base_url = "https://apitest.cybersource.com/"
|
||||
base_url = "https://api.shift4.com/"
|
||||
|
||||
[connectors.supported]
|
||||
wallets = ["klarna","braintree","applepay"]
|
||||
cards = ["stripe","adyen","authorizedotnet","checkout","braintree","shift4","cybersource"]
|
||||
wallets = ["klarna", "braintree", "applepay"]
|
||||
cards = ["stripe", "adyen", "authorizedotnet", "checkout", "braintree", "shift4", "cybersource"]
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
# Contributing to Orca
|
||||
# Contributing to hyperswitch
|
||||
|
||||
:tada: First off, thanks for taking the time to contribute!
|
||||
We are so happy to have you! :tada:
|
||||
|
||||
There are opportunities to contribute to Orca at any level.
|
||||
There are opportunities to contribute to hyperswitch at any level.
|
||||
It doesn't matter if you are just getting started with Rust or are the most
|
||||
weathered expert, we can use your help.
|
||||
|
||||
@ -13,10 +13,13 @@ This guide will help you get started.
|
||||
**Do not let this guide intimidate you.**
|
||||
It should be considered a map to help you navigate the process.
|
||||
|
||||
You can also get help with contributing on our [Discussions][discussions] space.
|
||||
You can also get help with contributing on our [Discord server][discord],
|
||||
[Slack workspace][slack], or [Discussions][discussions] space.
|
||||
Please join us!
|
||||
|
||||
[discussions]: https://github.com/juspay/orca/discussions
|
||||
[discord]: https://discord.gg/XbHNKqeAjE
|
||||
[slack]: https://join.slack.com/t/hyperswitch-io/shared_invite/zt-1k6cz4lee-SAJzhz6bjmpp4jZCDOtOIg
|
||||
[discussions]: https://github.com/juspay/hyperswitch/discussions
|
||||
|
||||
## Table of Contents
|
||||
|
||||
@ -46,7 +49,7 @@ Please join us!
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
The Orca project adheres to the [Rust Code of Conduct][coc].
|
||||
The hyperswitch project adheres to the [Rust Code of Conduct][coc].
|
||||
This describes the _minimum_ behavior expected from all contributors.
|
||||
|
||||
[coc]: https://www.rust-lang.org/policies/code-of-conduct
|
||||
@ -56,8 +59,8 @@ This describes the _minimum_ behavior expected from all contributors.
|
||||
For any issue, there are fundamentally three ways an individual can contribute:
|
||||
|
||||
1. By opening the issue for discussion: For instance, if you believe that you
|
||||
have discovered a bug in Orca, creating a new issue in [the juspay/orca issue
|
||||
tracker][issue] is the way to report it.
|
||||
have discovered a bug in hyperswitch, creating a new issue in [the
|
||||
juspay/hyperswitch issue tracker][issue] is the way to report it.
|
||||
|
||||
2. By helping to triage the issue: This can be done by providing supporting
|
||||
details (a test case that demonstrates a bug), providing suggestions on how
|
||||
@ -65,10 +68,10 @@ For any issue, there are fundamentally three ways an individual can contribute:
|
||||
|
||||
3. By helping to resolve the issue: Typically this is done either in the form of
|
||||
demonstrating that the issue reported is not a problem after all, or more
|
||||
often, by opening a Pull Request that changes some bit of something in Orca
|
||||
in a concrete and reviewable manner.
|
||||
often, by opening a Pull Request that changes some bit of something in
|
||||
hyperswitch in a concrete and reviewable manner.
|
||||
|
||||
[issue]: https://github.com/juspay/orca/issues
|
||||
[issue]: https://github.com/juspay/hyperswitch/issues
|
||||
|
||||
**Anybody can participate in any stage of contribution**.
|
||||
We urge you to participate in the discussion around bugs and participate in
|
||||
@ -82,12 +85,12 @@ having problems, you can [open a discussion] asking for help.
|
||||
In exchange for receiving help, we ask that you contribute back a documentation
|
||||
PR that helps others avoid the problems that you encountered.
|
||||
|
||||
[open a discussion]: https://github.com/juspay/orca/discussions/new
|
||||
[open a discussion]: https://github.com/juspay/hyperswitch/discussions/new
|
||||
|
||||
### Submitting a Bug Report
|
||||
|
||||
When opening a new issue in the Orca issue tracker, you will be presented with a
|
||||
basic template that should be filled in.
|
||||
When opening a new issue in the hyperswitch issue tracker, you will be presented
|
||||
with a basic template that should be filled in.
|
||||
If you believe that you have uncovered a bug, please fill out this form,
|
||||
following the template to the best of your ability.
|
||||
Do not worry if you cannot answer every detail, just fill in what you can.
|
||||
@ -128,12 +131,12 @@ In the majority of cases, issues are resolved by opening a Pull Request.
|
||||
The process for opening and reviewing a Pull Request is similar to that of
|
||||
opening and triaging issues, but carries with it a necessary review and approval
|
||||
workflow that ensures that the proposed changes meet the minimal quality and
|
||||
functional guidelines of the Orca project.
|
||||
functional guidelines of the hyperswitch project.
|
||||
|
||||
## Pull Requests
|
||||
|
||||
Pull Requests are the way concrete changes are made to the code, documentation,
|
||||
and dependencies in the Orca repository.
|
||||
and dependencies in the hyperswitch repository.
|
||||
|
||||
Even tiny pull requests (e.g., one character pull request fixing a typo in API
|
||||
documentation) are greatly appreciated.
|
||||
@ -143,8 +146,8 @@ This will increase the likelihood of the PR getting merged.
|
||||
|
||||
### Cargo Commands
|
||||
|
||||
Due to the extensive use of features in Orca, you will often need to add extra
|
||||
arguments to many common cargo commands.
|
||||
Due to the extensive use of features in hyperswitch, you will often need to add
|
||||
extra arguments to many common cargo commands.
|
||||
This section lists some commonly needed commands.
|
||||
|
||||
Some commands just need the `--all-features` argument:
|
||||
@ -327,7 +330,7 @@ Sample commit messages:
|
||||
Implement Redirection flow support. This can be used by any flow that
|
||||
requires redirection.
|
||||
|
||||
Fixes ORCA-123
|
||||
Fixes #123
|
||||
```
|
||||
|
||||
2. ```text
|
||||
@ -379,10 +382,10 @@ Request page.
|
||||
|
||||
## Reviewing Pull Requests
|
||||
|
||||
**Any Orca community member is welcome to review any pull request**.
|
||||
**Any hyperswitch community member is welcome to review any pull request**.
|
||||
|
||||
All Orca contributors who choose to review and provide feedback on Pull Requests
|
||||
have a responsibility to both the project and the individual making the
|
||||
All hyperswitch contributors who choose to review and provide feedback on Pull
|
||||
Requests have a responsibility to both the project and the individual making the
|
||||
contribution.
|
||||
Reviews and feedback must be helpful, insightful, and geared towards improving
|
||||
the contribution as opposed to simply blocking it.
|
||||
@ -412,8 +415,8 @@ Do not succumb to that temptation.
|
||||
|
||||
Focus first on the most significant aspects of the change:
|
||||
|
||||
1. Does this change make sense for Orca?
|
||||
2. Does this change make Orca better, even if only incrementally?
|
||||
1. Does this change make sense for hyperswitch?
|
||||
2. Does this change make hyperswitch better, even if only incrementally?
|
||||
3. Are there clear bugs or larger scale issues that need attending to?
|
||||
4. Is the commit message readable and correct?
|
||||
If it contains a breaking change is it clear enough?
|
||||
@ -432,9 +435,9 @@ The first impression you give to a new contributor never does.
|
||||
|
||||
Nits (requests for small changes that are not essential) are fine, but try to
|
||||
avoid stalling the Pull Request.
|
||||
Most nits can typically be fixed by the Orca Collaborator landing the Pull
|
||||
Request but they can also be an opportunity for the contributor to learn a bit
|
||||
more about the project.
|
||||
Most nits can typically be fixed by the hyperswitch collaborator landing the
|
||||
Pull Request but they can also be an opportunity for the contributor to learn a
|
||||
bit more about the project.
|
||||
|
||||
It is always good to clearly indicate nits when you comment: e.g.
|
||||
`Nit: change foo() to bar(). But this is not blocking.`
|
||||
@ -447,8 +450,9 @@ with the appropriate reason to keep the conversation flow concise and relevant.
|
||||
|
||||
Be aware that _how_ you communicate requests and reviews in your feedback can
|
||||
have a significant impact on the success of the Pull Request.
|
||||
Yes, we may land a particular change that makes Orca better, but the individual
|
||||
might just not want to have anything to do with Orca ever again.
|
||||
Yes, we may land a particular change that makes hyperswitch better, but the
|
||||
individual might just not want to have anything to do with hyperswitch ever
|
||||
again.
|
||||
The goal is not just having good code.
|
||||
|
||||
### Abandoned or Stalled Pull Requests
|
||||
@ -468,7 +472,7 @@ _Adapted from the [Node.js contributing guide][node]_.
|
||||
|
||||
## Keeping track of issues and PRs
|
||||
|
||||
The Orca GitHub repository has a lot of issues and PRs to keep track of.
|
||||
The hyperswitch GitHub repository has a lot of issues and PRs to keep track of.
|
||||
This section explains the meaning of various labels, as well as our [GitHub
|
||||
project][project].
|
||||
The section is primarily targeted at maintainers.
|
||||
|
||||
@ -157,7 +157,7 @@ pub enum StripeErrorCode {
|
||||
},
|
||||
#[error(error_type = StripeErrorType::InvalidRequestError, code = "", message = "The mandate information is invalid. {message}")]
|
||||
PaymentIntentMandateInvalid { message: String },
|
||||
// [#216]: https://github.com/juspay/orca/issues/216
|
||||
// [#216]: https://github.com/juspay/hyperswitch/issues/216
|
||||
// Implement the remaining stripe error codes
|
||||
|
||||
/*
|
||||
|
||||
@ -261,7 +261,7 @@ async fn get_parent_merchant(
|
||||
})
|
||||
})
|
||||
// TODO: Update the API validation error structs to provide more info about which field caused an error
|
||||
// In this case we have multiple fields which use merchant_id (perchant_id & parent_merchant_id)
|
||||
// In this case we have multiple fields which use merchant_id (merchant_id & parent_merchant_id)
|
||||
// making it hard to figure out what went wrong
|
||||
// https://juspay.atlassian.net/browse/ORCA-358
|
||||
.map(|id| validate_merchant_id(db, id))?.await?.merchant_id
|
||||
|
||||
@ -327,13 +327,7 @@ pub enum BachResponse<R> {
|
||||
Json(R),
|
||||
StatusOk,
|
||||
TextPlain(String),
|
||||
/*
|
||||
redirect form not used https://juspay.atlassian.net/browse/ORCA-301
|
||||
RedirectResponse(BachRedirectResponse),
|
||||
Form(BachRedirectForm),
|
||||
*/
|
||||
JsonForRedirection(api::RedirectionResponse),
|
||||
// RedirectResponse(BachRedirectResponse),
|
||||
Form(RedirectForm),
|
||||
}
|
||||
|
||||
|
||||
@ -98,8 +98,6 @@ pub struct PaymentsAuthorizeData {
|
||||
pub currency: storage_enums::Currency,
|
||||
pub confirm: bool,
|
||||
pub statement_descriptor_suffix: Option<String>,
|
||||
// redirect form not used https://juspay.atlassian.net/browse/ORCA-301
|
||||
// pub redirection: Option<Redirection>,
|
||||
pub capture_method: Option<storage_enums::CaptureMethod>,
|
||||
// Mandates
|
||||
pub setup_future_usage: Option<storage_enums::FutureUsage>,
|
||||
|
||||
@ -72,9 +72,9 @@ services:
|
||||
environment:
|
||||
- POSTGRES_USER=db_user
|
||||
- POSTGRES_PASSWORD=db_pass
|
||||
- POSTGRES_DB=orca_db
|
||||
- POSTGRES_DB=hyperswitch_db
|
||||
|
||||
orca-server:
|
||||
hyperswitch-server:
|
||||
image: rust:1.65
|
||||
command: cargo run -- -f ./config/docker_compose.toml
|
||||
working_dir: /app
|
||||
|
||||
|
Before Width: | Height: | Size: 494 KiB After Width: | Height: | Size: 494 KiB |
@ -54,9 +54,9 @@ Check the Table Of Contents to jump to the relevant section.
|
||||
5. Run database migrations:
|
||||
|
||||
```shell
|
||||
docker compose run orca-server bash -c \
|
||||
docker compose run hyperswitch-server bash -c \
|
||||
"cargo install diesel_cli && \
|
||||
diesel migration --database-url postgres://db_user:db_pass@pg:5432/orca_db run"
|
||||
diesel migration --database-url postgres://db_user:db_pass@pg:5432/hyperswitch_db run"
|
||||
```
|
||||
|
||||
6. Verify that the server is up and running by hitting the health endpoint:
|
||||
@ -217,7 +217,7 @@ Once you're done with setting up the dependencies, proceed with
|
||||
```shell
|
||||
export DB_USER="db_user"
|
||||
export DB_PASS="db_pass"
|
||||
export DB_NAME="orca_db"
|
||||
export DB_NAME="hyperswitch_db"
|
||||
```
|
||||
|
||||
On Ubuntu-based systems:
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
{
|
||||
description = "orca devshell";
|
||||
description = "hyperswitch devshell";
|
||||
|
||||
inputs = {
|
||||
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
|
||||
|
||||
@ -155,7 +155,7 @@ services:
|
||||
soft: 262144
|
||||
hard: 262144
|
||||
|
||||
orca-server:
|
||||
hyperswitch-server:
|
||||
image: rust:1.65
|
||||
command: cargo run -- -f ./config/docker_compose.toml
|
||||
working_dir: /app
|
||||
@ -192,7 +192,7 @@ services:
|
||||
environment:
|
||||
- POSTGRES_USER=db_user
|
||||
- POSTGRES_PASSWORD=db_pass
|
||||
- POSTGRES_DB=orca_db
|
||||
- POSTGRES_DB=hyperswitch_db
|
||||
|
||||
redis-queue:
|
||||
image: redis:7
|
||||
|
||||
@ -30,7 +30,7 @@ info:
|
||||
|
||||
# Authentication
|
||||
|
||||
When you sign up on our [dashboard](https://orca-test-app.netlify.app) and create a merchant account, you are given a secret key (also referred as api-key). You may authenticate all API requests with Juspay server by providing the appropriate key in the request Authorization header.
|
||||
When you sign up on our [dashboard](https://orca-dahboard.netlify.app) and create a merchant account, you are given a secret key (also referred as api-key). You may authenticate all API requests with Juspay server by providing the appropriate key in the request Authorization header.
|
||||
|
||||
Never share your secret api keys. Keep them guarded and secure.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user