Skip to content

Commit

Permalink
Merge pull request #296 from immutable/feat/orderbook-package
Browse files Browse the repository at this point in the history 
[DX-3294] feat: orderbook package
  • Loading branch information
@nattb8
nattb8 authored Oct 2, 2024
2 parents 975f961 + ef2d37b commit 79203ec
Show file tree
Hide file tree
Showing 217 changed files with 12,539 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/linter.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ jobs:
VALIDATE_ALL_CODEBASE: true
DEFAULT_BRANCH: main
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
FILTER_REGEX_EXCLUDE: (.*src/Packages/Passport/Runtime/ThirdParty/.*|.*src/Packages/Passport/Runtime/Resources/.*|.*Plugins/.*|.*src/Packages/Passport/Runtime/Assets/ImmutableAndroid.androidlib/.*)
FILTER_REGEX_EXCLUDE: (.*src/Packages/Passport/Runtime/ThirdParty/.*|.*src/Packages/Passport/Runtime/Resources/.*|.*Plugins/.*|.*src/Packages/Passport/Runtime/Assets/ImmutableAndroid.androidlib/.*|.*src/Packages/Orderbook)
VALIDATE_MARKDOWN: false
VALIDATE_GITLEAKS: false
VALIDATE_JSCPD: false
Expand Down
2 changes: 2 additions & 0 deletions sample/Packages/manifest.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
"com.alttester.sdk": "2.1.1",
"com.cysharp.unitask": "2.3.3",
"com.immutable.passport": "file:../../src/Packages/Passport",
"com.immutable.marketplace": "file:../../src/Packages/Marketplace",
"com.immutable.orderbook": "file:../../src/Packages/Orderbook",
"com.unity.ai.navigation": "1.1.4",
"com.unity.ide.visualstudio": "2.0.21",
"com.unity.ide.vscode": "1.2.5",
Expand Down
3 changes: 3 additions & 0 deletions src/Packages/Orderbook/CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Changelog

Please see https://github.com/immutable/unity-immutable-sdk/releases
7 changes: 7 additions & 0 deletions src/Packages/Orderbook/CHANGELOG.md.meta
View file

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

13 changes: 13 additions & 0 deletions src/Packages/Orderbook/Documentation~/Action.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Immutable.Orderbook.Model.Action

## Properties

Name | Type | Description | Notes
---------------------------|-----------------------------------------------------------------------------------------|-------------|------------
**PopulatedTransactions** | [**TransactionActionPopulatedTransactions**](TransactionActionPopulatedTransactions.md) | | [optional]
**Purpose** | **SignablePurpose** | | [optional]
**Type** | **string** | |
**Message** | [**SignableActionMessage**](SignableActionMessage.md) | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11 changes: 11 additions & 0 deletions src/Packages/Orderbook/Documentation~/BigNumberish.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Immutable.Orderbook.Model.BigNumberish

Any type that can be used where a big number is needed.

## Properties

Name | Type | Description | Notes
------|------|-------------|-------

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12 changes: 12 additions & 0 deletions src/Packages/Orderbook/Documentation~/CancelOrders200Response.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Immutable.Orderbook.Model.CancelOrders200Response

Response schema for the cancelOrder endpoint

## Properties

Name | Type | Description | Notes
------------|-----------------------------------------------------------------------|-------------|------------
**Result** | [**CancelOrders200ResponseResult**](CancelOrders200ResponseResult.md) | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12 changes: 12 additions & 0 deletions src/Packages/Orderbook/Documentation~/CancelOrders200ResponseResult.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Immutable.Orderbook.Model.CancelOrders200ResponseResult

## Properties

Name | Type | Description | Notes
-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|------------
**FailedCancellations** | [**List<CancelOrders200ResponseResultFailedCancellationsInner>**](CancelOrders200ResponseResultFailedCancellationsInner.md) | Orders which failed to be cancelled | [optional]
**PendingCancellations** | **List<string>** | Orders which are marked for cancellation but the cancellation cannot be guaranteed | [optional]
**SuccessfulCancellations** | **List<string>** | Orders which were successfully cancelled | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11 changes: 11 additions & 0 deletions ...derbook/Documentation~/CancelOrders200ResponseResultFailedCancellationsInner.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Immutable.Orderbook.Model.CancelOrders200ResponseResultFailedCancellationsInner

