Skip to content

feat: change cryptoNetwork from string to enum #331

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.

Sign up for GitHub

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

Open
pengying wants to merge 1 commit into
base: main
Choose a base branch
from
+89 −58
Open

feat: change cryptoNetwork from string to enum #331

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
42 changes: 29 additions & 13 deletions mintlify/openapi.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

42 changes: 29 additions & 13 deletions openapi.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

21 changes: 21 additions & 0 deletions openapi/components/schemas/crypto/CryptoNetwork.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
type: string
description: |
The blockchain network identifier. The environment (mainnet vs testnet) is determined
automatically based on whether the request is made against the production or sandbox API.

| Value | Production | Sandbox |
|-------|------------|---------|
| BITCOIN | Bitcoin mainnet | Bitcoin testnet |
| ETHEREUM | Ethereum mainnet | Ethereum Sepolia |
| SOLANA | Solana mainnet | Solana devnet |
| BASE | Base mainnet | Base Sepolia |
| SPARK | Spark mainnet | Spark testnet |
| LIGHTNING | Lightning mainnet | Lightning regtest |
enum:
- BITCOIN
- ETHEREUM
- SOLANA
- BASE
- SPARK
- LIGHTNING
example: SOLANA
8 changes: 1 addition & 7 deletions openapi/components/schemas/crypto/EstimateCryptoWithdrawalFeeRequest.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,7 @@ properties:
description: The currency code of the asset to withdraw (e.g. USDC).
example: USDC
cryptoNetwork:
type: string
description: >-
The blockchain network for the withdrawal. Example values: SOLANA_MAINNET,
SOLANA_DEVNET, ETHEREUM_MAINNET, ETHEREUM_TESTNET, BASE_MAINNET,
BASE_TESTNET, SPARK_MAINNET, SPARK_TESTNET, LIGHTNING_MAINNET,
LIGHTNING_REGTEST.
example: SOLANA_MAINNET
$ref: ./CryptoNetwork.yaml
amount:
type: integer
description: The amount to withdraw in the smallest unit of the currency.
Expand Down
8 changes: 1 addition & 7 deletions openapi/components/schemas/external_accounts/ExternalAccount.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,6 @@ allOf:
$ref: ./BeneficiaryVerifiedData.yaml
description: Verified beneficiary data returned by the payment rail, if available
cryptoNetwork:
type: string
description: >-
The blockchain network for this external account, if applicable. Present when the account
is a cryptocurrency wallet. Example values: SOLANA_MAINNET, SOLANA_DEVNET,
ETHEREUM_MAINNET, ETHEREUM_TESTNET, BASE_MAINNET, BASE_TESTNET,
SPARK_MAINNET, SPARK_TESTNET, LIGHTNING_MAINNET, LIGHTNING_REGTEST.
example: SOLANA_MAINNET
$ref: ../crypto/CryptoNetwork.yaml
accountInfo:
$ref: ./ExternalAccountInfoOneOf.yaml
9 changes: 1 addition & 8 deletions openapi/components/schemas/external_accounts/ExternalAccountCreateRequest.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,6 @@ allOf:
incoming UMA payments will be deposited into the primary internal account for the customer.
default: false
cryptoNetwork:
type: string
description: >-
The blockchain network for this external account. Required when the account is a
cryptocurrency wallet. Specifies which network the wallet is on. Example values:
SOLANA_MAINNET, SOLANA_DEVNET, ETHEREUM_MAINNET, ETHEREUM_TESTNET,
BASE_MAINNET, BASE_TESTNET, SPARK_MAINNET, SPARK_TESTNET, LIGHTNING_MAINNET,
LIGHTNING_REGTEST.
example: SOLANA_MAINNET
$ref: ../crypto/CryptoNetwork.yaml
accountInfo:
$ref: ./ExternalAccountInfoOneOf.yaml
15 changes: 6 additions & 9 deletions openapi/components/schemas/quotes/RealtimeFundingQuoteSource.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,12 @@ allOf:
for the full list of supported fiat and crypto currencies.
example: USD
cryptoNetwork:
type: string
description: >-
The crypto network to use for the funding source. Required when `currency` is a
stablecoin (e.g. USDC, USDT). Specifies which network the customer will deposit
on, so the correct deposit address can be generated. Example values:
`SOLANA_MAINNET`, `SOLANA_DEVNET`, `ETHEREUM_MAINNET`, `ETHEREUM_TESTNET`,
`BASE_MAINNET`, `BASE_TESTNET`, `SPARK_MAINNET`, `SPARK_TESTNET`,
`LIGHTNING_MAINNET`, `LIGHTNING_REGTEST`.
example: SOLANA_MAINNET
allOf:
- $ref: ../crypto/CryptoNetwork.yaml
- description: >-
The crypto network to use for the funding source. Required when `currency` is a
stablecoin (e.g. USDC, USDT). Specifies which network the customer will deposit
on, so the correct deposit address can be generated.
description: >-
Fund the quote using a real-time funding source (RTP, SEPA Instant, Spark, Stables, etc.).
This will require manual just-in-time funding using `paymentInstructions` in the response.
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/crypto/crypto_estimate-withdrawal-fee.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ post:
value:
internalAccountId: InternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123
currency: USDC
cryptoNetwork: SOLANA_MAINNET
cryptoNetwork: SOLANA
amount: 1000000
destinationAddress: 7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU
responses:
Expand Down
Loading