Skip to content

Commit

Permalink
Refactoring
Browse files Browse the repository at this point in the history
- Moving external accounts to externalaccount module
- Adding basic KYC and Customer api module
- Reusing transfers module schema for crosstransfer creation

correcting endpoint paths
  • Loading branch information
Milan Jarić committed Nov 20, 2024
1 parent 9c2d1c0 commit 47dbdec
Show file tree
Hide file tree
Showing 8 changed files with 1,684 additions and 1,345 deletions.
2 changes: 2 additions & 0 deletions v2/api-validator/src/config/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,8 @@ const config = convict({
'fb-provider-liquidity-api.yaml',
'fb-provider-trading-api.yaml',
'fb-provider-transfer-api.yaml',
'fb-provider-customers-api.yaml',
'fb-provider-accountsexternal-api.yaml',
'fb-provider-crosstransfer-api.yaml',
],
},
Expand Down
14 changes: 13 additions & 1 deletion v2/openapi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,10 @@ this response indicates that all the capabilities are supported:
"transfersBlockchain": "*",
"transfersFiat": "*",
"transfersPeerAccounts": "*",
"transfersCrossTransfer": "*",
"crosstransfers": "*",
"crosstransfersOnRamp": '*',
"crosstransfersOffRamp": '*',
"crosstransfersBridging": '*',
"trading": "*",
"liquidity": "*"
}
Expand Down Expand Up @@ -159,6 +162,15 @@ be replaced by a list of account IDs:
Based on the response, Fireblocks platform will use the endpoints specific to each
component to discover the specific capabilities for each component.

Note that the `crosstransfers` component is used to define the capabilities for
on-ramp, off-ramp, and bridging without specifying a concrete account.
The actual transfers are executed using the **omnibus account**, which implies
the capabilities of that account.

For individual accounts (customer accounts), the capabilities are defined in the
`crosstransfersOnRamp`, `crosstransfersOffRamp`, and `crosstransfersBridging` components.
So it is possible to have different capabilities for different customer accounts.

## Mandatory endpoints

All the capability, accounts, and balances endpoints must be always implemented, for all
Expand Down
Loading

0 comments on commit 47dbdec

Please sign in to comment.