## Properties

Name | Type | Description | Notes
----------------|------------|-------------------------------------------------------------|------------
**Order** | **string** | ID of the order which failed to be cancelled | [optional]
**ReasonCode** | **string** | Reason code indicating why the order failed to be cancelled | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12 changes: 12 additions & 0 deletions src/Packages/Orderbook/Documentation~/CancelOrdersOnChain200Response.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Immutable.Orderbook.Model.CancelOrdersOnChain200Response

Response schema for the cancelOrder endpoint

## Properties

Name | Type | Description | Notes
------------------------|-----------------------------------------------|-------------|------------
**CancellationAction** | [**TransactionAction**](TransactionAction.md) | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11 changes: 11 additions & 0 deletions src/Packages/Orderbook/Documentation~/CancelOrdersOnChainRequest.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Immutable.Orderbook.Model.CancelOrdersOnChainRequest

## Properties

Name | Type | Description | Notes
--------------------|------------------------|-------------|-------
**OrderIds** | **List<string>** | |
**AccountAddress** | **string** | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12 changes: 12 additions & 0 deletions src/Packages/Orderbook/Documentation~/CancelOrdersRequest.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Immutable.Orderbook.Model.CancelOrdersRequest

## Properties

Name | Type | Description | Notes
--------------------|------------------------|-------------|-------
**OrderIds** | **List<string>** | |
**AccountAddress** | **string** | |
**Signature** | **string** | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11 changes: 11 additions & 0 deletions src/Packages/Orderbook/Documentation~/CancellationType.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Immutable.Orderbook.Model.CancellationType

Whether the cancellation was done on-chain or off-chain or as a result of an underfunded account

## Properties

Name | Type | Description | Notes
------|------|-------------|-------

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11 changes: 11 additions & 0 deletions src/Packages/Orderbook/Documentation~/CancelledOrderStatusCancellationType.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Immutable.Orderbook.Model.CancelledOrderStatusCancellationType

Whether the cancellation was done on-chain or off-chain or as a result of an underfunded account

## Properties

Name | Type | Description | Notes
------|------|-------------|-------

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12 changes: 12 additions & 0 deletions src/Packages/Orderbook/Documentation~/CreateListing200Response.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Immutable.Orderbook.Model.CreateListing200Response

The response schema for the create listing endpoint

## Properties

Name | Type | Description | Notes
------------|-----------------------|-------------|------------
**Result** | [**Order**](Order.md) | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13 changes: 13 additions & 0 deletions src/Packages/Orderbook/Documentation~/CreateListingRequest.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Immutable.Orderbook.Model.CreateListingRequest

## Properties

Name | Type | Description | Notes
---------------------|-------------------------------------------|-------------|-------
**MakerFees** | [**List<FeeValue>**](FeeValue.md) | |
**OrderComponents** | [**OrderComponents**](OrderComponents.md) | |
**OrderHash** | **string** | |
**OrderSignature** | **string** | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13 changes: 13 additions & 0 deletions src/Packages/Orderbook/Documentation~/ERC1155Item.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Immutable.Orderbook.Model.ERC1155Item

## Properties

Name | Type | Description | Notes
---------------------|------------|-------------|-------
**Amount** | **string** | |
**ContractAddress** | **string** | |
**TokenId** | **string** | |
**Type** | **string** | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12 changes: 12 additions & 0 deletions src/Packages/Orderbook/Documentation~/ERC20Item.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Immutable.Orderbook.Model.ERC20Item

## Properties

Name | Type | Description | Notes
---------------------|------------|-------------|-------
**Amount** | **string** | |
**ContractAddress** | **string** | |
**Type** | **string** | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12 changes: 12 additions & 0 deletions src/Packages/Orderbook/Documentation~/ERC721Item.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Immutable.Orderbook.Model.ERC721Item

## Properties

Name | Type | Description | Notes
---------------------|------------|-------------|-------
**ContractAddress** | **string** | |
**TokenId** | **string** | |
**Type** | **string** | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12 changes: 12 additions & 0 deletions src/Packages/Orderbook/Documentation~/Fee.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Immutable.Orderbook.Model.Fee

## Properties

