Skip to content

Commit

Permalink
feat: add tokenization api (#12)
Browse files Browse the repository at this point in the history
  • Loading branch information
asafs932 authored May 8, 2024
1 parent 59fa46b commit 62b8bf4
Show file tree
Hide file tree
Showing 224 changed files with 29,617 additions and 5,818 deletions.
95 changes: 79 additions & 16 deletions README.md

Large diffs are not rendered by default.

13,229 changes: 8,178 additions & 5,051 deletions api/openapi.yaml

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ apply plugin: 'eclipse'
apply plugin: 'com.diffplug.spotless'

group = 'com.fireblocks.sdk'
version = '1.1.0'
version = '2.0.0'

buildscript {
repositories {
Expand Down
38 changes: 38 additions & 0 deletions docs/AbiFunction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@


# AbiFunction


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | The name of the contract function as it appears in the ABI | [optional] |
|**stateMutability** | [**StateMutabilityEnum**](#StateMutabilityEnum) | The state mutability of the contract function as it appears in the ABI | [optional] |
|**type** | [**TypeEnum**](#TypeEnum) | The type if the function | |
|**inputs** | [**List<Parameter>**](Parameter.md) | The parameters that this function/constructor posses | |
|**outputs** | [**List<Parameter>**](Parameter.md) | The parameters that this 'read' function returns | [optional] |
|**description** | **String** | The documentation of this function (if has any) | [optional] |



## Enum: StateMutabilityEnum

| Name | Value |
|---- | -----|
| PURE | "pure" |
| VIEW | "view" |
| NONPAYABLE | "nonpayable" |
| PAYABLE | "payable" |



## Enum: TypeEnum

| Name | Value |
|---- | -----|
| FUNCTION | "function" |
| CONSTRUCTOR | "constructor" |



15 changes: 8 additions & 7 deletions docs/ApiUserApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@ All URIs are relative to https://developers.fireblocks.com/reference/

| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**createApiUser**](ApiUserApi.md#createApiUser) | **POST** /management/api_users | create api user |
| [**getApiUsers**](ApiUserApi.md#getApiUsers) | **GET** /management/api_users | get api users |
| [**createApiUser**](ApiUserApi.md#createApiUser) | **POST** /management/api_users | Create Api user |
| [**getApiUsers**](ApiUserApi.md#getApiUsers) | **GET** /management/api_users | Get Api users |



## createApiUser

> CompletableFuture<ApiResponse<Void>> createApiUser createApiUser(createAPIUser, idempotencyKey)
create api user
Create Api user

creates api user
Creates Api user in your tenant

### Example

Expand Down Expand Up @@ -89,7 +89,8 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | User sent for creation | * X-Request-ID - <br> |
| **200** | User creation approval request has been sent | * X-Request-ID - <br> |
| **400** | bad request | * X-Request-ID - <br> |
| **401** | Unauthorized. Missing / invalid JWT token in Authorization header. | * X-Request-ID - <br> |
| **403** | Lacking permissions. | * X-Request-ID - <br> |
| **5XX** | Internal error. | * X-Request-ID - <br> |
Expand All @@ -100,9 +101,9 @@ No authorization required

> CompletableFuture<ApiResponse<GetAPIUsersResponse>> getApiUsers getApiUsers()
get api users
Get Api users

get api users from the current tenant
Get Api users of your tenant

### Example

Expand Down
15 changes: 15 additions & 0 deletions docs/AssetAlreadyExistHttpError.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@


# AssetAlreadyExistHttpError


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**statusCode** | **Integer** | HTTP status code | [optional] |
|**message** | **String** | Error message | [optional] |
|**error** | **String** | Short description of the HTTP error | [optional] |



15 changes: 15 additions & 0 deletions docs/AssetDoesNotExistHttpError.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@


# AssetDoesNotExistHttpError


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**statusCode** | **Integer** | HTTP status code | [optional] |
|**message** | **String** | Error message | [optional] |
|**error** | **String** | Short description of the HTTP error | [optional] |



14 changes: 14 additions & 0 deletions docs/AssetForbiddenErrorResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@


# AssetForbiddenErrorResponse


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**message** | **String** | Forbidden error code | |
|**code** | **String** | Error code | |



25 changes: 25 additions & 0 deletions docs/AssetMetadataDto.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@


# AssetMetadataDto


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**assetId** | **String** | The Fireblocks&#x60; asset id | |
|**name** | **String** | The name of the token | [optional] |
|**symbol** | **String** | The symbol of the token | [optional] |
|**networkProtocol** | **String** | The network protocol of the token | [optional] |
|**totalSupply** | **String** | The total supply of the token | [optional] |
|**holdersCount** | **BigDecimal** | The number of holders of the token | [optional] |
|**type** | **String** | The type of the token | [optional] |
|**contractAddress** | **String** | The address of the token contract | [optional] |
|**issuerAddress** | **String** | In case of Stellar or Ripple, the address of the issuer of the token | [optional] |
|**testnet** | **Boolean** | Is it deployed on testnet or to mainnet | [optional] |
|**blockchain** | **String** | The blockchain native asset id which the token is deployed on | [optional] |
|**decimals** | **BigDecimal** | The number of decimals of the token | [optional] |
|**vaultAccountId** | **String** | The id of the vault account that initiated the request to issue the token. Will be empty if token was issued outside of Fireblocks. | [optional] |



15 changes: 15 additions & 0 deletions docs/AuditorData.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@


# AuditorData


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | | |
|**imageURL** | **String** | | |
|**link** | **String** | | |



7 changes: 4 additions & 3 deletions docs/BlockchainsAssetsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,8 +170,9 @@ No authorization required
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | A new asset has been created successfully | - |
| **400** | - Listing an asset on the requested blockchain is not supported. Error code: 1000 - The asset address is invalid. Error code: 1004 | - |
| **404** | - Invalid address, could not get asset information. Error code 1004 | - |
| **409** | - The asset is already supported globally. Error code: 1002 - The asset has already been added to this workspace. Error code: 1003 | - |
| **400** | - Listing an asset on the requested blockchain is not supported. Error code: 1000 - The asset address is invalid. Error code: 1003 - Self serve listing an asset on the requested blockchain is currently not supported, please contact support. Error code: 1004 | - |
| **403** | - The asset creation quota reached. Error code: 1005 | - |
| **404** | - Invalid address, could not get asset information. Error code 1003 | - |
| **409** | - The asset is already supported globally. Error code: 1001 - The asset has already been added to this workspace. Error code: 1002 | - |
| **500** | Failed to create asset | - |

18 changes: 18 additions & 0 deletions docs/CollectionMetadataDto.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@


# CollectionMetadataDto


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**fbCollectionId** | **String** | Fireblocks collection id | |
|**name** | **String** | Collection name | [optional] |
|**symbol** | **String** | Collection symbol | [optional] |
|**standard** | **String** | Collection contract standard | [optional] |
|**blockchainDescriptor** | **String** | Collection&#39;s blockchain | |
|**contractAddress** | **String** | Collection contract address | [optional] |



2 changes: 2 additions & 0 deletions docs/CollectionOwnershipResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,10 @@
| ETH | &quot;ETH&quot; |
| ETH_TEST3 | &quot;ETH_TEST3&quot; |
| ETH_TEST5 | &quot;ETH_TEST5&quot; |
| ETH_TEST6 | &quot;ETH_TEST6&quot; |
| POLYGON | &quot;POLYGON&quot; |
| POLYGON_TEST_MUMBAI | &quot;POLYGON_TEST_MUMBAI&quot; |
| AMOY_POLYGON_TEST | &quot;AMOY_POLYGON_TEST&quot; |
| XTZ | &quot;XTZ&quot; |
| XTZ_TEST | &quot;XTZ_TEST&quot; |
| BASECHAIN_ETH | &quot;BASECHAIN_ETH&quot; |
Expand Down
14 changes: 7 additions & 7 deletions docs/ConsoleUserApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@ All URIs are relative to https://developers.fireblocks.com/reference/

| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**createConsoleUser**](ConsoleUserApi.md#createConsoleUser) | **POST** /management/users | create console user |
| [**getConsoleUsers**](ConsoleUserApi.md#getConsoleUsers) | **GET** /management/users | get console users |
| [**createConsoleUser**](ConsoleUserApi.md#createConsoleUser) | **POST** /management/users | Create console user |
| [**getConsoleUsers**](ConsoleUserApi.md#getConsoleUsers) | **GET** /management/users | Get console users |



## createConsoleUser

> CompletableFuture<ApiResponse<Void>> createConsoleUser createConsoleUser(createConsoleUser, idempotencyKey)
create console user
Create console user

creates fireblocks console user
Creates console user in your tenant

### Example

Expand Down Expand Up @@ -89,7 +89,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Users sent for creation | * X-Request-ID - <br> |
| **200** | User creation approval request has been sent | * X-Request-ID - <br> |
| **400** | bad request | * X-Request-ID - <br> |
| **401** | Unauthorized. Missing / invalid JWT token in Authorization header. | * X-Request-ID - <br> |
| **403** | Lacking permissions. | * X-Request-ID - <br> |
Expand All @@ -101,9 +101,9 @@ No authorization required

> CompletableFuture<ApiResponse<GetConsoleUsersResponse>> getConsoleUsers getConsoleUsers()
get console users
Get console users

get console users from the current tenant
Get console users for your tenant

### Example

Expand Down
14 changes: 14 additions & 0 deletions docs/ContractAbiResponseDto.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@


# ContractAbiResponseDto


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**abi** | [**List&lt;AbiFunction&gt;**](AbiFunction.md) | The abi of the contract | |
|**implementationAbi** | [**List&lt;AbiFunction&gt;**](AbiFunction.md) | The abi of the implementation contract if exists. Relevant only for proxy patterns | [optional] |



15 changes: 15 additions & 0 deletions docs/ContractAttributes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@


# ContractAttributes


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**useCases** | **List&lt;String&gt;** | | |
|**standards** | **List&lt;String&gt;** | | |
|**auditor** | [**AuditorData**](AuditorData.md) | | |



15 changes: 15 additions & 0 deletions docs/ContractDeployRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@


# ContractDeployRequest


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**assetId** | **String** | The base asset identifier of the blockchain you want to deploy to | |
|**vaultAccountId** | **String** | The vault account id you wish to deploy from | |
|**constructorParameters** | [**List&lt;ParameterWithValue&gt;**](ParameterWithValue.md) | The constructor parameters of this contract | [optional] |



13 changes: 13 additions & 0 deletions docs/ContractDeployResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@


# ContractDeployResponse


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**txId** | **String** | The transaction id of the deployment request | |



17 changes: 17 additions & 0 deletions docs/ContractDoc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@


# ContractDoc


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**details** | **String** | A description of the contract | [optional] |
|**events** | **String** | A description of the contract&#x60;s events | [optional] |
|**kind** | **String** | Is it devdoc or userdoc | |
|**methods** | [**Map&lt;String, FunctionDoc&gt;**](FunctionDoc.md) | The description of the contract functions | |
|**version** | **String** | The version of the contract | |



Loading

0 comments on commit 62b8bf4

Please sign in to comment.