Name | Type | Description | Notes
----------------------|-------------|-------------|------------
**Amount** | **string** | | [optional]
**RecipientAddress** | **string** | | [optional]
**Type** | **FeeType** | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9 changes: 9 additions & 0 deletions src/Packages/Orderbook/Documentation~/FeeType.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Immutable.Orderbook.Model.FeeType

## Properties

Name | Type | Description | Notes
------|------|-------------|-------

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11 changes: 11 additions & 0 deletions src/Packages/Orderbook/Documentation~/FeeValue.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Immutable.Orderbook.Model.FeeValue

## Properties

Name | Type | Description | Notes
----------------------|------------|-------------|-------
**Amount** | **string** | |
**RecipientAddress** | **string** | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

14 changes: 14 additions & 0 deletions src/Packages/Orderbook/Documentation~/FulfillOrder200Response.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Immutable.Orderbook.Model.FulfillOrder200Response

Response schema for the fulfillOrder endpoint

## Properties

Name | Type | Description | Notes
----------------|-----------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|------------
**Actions** | [**List<TransactionAction>**](TransactionAction.md) | | [optional]
**Expiration** | **string** | User MUST submit the fulfillment transaction before the expiration Submitting after the expiration will result in a on chain revert | [optional]
**Order** | [**Order**](Order.md) | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13 changes: 13 additions & 0 deletions src/Packages/Orderbook/Documentation~/FulfillOrderRequest.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Immutable.Orderbook.Model.FulfillOrderRequest

## Properties

Name | Type | Description | Notes
------------------|-------------------------------------------------------------------------------------------|--------------|------------
**ListingId** | **string** | listingId |
**TakerAddress** | **string** | takerAddress |
**TakerFees** | [**List<FulfillOrderRequestTakerFeesInner>**](FulfillOrderRequestTakerFeesInner.md) | takerFees |
**AmountToFill** | **string** | amountToFill | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11 changes: 11 additions & 0 deletions src/Packages/Orderbook/Documentation~/FulfillOrderRequestTakerFeesInner.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Immutable.Orderbook.Model.FulfillOrderRequestTakerFeesInner

## Properties

Name | Type | Description | Notes
----------------------|------------|-------------|-------
**Amount** | **string** | |
**RecipientAddress** | **string** | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9 changes: 9 additions & 0 deletions src/Packages/Orderbook/Documentation~/ItemType.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Immutable.Orderbook.Model.ItemType

## Properties

Name | Type | Description | Notes
------|------|-------------|-------

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11 changes: 11 additions & 0 deletions src/Packages/Orderbook/Documentation~/NativeItem.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Immutable.Orderbook.Model.NativeItem

## Properties

Name | Type | Description | Notes
------------|------------|-------------|-------
**Amount** | **string** | |
**Type** | **string** | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

26 changes: 26 additions & 0 deletions src/Packages/Orderbook/Documentation~/Order.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Immutable.Orderbook.Model.Order

## Properties

Name | Type | Description | Notes
--------------------|---------------------------------------------------------------------------|-------------------------------------------------|------------
**AccountAddress** | **string** | | [optional]
**Buy** | [**List<PrepareListingRequestBuy>**](PrepareListingRequestBuy.md) | | [optional]
**Chain** | [**OrderChain**](OrderChain.md) | | [optional]
**CreatedAt** | **string** | | [optional]
**EndAt** | **string** | Time after which the Order is expired | [optional]
**Fees** | [**List<Fee>**](Fee.md) | | [optional]
**FillStatus** | [**OrderFillStatus**](OrderFillStatus.md) | | [optional]
**Id** | **string** | |
**OrderHash** | **string** | |
**ProtocolData** | [**OrderProtocolData**](OrderProtocolData.md) | | [optional]
**Salt** | **string** | | [optional]
**Sell** | [**List<PrepareListingRequestSell>**](PrepareListingRequestSell.md) | |
**Signature** | **string** | |
**StartAt** | **string** | Time after which the Order is considered active |
**Status** | [**OrderStatus**](OrderStatus.md) | |
**Type** | **string** | |
**UpdatedAt** | **string** | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11 changes: 11 additions & 0 deletions src/Packages/Orderbook/Documentation~/OrderChain.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Immutable.Orderbook.Model.OrderChain

## Properties

Name | Type | Description | Notes
----------|------------|-------------|------------
**Id** | **string** | | [optional]
**Name** | **string** | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Loading

0 comments on commit 79203ec

Please sign in to comment.