diff --git a/.github/workflows/docs-validate-build.yml b/.github/workflows/docs-validate-build.yml
index 2a482b639d..2577f51738 100644
--- a/.github/workflows/docs-validate-build.yml
+++ b/.github/workflows/docs-validate-build.yml
@@ -10,14 +10,13 @@ concurrency:
jobs:
build:
runs-on: ubuntu-latest
- defaults:
- run:
- working-directory: ./docs
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
- node-version: 18
+ node-version: 20
+ - name: Build whole project
+ run: npm run build && cd docs
- name: Allow modern Yarn
run: corepack enable
- name: Install dependencies
diff --git a/README.md b/README.md
index 5369ae094f..325fb1b49e 100644
--- a/README.md
+++ b/README.md
@@ -1,38 +1,199 @@
+
+
+
+
+
+
+
+
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![MIT License][license-shield]][license-url]
+[![LinkedIn][linkedin-shield]][linkedin-url]
+
+
+
-# Framework
+
+
+ Table of Contents
+
+ -
+ About The Project
+
+
+ -
+ Getting Started
+
+
+ - Usage
+ - Contributing
+ - License
+ - Contact
+
+
+
+
+
+
+## About The Project
+
+Build.5 is your Enterprise ready web3 plug & play platform. This repo contains the back-end based on [serverless functions](./packages/functions/) and our easy to use [SDK](./packages/sdk/) for third parties.
+
+(back to top)
+
+
+
+### Built With
+
+* [![Typescript][Typescript]][Typescript-url]
+* [![Firestore][Firestore]][Firestore-url]
+
+(back to top)
+
+
+
+
+## Getting Started
+
+To build the project locally, follow these simple steps. If you are interested in using the SDK to interact with our services, please refer to the [SDK documentation](https://developer.build5.com/).
+
+### Prerequisites
+
+Make sure you have the following installed:
+
+* npm
+* node >= 20
+* modern yarn (optional, for running the docs locally)
+
+
+
+### Installation
+
+1. Clone the repo
+ ```sh
+ git clone https://github.com/build-5/core.git
+ ```
+2. Install NPM packages
+ ```sh
+ npm install
+ ```
+3. Build the packages
+ ```sh
+ yarn build
+ ```
+
+For running the docs locally, please refer to the documentation [README](./docs/README.md).
+
+(back to top)
+
+
+
+
+## Usage
+
+The best way to get started with the SDK and interacting with Build.5 is [installing the SDK](https://www.npmjs.com/package/@build-5/sdk) and have a look at our [documentation](https://developer.build5.com).
+
+(back to top)
+
+
+
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
+Don't forget to give the project a star! Thanks again!
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+For more information on how to contribute, please read [CONTRIBUTING.md](./CONTRIBUTING.md)
+
+[](https://github.com/build-5/core/pulls)
+
+(back to top)
+
+
+
+
+## License
+
+Distributed under the Apache License. See `LICENSE` for more information.
+
+(back to top)
-The platform is designed to eventually transition away from all centralized services. It has been build using modern development tools and primarely using Typescript language.
-Back-end is written as serverless functions (see /packages/functions)
-Library for third parties is located under /packages/lib and /packages/interfaces
+
+## Contact
-### /packages/functions
+Build.5 - [@build5tech](https://twitter.com/build5tech) - hello@build5.com
-- Typescript Functions
-- Firestore (Database)
-- Typescript
+Project Link: [https://build5.com](https://build5.com)
-# 🤝 Contributing
+(back to top)
-[](https://github.com/soonaverse/soonaverse/pulls)
-We welcome all contributions. Please read our [CONTRIBUTING.md](https://github.com/soonaverse/soonaverse/blob/master/CONTRIBUTING.md) first. You can submit any ideas as [pull requests](https://github.com/soonaverse/soonaverse/pulls) or as [GitHub issues](https://github.com/soonaverse/soonaverse/issues).
-Thank you for supporting us free open source licenses.
+
+
+[contributors-shield]: https://img.shields.io/github/contributors/build-5/core.svg?style=for-the-badge
+[contributors-url]: https://github.com/build-5/core/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/build-5/core.svg?style=for-the-badge
+[forks-url]: https://github.com/build-5/core/network/members
+[stars-shield]: https://img.shields.io/github/stars/build-5/core.svg?style=for-the-badge
+[stars-url]: https://github.com/build-5/core/stargazers
+[issues-shield]: https://img.shields.io/github/issues/build-5/core.svg?style=for-the-badge
+[issues-url]: https://github.com/build-5/core/issues
+[license-shield]: https://img.shields.io/github/license/build-5/core.svg?style=for-the-badge
+[license-url]: https://github.com/build-5/core/blob/master/LICENSE
+[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
+[linkedin-url]: https://linkedin.com/company/build5/
+[Typescript]: https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white
+[Typescript-url]: https://www.typescriptlang.org/
+[Firestore]: https://img.shields.io/badge/Firebase-FFCA28?style=for-the-badge&logo=firebase&logoColor=black
+[Firestore-url]: https://firebase.google.com/
diff --git a/docs/.gitignore b/docs/.gitignore
index 54358bea24..0092a16bdb 100644
--- a/docs/.gitignore
+++ b/docs/.gitignore
@@ -4,6 +4,8 @@
# Production
/build
/docs/search-*
+/docs/reference-api
+/docs/sdk
# Generated files
.docusaurus
diff --git a/docs/.yarnrc.yml b/docs/.yarnrc.yml
new file mode 100644
index 0000000000..3186f3f079
--- /dev/null
+++ b/docs/.yarnrc.yml
@@ -0,0 +1 @@
+nodeLinker: node-modules
diff --git a/docs/README.md b/docs/README.md
index af649319a2..7b75463d88 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,12 +1,15 @@
# Website
-This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.
### Installation
> [!NOTE]
> The docs use modern [Yarn](https://yarnpkg.com). So don't forget to run `corepack enable` first if you don't have it already.
+> [!NOTE]
+> To use the docs you have to [build](../README.md) the packages first.
+
```
$ yarn
```
diff --git a/docs/docs/_admonitions/_deep_link.md b/docs/docs/_admonitions/_deep_link.md
index e25e7dd90a..3f07e62a23 100644
--- a/docs/docs/_admonitions/_deep_link.md
+++ b/docs/docs/_admonitions/_deep_link.md
@@ -1,4 +1,4 @@
-:::warning OTR Request Deep Link
+:::info OTR Request Deep Link
The SDK provides the helper functions `getFireflyDeepLink()` and `getBloomDeepLink()` to generate deep links for OTR requests.
diff --git a/docs/docs/getting-started.mdx b/docs/docs/getting-started.mdx
index e49d2b8d7c..d2d6cfbf61 100644
--- a/docs/docs/getting-started.mdx
+++ b/docs/docs/getting-started.mdx
@@ -24,9 +24,9 @@ npm i @build-5/interfaces
## API
There are REST APIs to simplify read and write operations. See following:
-- [GET](search-get) - Use this APIs to get any data from Build.5
-- [WSS](search-get) - Any [GET](search-get) can be requested as wss:// to receive web socket with real-time updates
-- [POST](search-post) - Use these APIs to post any requests to Build.5 (alternative to [OTR](search-otr))
+- [GET](reference-api) - Use this APIs to get any data from Build.5
+- [WSS](reference-api) - Any [GET](reference-api) can be requested as wss:// to receive web socket with real-time updates
+- [POST](reference-api) - Use these APIs to post any requests to Build.5 (alternative to [OTR](reference-api))
:::info
diff --git a/docs/docs/on-tangle-request.md b/docs/docs/on-tangle-request.md
index ab86827681..5591e838fb 100644
--- a/docs/docs/on-tangle-request.md
+++ b/docs/docs/on-tangle-request.md
@@ -8,7 +8,7 @@ tags:
On tangle requests are a secure and transparent way to interact with build.5 products. They are a way to send a request to a build.5 backend over the Tangle. The backend will then execute the request. All interactions can be verified on the Tangle.
-OTR uses metadata to describe the request. The metadata is a JSON object. You can find the API reference for the metadata [here](search-otr), but we recommend using our [SDK](https://developer.build5.com/docs/getting_started#sdk).
+OTR uses metadata to describe the request. The metadata is a JSON object. You can find the API reference for the metadata [here](reference-api), but we recommend using our [SDK](https://developer.build5.com/docs/getting_started#sdk).
## Why OTR?
diff --git a/docs/docs/products/dao-management/member/how-to/create-member.md b/docs/docs/products/dao-management/member/how-to/create-member.md
index 4d564645b9..8d20225d21 100644
--- a/docs/docs/products/dao-management/member/how-to/create-member.md
+++ b/docs/docs/products/dao-management/member/how-to/create-member.md
@@ -7,7 +7,7 @@ tags:
---
To create a member, you need to call `createMember`.
-`createMember` takes an object of type `Build5Request<`[`CreateMemberRequest`](../../../../search-post/interfaces/CreateMemberRequest.md)`>` as parameter.
+`createMember` takes an object of type `Build5Request<`[`CreateMemberRequest`](../../../../reference-api/interfaces/CreateMemberRequest.md)`>` as parameter.
```tsx file=../../../../../../packages/sdk/examples/member/create.ts#L7-L13
diff --git a/docs/docs/products/dao-management/member/how-to/update-member.md b/docs/docs/products/dao-management/member/how-to/update-member.md
index e63939177b..1387321a9d 100644
--- a/docs/docs/products/dao-management/member/how-to/update-member.md
+++ b/docs/docs/products/dao-management/member/how-to/update-member.md
@@ -12,7 +12,7 @@ To update a member, we first get the member with their ID, which, in this case,
```
With the member, we can create a signature and update, for example, the name by calling `update` on `dataset(Dataset.MEMBER)` and passing the new name in the body.
-`update` takes an object of type `Build5Request<`[`MemberUpdateRequest`](../../../../search-post/interfaces/MemberUpdateRequest.md)`>` as parameter.
+`update` takes an object of type `Build5Request<`[`MemberUpdateRequest`](../../../../reference-api/interfaces/MemberUpdateRequest.md)`>` as parameter.
```tsx file=../../../../../../packages/sdk/examples/member/update.ts#L17-L30
```
diff --git a/docs/docs/products/dao-management/member/how-to/validate-address.md b/docs/docs/products/dao-management/member/how-to/validate-address.md
index f0a8904c57..d982b65fa8 100644
--- a/docs/docs/products/dao-management/member/how-to/validate-address.md
+++ b/docs/docs/products/dao-management/member/how-to/validate-address.md
@@ -2,7 +2,7 @@
title: Validate Space Address
---
-To validate the address of a member, you must call `validateAddress` on `dataset(Dataset.MEMBER)`. `validateAddress` takes an object of type `Build5Request<`[`AddressValidationRequest`](../../../../search-post/interfaces/AddressValidationRequest.md)`>` as parameter.
+To validate the address of a member, you must call `validateAddress` on `dataset(Dataset.MEMBER)`. `validateAddress` takes an object of type `Build5Request<`[`AddressValidationRequest`](../../../../reference-api/interfaces/AddressValidationRequest.md)`>` as parameter.
```tsx file=../../../../../../packages/sdk/examples/member/validate_address.ts#L16-L30
```
diff --git a/docs/docs/products/dao-management/space/how-to/create-space.md b/docs/docs/products/dao-management/space/how-to/create-space.md
index 70f601f857..7757f069f5 100644
--- a/docs/docs/products/dao-management/space/how-to/create-space.md
+++ b/docs/docs/products/dao-management/space/how-to/create-space.md
@@ -7,7 +7,7 @@ tags:
---
To create a space, you must call `create` on `dataset(Dataset.SPACE)`. In the body, you can specify the name of the space.
-`create` takes an object of type `Build5Request<`[`SpaceCreateRequest`](../../../../search-post/interfaces/SpaceCreateRequest.md)`>` as parameter.
+`create` takes an object of type `Build5Request<`[`SpaceCreateRequest`](../../../../reference-api/interfaces/SpaceCreateRequest.md)`>` as parameter.
:::info Create a Member first
diff --git a/docs/docs/products/dao-management/space/how-to/update-space.md b/docs/docs/products/dao-management/space/how-to/update-space.md
index 3187b133ca..db310c4ed4 100644
--- a/docs/docs/products/dao-management/space/how-to/update-space.md
+++ b/docs/docs/products/dao-management/space/how-to/update-space.md
@@ -1,6 +1,6 @@
---
title: Update Space
-keywords:
+tags:
- how-to
- update
- space
@@ -18,7 +18,7 @@ You can only update Spaces where you are a Guardian
:::
With the space ID and Guardian member we can create a signature and update, for example, the name by calling `update` on `dataset(Dataset.SPACE)` and passing the new name in the body.
-`update` takes an object of type `Build5Request<`[`SpaceUpdateRequest`](../../../../search-post/interfaces/SpaceUpdateRequest.md)`>` as parameter.
+`update` takes an object of type `Build5Request<`[`SpaceUpdateRequest`](../../../../reference-api/interfaces/SpaceUpdateRequest.md)`>` as parameter.
```tsx file=../../../../../../packages/sdk/examples/space/update.ts#L19-L33
```
diff --git a/docs/docs/products/dao-management/space/how-to/validate-address.md b/docs/docs/products/dao-management/space/how-to/validate-address.md
index f5bf615eff..75edbfe3d3 100644
--- a/docs/docs/products/dao-management/space/how-to/validate-address.md
+++ b/docs/docs/products/dao-management/space/how-to/validate-address.md
@@ -2,7 +2,7 @@
title: Validate Space Address
---
-To validate the address of a space, you must call `validateAddress` on `dataset(Dataset.SPACE)`. `validateAddress` takes an object of type `Build5Request<`[`AddressValidationRequest`](../../../../search-post/interfaces/AddressValidationRequest.md)`>` as parameter in wich you can specify the name of the space.
+To validate the address of a space, you must call `validateAddress` on `dataset(Dataset.SPACE)`. `validateAddress` takes an object of type `Build5Request<`[`AddressValidationRequest`](../../../../reference-api/interfaces/AddressValidationRequest.md)`>` as parameter in wich you can specify the name of the space.
```tsx file=../../../../../../packages/sdk/examples/space/validate_address.ts#L19-L33
```
diff --git a/docs/docs/products/digital-twin-nft/overview.md b/docs/docs/products/digital-twin-nft/overview.md
deleted file mode 100644
index 4c87280a2d..0000000000
--- a/docs/docs/products/digital-twin-nft/overview.md
+++ /dev/null
@@ -1,21 +0,0 @@
----
-title: Overview
----
-
-import NotStarted from '../../_admonitions/_not-started-yet.md';
-
-
-
-Digital Twin through Metadata NFT.
-:::note
-
-This is not following the [IRC27](https://github.com/iotaledger/tips/blob/main/tips/TIP-0027/tip-0027.md) standard. To create IRC27 NFTs, continue [here](../nft/overview.md)
-
-:::
-
-__Features__:
-- Digital Twin management
-- Digital Twin parent-child relationship management
-
-__Tutorials__:
-- [Digital Twin NFT](https://github.com/build-5/build5-otr-examples/edit/master/src/examples/metadata_nft/TUTORIAL.md)
diff --git a/docs/docs/products/nft/how-to/bulk-purchase.md b/docs/docs/products/nft/how-to/bulk-purchase.md
index 30b55d23cd..73ad5dab2c 100644
--- a/docs/docs/products/nft/how-to/bulk-purchase.md
+++ b/docs/docs/products/nft/how-to/bulk-purchase.md
@@ -9,18 +9,21 @@ tags:
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
+import DeepLink from '../../../_admonitions/_deep_link.md'
To bulk purchase NFTs, you must call `bulkPurchase` on `dataset(Dataset.NFT)`.
- `bulkPurchase` takes an object of type [`NftPurchaseBulkTangleRequest`](../../../search-otr/interfaces/NftPurchaseBulkTangleRequest.md) as parameter.
+ `bulkPurchase` takes an object of type [`NftPurchaseBulkTangleRequest`](../../../reference-api/interfaces/NftPurchaseBulkTangleRequest.md) as parameter.
- ```tsx file=../../../../../packages/sdk/examples/nft/otr/bulk_purchase.ts#L11-L13
+ ```tsx file=../../../../../packages/sdk/examples/nft/otr/bulk_purchase.ts#L12-L14
```
+
+
To bulk purchase NFTs, you must call `bulkPurchase` on `dataset(Dataset.NFT)`.
- `bulkPurchase` takes an object of type [`NftPurchaseBulkRequest`](../../../search-post/interfaces/NftPurchaseBulkRequest.md) as parameter.
+ `bulkPurchase` takes an object of type [`NftPurchaseBulkRequest`](../../../reference-api/interfaces/NftPurchaseBulkRequest.md) as parameter.
```tsx file=../../../../../packages/sdk/examples/nft/https/bulk_purchase.ts#L22-L35
```
diff --git a/docs/docs/products/nft/how-to/create-collection.md b/docs/docs/products/nft/how-to/create-collection.md
index 070e2d5fcf..b1538b8af7 100644
--- a/docs/docs/products/nft/how-to/create-collection.md
+++ b/docs/docs/products/nft/how-to/create-collection.md
@@ -9,7 +9,7 @@ tags:
---
To create a NFT collection, you must call `create` on `dataset(Dataset.NFT_COLLECTION)`. In the body, you can specify the collection's name, the symbol, the base URI, and more.
-`create` takes an object of type `Build5Request<`[`CreateCollectionRequest`](../../../search-post/interfaces/CreateCollectionRequest.md)`>` as parameter.
+`create` takes an object of type `Build5Request<`[`CreateCollectionRequest`](../../../reference-api/interfaces/CreateCollectionRequest.md)`>` as parameter.
```tsx file=../../../../../packages/sdk/examples/nft/https/create_collection.ts#L18-L43
```
@@ -35,7 +35,7 @@ After that, you should create a list of objects that describe the single NFTs, t
```
As a last step, you can mint the batch of NFTs by calling `createBatch` on `dataset(Dataset.NFT)` and passing the list of NFTs in the body.
-`createBatch` takes an object of type `Build5Request<`[`NftCreateRequest`](../../../search-post/interfaces/NftCreateRequest.md)`[]>` as parameter.
+`createBatch` takes an object of type `Build5Request<`[`NftCreateRequest`](../../../reference-api/interfaces/NftCreateRequest.md)`[]>` as parameter.
```tsx file=../../../../../packages/sdk/examples/nft/https/create_collection.ts#L66-L77
```
diff --git a/docs/docs/products/nft/how-to/create-metadata.md b/docs/docs/products/nft/how-to/create-metadata.md
new file mode 100644
index 0000000000..14fb81ece0
--- /dev/null
+++ b/docs/docs/products/nft/how-to/create-metadata.md
@@ -0,0 +1,14 @@
+---
+title: Create NFT with Metadata
+tags:
+ - how-to
+ - create
+ - nft
+ - metadata
+ - digital twin
+---
+
+To create a NFT with Metadata, you must call `mintMetadataNft` on `dataset(Dataset.NFT)`. `mintMetadataNft` takes an object of type [`MintMetadataNftTangleRequest`](../../../reference-api/interfaces/MintMetadataNftTangleRequest.md) as parameter. In there you can specify the metadata of the NFT which for example could be used to create a digital twin.
+
+```tsx file=../../../../../packages/sdk/examples/nft/otr/metadata.ts#L6-L10
+```
diff --git a/docs/docs/products/nft/how-to/transfer.md b/docs/docs/products/nft/how-to/transfer.md
new file mode 100644
index 0000000000..01e1f23725
--- /dev/null
+++ b/docs/docs/products/nft/how-to/transfer.md
@@ -0,0 +1,31 @@
+---
+title: Transfer NFTs
+tags:
+ - how-to
+ - transfer
+ - nft
+ - bulk
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import DeepLink from '../../../_admonitions/_deep_link.md'
+
+
+
+ To transfer NFTs, you must call `transfer` on `dataset(Dataset.NFT)`.
+ `transfer` takes an object of type [`NftTransferTangleRequest`](../../../reference-api/interfaces/NftTransferTangleRequest.md) as parameter.
+
+ ```tsx file=../../../../../packages/sdk/examples/nft/otr/transfer.ts#L9-L16
+ ```
+
+
+
+
+ To transfer NFTs, you must call `transfer` on `dataset(Dataset.NFT)`.
+ `transfer` takes an object of type [`NftTransferRequest`](../../../reference-api/interfaces/NftTransferRequest.md) as parameter.
+
+ ```tsx file=../../../../../packages/sdk/examples/nft/https/transfer.ts#L19-L35
+ ```
+
+
diff --git a/docs/docs/products/overview.md b/docs/docs/products/overview.md
index b4326a552b..fcd35b53cf 100644
--- a/docs/docs/products/overview.md
+++ b/docs/docs/products/overview.md
@@ -1,6 +1,6 @@
---
title: 'BUILD.5 Products'
-keywords: ['products', 'api', 'blockchain', 'nft', 'digital twin', 'token', 'staking', 'trading', 'launchpad', 'staking', 'reputation', 'member', 'project', 'proposal', 'stake reward', 'token distribution', 'dao management']
+tags: ['products', 'api', 'blockchain', 'nft', 'digital twin', 'token', 'staking', 'trading', 'launchpad', 'staking', 'reputation', 'member', 'project', 'proposal', 'stake reward', 'token distribution', 'dao management']
---
Learn about the BUILD.5 products and how to use them.
diff --git a/docs/docs/products/project/how-to/create-project.mdx b/docs/docs/products/project/how-to/create-project.mdx
index efaf2786b1..93fae91c70 100644
--- a/docs/docs/products/project/how-to/create-project.mdx
+++ b/docs/docs/products/project/how-to/create-project.mdx
@@ -11,7 +11,7 @@ tags:
import SoonaverseProject from '../../../_admonitions/_soonaverse-project.md';
Before creating NFT collections, tokens, and more, the first thing to do should be to create a project with the `createProject` function.
-`createProject` takes an object of type `Build5Request<`[`ProjectCreateRequest`](../../../search-post/interfaces/ProjectCreateRequest.md)`>` as parameter.
+`createProject` takes an object of type `Build5Request<`[`ProjectCreateRequest`](../../../reference-api/interfaces/ProjectCreateRequest.md)`>` as parameter.
diff --git a/docs/docs/products/stamp/how-to/create-stamp.md b/docs/docs/products/stamp/how-to/create-stamp.md
index a3a926a4e8..00bc52101e 100644
--- a/docs/docs/products/stamp/how-to/create-stamp.md
+++ b/docs/docs/products/stamp/how-to/create-stamp.md
@@ -6,7 +6,26 @@ tags:
- stamp
---
-To create a stamp, you must call `create` on `dataset(Dataset.STAMP)`. `create` takes an object of type `Build5Request<`[`CreateMemberRequest`](../../../search-post/interfaces/StampRequest.md)`>` as parameter in which you can specify the file you want to stamp.
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-```tsx file=../../../../../packages/sdk/examples/create_stamp.ts#L13-L27
-```
+
+
+ To create a stamp, you must call `create` on `dataset(Dataset.STAMP)`. `create` takes an object of type [`StampTangleRequest`](../../../reference-api/interfaces/StampTangleRequest.md) as parameter in which you can specify the uri for the file you want to stamp.
+
+ ```tsx file=../../../../../packages/sdk/examples/stamp/otr/create.ts#L10-L12
+ ```
+
+:::info Days Parameter
+
+When you create a stamp, you can specify the number of days the stamped file should be stored. If the OTR contains more funds as needed, the remaining funds will be returned. If you don't specify the number of days, the stamped file will be stored for the total time you paid for in the OTR.
+
+:::
+
+
+ To create a stamp, you must call `create` on `dataset(Dataset.STAMP)`. `create` takes an object of type `Build5Request<`[`StampRequest`](../../../reference-api/interfaces/StampRequest.md)`>` as parameter in which you can specify the file you want to stamp.
+
+ ```tsx file=../../../../../packages/sdk/examples/stamp/https/create.ts#L13-L27
+ ```
+
+
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
index e192d4f276..a663e00946 100644
--- a/docs/docusaurus.config.js
+++ b/docs/docusaurus.config.js
@@ -21,65 +21,21 @@ const config = {
onBrokenMarkdownLinks: 'throw',
plugins: [
[
+ // FUll help: https://typedoc.org/options/configuration/
'docusaurus-plugin-typedoc',
{
- id: 'search-post',
+ id: 'reference-api',
+ name: 'Reference API',
sidebar: {
- categoryLabel: 'POST Requests',
- },
- entryPoints: ['../packages/interfaces/src/search/post/index.ts'],
- tsconfig: '../packages/interfaces/tsconfig.json',
- out: 'search-post',
- watch: process.env.TYPEDOC_WATCH,
- cleanOutputDir: true,
- },
- ],
- [
- 'docusaurus-plugin-typedoc',
- {
- id: 'search-get',
- sidebar: {
- categoryLabel: 'GET Requests',
- },
- entryPoints: [
- '../packages/interfaces/src/search/base.ts',
- '../packages/interfaces/src/search/request.ts',
- ],
- tsconfig: '../packages/interfaces/tsconfig.json',
- out: 'search-get',
- watch: process.env.TYPEDOC_WATCH,
- cleanOutputDir: true,
- },
- ],
- [
- 'docusaurus-plugin-typedoc',
- {
- id: 'search-otr',
- sidebar: {
- categoryLabel: 'OTR Requests',
- },
- entryPoints: ['../packages/interfaces/src/search/tangle/index.ts'],
- tsconfig: '../packages/interfaces/tsconfig.json',
- out: 'search-otr',
- watch: process.env.TYPEDOC_WATCH,
- cleanOutputDir: true,
- },
- ],
- [
- 'docusaurus-plugin-typedoc',
- {
- id: 'search-models',
- sidebar: {
- categoryLabel: 'Records / Models',
+ categoryLabel: 'Reference API',
},
entryPoints: [
- '../packages/interfaces/src/models/index.ts',
- '../packages/interfaces/src/models/transaction/index.ts',
- '../packages/interfaces/src/config.ts',
- '../packages/interfaces/src/errors.ts',
+ // SDK Documentation.
+ '../packages/sdk/doc.ts',
],
- tsconfig: '../packages/interfaces/tsconfig.json',
- out: 'search-models',
+ readme: '../packages/interfaces/README.md',
+ tsconfig: './tsconfig.api-doc.json',
+ out: 'reference-api',
watch: process.env.TYPEDOC_WATCH,
cleanOutputDir: true,
},
diff --git a/docs/sidebars.js b/docs/sidebars.js
index 0482762159..9672f602ea 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -75,6 +75,8 @@ const sidebars = {
'How To': [
'products/nft/how-to/create-collection',
'products/nft/how-to/bulk-purchase',
+ 'products/nft/how-to/create-metadata',
+ 'products/nft/how-to/transfer',
],
}
],
@@ -89,9 +91,6 @@ const sidebars = {
}
],
},
- {
- 'Digital Twin NFT': ['products/digital-twin-nft/overview'],
- },
{
'NFT Trading API': ['products/nft-trading/overview'],
},
@@ -157,32 +156,11 @@ const sidebars = {
apiSidebar: [
{
type: 'category',
- label: 'Models',
- collapsible: true,
- collapsed: true,
- items: [{ type: 'autogenerated', dirName: 'search-models' }],
- },
- {
- type: 'category',
- label: 'GET Requests',
- collapsible: true,
- collapsed: true,
- items: [{ type: 'autogenerated', dirName: 'search-get' }],
- },
- {
- type: 'category',
- label: 'OTR Requests',
+ label: 'Reference API',
collapsible: true,
collapsed: true,
- items: [{ type: 'autogenerated', dirName: 'search-otr' }],
- },
- {
- type: 'category',
- label: 'POST Requets',
- collapsible: true,
- collapsed: true,
- items: [{ type: 'autogenerated', dirName: 'search-post' }],
- },
+ items: [{ type: 'autogenerated', dirName: 'reference-api' }],
+ }
],
};
diff --git a/docs/tsconfig.api-doc.json b/docs/tsconfig.api-doc.json
new file mode 100644
index 0000000000..761a9bb51c
--- /dev/null
+++ b/docs/tsconfig.api-doc.json
@@ -0,0 +1,21 @@
+{
+ "compilerOptions": {
+ "declaration": true,
+ "module": "commonjs",
+ "noImplicitReturns": true,
+ "strictNullChecks": false,
+ "noUnusedLocals": true,
+ "outDir": "lib",
+ "sourceMap": true,
+ "strict": true,
+ "target": "es2017",
+ "skipLibCheck": true,
+ "esModuleInterop": true,
+ "resolveJsonModule": true
+ },
+ "compileOnSave": true,
+ "include": [
+ "../packages/interfaces",
+ "../packages/sdk"
+ ]
+}
\ No newline at end of file
diff --git a/docs/yarn.lock b/docs/yarn.lock
index 1eea00d0df..b3426c1b11 100644
--- a/docs/yarn.lock
+++ b/docs/yarn.lock
@@ -48,83 +48,83 @@ __metadata:
languageName: node
linkType: hard
-"@algolia/cache-browser-local-storage@npm:4.22.0":
- version: 4.22.0
- resolution: "@algolia/cache-browser-local-storage@npm:4.22.0"
+"@algolia/cache-browser-local-storage@npm:4.22.1":
+ version: 4.22.1
+ resolution: "@algolia/cache-browser-local-storage@npm:4.22.1"
dependencies:
- "@algolia/cache-common": "npm:4.22.0"
- checksum: 945bdb8c0c24b67b039adb2b6fb6d41d05224abe5fe1e2b925984158ad6acc290a7cbb1a468c4c27e55d49beb333470ed3e983576308f4f62f95d9778c5d4a58
+ "@algolia/cache-common": "npm:4.22.1"
+ checksum: 18dfe05cab0a369ce67d165b748c6bfac74b17621e1bd27618756136ebf517eeab836ffaedbeff55ef28cd13eaeee52b296f681a9af8f7c41db2f37b1e1b0073
languageName: node
linkType: hard
-"@algolia/cache-common@npm:4.22.0":
- version: 4.22.0
- resolution: "@algolia/cache-common@npm:4.22.0"
- checksum: 2b5018fcab1222ac756610d1e28ba1b7b9af065e7ba73f1c202a8830e3ad530f52a37bca689d6b82486345a947b6e0fe837b6c6e207379b35ac0bcb21290cfc5
+"@algolia/cache-common@npm:4.22.1":
+ version: 4.22.1
+ resolution: "@algolia/cache-common@npm:4.22.1"
+ checksum: 3b1ed5694c38e6f0018914cd4151198804f76780bda8364d1a4b68658ba19f56a3bc92633569604cb3a11ab01246abddde44885a9fa40bc8aebc2e227e6a91f8
languageName: node
linkType: hard
-"@algolia/cache-in-memory@npm:4.22.0":
- version: 4.22.0
- resolution: "@algolia/cache-in-memory@npm:4.22.0"
+"@algolia/cache-in-memory@npm:4.22.1":
+ version: 4.22.1
+ resolution: "@algolia/cache-in-memory@npm:4.22.1"
dependencies:
- "@algolia/cache-common": "npm:4.22.0"
- checksum: 4b2c990ee587870282d6f1e1e1b976b387cc976ca9a6c58f42175f2024d1f683c2efc7266d4b86b678db8de191d959f14a2226e5b7fab69f4b6507474bf7f813
+ "@algolia/cache-common": "npm:4.22.1"
+ checksum: cd66ffcbb754553da405a418e7eceb8fc25ea8dcd9f7cb9886711f45b5d00aa57b949135e997a6c3cf4082423a18ce1abd4f1c097bdffa3289883e92cb6112be
languageName: node
linkType: hard
-"@algolia/client-account@npm:4.22.0":
- version: 4.22.0
- resolution: "@algolia/client-account@npm:4.22.0"
+"@algolia/client-account@npm:4.22.1":
+ version: 4.22.1
+ resolution: "@algolia/client-account@npm:4.22.1"
dependencies:
- "@algolia/client-common": "npm:4.22.0"
- "@algolia/client-search": "npm:4.22.0"
- "@algolia/transporter": "npm:4.22.0"
- checksum: 157939aa5b63b01f0710078fd5a131600b335f8f0f845ccd044b1b96395b89403e782dbd40ae30f519159aa99ba97db16404e40be829b0847a3c19cb7e5e6eae
+ "@algolia/client-common": "npm:4.22.1"
+ "@algolia/client-search": "npm:4.22.1"
+ "@algolia/transporter": "npm:4.22.1"
+ checksum: 8aabe87fd8bf72732ba3c7158e59d1e10215a72cd62ab6604923598544bd4321b3823a2b3fbef82f0c981659a97092d8d5f108014e4f6963e1be7bed5819f755
languageName: node
linkType: hard
-"@algolia/client-analytics@npm:4.22.0":
- version: 4.22.0
- resolution: "@algolia/client-analytics@npm:4.22.0"
+"@algolia/client-analytics@npm:4.22.1":
+ version: 4.22.1
+ resolution: "@algolia/client-analytics@npm:4.22.1"
dependencies:
- "@algolia/client-common": "npm:4.22.0"
- "@algolia/client-search": "npm:4.22.0"
- "@algolia/requester-common": "npm:4.22.0"
- "@algolia/transporter": "npm:4.22.0"
- checksum: aa6baa7f10818333f179a4ea0eba9f6d97fdb33eb7f2cf0da9494bd14ed533a4ea7356bcfe8a995bb9eef814443acf2a7bff394f96379e08d2be9f63f444fbd7
+ "@algolia/client-common": "npm:4.22.1"
+ "@algolia/client-search": "npm:4.22.1"
+ "@algolia/requester-common": "npm:4.22.1"
+ "@algolia/transporter": "npm:4.22.1"
+ checksum: aacb649b1f6ee9604c9c22684f56a2810bfd987845190caa1c40287ea35150654584f2b51660b3e77fbb729a95a99f7e3a29a9c1e82dadb7ae0fec00c7c305d7
languageName: node
linkType: hard
-"@algolia/client-common@npm:4.22.0":
- version: 4.22.0
- resolution: "@algolia/client-common@npm:4.22.0"
+"@algolia/client-common@npm:4.22.1":
+ version: 4.22.1
+ resolution: "@algolia/client-common@npm:4.22.1"
dependencies:
- "@algolia/requester-common": "npm:4.22.0"
- "@algolia/transporter": "npm:4.22.0"
- checksum: 3e106c927254a14844050a91cead947ec5e72f8aa682f812e421cb9065a75eb8b1b1e93c90cf5b510c7d61552fe1ea4ce010bac0e9ad46f914f15f64dfa57f78
+ "@algolia/requester-common": "npm:4.22.1"
+ "@algolia/transporter": "npm:4.22.1"
+ checksum: 39a3b57178a8a100f766758fad4845d6684c7b93a4df4409a4829e367d9249c5e95d5e5c5cf56b6058b3ea1779b132235619f0458641a47f52d9a886bd54c2a8
languageName: node
linkType: hard
-"@algolia/client-personalization@npm:4.22.0":
- version: 4.22.0
- resolution: "@algolia/client-personalization@npm:4.22.0"
+"@algolia/client-personalization@npm:4.22.1":
+ version: 4.22.1
+ resolution: "@algolia/client-personalization@npm:4.22.1"
dependencies:
- "@algolia/client-common": "npm:4.22.0"
- "@algolia/requester-common": "npm:4.22.0"
- "@algolia/transporter": "npm:4.22.0"
- checksum: 590165c1e2c60da995ed263f8c0008e11f9368334b9255058fc49a1898edc770ce0f63f6971932a199c1f09e91921c7cc8d5f1218ba87ec677ef5ea787ecc10c
+ "@algolia/client-common": "npm:4.22.1"
+ "@algolia/requester-common": "npm:4.22.1"
+ "@algolia/transporter": "npm:4.22.1"
+ checksum: a5d37f3ce695d05ce0b280db94d59c00848161ffb96b8876844dc4dffce2319e3f71faa816b6514c77e3c34e37d575d88422b96392088d82fd625ca0bb2e9cf3
languageName: node
linkType: hard
-"@algolia/client-search@npm:4.22.0":
- version: 4.22.0
- resolution: "@algolia/client-search@npm:4.22.0"
+"@algolia/client-search@npm:4.22.1":
+ version: 4.22.1
+ resolution: "@algolia/client-search@npm:4.22.1"
dependencies:
- "@algolia/client-common": "npm:4.22.0"
- "@algolia/requester-common": "npm:4.22.0"
- "@algolia/transporter": "npm:4.22.0"
- checksum: efe78d440c5d349640a3878f4da46c82dba8632e887689df96b1a3a9cd446f3afafb6c1441d4d76dee78e6c01e0b48afe2610cd40d0066f30a0bc8b0ac21b126
+ "@algolia/client-common": "npm:4.22.1"
+ "@algolia/requester-common": "npm:4.22.1"
+ "@algolia/transporter": "npm:4.22.1"
+ checksum: 2d6bf304d7b5329b1940a4fda3ada89bc65d8528110cb06d33831af165a515da82f847f28d97b099c18b728fa3fc88e2850c048f4dcc7f2226b476984f2b69b4
languageName: node
linkType: hard
@@ -135,55 +135,55 @@ __metadata:
languageName: node
linkType: hard
-"@algolia/logger-common@npm:4.22.0":
- version: 4.22.0
- resolution: "@algolia/logger-common@npm:4.22.0"
- checksum: f838ced854f18fa4fad0954de196da4f1a8c4865ed9c41c8786bf34963cce0cdf0a03de8ab34b49f99c0811063c956edffba6e2f6d5a602bdf34d1693ff1c87b
+"@algolia/logger-common@npm:4.22.1":
+ version: 4.22.1
+ resolution: "@algolia/logger-common@npm:4.22.1"
+ checksum: 66fcfa90d3e94fe582f6a7ded8f413689f25c8c8c3c420f40cccd7acc7e7bc7895b1c5191e2c371e81d31a8dfc5dc8d0e7c9995a57635f1afb833f665c8dfb7c
languageName: node
linkType: hard
-"@algolia/logger-console@npm:4.22.0":
- version: 4.22.0
- resolution: "@algolia/logger-console@npm:4.22.0"
+"@algolia/logger-console@npm:4.22.1":
+ version: 4.22.1
+ resolution: "@algolia/logger-console@npm:4.22.1"
dependencies:
- "@algolia/logger-common": "npm:4.22.0"
- checksum: 454f63d86b2940a09260a9e7790a8c5eb720e2f08b484e8eb8cf467e02f77e18b896136a36cb43739b6354e22c4b84d6febab946cb39e0c2aaddcaed580922d7
+ "@algolia/logger-common": "npm:4.22.1"
+ checksum: b93522a3c699537805b347028f7a46af0860ce6ca5fd4bfee717f01cbd1341b04b48441cfb96e1582a35a3382029fb8ae2448efc6a750a703ef1dbb577011c5a
languageName: node
linkType: hard
-"@algolia/requester-browser-xhr@npm:4.22.0":
- version: 4.22.0
- resolution: "@algolia/requester-browser-xhr@npm:4.22.0"
+"@algolia/requester-browser-xhr@npm:4.22.1":
+ version: 4.22.1
+ resolution: "@algolia/requester-browser-xhr@npm:4.22.1"
dependencies:
- "@algolia/requester-common": "npm:4.22.0"
- checksum: cf9899dc2a420afdd343548b5a8133d5186d50daaf26d29d0770cc6235110d774a0543196ac8796524130265c9bf884c33294f4b3aac61eb835d939b4c76f4b3
+ "@algolia/requester-common": "npm:4.22.1"
+ checksum: bae3555e5660582e7e2b2fe6a637591ddb89e2b463a295fd541e01e8b1eb5c05d7efb00cdc231f8615e408dfd64f078b4bfcf6ca8c0b1c99bfc6d2fd05530f9a
languageName: node
linkType: hard
-"@algolia/requester-common@npm:4.22.0":
- version: 4.22.0
- resolution: "@algolia/requester-common@npm:4.22.0"
- checksum: 5a46bc1630ef2c7579d7ea9faea675321d310005dfa06be0bc71ddf0fceebcf5895ad68f690e2b29b8224f563bd6553231ebc3dc92b77e1aef5c330ee40a1cec
+"@algolia/requester-common@npm:4.22.1":
+ version: 4.22.1
+ resolution: "@algolia/requester-common@npm:4.22.1"
+ checksum: e0c61fd4515e30163ace99528212e50478ece175f96186f9b7d4f79406a70f78e98a4fb09f929f178f2a3e193257f749fdcd7acc44dd41d875d073172f4a2d8b
languageName: node
linkType: hard
-"@algolia/requester-node-http@npm:4.22.0":
- version: 4.22.0
- resolution: "@algolia/requester-node-http@npm:4.22.0"
+"@algolia/requester-node-http@npm:4.22.1":
+ version: 4.22.1
+ resolution: "@algolia/requester-node-http@npm:4.22.1"
dependencies:
- "@algolia/requester-common": "npm:4.22.0"
- checksum: fb13b9698fd05f71019d9affdcec30b070331b2d97b2f976ed73f4f8671ef496c609ed42862b5c3b89366c645eec757d29fe736e8f9685c574d03b435a5ded5f
+ "@algolia/requester-common": "npm:4.22.1"
+ checksum: ca934a1ae6b6b2f5bd78df9c88e133461eb67a8394cc5764d7a8f430cd7a6f069f55a9a4f26c4aed9bed76c4aa1edfce4727feeaec4a86d672a0ade3b1be1846
languageName: node
linkType: hard
-"@algolia/transporter@npm:4.22.0":
- version: 4.22.0
- resolution: "@algolia/transporter@npm:4.22.0"
+"@algolia/transporter@npm:4.22.1":
+ version: 4.22.1
+ resolution: "@algolia/transporter@npm:4.22.1"
dependencies:
- "@algolia/cache-common": "npm:4.22.0"
- "@algolia/logger-common": "npm:4.22.0"
- "@algolia/requester-common": "npm:4.22.0"
- checksum: c17d5813f2658075b48b6155f79d1843d40df5b2575f53bf2d8c03c4a9617b5771b8467b7edd125b6fd6961f72d3dd7e2b73b70d8ff138e390cad34e4d14c46d
+ "@algolia/cache-common": "npm:4.22.1"
+ "@algolia/logger-common": "npm:4.22.1"
+ "@algolia/requester-common": "npm:4.22.1"
+ checksum: e43c4258100cfe8dddab7a77d2beb3161d01b570358f4e24357761afcfa1cac480cc183ff71f6c6399019c3652d822edecf74483406188712025e897d193c380
languageName: node
linkType: hard
@@ -327,6 +327,21 @@ __metadata:
languageName: node
linkType: hard
+"@babel/helper-define-polyfill-provider@npm:^0.5.0":
+ version: 0.5.0
+ resolution: "@babel/helper-define-polyfill-provider@npm:0.5.0"
+ dependencies:
+ "@babel/helper-compilation-targets": "npm:^7.22.6"
+ "@babel/helper-plugin-utils": "npm:^7.22.5"
+ debug: "npm:^4.1.1"
+ lodash.debounce: "npm:^4.0.8"
+ resolve: "npm:^1.14.2"
+ peerDependencies:
+ "@babel/core": ^7.4.0 || ^8.0.0-0 <8.0.0
+ checksum: 2b053b96a0c604a7e0f5c7d13a8a55f4451d938f7af42bd40f62a87df15e6c87a0b1dbd893a0f0bb51077b54dc3ba00a58b166531a5940ad286ab685dd8979ec
+ languageName: node
+ linkType: hard
+
"@babel/helper-environment-visitor@npm:^7.22.20":
version: 7.22.20
resolution: "@babel/helper-environment-visitor@npm:7.22.20"
@@ -488,13 +503,13 @@ __metadata:
linkType: hard
"@babel/helpers@npm:^7.23.7":
- version: 7.23.7
- resolution: "@babel/helpers@npm:7.23.7"
+ version: 7.23.8
+ resolution: "@babel/helpers@npm:7.23.8"
dependencies:
"@babel/template": "npm:^7.22.15"
"@babel/traverse": "npm:^7.23.7"
"@babel/types": "npm:^7.23.6"
- checksum: f74a61ad28a1bc1fdd9133ad571c07787b66d6db017c707b87c203b0cd06879cea8b33e9c6a8585765a4949efa5df3cc9e19b710fe867f11be38ee29fd4a0488
+ checksum: d9fce49278a31aaa017a40c1fcdaa450999c49e33582cce8138058c58b1acbe3a2d2488f010f28e91dedf0d35795ea32f0ee18745bbb6c7f54052ae0fd7e6a3f
languageName: node
linkType: hard
@@ -869,22 +884,21 @@ __metadata:
languageName: node
linkType: hard
-"@babel/plugin-transform-classes@npm:^7.23.5":
- version: 7.23.5
- resolution: "@babel/plugin-transform-classes@npm:7.23.5"
+"@babel/plugin-transform-classes@npm:^7.23.8":
+ version: 7.23.8
+ resolution: "@babel/plugin-transform-classes@npm:7.23.8"
dependencies:
"@babel/helper-annotate-as-pure": "npm:^7.22.5"
- "@babel/helper-compilation-targets": "npm:^7.22.15"
+ "@babel/helper-compilation-targets": "npm:^7.23.6"
"@babel/helper-environment-visitor": "npm:^7.22.20"
"@babel/helper-function-name": "npm:^7.23.0"
- "@babel/helper-optimise-call-expression": "npm:^7.22.5"
"@babel/helper-plugin-utils": "npm:^7.22.5"
"@babel/helper-replace-supers": "npm:^7.22.20"
"@babel/helper-split-export-declaration": "npm:^7.22.6"
globals: "npm:^11.1.0"
peerDependencies:
"@babel/core": ^7.0.0-0
- checksum: 07988f52b4893151887d1ea6ff79e5fe834078c5731bd09babd5659edbbae21ea4e2de326a02443a63fd776b4c945da6177f07875b56fe66e0b7899e830a9e92
+ checksum: 227ac5166501e04d9e7fbd5eda6869b084ffa4af6830ac12544ac6ea14953ca00eb1762b0df9349c0f6c8d2a799385910f558066cd0fb85b9ca437b1131a6043
languageName: node
linkType: hard
@@ -1456,8 +1470,8 @@ __metadata:
linkType: hard
"@babel/preset-env@npm:^7.19.4, @babel/preset-env@npm:^7.22.9":
- version: 7.23.7
- resolution: "@babel/preset-env@npm:7.23.7"
+ version: 7.23.8
+ resolution: "@babel/preset-env@npm:7.23.8"
dependencies:
"@babel/compat-data": "npm:^7.23.5"
"@babel/helper-compilation-targets": "npm:^7.23.6"
@@ -1492,7 +1506,7 @@ __metadata:
"@babel/plugin-transform-block-scoping": "npm:^7.23.4"
"@babel/plugin-transform-class-properties": "npm:^7.23.3"
"@babel/plugin-transform-class-static-block": "npm:^7.23.4"
- "@babel/plugin-transform-classes": "npm:^7.23.5"
+ "@babel/plugin-transform-classes": "npm:^7.23.8"
"@babel/plugin-transform-computed-properties": "npm:^7.23.3"
"@babel/plugin-transform-destructuring": "npm:^7.23.3"
"@babel/plugin-transform-dotall-regex": "npm:^7.23.3"
@@ -1541,7 +1555,7 @@ __metadata:
semver: "npm:^6.3.1"
peerDependencies:
"@babel/core": ^7.0.0-0
- checksum: ac9def873cec52ee02a550bde6e22eced16d1ae331bb8ebc82c03e4c91c12ac17e3e4027647e61612937bcc25ac46e71370aaf99dc2e85dbd11f7777ffeed54e
+ checksum: e602ad954645f1a509644e3d2c72b3c63bdc2273c377e7a83b78f076eca215887ea3624ffc36aaad03deb9ac8acd89e247fd4562b96e0f2b679485e20d8ff25f
languageName: node
linkType: hard
@@ -1597,21 +1611,21 @@ __metadata:
linkType: hard
"@babel/runtime-corejs3@npm:^7.22.6":
- version: 7.23.7
- resolution: "@babel/runtime-corejs3@npm:7.23.7"
+ version: 7.23.8
+ resolution: "@babel/runtime-corejs3@npm:7.23.8"
dependencies:
core-js-pure: "npm:^3.30.2"
regenerator-runtime: "npm:^0.14.0"
- checksum: 7230942b6dadddd68334283068f360323c6df205542811bd7e37384ebfc0b5dcc266470db99e5905a8c6e3bb9898f7f066dde145b33b560acd271118ed9b41b2
+ checksum: 2ccc006308dc0afb88dab5b91380be3a644a7616b9e33b6039eeceb11080541d566e8c29d1e81495c3983990c6843cb872bb150dd6c0f23f85fa9eb8d1fe20c5
languageName: node
linkType: hard
"@babel/runtime@npm:^7.1.2, @babel/runtime@npm:^7.10.3, @babel/runtime@npm:^7.12.13, @babel/runtime@npm:^7.12.5, @babel/runtime@npm:^7.22.6, @babel/runtime@npm:^7.8.4":
- version: 7.23.7
- resolution: "@babel/runtime@npm:7.23.7"
+ version: 7.23.8
+ resolution: "@babel/runtime@npm:7.23.8"
dependencies:
regenerator-runtime: "npm:^0.14.0"
- checksum: 3e304133ee55b0750e03e53cb4efb47fb2bdcdb5795f85bbffa10595196c34b9be60eb65bd6d833c87f49fc827f0365f86f95f51d85b188004d3128bb5129c93
+ checksum: ba5e8fbb32ef04f6cab5e89c54a0497c2fde7b730595cc1af93496270314f13ff2c6a9360fdb2f0bdd4d6b376752ce3cf85642bd6b876969a6a62954934c2df8
languageName: node
linkType: hard
@@ -1644,7 +1658,7 @@ __metadata:
languageName: node
linkType: hard
-"@babel/types@npm:^7.20.0, @babel/types@npm:^7.22.15, @babel/types@npm:^7.22.19, @babel/types@npm:^7.22.5, @babel/types@npm:^7.23.0, @babel/types@npm:^7.23.4, @babel/types@npm:^7.23.6, @babel/types@npm:^7.4.4, @babel/types@npm:^7.8.3":
+"@babel/types@npm:^7.20.0, @babel/types@npm:^7.22.15, @babel/types@npm:^7.22.19, @babel/types@npm:^7.22.5, @babel/types@npm:^7.23.0, @babel/types@npm:^7.23.4, @babel/types@npm:^7.23.6, @babel/types@npm:^7.4.4":
version: 7.23.6
resolution: "@babel/types@npm:7.23.6"
dependencies:
@@ -1655,6 +1669,17 @@ __metadata:
languageName: node
linkType: hard
+"@babel/types@npm:^7.8.3":
+ version: 7.23.9
+ resolution: "@babel/types@npm:7.23.9"
+ dependencies:
+ "@babel/helper-string-parser": "npm:^7.23.4"
+ "@babel/helper-validator-identifier": "npm:^7.22.20"
+ to-fast-properties: "npm:^2.0.0"
+ checksum: edc7bb180ce7e4d2aea10c6972fb10474341ac39ba8fdc4a27ffb328368dfdfbf40fca18e441bbe7c483774500d5c05e222cec276c242e952853dcaf4eb884f7
+ languageName: node
+ linkType: hard
+
"@colors/colors@npm:1.5.0":
version: 1.5.0
resolution: "@colors/colors@npm:1.5.0"
@@ -2249,14 +2274,14 @@ __metadata:
languageName: node
linkType: hard
-"@hapi/hoek@npm:^9.0.0":
+"@hapi/hoek@npm:^9.0.0, @hapi/hoek@npm:^9.3.0":
version: 9.3.0
resolution: "@hapi/hoek@npm:9.3.0"
checksum: a096063805051fb8bba4c947e293c664b05a32b47e13bc654c0dd43813a1cec993bdd8f29ceb838020299e1d0f89f68dc0d62a603c13c9cc8541963f0beca055
languageName: node
linkType: hard
-"@hapi/topo@npm:^5.0.0":
+"@hapi/topo@npm:^5.1.0":
version: 5.1.0
resolution: "@hapi/topo@npm:5.1.0"
dependencies:
@@ -2345,12 +2370,12 @@ __metadata:
linkType: hard
"@jridgewell/trace-mapping@npm:^0.3.17, @jridgewell/trace-mapping@npm:^0.3.20, @jridgewell/trace-mapping@npm:^0.3.9":
- version: 0.3.20
- resolution: "@jridgewell/trace-mapping@npm:0.3.20"
+ version: 0.3.22
+ resolution: "@jridgewell/trace-mapping@npm:0.3.22"
dependencies:
"@jridgewell/resolve-uri": "npm:^3.1.0"
"@jridgewell/sourcemap-codec": "npm:^1.4.14"
- checksum: 0ea0b2675cf513ec44dc25605616a3c9b808b9832e74b5b63c44260d66b58558bba65764f81928fc1033ead911f8718dca1134049c3e7a93937faf436671df31
+ checksum: 18cf19f88e2792c1c91515f2b629aae05f3cdbb2e60c3886e16e80725234ce26dd10144c4981c05d9366e7094498c0b4fe5c1a89f4a730d7376a4ba4af448149
languageName: node
linkType: hard
@@ -2501,7 +2526,7 @@ __metadata:
languageName: node
linkType: hard
-"@sideway/address@npm:^4.1.3":
+"@sideway/address@npm:^4.1.4":
version: 4.1.4
resolution: "@sideway/address@npm:4.1.4"
dependencies:
@@ -2806,12 +2831,12 @@ __metadata:
linkType: hard
"@types/eslint@npm:*":
- version: 8.56.0
- resolution: "@types/eslint@npm:8.56.0"
+ version: 8.56.2
+ resolution: "@types/eslint@npm:8.56.2"
dependencies:
"@types/estree": "npm:*"
"@types/json-schema": "npm:*"
- checksum: afba97b10d02cb7c7e7658de38f626c65b81be0fe45bc479e058ab14bc089911193811dce681edd656fc6b59c91fd8d0c976972476fc98b5e782b2c3b08aaa6c
+ checksum: e33ca87a30a9454ba9943e1270ac759996f5fe598a1c1afbaec1d1e7346a339e20bf2a9d81f177067116bbaa6cfa4f748993cb338f57978ae862ad38ffae56fe
languageName: node
linkType: hard
@@ -2956,14 +2981,7 @@ __metadata:
languageName: node
linkType: hard
-"@types/mime@npm:*":
- version: 3.0.4
- resolution: "@types/mime@npm:3.0.4"
- checksum: db478bc0f99e40f7b3e01d356a9bdf7817060808a294978111340317bcd80ca35382855578c5b60fbc84ae449674bd9bb38427b18417e1f8f19e4f72f8b242cd
- languageName: node
- linkType: hard
-
-"@types/mime@npm:^1":
+"@types/mime@npm:*, @types/mime@npm:^1":
version: 1.3.5
resolution: "@types/mime@npm:1.3.5"
checksum: c2ee31cd9b993804df33a694d5aa3fa536511a49f2e06eeab0b484fef59b4483777dbb9e42a4198a0809ffbf698081fdbca1e5c2218b82b91603dfab10a10fbc
@@ -2978,20 +2996,20 @@ __metadata:
linkType: hard
"@types/node-forge@npm:^1.3.0":
- version: 1.3.10
- resolution: "@types/node-forge@npm:1.3.10"
+ version: 1.3.11
+ resolution: "@types/node-forge@npm:1.3.11"
dependencies:
"@types/node": "npm:*"
- checksum: b190e93e36e3bf5881e099df930645bbeb963c1cabb110948f90e11f5f59a2514d5632e6bd1101dfb839725eab25a8e2eba4a2b1b7551f12bc43302863e050ae
+ checksum: 3d7d23ca0ba38ac0cf74028393bd70f31169ab9aba43f21deb787840170d307d662644bac07287495effe2812ddd7ac8a14dbd43f16c2936bbb06312e96fc3b9
languageName: node
linkType: hard
"@types/node@npm:*":
- version: 20.10.6
- resolution: "@types/node@npm:20.10.6"
+ version: 20.11.5
+ resolution: "@types/node@npm:20.11.5"
dependencies:
undici-types: "npm:~5.26.4"
- checksum: 6692ccfa8552ef60c4069fda3c8de726c23e8d403cdf788e3c7efa769987e80fbda5f02723dd857f9de7df24a5fa40b3ed4580ec3c5cbac04eba44cf7b2ab1dc
+ checksum: 6d18cec852f5cfbed3ec42b5c01c026e7a3f9da540d6e3d6738d4cee9979fb308cf27b6df7ba40a6553e7bc82e678f0ef53ba6e6ad52e5b86bd97b7783c2a42c
languageName: node
linkType: hard
@@ -3070,13 +3088,13 @@ __metadata:
linkType: hard
"@types/react@npm:*":
- version: 18.2.46
- resolution: "@types/react@npm:18.2.46"
+ version: 18.2.48
+ resolution: "@types/react@npm:18.2.48"
dependencies:
"@types/prop-types": "npm:*"
"@types/scheduler": "npm:*"
csstype: "npm:^3.0.2"
- checksum: 814cc67107e5e69501d65bfc371cc2c716665d2a3608d395a2f81e24c3a2875db28e2cad717dfb17017eabcffd1d68ee2c9e09ecaba3f7108d5b7fbb9888ebab
+ checksum: 7e89f18ea2928b1638f564b156d692894dcb9352a7e0a807873c97e858abe1f23dbd165a25dd088a991344e973fdeef88ba5724bfb64504b74072cbc9c220c3a
languageName: node
linkType: hard
@@ -3389,9 +3407,9 @@ __metadata:
linkType: hard
"acorn-walk@npm:^8.0.0":
- version: 8.3.1
- resolution: "acorn-walk@npm:8.3.1"
- checksum: a23d2f7c6b6cad617f4c77f14dfeb062a239208d61753e9ba808d916c550add92b39535467d2e6028280761ac4f5a904cc9df21530b84d3f834e3edef74ddde5
+ version: 8.3.2
+ resolution: "acorn-walk@npm:8.3.2"
+ checksum: 7e2a8dad5480df7f872569b9dccff2f3da7e65f5353686b1d6032ab9f4ddf6e3a2cb83a9b52cf50b1497fd522154dda92f0abf7153290cc79cd14721ff121e52
languageName: node
linkType: hard
@@ -3500,24 +3518,24 @@ __metadata:
linkType: hard
"algoliasearch@npm:^4.18.0, algoliasearch@npm:^4.19.1":
- version: 4.22.0
- resolution: "algoliasearch@npm:4.22.0"
- dependencies:
- "@algolia/cache-browser-local-storage": "npm:4.22.0"
- "@algolia/cache-common": "npm:4.22.0"
- "@algolia/cache-in-memory": "npm:4.22.0"
- "@algolia/client-account": "npm:4.22.0"
- "@algolia/client-analytics": "npm:4.22.0"
- "@algolia/client-common": "npm:4.22.0"
- "@algolia/client-personalization": "npm:4.22.0"
- "@algolia/client-search": "npm:4.22.0"
- "@algolia/logger-common": "npm:4.22.0"
- "@algolia/logger-console": "npm:4.22.0"
- "@algolia/requester-browser-xhr": "npm:4.22.0"
- "@algolia/requester-common": "npm:4.22.0"
- "@algolia/requester-node-http": "npm:4.22.0"
- "@algolia/transporter": "npm:4.22.0"
- checksum: 6be8b0da31ff11705e8f39f85370344212fb9c8d88cb4d98823e0814c1b7ed770eaf156919026d8d14f6d041369779532e029c0bea5302958e5cd6a8c295e141
+ version: 4.22.1
+ resolution: "algoliasearch@npm:4.22.1"
+ dependencies:
+ "@algolia/cache-browser-local-storage": "npm:4.22.1"
+ "@algolia/cache-common": "npm:4.22.1"
+ "@algolia/cache-in-memory": "npm:4.22.1"
+ "@algolia/client-account": "npm:4.22.1"
+ "@algolia/client-analytics": "npm:4.22.1"
+ "@algolia/client-common": "npm:4.22.1"
+ "@algolia/client-personalization": "npm:4.22.1"
+ "@algolia/client-search": "npm:4.22.1"
+ "@algolia/logger-common": "npm:4.22.1"
+ "@algolia/logger-console": "npm:4.22.1"
+ "@algolia/requester-browser-xhr": "npm:4.22.1"
+ "@algolia/requester-common": "npm:4.22.1"
+ "@algolia/requester-node-http": "npm:4.22.1"
+ "@algolia/transporter": "npm:4.22.1"
+ checksum: 0e0d0e84c532ad72428da35a36beec0aabdbcf3fd202070be5aafa2d4c51c8fbb98e6bcaabe745b0e95858887ec5ec603854d04571d19fe3f7325d799e54f231
languageName: node
linkType: hard
@@ -3625,13 +3643,6 @@ __metadata:
languageName: node
linkType: hard
-"array-flatten@npm:^2.1.2":
- version: 2.1.2
- resolution: "array-flatten@npm:2.1.2"
- checksum: bdc1cee68e41bec9cfc1161408734e2269428ef371445606bce4e6241001e138a94b9a617cc9a5b4b7fe6a3a51e3d5a942646975ce82a2e202ccf3e9b478c82f
- languageName: node
- linkType: hard
-
"array-union@npm:^2.1.0":
version: 2.1.0
resolution: "array-union@npm:2.1.0"
@@ -3656,12 +3667,12 @@ __metadata:
linkType: hard
"autoprefixer@npm:^10.4.12, autoprefixer@npm:^10.4.14":
- version: 10.4.16
- resolution: "autoprefixer@npm:10.4.16"
+ version: 10.4.17
+ resolution: "autoprefixer@npm:10.4.17"
dependencies:
- browserslist: "npm:^4.21.10"
- caniuse-lite: "npm:^1.0.30001538"
- fraction.js: "npm:^4.3.6"
+ browserslist: "npm:^4.22.2"
+ caniuse-lite: "npm:^1.0.30001578"
+ fraction.js: "npm:^4.3.7"
normalize-range: "npm:^0.1.2"
picocolors: "npm:^1.0.0"
postcss-value-parser: "npm:^4.2.0"
@@ -3669,7 +3680,7 @@ __metadata:
postcss: ^8.1.0
bin:
autoprefixer: bin/autoprefixer
- checksum: e00256e754d481a026d928bca729b25954074dd142dbec022f0a7db0d3bbc0dc2e2dc7542e94fec22eff81e21fe140e6856448e2d9a002660cb1e2ad434daee0
+ checksum: 1d21cc8edb7bf993682094ceed03a32c18f5293f071182a64c2c6defb44bbe91d576ad775d2347469a81997b80cea0bbc4ad3eeb5b12710f9feacf2e6c04bb51
languageName: node
linkType: hard
@@ -3696,15 +3707,15 @@ __metadata:
linkType: hard
"babel-plugin-polyfill-corejs2@npm:^0.4.7":
- version: 0.4.7
- resolution: "babel-plugin-polyfill-corejs2@npm:0.4.7"
+ version: 0.4.8
+ resolution: "babel-plugin-polyfill-corejs2@npm:0.4.8"
dependencies:
"@babel/compat-data": "npm:^7.22.6"
- "@babel/helper-define-polyfill-provider": "npm:^0.4.4"
+ "@babel/helper-define-polyfill-provider": "npm:^0.5.0"
semver: "npm:^6.3.1"
peerDependencies:
"@babel/core": ^7.4.0 || ^8.0.0-0 <8.0.0
- checksum: f80f7284ec72c63e7dd751e0bdf25e9978df195a79e0887470603bfdea13ee518d62573cf360bb1bc01b80819e54915dd5edce9cff14c52d0af5f984aa3d36a3
+ checksum: 843e7528de0e03a31a6f3837896a95f75b0b24b0294a077246282372279e974400b0bdd82399e8f9cbfe42c87ed56540fd71c33eafb7c8e8b9adac546ecc5fe5
languageName: node
linkType: hard
@@ -3721,13 +3732,13 @@ __metadata:
linkType: hard
"babel-plugin-polyfill-regenerator@npm:^0.5.4":
- version: 0.5.4
- resolution: "babel-plugin-polyfill-regenerator@npm:0.5.4"
+ version: 0.5.5
+ resolution: "babel-plugin-polyfill-regenerator@npm:0.5.5"
dependencies:
- "@babel/helper-define-polyfill-provider": "npm:^0.4.4"
+ "@babel/helper-define-polyfill-provider": "npm:^0.5.0"
peerDependencies:
"@babel/core": ^7.4.0 || ^8.0.0-0 <8.0.0
- checksum: 0b903f5fe2f8c487b4260935dfe60bd9a95bcaee7ae63958f063045093b16d4e8288c232199d411261300aa21f6b106a3cb83c42cc996de013b337f5825a79fe
+ checksum: 2aab692582082d54e0df9f9373dca1b223e65b4e7e96440160f27ed8803d417a1fa08da550f08aa3820d2010329ca91b68e2b6e9bd7aed51c93d46dfe79629bb
languageName: node
linkType: hard
@@ -3787,14 +3798,12 @@ __metadata:
linkType: hard
"bonjour-service@npm:^1.0.11":
- version: 1.1.1
- resolution: "bonjour-service@npm:1.1.1"
+ version: 1.2.1
+ resolution: "bonjour-service@npm:1.2.1"
dependencies:
- array-flatten: "npm:^2.1.2"
- dns-equal: "npm:^1.0.0"
fast-deep-equal: "npm:^3.1.3"
multicast-dns: "npm:^7.2.5"
- checksum: 8dd3fef3ff8a11678d8f586be03c85004a45bae4353c55d7dbffe288cad73ddb38dee08b57425b9945c9a3a840d50bd40ae5aeda0066186dabe4b84a315b4e05
+ checksum: 953cbfc27fc9e36e6f988012993ab2244817d82426603e0390d4715639031396c932b6657b1aa4ec30dbb5fa903d6b2c7f1be3af7a8ba24165c93e987c849730
languageName: node
linkType: hard
@@ -3865,7 +3874,7 @@ __metadata:
languageName: node
linkType: hard
-"browserslist@npm:^4.0.0, browserslist@npm:^4.14.5, browserslist@npm:^4.18.1, browserslist@npm:^4.21.10, browserslist@npm:^4.21.4, browserslist@npm:^4.22.2":
+"browserslist@npm:^4.0.0, browserslist@npm:^4.14.5, browserslist@npm:^4.18.1, browserslist@npm:^4.21.4, browserslist@npm:^4.22.2":
version: 4.22.2
resolution: "browserslist@npm:4.22.2"
dependencies:
@@ -3901,8 +3910,8 @@ __metadata:
linkType: hard
"cacache@npm:^18.0.0":
- version: 18.0.1
- resolution: "cacache@npm:18.0.1"
+ version: 18.0.2
+ resolution: "cacache@npm:18.0.2"
dependencies:
"@npmcli/fs": "npm:^3.1.0"
fs-minipass: "npm:^3.0.0"
@@ -3916,7 +3925,7 @@ __metadata:
ssri: "npm:^10.0.0"
tar: "npm:^6.1.11"
unique-filename: "npm:^3.0.0"
- checksum: a31666805a80a8b16ad3f85faf66750275a9175a3480896f4f6d31b5d53ef190484fabd71bdb6d2ea5603c717fbef09f4af03d6a65b525c8ef0afaa44c361866
+ checksum: 7992665305cc251a984f4fdbab1449d50e88c635bc43bf2785530c61d239c61b349e5734461baa461caaee65f040ab14e2d58e694f479c0810cffd181ba5eabc
languageName: node
linkType: hard
@@ -3996,10 +4005,10 @@ __metadata:
languageName: node
linkType: hard
-"caniuse-lite@npm:^1.0.0, caniuse-lite@npm:^1.0.30001538, caniuse-lite@npm:^1.0.30001565":
- version: 1.0.30001572
- resolution: "caniuse-lite@npm:1.0.30001572"
- checksum: 7d02570fa576b158d96739f2c65ea3ad22e90a8b028a343902de1f13b7db8512144870f1d29ec5e9ae7189d96158d9643871b6e902e6680a06b27a9afe556da2
+"caniuse-lite@npm:^1.0.0, caniuse-lite@npm:^1.0.30001565, caniuse-lite@npm:^1.0.30001578":
+ version: 1.0.30001579
+ resolution: "caniuse-lite@npm:1.0.30001579"
+ checksum: 4003970f8d01a5fa314e39f4a21751dc750a530f3d19aed225e18e8e02892b590b8b0debfa0961eae9bc0e49b77bfb17cf30d2469540e428a8305e3cc9164fb8
languageName: node
linkType: hard
@@ -4441,25 +4450,25 @@ __metadata:
linkType: hard
"core-js-compat@npm:^3.31.0, core-js-compat@npm:^3.33.1":
- version: 3.35.0
- resolution: "core-js-compat@npm:3.35.0"
+ version: 3.35.1
+ resolution: "core-js-compat@npm:3.35.1"
dependencies:
browserslist: "npm:^4.22.2"
- checksum: 8c4379240b8decb94b21e81d5ba6f768418721061923b28c9dfc97574680c35d778d39c010207402fc7c8308a68a4cf6d5e02bcbcb96e931c52e6e0dce29a68c
+ checksum: c3b872e1f9703aa9554cce816207d85730da4703f1776c540b4da11bbbef6d9a1e6041625b5c1f58d2ada3d05f4a2b92897b7de5315c5ecd5d33d50dec86cca7
languageName: node
linkType: hard
"core-js-pure@npm:^3.30.2":
- version: 3.35.0
- resolution: "core-js-pure@npm:3.35.0"
- checksum: 4e58b6b2b3759ffbfe3f904beafd547751aaefa87b94245136aced963120bc2cefc8787c7a980cd397c2c408eca141e0993fcda7ed2383c93ce53bc421acfec4
+ version: 3.35.1
+ resolution: "core-js-pure@npm:3.35.1"
+ checksum: 1e3154d47be12ba82dd927b0af87fac4c6011d36772bc03e3690b1e70d9fc16f31af058f5cff647e82f8500bf08c58e1261e63dcc797faea568ebc6fc50331a7
languageName: node
linkType: hard
"core-js@npm:^3.31.1":
- version: 3.35.0
- resolution: "core-js@npm:3.35.0"
- checksum: 1d545ff4406f2afa5e681f44b45ed5f7f119d158b380234d5aa7787ce7e47fc7a635b98b74c28c766ba8191e3db8c2316ad6ab4ff1ddecbc3fd618413a52c29c
+ version: 3.35.1
+ resolution: "core-js@npm:3.35.1"
+ checksum: ebc8e22c36d13bcf2140cbc1d8ad65d1b08192bff4c43ade70c72eac103cb4dcfbc521f2b1ad1c74881b0a4353e64986537893ae4f07888e49228340efa13ae6
languageName: node
linkType: hard
@@ -4543,20 +4552,20 @@ __metadata:
linkType: hard
"css-loader@npm:^6.8.1":
- version: 6.8.1
- resolution: "css-loader@npm:6.8.1"
+ version: 6.9.1
+ resolution: "css-loader@npm:6.9.1"
dependencies:
icss-utils: "npm:^5.1.0"
- postcss: "npm:^8.4.21"
+ postcss: "npm:^8.4.33"
postcss-modules-extract-imports: "npm:^3.0.0"
- postcss-modules-local-by-default: "npm:^4.0.3"
- postcss-modules-scope: "npm:^3.0.0"
+ postcss-modules-local-by-default: "npm:^4.0.4"
+ postcss-modules-scope: "npm:^3.1.1"
postcss-modules-values: "npm:^4.0.0"
postcss-value-parser: "npm:^4.2.0"
- semver: "npm:^7.3.8"
+ semver: "npm:^7.5.4"
peerDependencies:
webpack: ^5.0.0
- checksum: a6e23de4ec1d2832f10b8ca3cfec6b6097a97ca3c73f64338ae5cd110ac270f1b218ff0273d39f677a7a561f1a9d9b0d332274664d0991bcfafaae162c2669c4
+ checksum: 3dfff7d4372a1d8f2b1606a8376f2f5e484e59d7ffdc373ea3b04aa2b54ecd052aaf72c090a97148b0eb8a164cdc1f9dcb7a68686b2d5d190d69367c30f76132
languageName: node
linkType: hard
@@ -4934,13 +4943,6 @@ __metadata:
languageName: node
linkType: hard
-"dns-equal@npm:^1.0.0":
- version: 1.0.0
- resolution: "dns-equal@npm:1.0.0"
- checksum: da966e5275ac50546e108af6bc29aaae2164d2ae96d60601b333c4a3aff91f50b6ca14929cf91f20a9cad1587b356323e300cea3ff6588a6a816988485f445f1
- languageName: node
- linkType: hard
-
"dns-packet@npm:^5.2.2":
version: 5.6.1
resolution: "dns-packet@npm:5.6.1"
@@ -5105,9 +5107,9 @@ __metadata:
linkType: hard
"electron-to-chromium@npm:^1.4.601":
- version: 1.4.616
- resolution: "electron-to-chromium@npm:1.4.616"
- checksum: a02416f3293d28120d5132546a6aea614ebd2d820a684f41b1c20138331922ddc672c4a59bfc4b91bb5aee1ba608f6c10cd3f69c344cd434397e7f14a4c97348
+ version: 1.4.640
+ resolution: "electron-to-chromium@npm:1.4.640"
+ checksum: fe5e2eaf3bdd73c1628ed0a7856a1d6afad99bdcceec6cacf87e7bac31db8514a52084d040b95b956ceba4f95723a6f3cf40a91f21b0061e6490328c9099dc4a
languageName: node
linkType: hard
@@ -5657,12 +5659,12 @@ __metadata:
linkType: hard
"follow-redirects@npm:^1.0.0":
- version: 1.15.4
- resolution: "follow-redirects@npm:1.15.4"
+ version: 1.15.5
+ resolution: "follow-redirects@npm:1.15.5"
peerDependenciesMeta:
debug:
optional: true
- checksum: 5f37ed9170c9eb19448c5418fdb0f2b73f644b5364834e70791a76ecc7db215246f9773bbef4852cfae4067764ffc852e047f744b661b0211532155b73556a6a
+ checksum: 418d71688ceaf109dfd6f85f747a0c75de30afe43a294caa211def77f02ef19865b547dfb73fde82b751e1cc507c06c754120b848fe5a7400b0a669766df7615
languageName: node
linkType: hard
@@ -5728,7 +5730,7 @@ __metadata:
languageName: node
linkType: hard
-"fraction.js@npm:^4.3.6":
+"fraction.js@npm:^4.3.7":
version: 4.3.7
resolution: "fraction.js@npm:4.3.7"
checksum: df291391beea9ab4c263487ffd9d17fed162dbb736982dee1379b2a8cc94e4e24e46ed508c6d278aded9080ba51872f1bc5f3a5fd8d7c74e5f105b508ac28711
@@ -6082,7 +6084,7 @@ __metadata:
languageName: node
linkType: hard
-"has-property-descriptors@npm:^1.0.0":
+"has-property-descriptors@npm:^1.0.0, has-property-descriptors@npm:^1.0.1":
version: 1.0.1
resolution: "has-property-descriptors@npm:1.0.1"
dependencies:
@@ -6147,8 +6149,8 @@ __metadata:
linkType: hard
"hast-util-raw@npm:^9.0.0":
- version: 9.0.1
- resolution: "hast-util-raw@npm:9.0.1"
+ version: 9.0.2
+ resolution: "hast-util-raw@npm:9.0.2"
dependencies:
"@types/hast": "npm:^3.0.0"
"@types/unist": "npm:^3.0.0"
@@ -6163,7 +6165,7 @@ __metadata:
vfile: "npm:^6.0.0"
web-namespaces: "npm:^2.0.0"
zwitch: "npm:^2.0.0"
- checksum: 60ee6495681f020930380649af58b2a6ca081bec1abd1089f58b0ee892eac2c87dc2077fb30370e51848734b58d2d539e3cde5148c18aa70a89f2c7285e57c91
+ checksum: 0162c104c3fdf8b749b2d271d36b48f609c2cb3bc30cb21feb087ac67bdf806988c8cd14c2e2c71ff982b0a7525b0b1ffd09476f9d79b517337d78ada8042b0c
languageName: node
linkType: hard
@@ -6549,13 +6551,13 @@ __metadata:
linkType: hard
"image-size@npm:^1.0.2":
- version: 1.1.0
- resolution: "image-size@npm:1.1.0"
+ version: 1.1.1
+ resolution: "image-size@npm:1.1.1"
dependencies:
queue: "npm:6.0.2"
bin:
image-size: bin/image-size.js
- checksum: b6b7536240ff873720a98127cab08e6ea7954a965c646df2b61cf80d276dd471b47bea92f226ae5a1efa31c65ee402d9fb3af3efd80028af9711321d94903dfa
+ checksum: 2660470096d12be82195f7e80fe03274689fbd14184afb78eaf66ade7cd06352518325814f88af4bde4b26647889fe49e573129f6e7ba8f5ff5b85cc7f559000
languageName: node
linkType: hard
@@ -7043,15 +7045,15 @@ __metadata:
linkType: hard
"joi@npm:^17.9.2":
- version: 17.11.0
- resolution: "joi@npm:17.11.0"
+ version: 17.12.0
+ resolution: "joi@npm:17.12.0"
dependencies:
- "@hapi/hoek": "npm:^9.0.0"
- "@hapi/topo": "npm:^5.0.0"
- "@sideway/address": "npm:^4.1.3"
+ "@hapi/hoek": "npm:^9.3.0"
+ "@hapi/topo": "npm:^5.1.0"
+ "@sideway/address": "npm:^4.1.4"
"@sideway/formula": "npm:^3.0.1"
"@sideway/pinpoint": "npm:^2.0.0"
- checksum: c41c86fe772828b88fbdbcaef2e41235ccbb107c22523a377f9a2fd39829f203213f37a352589f49d9a9b38bf1c645846defede8b81d8c1f3123117c1a600010
+ checksum: 2378f4ec8de2bc12674ce3e6faac509f52ff4f734c67bf68c288816b20336d4e59433ea1c1e187f1009075c81ec5fa8b5061094feb37a855d6e3ee0cfcd79dd8
languageName: node
linkType: hard
@@ -7339,9 +7341,9 @@ __metadata:
linkType: hard
"lru-cache@npm:^10.0.1, lru-cache@npm:^9.1.1 || ^10.0.0":
- version: 10.1.0
- resolution: "lru-cache@npm:10.1.0"
- checksum: 778bc8b2626daccd75f24c4b4d10632496e21ba064b126f526c626fbdbc5b28c472013fccd45d7646b9e1ef052444824854aed617b59cd570d01a8b7d651fc1e
+ version: 10.2.0
+ resolution: "lru-cache@npm:10.2.0"
+ checksum: c9847612aa2daaef102d30542a8d6d9b2c2bb36581c1bf0dc3ebf5e5f3352c772a749e604afae2e46873b930a9e9523743faac4e5b937c576ab29196774712ee
languageName: node
linkType: hard
@@ -7624,8 +7626,8 @@ __metadata:
linkType: hard
"mdast-util-to-hast@npm:^13.0.0":
- version: 13.0.2
- resolution: "mdast-util-to-hast@npm:13.0.2"
+ version: 13.1.0
+ resolution: "mdast-util-to-hast@npm:13.1.0"
dependencies:
"@types/hast": "npm:^3.0.0"
"@types/mdast": "npm:^4.0.0"
@@ -7635,7 +7637,8 @@ __metadata:
trim-lines: "npm:^3.0.0"
unist-util-position: "npm:^5.0.0"
unist-util-visit: "npm:^5.0.0"
- checksum: f6e9a5b1ab94483ce1cf2ef229578fde4fe7d085f8b9d88a048823da5f93f9469adc98839e8db73f7475e8128a6df30eccad9cd0f9ee0a1d410e74db19b82d8c
+ vfile: "npm:^6.0.0"
+ checksum: a2b761bfae37b7eb6039e25ca2d3c4dc2f190cdef6b00e404e885d749ecc7f0ce6149f39130bdb02e122785c662eeb84dd1ac999ce3c311ffafe32ecf950071b
languageName: node
linkType: hard
@@ -8237,7 +8240,7 @@ __metadata:
languageName: node
linkType: hard
-"mime-types@npm:2.1.18":
+"mime-types@npm:2.1.18, mime-types@npm:~2.1.17":
version: 2.1.18
resolution: "mime-types@npm:2.1.18"
dependencies:
@@ -8246,7 +8249,7 @@ __metadata:
languageName: node
linkType: hard
-"mime-types@npm:^2.1.27, mime-types@npm:^2.1.31, mime-types@npm:~2.1.17, mime-types@npm:~2.1.24, mime-types@npm:~2.1.34":
+"mime-types@npm:^2.1.27, mime-types@npm:^2.1.31, mime-types@npm:~2.1.24, mime-types@npm:~2.1.34":
version: 2.1.35
resolution: "mime-types@npm:2.1.35"
dependencies:
@@ -8293,13 +8296,13 @@ __metadata:
linkType: hard
"mini-css-extract-plugin@npm:^2.7.6":
- version: 2.7.6
- resolution: "mini-css-extract-plugin@npm:2.7.6"
+ version: 2.7.7
+ resolution: "mini-css-extract-plugin@npm:2.7.7"
dependencies:
schema-utils: "npm:^4.0.0"
peerDependencies:
webpack: ^5.0.0
- checksum: 4862da928f52c18b37daa52d548c9f2a1ac65c900a48b63f7faa3354d8cfcd21618c049696559e73e2e27fc12d46748e6a490e0b885e54276429607d0d08c156
+ checksum: e22f76d96966ee4dfc1318e0f4c45ac75638932df468dc7d103094e1c97cb2d01ea7ccfb354e39d9e57d1971218cdc92678b9c8676472b2f1f801bb514967c44
languageName: node
linkType: hard
@@ -9227,27 +9230,27 @@ __metadata:
languageName: node
linkType: hard
-"postcss-modules-local-by-default@npm:^4.0.3":
- version: 4.0.3
- resolution: "postcss-modules-local-by-default@npm:4.0.3"
+"postcss-modules-local-by-default@npm:^4.0.4":
+ version: 4.0.4
+ resolution: "postcss-modules-local-by-default@npm:4.0.4"
dependencies:
icss-utils: "npm:^5.0.0"
postcss-selector-parser: "npm:^6.0.2"
postcss-value-parser: "npm:^4.1.0"
peerDependencies:
postcss: ^8.1.0
- checksum: be49b86efbfb921f42287e227584aac91af9826fc1083db04958ae283dfe215ca539421bfba71f9da0f0b10651f28e95a64b5faca7166f578a1933b8646051f7
+ checksum: 9ebf464867eb10b29b73501b1466dcac8352ed852ef68ec23571f515daa74401d7ace9a6c72f354542081fdbb47d098c9bc6b05373b553a6e35779d072f967bb
languageName: node
linkType: hard
-"postcss-modules-scope@npm:^3.0.0":
- version: 3.1.0
- resolution: "postcss-modules-scope@npm:3.1.0"
+"postcss-modules-scope@npm:^3.1.1":
+ version: 3.1.1
+ resolution: "postcss-modules-scope@npm:3.1.1"
dependencies:
postcss-selector-parser: "npm:^6.0.4"
peerDependencies:
postcss: ^8.1.0
- checksum: bc8e12e9312d7070f34ccef2929f65154102e2b2984a385eaf2ef25b6d4e22234de71116c240a05b541a79946b717d6fa8c5d314f6697bf05f295261693050fe
+ checksum: 3ef6ac14fcda1581bc43e37622256bd87b99ea49c59b2aae648d057d57f5ecc634648cce9910166220a797567af674bc09246ccc010f1dd58d2863b805719109
languageName: node
linkType: hard
@@ -9467,14 +9470,14 @@ __metadata:
languageName: node
linkType: hard
-"postcss@npm:^8.4.17, postcss@npm:^8.4.21, postcss@npm:^8.4.26":
- version: 8.4.32
- resolution: "postcss@npm:8.4.32"
+"postcss@npm:^8.4.17, postcss@npm:^8.4.21, postcss@npm:^8.4.26, postcss@npm:^8.4.33":
+ version: 8.4.33
+ resolution: "postcss@npm:8.4.33"
dependencies:
nanoid: "npm:^3.3.7"
picocolors: "npm:^1.0.0"
source-map-js: "npm:^1.0.2"
- checksum: 39308a9195fa34d4dbdd7b58a896cff0c7809f84f7a4ac1b95b68ca86c9138a395addff33075668ed3983d41b90aac05754c445237a9365eb1c3a5602ebd03ad
+ checksum: 16eda83458fcd8a91bece287b5920c7f57164c3ea293e6c80d0ea71ce7843007bcd8592260a5160b9a7f02693e6ac93e2495b02d8c7596d3f3f72c1447e3ba79
languageName: node
linkType: hard
@@ -9750,28 +9753,14 @@ __metadata:
languageName: node
linkType: hard
-"react-fast-compare@npm:^3.2.0, react-fast-compare@npm:^3.2.2":
+"react-fast-compare@npm:^3.2.0":
version: 3.2.2
resolution: "react-fast-compare@npm:3.2.2"
checksum: 0bbd2f3eb41ab2ff7380daaa55105db698d965c396df73e6874831dbafec8c4b5b08ba36ff09df01526caa3c61595247e3269558c284e37646241cba2b90a367
languageName: node
linkType: hard
-"react-helmet-async@npm:*":
- version: 2.0.4
- resolution: "react-helmet-async@npm:2.0.4"
- dependencies:
- invariant: "npm:^2.2.4"
- react-fast-compare: "npm:^3.2.2"
- shallowequal: "npm:^1.1.0"
- peerDependencies:
- react: ^16.6.0 || ^17.0.0 || ^18.0.0
- react-dom: ^16.6.0 || ^17.0.0 || ^18.0.0
- checksum: 91f99150c0cfb3853fc68658c10ff8e63bde4e635bd8ae5e820b586b2a9e45af78b7f9040d399aae55ab5698a588055549424084b09e482be2031ba7a85dee3e
- languageName: node
- linkType: hard
-
-"react-helmet-async@npm:^1.3.0":
+"react-helmet-async@npm:*, react-helmet-async@npm:^1.3.0":
version: 1.3.0
resolution: "react-helmet-async@npm:1.3.0"
dependencies:
@@ -10110,15 +10099,15 @@ __metadata:
linkType: hard
"remark-rehype@npm:^11.0.0":
- version: 11.0.0
- resolution: "remark-rehype@npm:11.0.0"
+ version: 11.1.0
+ resolution: "remark-rehype@npm:11.1.0"
dependencies:
"@types/hast": "npm:^3.0.0"
"@types/mdast": "npm:^4.0.0"
mdast-util-to-hast: "npm:^13.0.0"
unified: "npm:^11.0.0"
vfile: "npm:^6.0.0"
- checksum: d88180819f6695bc4f257cffcbe201973fc946144cc0101da589f25f3238932e384e98a8897b6060948ad2b5679eb2de5a720866b8b6f36b74e9f20e3e0b1d5d
+ checksum: 7a9534847ea70e78cf09227a4302af7e491f625fd092351a1b1ee27a2de0a369ac4acf069682e8a8ec0a55847b3e83f0be76b2028aa90e98e69e21420b9794c3
languageName: node
linkType: hard
@@ -10401,7 +10390,7 @@ __metadata:
languageName: node
linkType: hard
-"semver@npm:^7.3.2, semver@npm:^7.3.5, semver@npm:^7.3.7, semver@npm:^7.3.8, semver@npm:^7.5.4":
+"semver@npm:^7.3.2, semver@npm:^7.3.5, semver@npm:^7.3.7, semver@npm:^7.5.4":
version: 7.5.4
resolution: "semver@npm:7.5.4"
dependencies:
@@ -10434,11 +10423,11 @@ __metadata:
linkType: hard
"serialize-javascript@npm:^6.0.0, serialize-javascript@npm:^6.0.1":
- version: 6.0.1
- resolution: "serialize-javascript@npm:6.0.1"
+ version: 6.0.2
+ resolution: "serialize-javascript@npm:6.0.2"
dependencies:
randombytes: "npm:^2.1.0"
- checksum: 1af427f4fee3fee051f54ffe15f77068cff78a3c96d20f5c1178d20630d3ab122d8350e639d5e13cde8111ef9db9439b871305ffb185e24be0a2149cec230988
+ checksum: 2dd09ef4b65a1289ba24a788b1423a035581bef60817bea1f01eda8e3bda623f86357665fe7ac1b50f6d4f583f97db9615b3f07b2a2e8cbcb75033965f771dd2
languageName: node
linkType: hard
@@ -10486,14 +10475,15 @@ __metadata:
linkType: hard
"set-function-length@npm:^1.1.1":
- version: 1.1.1
- resolution: "set-function-length@npm:1.1.1"
+ version: 1.2.0
+ resolution: "set-function-length@npm:1.2.0"
dependencies:
define-data-property: "npm:^1.1.1"
- get-intrinsic: "npm:^1.2.1"
+ function-bind: "npm:^1.1.2"
+ get-intrinsic: "npm:^1.2.2"
gopd: "npm:^1.0.1"
- has-property-descriptors: "npm:^1.0.0"
- checksum: a29e255c116c29e3323b851c4f46c58c91be9bb8b065f191e2ea1807cb2c839df56e3175732a498e0c6d54626ba6b6fef896bf699feb7ab70c42dc47eb247c95
+ has-property-descriptors: "npm:^1.0.1"
+ checksum: b4fdf68bbfa9944284a9469c04e0d9cdb7924942fab75cd11fb61e8a7518f0d40bbbbc1b46871f648a93b97d170d8047fe3492cdadff066a8a8ae4ce68d0564a
languageName: node
linkType: hard
@@ -11072,8 +11062,8 @@ __metadata:
linkType: hard
"terser@npm:^5.10.0, terser@npm:^5.15.1, terser@npm:^5.26.0":
- version: 5.26.0
- resolution: "terser@npm:5.26.0"
+ version: 5.27.0
+ resolution: "terser@npm:5.27.0"
dependencies:
"@jridgewell/source-map": "npm:^0.3.3"
acorn: "npm:^8.8.2"
@@ -11081,7 +11071,7 @@ __metadata:
source-map-support: "npm:~0.5.20"
bin:
terser: bin/terser
- checksum: 3906289c6bacd75804a47a583cdafefbd76c5edb39435369755c7b1592e57586fb2f4bddf6eb37a807d6e782171dbf0aa7bbdc80fd5b77b2f2b62196cac49b62
+ checksum: bed0d39d9a7f2b82c87173e48081c46426a8820ba1dcb864bbfccd2df2b7fb8498a7ea4c8ef045ccce5713b23a6b4c3a784967f1b9f3115adaa7f51712f6e6ae
languageName: node
linkType: hard
@@ -11228,8 +11218,8 @@ __metadata:
linkType: hard
"typedoc@npm:^0.25.5":
- version: 0.25.5
- resolution: "typedoc@npm:0.25.5"
+ version: 0.25.7
+ resolution: "typedoc@npm:0.25.7"
dependencies:
lunr: "npm:^2.3.9"
marked: "npm:^4.3.0"
@@ -11239,7 +11229,7 @@ __metadata:
typescript: 4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x
bin:
typedoc: bin/typedoc
- checksum: d4f8de49183f86b3a26e598d008625575d1df5eaa9e997f89e90e65abc9ce7363855cac59e5847faa50247f85a0b8d56012481964a8e56f90685b763b51147b0
+ checksum: e663be0534dd56f45f041a478ee0613a1bf96cad7208a5cfc771981c904d0f30d8dca51956486f125f8004237264acc5dd45920fa6a0a32e351e36d74279abb1
languageName: node
linkType: hard
@@ -11556,9 +11546,9 @@ __metadata:
linkType: hard
"utility-types@npm:^3.10.0":
- version: 3.10.0
- resolution: "utility-types@npm:3.10.0"
- checksum: 79a6f7ea0cdd4fcafcec8c6e68e1e0cfa657e414b6f1696552d89ae70a3634b12ac6c16b7a0a3bfdb0a222ebc3d9a7649f2de434a78f2d65d318b50f314a85e4
+ version: 3.11.0
+ resolution: "utility-types@npm:3.11.0"
+ checksum: 2f1580137b0c3e6cf5405f37aaa8f5249961a76d26f1ca8efc0ff49a2fc0e0b2db56de8e521a174d075758e0c7eb3e590edec0832eb44478b958f09914920f19
languageName: node
linkType: hard
diff --git a/packages/interfaces/README.md b/packages/interfaces/README.md
index e9f965d95b..31b830a3ad 100644
--- a/packages/interfaces/README.md
+++ b/packages/interfaces/README.md
@@ -1,10 +1,6 @@
-# About
-
-Build.5 - Your Enterprise ready web3 plug & play platform
-
# Overview
-Build.5 interfaces for all models.
+Complete reference documentation for @build-5/sdk and @build-5/interfaces.
# 🤝 Contributing
diff --git a/packages/interfaces/doc.ts b/packages/interfaces/doc.ts
new file mode 100644
index 0000000000..cba1843545
--- /dev/null
+++ b/packages/interfaces/doc.ts
@@ -0,0 +1 @@
+export * from './src/index';
diff --git a/packages/interfaces/src/models/base.ts b/packages/interfaces/src/models/base.ts
index c1e4b63890..d1a8faeeef 100644
--- a/packages/interfaces/src/models/base.ts
+++ b/packages/interfaces/src/models/base.ts
@@ -32,19 +32,43 @@ export class Timestamp {
};
}
+/**
+ * Build 5 Request
+ */
export interface Build5Request {
+ /**
+ * Network Address.
+ */
address: NetworkAddress;
+ /**
+ * Signature
+ */
signature?: string;
+ /**
+ * Project API Key
+ */
projectApiKey?: string;
+ /**
+ * Custom token
+ */
customToken?: string;
+ /**
+ * Public key
+ */
publicKey?: {
hex: string;
network: Network;
};
+ /**
+ * Legacy public key, pre stardust signatures.
+ */
legacyPublicKey?: {
hex: string;
network: Network;
};
+ /**
+ * Payload for the request.
+ */
body: T;
}
@@ -183,27 +207,73 @@ export interface ValidatedAddress {
* NFT Minted Metadata.
*/
export interface NftMintingData {
+ /**
+ * Address of the asset.
+ */
readonly address?: string;
+ /**
+ * Network its minted on.
+ */
readonly network?: Network;
-
+ /**
+ * Date minted on.
+ */
readonly mintedOn?: Timestamp;
+ /**
+ * User it's minted by.
+ */
readonly mintedBy?: string;
-
+ /**
+ * Block id on the chain
+ */
readonly blockId?: string;
+ /**
+ * NFT ID on the chain.
+ */
readonly nftId?: string;
+ /**
+ * Storage deposit requirement.
+ */
readonly storageDeposit?: number;
-
+ /**
+ * Alias Block Id on chain.
+ */
readonly aliasBlockId?: string;
+ /**
+ * Alias Id on chain.
+ */
readonly aliasId?: string;
+ /**
+ * Alias storage deposit requirement.
+ */
readonly aliasStorageDeposit?: number;
-
+ /**
+ * Minting order id to initiate this mint.
+ */
readonly mintingOrderId?: string;
-
+ /**
+ * Total number of NFTs to be minted.
+ */
readonly nftsToMint?: number;
+ /**
+ * Total number of NFTs to be uploaded to file storage.
+ */
readonly nftMediaToUpload?: number;
+ /**
+ * Total number of NFTs to be prepared for the file upload.
+ */
readonly nftMediaToPrepare?: number;
+ /**
+ * Unsold options. What happens to unsold NFTs after mint.
+ */
readonly unsoldMintingOptions?: UnsoldMintingOptions;
+ /**
+ * New price for NFT after it's minted.
+ */
readonly newPrice?: number;
+ /**
+ * NFT Storage deposit requirement.
+ */
readonly nftsStorageDeposit?: number;
}
diff --git a/packages/interfaces/src/models/ticker.ts b/packages/interfaces/src/models/ticker.ts
index 3208528629..c887e5c4d3 100644
--- a/packages/interfaces/src/models/ticker.ts
+++ b/packages/interfaces/src/models/ticker.ts
@@ -4,8 +4,8 @@ import { BaseRecord } from './base';
* Available tickers.
*/
export enum TICKERS {
- SMRUSD = 'SMRUSD',
- IOTAUSD = 'IOTAUSD',
+ SMRUSD = 'smrusd',
+ IOTAUSD = 'iotausd',
}
/**
diff --git a/packages/sdk/README.md b/packages/sdk/README.md
index 5cd285a0c1..48f1ddccac 100644
--- a/packages/sdk/README.md
+++ b/packages/sdk/README.md
@@ -1,9 +1,9 @@
Super easy to use framework to interact with Web3
+ alt="NPM Version" />
+ src="https://img.shields.io/badge/license-APACHE2-brightgreen.svg?style=flat-square" alt="License" />
> @build-5/sdk is a complete framework to interact with Build5 platform and various DLTs like IOTA and Shimmer.
diff --git a/packages/sdk/doc.ts b/packages/sdk/doc.ts
new file mode 100644
index 0000000000..9a69172924
--- /dev/null
+++ b/packages/sdk/doc.ts
@@ -0,0 +1,67 @@
+/**
+ * Manually prepare TS file for docusaurus to export documentation.
+ *
+ * I'm not sure how better to do it atm.
+ */
+// Interfaces.
+export * from '../interfaces/doc';
+
+// HTTPS functions.
+export * from './src/https/https';
+
+// Datasets
+export * from './src/https/datasets/AuctionDataset';
+export * from './src/https/datasets/BadgesDataset';
+export * from './src/https/datasets/Dataset';
+export * from './src/https/datasets/MemberDataset';
+export * from './src/https/datasets/NftDataset';
+export * from './src/https/datasets/NotificationDataset';
+export * from './src/https/datasets/ProjectDataset';
+export * from './src/https/datasets/StakeDataset';
+export * from './src/https/datasets/StakeRewardDataset';
+export * from './src/https/datasets/StampDataset';
+export * from './src/https/datasets/Subset';
+export * from './src/https/datasets/TickerDataset';
+export * from './src/https/datasets/TransactionDataset';
+export * from './src/https/datasets/collection/CollectionDataset';
+export * from './src/https/datasets/common';
+export * from './src/https/datasets/milestone/MilestoneDataset';
+export * from './src/https/datasets/proposal/ProposalDataset';
+export * from './src/https/datasets/space/SpaceDataset';
+export * from './src/https/datasets/token/TokenDataset';
+
+// Subsets
+export * from './src/https/datasets/award/AwardDataset';
+export * from './src/https/datasets/award/AwardOwnerSubset';
+export * from './src/https/datasets/award/AwardParticipantSubset';
+export * from './src/https/datasets/collection/CollectionStatsSubset';
+export * from './src/https/datasets/milestone/MilestoneTransactionSubset';
+export * from './src/https/datasets/proposal/ProposalMemberSubset';
+export * from './src/https/datasets/proposal/ProposalOwnerSubset';
+export * from './src/https/datasets/space/SpaceBlockedMemberSubset';
+export * from './src/https/datasets/space/SpaceGuardianSubset';
+export * from './src/https/datasets/space/SpaceKnockingMemberSubset';
+export * from './src/https/datasets/space/SpaceMemberSubset';
+export * from './src/https/datasets/token/AirdropDataset';
+export * from './src/https/datasets/token/TokenDistributionSubset';
+export * from './src/https/datasets/token/TokenMarketDataset';
+export * from './src/https/datasets/token/TokenPurchaseDataset';
+export * from './src/https/datasets/token/TokenStatsSubset';
+
+// Support functions
+export * from './src/https/fetch.utils';
+export * from './src/https/tag.tracker';
+
+// OTR Functions
+export * from './src/otr/otr';
+
+// Datasets
+export * from './src/otr/datasets/AuctionOtrDataset';
+export * from './src/otr/datasets/AwardOtrDataset';
+export * from './src/otr/datasets/MemberOtrDataset';
+export * from './src/otr/datasets/NftOtrDataset';
+export * from './src/otr/datasets/ProposalOtrDataset';
+export * from './src/otr/datasets/SpaceOtrDataset';
+export * from './src/otr/datasets/StampOtrDataset';
+export * from './src/otr/datasets/TokenOtrDataset';
+export * as DatasetClassOtr from './src/otr/datasets/common';
diff --git a/packages/sdk/examples/nft/transfer.ts/nft.transfer.ts b/packages/sdk/examples/nft/https/transfer.ts
similarity index 93%
rename from packages/sdk/examples/nft/transfer.ts/nft.transfer.ts
rename to packages/sdk/examples/nft/https/transfer.ts
index 8ebebfd718..d751c97fa4 100644
--- a/packages/sdk/examples/nft/transfer.ts/nft.transfer.ts
+++ b/packages/sdk/examples/nft/https/transfer.ts
@@ -16,7 +16,7 @@ async function main() {
try {
const signature = await walletSign(member.uid, address);
- const respose = await https(origin)
+ const response = await https(origin)
.project(SoonaverseApiKey[origin])
.dataset(Dataset.NFT)
.transfer({
@@ -34,7 +34,7 @@ async function main() {
},
});
- console.log(respose);
+ console.log(response);
} catch (e) {
console.log(e);
return;
diff --git a/packages/sdk/examples/nft/otr/bulk_purchase.ts b/packages/sdk/examples/nft/otr/bulk_purchase.ts
index 543cd8b458..20b3ba401f 100644
--- a/packages/sdk/examples/nft/otr/bulk_purchase.ts
+++ b/packages/sdk/examples/nft/otr/bulk_purchase.ts
@@ -5,6 +5,7 @@ const collectionId = 'build5nftcollectionid';
const nftIds = ['build5nftid1', 'build5nftid2'];
const origin = Build5.TEST;
+// @ts-ignore
const otrAddress = Build5OtrAddress[origin];
async function main() {
diff --git a/packages/sdk/examples/nft/metadata/nft.metadata.ts b/packages/sdk/examples/nft/otr/metadata.ts
similarity index 100%
rename from packages/sdk/examples/nft/metadata/nft.metadata.ts
rename to packages/sdk/examples/nft/otr/metadata.ts
diff --git a/packages/sdk/examples/nft/transfer.ts/nft.otr.transfer.ts b/packages/sdk/examples/nft/otr/transfer.ts
similarity index 71%
rename from packages/sdk/examples/nft/transfer.ts/nft.otr.transfer.ts
rename to packages/sdk/examples/nft/otr/transfer.ts
index cdf8d41aee..b655ab34aa 100644
--- a/packages/sdk/examples/nft/transfer.ts/nft.otr.transfer.ts
+++ b/packages/sdk/examples/nft/otr/transfer.ts
@@ -2,20 +2,21 @@ import { Dataset } from '@build-5/interfaces';
import { Build5, Build5OtrAddress, otr } from '@build-5/sdk';
const origin = Build5.TEST;
+// @ts-ignore
const otrAddress = Build5OtrAddress[origin];
async function main() {
- const fireflyDeepling = otr(otrAddress)
+ const otrRequest = otr(otrAddress)
.dataset(Dataset.NFT)
.transfer({
transfers: [
{ nft: 'build5nftid', target: 'build5memberid' },
{ nft: 'build5nftid', target: 'tangleaddress' },
],
- })
- .getFireflyDeepLink();
+ });
+ const fireflyDeeplink = otrRequest.getFireflyDeepLink();
- console.log('Sent amount with ', fireflyDeepling);
+ console.log('Sent amount with ', fireflyDeeplink);
}
main().then(() => process.exit());
diff --git a/packages/sdk/examples/create_stamp.ts b/packages/sdk/examples/stamp/https/create.ts
similarity index 91%
rename from packages/sdk/examples/create_stamp.ts
rename to packages/sdk/examples/stamp/https/create.ts
index 5548aa9c08..7518a9eaf0 100644
--- a/packages/sdk/examples/create_stamp.ts
+++ b/packages/sdk/examples/stamp/https/create.ts
@@ -1,7 +1,7 @@
import { Dataset, Network, Transaction } from '@build-5/interfaces';
import { Build5, SoonaverseApiKey, https } from '@build-5/sdk';
-import { address } from './utils/secret';
-import { walletSign } from './utils/utils';
+import { address } from '../../utils/secret';
+import { walletSign } from '../../utils/utils';
async function main() {
const origin = Build5.TEST;
diff --git a/packages/sdk/examples/stamp/otr/create.ts b/packages/sdk/examples/stamp/otr/create.ts
new file mode 100644
index 0000000000..7807f7b0f2
--- /dev/null
+++ b/packages/sdk/examples/stamp/otr/create.ts
@@ -0,0 +1,22 @@
+import { Dataset } from '@build-5/interfaces';
+import { Build5, Build5OtrAddress, otr } from '@build-5/sdk';
+
+async function main() {
+ const origin = Build5.TEST;
+ // @ts-ignore
+ const otrAddress = Build5OtrAddress[origin];
+
+ console.log('Create stamp under your project...');
+ try {
+ const otrRequest = await otr(otrAddress)
+ .dataset(Dataset.STAMP)
+ .stamp({ uri: 'https://www.africau.edu/images/default/sample.pdf' });
+
+ const fireflyDeeplink = otrRequest.getFireflyDeepLink();
+ console.log(fireflyDeeplink);
+ } catch (error) {
+ console.error('Error: ', error);
+ }
+}
+
+main().then(() => process.exit());
diff --git a/packages/sdk/src/https/datasets/AuctionDataset.ts b/packages/sdk/src/https/datasets/AuctionDataset.ts
index 9b13a1f99e..2f4d6236e2 100644
--- a/packages/sdk/src/https/datasets/AuctionDataset.ts
+++ b/packages/sdk/src/https/datasets/AuctionDataset.ts
@@ -2,14 +2,32 @@ import {
Auction,
AuctionBidRequest,
AuctionCreateRequest,
+ Build5Request,
Dataset,
Transaction,
WEN_FUNC,
} from '@build-5/interfaces';
import { DatasetClass } from './Dataset';
+/**
+ * Auction dataset to read and trigger POST actions against the API
+ */
export class AuctionDataset extends DatasetClass {
- create = this.sendRequest(WEN_FUNC.createauction);
+ /**
+ * Create generic Auction.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link AuctionCreateRequest}
+ * @returns
+ */
+ create = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.createauction)(req);
- bid = this.sendRequest(WEN_FUNC.bidAuction);
+ /**
+ * Bid on auction.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link AuctionBidRequest}
+ * @returns
+ */
+ bid = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.bidAuction)(req);
}
diff --git a/packages/sdk/src/https/datasets/BadgesDataset.ts b/packages/sdk/src/https/datasets/BadgesDataset.ts
index cdf9ad6822..be2642657a 100644
--- a/packages/sdk/src/https/datasets/BadgesDataset.ts
+++ b/packages/sdk/src/https/datasets/BadgesDataset.ts
@@ -1,4 +1,7 @@
import { Badge, Dataset } from '@build-5/interfaces';
import { DatasetClass } from './Dataset';
+/**
+ * Badges dataset.
+ */
export class BadgesDataset extends DatasetClass {}
diff --git a/packages/sdk/src/https/datasets/Dataset.ts b/packages/sdk/src/https/datasets/Dataset.ts
index 86595c43ab..8c11d8783f 100644
--- a/packages/sdk/src/https/datasets/Dataset.ts
+++ b/packages/sdk/src/https/datasets/Dataset.ts
@@ -57,19 +57,41 @@ abstract class BaseDataSetClass extends BaseSet {
};
}
+/**
+ * Dataset base class.
+ */
export abstract class DatasetClass extends BaseDataSetClass {
+ /**
+ * Get many records by id.
+ *
+ * @param setIds
+ * @returns
+ */
getManyById = (setIds: string[]) =>
wrappedFetch(this.apiKey, this.origin + ApiRoutes.GET_MANY_BY_ID, {
dataset: this.dataset,
setIds,
});
-
+ /**
+ * Get many records by id. Real time stream.
+ *
+ * @param setIds
+ * @returns
+ */
getManyByIdLive = (setIds: string[]): Observable => {
const params = { dataset: this.dataset, setIds };
const url = this.origin + ApiRoutes.GET_MANY_BY_ID + toQueryParams({ ...params });
return fetchLive(this.apiKey, url);
};
+ /**
+ * Get records by field.
+ *
+ * @param fieldName
+ * @param fieldValue
+ * @param startAfter
+ * @returns
+ */
getByField = async (
fieldName: string | string[],
fieldValue: string | number | boolean | (string | number | boolean)[],
@@ -79,6 +101,13 @@ export abstract class DatasetClass extends BaseDataSetClas
return await wrappedFetch(this.apiKey, this.origin + ApiRoutes.GET_MANY, params);
};
+ /**
+ * Get records by field. Real time stream.
+ * @param fieldName
+ * @param fieldValue
+ * @param startAfter
+ * @returns
+ */
getByFieldLive = (
fieldName: string | string[],
fieldValue: string | number | boolean | (string | number | boolean)[],
@@ -89,6 +118,13 @@ export abstract class DatasetClass extends BaseDataSetClas
return fetchLive(this.apiKey, url);
};
+ /**
+ * Get records by space.
+ *
+ * @param space
+ * @param startAfter
+ * @returns
+ */
getBySpace = async (space: string, startAfter?: string) => {
const params: GetManyRequest = {
dataset: this.dataset,
@@ -100,6 +136,12 @@ export abstract class DatasetClass extends BaseDataSetClas
return await wrappedFetch(this.apiKey, url, { ...params });
};
+ /**
+ * Get records by space. Real time stream.
+ * @param space
+ * @param startAfter
+ * @returns
+ */
getBySpaceLive = (space: string, startAfter?: string) => {
const params: GetManyAdvancedRequest = {
dataset: this.dataset,
@@ -113,12 +155,25 @@ export abstract class DatasetClass extends BaseDataSetClas
return this.getManyAdvancedLive(params);
};
+ /**
+ * Get all records updated after unix timestamp.
+ *
+ * @param updatedAfter
+ * @param startAfter
+ * @returns
+ */
getAllUpdatedAfter = async (updatedAfter: number, startAfter?: string) => {
const params: GetUpdatedAfterRequest = { dataset: this.dataset, updatedAfter, startAfter };
const url = this.origin + ApiRoutes.GET_UPDATED_AFTER;
return await wrappedFetch(this.apiKey, url, { ...params });
};
-
+ /**
+ * Get all records updated after unix timestamp. Real time stream.
+ *
+ * @param updatedAfter
+ * @param startAfter
+ * @returns
+ */
getAllUpdatedAfterLive = (updatedAfter: number, startAfter?: string): Observable => {
const params: GetUpdatedAfterRequest = { dataset: this.dataset, updatedAfter, startAfter };
const url = this.origin + ApiRoutes.GET_UPDATED_AFTER + toQueryParams({ ...params });
diff --git a/packages/sdk/src/https/datasets/MemberDataset.ts b/packages/sdk/src/https/datasets/MemberDataset.ts
index c02eec9621..1620f104d8 100644
--- a/packages/sdk/src/https/datasets/MemberDataset.ts
+++ b/packages/sdk/src/https/datasets/MemberDataset.ts
@@ -1,5 +1,6 @@
import {
AddressValidationRequest,
+ Build5Request,
CustomTokenRequest,
Dataset,
Member,
@@ -9,13 +10,32 @@ import {
} from '@build-5/interfaces';
import { DatasetClass } from './Dataset';
+/**
+ * Member dataset
+ */
export class MemberDataset extends DatasetClass {
- update = this.sendRequest(WEN_FUNC.updateMember);
-
- generateCustomToken = this.sendRequest(WEN_FUNC.generateCustomToken);
-
- validateAddress = this.sendRequest(WEN_FUNC.validateAddress)<
- AddressValidationRequest,
- Transaction
- >;
+ /**
+ * Update member details.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link MemberUpdateRequest}
+ * @returns
+ */
+ update = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.updateMember)(req);
+ /**
+ * Generate AUTH token.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link CustomTokenRequest}
+ * @returns
+ */
+ generateCustomToken = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.generateCustomToken)(req);
+ /**
+ * Validate member address.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link AddressValidationRequest}
+ * @returns
+ */
+ validateAddress = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.validateAddress)(req);
}
diff --git a/packages/sdk/src/https/datasets/NftDataset.ts b/packages/sdk/src/https/datasets/NftDataset.ts
index 5f153e5888..b2daf3e62d 100644
--- a/packages/sdk/src/https/datasets/NftDataset.ts
+++ b/packages/sdk/src/https/datasets/NftDataset.ts
@@ -1,4 +1,5 @@
import {
+ Build5Request,
Dataset,
GetManyAdvancedRequest,
Nft,
@@ -17,27 +18,99 @@ import {
} from '@build-5/interfaces';
import { DatasetClass } from './Dataset';
+/**
+ * NFT Dataset.
+ */
export class NftDataset extends DatasetClass {
- create = this.sendRequest(WEN_FUNC.createNft);
-
- createBatch = this.sendRequest(WEN_FUNC.createBatchNft);
-
- setForSale = this.sendRequest(WEN_FUNC.setForSaleNft);
-
- withdraw = this.sendRequest(WEN_FUNC.withdrawNft);
-
- deposit = this.sendRequest(WEN_FUNC.depositNft);
-
- updateUnsold = this.sendRequest(WEN_FUNC.updateUnsoldNft);
-
- order = this.sendRequest(WEN_FUNC.orderNft);
-
- openBid = this.sendRequest(WEN_FUNC.openBid);
-
- bulkPurchase = this.sendRequest(WEN_FUNC.orderNftBulk);
-
+ /**
+ * Create NFT
+ *
+ * @param req Use {@link Build5Request} with data based on {@link NftCreateRequest}
+ * @returns
+ */
+ create = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.createNft)(req);
+ /**
+ * Create batch NFT
+ *
+ * @param req Use {@link Build5Request} with data based on {@link NftCreateRequest}
+ * @returns
+ */
+ createBatch = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.createBatchNft)(req);
+ /**
+ * Set NFT for sale
+ *
+ * @param req Use {@link Build5Request} with data based on {@link NftSetForSaleRequest}
+ * @returns
+ */
+ setForSale = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.setForSaleNft)(req);
+ /**
+ * Withdraw NFT
+ *
+ * @param req Use {@link Build5Request} with data based on {@link NftWithdrawRequest}
+ * @returns
+ */
+ withdraw = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.withdrawNft)(req);
+ /**
+ * Deposit NFT
+ *
+ * @param req Use {@link Build5Request} with data based on {@link ProjectDeactivateRequest}
+ * @returns
+ */
+ deposit = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.depositNft)(req);
+ /**
+ * Update unsold NFT.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link NftUpdateUnsoldRequest}
+ * @returns
+ */
+ updateUnsold = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.updateUnsoldNft)(req);
+ /**
+ * Buy NFT.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link NftPurchaseRequest}
+ * @returns
+ */
+ order = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.orderNft)(req);
+ /**
+ * Bin on NFT.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link NftBidRequest}
+ * @returns
+ */
+ openBid = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.openBid)(req);
+ /**
+ * Bulk purchase of NFTs
+ *
+ * @param req Use {@link Build5Request} with data based on {@link NftPurchaseBulkRequest}
+ * @returns
+ */
+ bulkPurchase = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.orderNftBulk)(req);
+ /**
+ * Transfer NFT
+ *
+ * @param req Use {@link Build5Request} with data based on {@link NftTransferRequest}
+ * @returns
+ */
transfer = this.sendRequest(WEN_FUNC.nftTransfer);
+ /**
+ * Get all NFTs by collection. Real time stream.
+ *
+ * @param collection
+ * @param orderBy
+ * @param orderByDir
+ * @param startAfter
+ * @returns
+ */
getByCollectionLive = (
collection: string,
orderBy: string[],
@@ -56,6 +129,12 @@ export class NftDataset extends DatasetClass {
return this.getManyAdvancedLive(params);
};
+ /**
+ * Get all NFTs by owner. Real time stream.
+ * @param owner
+ * @param startAfter
+ * @returns
+ */
getByOwnerLive = (owner: string, startAfter?: string) => {
const params: GetManyAdvancedRequest = {
dataset: this.dataset,
diff --git a/packages/sdk/src/https/datasets/NftStakeDataset.ts b/packages/sdk/src/https/datasets/NftStakeDataset.ts
index 11b7fa8fe6..e0deee3981 100644
--- a/packages/sdk/src/https/datasets/NftStakeDataset.ts
+++ b/packages/sdk/src/https/datasets/NftStakeDataset.ts
@@ -1,6 +1,23 @@
-import { Dataset, NftStake, NftStakeRequest, Transaction, WEN_FUNC } from '@build-5/interfaces';
+import {
+ Build5Request,
+ Dataset,
+ NftStake,
+ NftStakeRequest,
+ Transaction,
+ WEN_FUNC,
+} from '@build-5/interfaces';
import { DatasetClass } from './Dataset';
+/**
+ * NFT Stake Dataset.
+ */
export class NftStakeDataset extends DatasetClass {
- stake = this.sendRequest(WEN_FUNC.stakeNft);
+ /**
+ * Stake NFT
+ *
+ * @param req Use {@link Build5Request} with data based on {@link NftStakeRequest}
+ * @returns
+ */
+ stake = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.stakeNft)(req);
}
diff --git a/packages/sdk/src/https/datasets/NotificationDataset.ts b/packages/sdk/src/https/datasets/NotificationDataset.ts
index e9e7545140..8b849e5a32 100644
--- a/packages/sdk/src/https/datasets/NotificationDataset.ts
+++ b/packages/sdk/src/https/datasets/NotificationDataset.ts
@@ -1,7 +1,17 @@
import { Dataset, GetManyAdvancedRequest, Notification, Opr } from '@build-5/interfaces';
import { DatasetClass } from './Dataset';
+/**
+ * Notification Dataset
+ */
export class NotificationDataset extends DatasetClass {
+ /**
+ * Get notification by member. Real time stream.
+ * @param member
+ * @param startAfter
+ * @param limit
+ * @returns
+ */
getByMemberLive = (member: string, startAfter?: string, limit?: number) => {
const params: GetManyAdvancedRequest = {
dataset: this.dataset,
diff --git a/packages/sdk/src/https/datasets/ProjectDataset.ts b/packages/sdk/src/https/datasets/ProjectDataset.ts
index 420ead9b17..934a5dc1ed 100644
--- a/packages/sdk/src/https/datasets/ProjectDataset.ts
+++ b/packages/sdk/src/https/datasets/ProjectDataset.ts
@@ -1,6 +1,22 @@
-import { Dataset, Project, ProjectDeactivateRequest, WEN_FUNC } from '@build-5/interfaces';
+import {
+ Build5Request,
+ Dataset,
+ Project,
+ ProjectDeactivateRequest,
+ WEN_FUNC,
+} from '@build-5/interfaces';
import { DatasetClass } from './Dataset';
+/**
+ * Project dataset.
+ */
export class ProjectDataset extends DatasetClass {
- deactivate = this.sendRequest(WEN_FUNC.deactivateProject);
+ /**
+ * Deactivate project.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link ProjectDeactivateRequest}
+ * @returns
+ */
+ deactivate = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.deactivateProject)(req);
}
diff --git a/packages/sdk/src/https/datasets/StakeDataset.ts b/packages/sdk/src/https/datasets/StakeDataset.ts
index 8a5f502a8e..2a6f1a7c9b 100644
--- a/packages/sdk/src/https/datasets/StakeDataset.ts
+++ b/packages/sdk/src/https/datasets/StakeDataset.ts
@@ -1,4 +1,5 @@
import {
+ Build5Request,
Dataset,
GetManyAdvancedRequest,
Opr,
@@ -9,9 +10,26 @@ import {
} from '@build-5/interfaces';
import { DatasetClass } from './Dataset';
+/**
+ * Token Stake Dataset.
+ */
export class StakeDataset extends DatasetClass {
- deposit = this.sendRequest(WEN_FUNC.depositStake);
+ /**
+ * Stake Token
+ *
+ * @param req Use {@link Build5Request} with data based on {@link TokenStakeRequest}
+ * @returns
+ */
+ deposit = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.depositStake)(req);
+ /**
+ * Get stakes by member. Real time stream.
+ * @param member
+ * @param startAfter
+ * @param limit
+ * @returns
+ */
getByMemberLive = (member: string, startAfter?: string, limit?: number) => {
const params: GetManyAdvancedRequest = {
dataset: this.dataset,
diff --git a/packages/sdk/src/https/datasets/StakeRewardDataset.ts b/packages/sdk/src/https/datasets/StakeRewardDataset.ts
index c313a54639..33122ccb93 100644
--- a/packages/sdk/src/https/datasets/StakeRewardDataset.ts
+++ b/packages/sdk/src/https/datasets/StakeRewardDataset.ts
@@ -1,4 +1,5 @@
import {
+ Build5Request,
Dataset,
GetManyAdvancedRequest,
Opr,
@@ -10,11 +11,34 @@ import {
} from '@build-5/interfaces';
import { DatasetClass } from './Dataset';
+/**
+ * Stake Reward dataset.
+ */
export class StakeRewardDataset extends DatasetClass {
- create = this.sendRequest(WEN_FUNC.stakeReward);
-
- remove = this.sendRequest(WEN_FUNC.removeStakeReward);
+ /**
+ * Create stake reward.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link TokenStakeRewardRequest}
+ * @returns
+ */
+ create = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.stakeReward)(req);
+ /**
+ * Remove stake reward.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link TokenStakeRewardsRemoveRequest}
+ * @returns
+ */
+ remove = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.removeStakeReward)(req);
+ /**
+ * TODO
+ *
+ * @param token
+ * @param startAfter
+ * @returns
+ */
getByTokenLive = (token: string, startAfter?: string) => {
const params: GetManyAdvancedRequest = {
dataset: this.dataset,
diff --git a/packages/sdk/src/https/datasets/StampDataset.ts b/packages/sdk/src/https/datasets/StampDataset.ts
index c6cea5fa6d..edc083b134 100644
--- a/packages/sdk/src/https/datasets/StampDataset.ts
+++ b/packages/sdk/src/https/datasets/StampDataset.ts
@@ -1,6 +1,23 @@
-import { Dataset, Stamp, StampRequest, Transaction, WEN_FUNC } from '@build-5/interfaces';
+import {
+ Build5Request,
+ Dataset,
+ Stamp,
+ StampRequest,
+ Transaction,
+ WEN_FUNC,
+} from '@build-5/interfaces';
import { DatasetClass } from './Dataset';
+/**
+ * Stamp Dataset
+ */
export class StampDataset extends DatasetClass {
- stamp = this.sendRequest(WEN_FUNC.stamp);
+ /**
+ * Stamping API.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link StampRequest}
+ * @returns
+ */
+ stamp = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.stamp)(req);
}
diff --git a/packages/sdk/src/https/datasets/TickerDataset.ts b/packages/sdk/src/https/datasets/TickerDataset.ts
index 9c46906ef8..b2e51ad5d0 100644
--- a/packages/sdk/src/https/datasets/TickerDataset.ts
+++ b/packages/sdk/src/https/datasets/TickerDataset.ts
@@ -1,4 +1,7 @@
import { Dataset, Ticker } from '@build-5/interfaces';
import { DatasetClass } from './Dataset';
+/**
+ * Price ticker Dataset
+ */
export class TickerDataset extends DatasetClass {}
diff --git a/packages/sdk/src/https/datasets/TransactionDataset.ts b/packages/sdk/src/https/datasets/TransactionDataset.ts
index 6c95d2ea08..a48badb8e3 100644
--- a/packages/sdk/src/https/datasets/TransactionDataset.ts
+++ b/packages/sdk/src/https/datasets/TransactionDataset.ts
@@ -1,5 +1,6 @@
import {
ApiRoutes,
+ Build5Request,
CreditUnrefundableRequest,
Dataset,
GetManyAdvancedRequest,
@@ -16,11 +17,22 @@ import { fetchLive } from '../get/observable';
import { DatasetClass } from './Dataset';
export class TransactionDataset extends DatasetClass {
- creditUnrefundable = this.sendRequest(WEN_FUNC.creditUnrefundable)<
- CreditUnrefundableRequest,
- Transaction
- >;
-
+ /**
+ * Credit blocked transactions back (ie. not gifted storage deposit)
+ *
+ * @param req Use {@link Build5Request} with data based on {@link CreditUnrefundableRequest}
+ * @returns
+ */
+ creditUnrefundable = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.creditUnrefundable)(req);
+ /**
+ * TODO
+ *
+ * @param member
+ * @param orderBy
+ * @param startAfter
+ * @returns
+ */
getBadgesForMemberLive = (member: string, orderBy = ['createdOn'], startAfter?: string) => {
const fieldName = ['member', 'type', 'payload.type'];
const params: GetManyAdvancedRequest = {
@@ -34,7 +46,15 @@ export class TransactionDataset extends DatasetClass extends DatasetClass {
const params: GetManyAdvancedRequest = {
dataset: this.dataset,
@@ -95,7 +121,15 @@ export class TransactionDataset extends DatasetClass {
const fieldName = ['member', 'payload.nft', 'type', 'type'];
const fieldValue: (string | number)[] = [
@@ -125,6 +159,14 @@ export class TransactionDataset extends DatasetClass {
const fieldName = ['payload.proposalId', 'type'];
const fieldValue = [proposal, TransactionType.VOTE];
@@ -145,7 +187,12 @@ export class TransactionDataset extends DatasetClass {
const params: GetManyRequest = {
dataset: this.dataset,
@@ -156,6 +203,12 @@ export class TransactionDataset extends DatasetClass(this.apiKey, url);
};
+ /**
+ * TODO
+ *
+ * @param sourceTransaction
+ * @returns
+ */
getBySourceTransactionLive = (sourceTransaction: string) => {
const params: GetManyAdvancedRequest = {
dataset: this.dataset,
diff --git a/packages/sdk/src/https/datasets/award/AwardDataset.ts b/packages/sdk/src/https/datasets/award/AwardDataset.ts
index e3ecadf5ac..b803cefcd7 100644
--- a/packages/sdk/src/https/datasets/award/AwardDataset.ts
+++ b/packages/sdk/src/https/datasets/award/AwardDataset.ts
@@ -9,6 +9,7 @@ import {
AwardParticipant,
AwardParticpateRequest,
AwardRejectRequest,
+ Build5Request,
Dataset,
GetManyAdvancedRequest,
Opr,
@@ -20,27 +21,76 @@ import { switchMap } from 'rxjs';
import { DatasetClass } from '../Dataset';
import { SubsetType } from '../common';
+/**
+ * Award HTTPS Dataset object
+ */
export class AwardDataset extends DatasetClass {
- create = this.sendRequest(WEN_FUNC.createAward);
-
- fund = this.sendRequest(WEN_FUNC.fundAward);
-
- rejec = this.sendRequest(WEN_FUNC.rejectAward);
-
- addOwner = this.sendRequest(WEN_FUNC.addOwnerAward);
-
- participate = this.sendRequest(WEN_FUNC.participateAward)<
- AwardParticpateRequest,
- AwardParticipant
- >;
-
- approveParticipant = this.sendRequest(WEN_FUNC.approveParticipantAward)<
- AwardApproveParticipantRequest,
- AwardApproveParticipantResponse
- >;
-
- cancel = this.sendRequest(WEN_FUNC.cancelAward);
-
+ /**
+ * Create Award
+ *
+ * @param req Use {@link Build5Request} with data based on {@link AwardCreateRequest}
+ * @returns
+ */
+ create = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.createAward)(req);
+ /**
+ * Fund award with native or base token.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link AwardFundRequest}
+ * @returns
+ */
+ fund = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.fundAward)(req);
+ /**
+ * Reject award
+ *
+ * @param req Use {@link Build5Request} with data based on {@link AwardRejectRequest}
+ * @returns
+ */
+ reject = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.rejectAward)(req);
+ /**
+ * Add owner of the award. This grants the ability to manage it.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link AwardAddOwnerRequest}
+ * @returns
+ */
+ addOwner = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.addOwnerAward)(req);
+ /**
+ * Participate in the award to receive badge and tokens.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link AwardParticpateRequest}
+ * @returns
+ */
+ participate = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.participateAward)(req);
+ /**
+ * Approve participants and distribute them with token and NFT
+ *
+ * @param req Use {@link Build5Request} with data based on {@link AwardApproveParticipantRequest}
+ * @returns
+ */
+ approveParticipant = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.approveParticipantAward)<
+ AwardApproveParticipantRequest,
+ AwardApproveParticipantResponse
+ >(req);
+ /**
+ * Cancel ongoing award and get refunded with remaining tokens.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link AwardCancelRequest}
+ * @returns
+ */
+ cancel = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.cancelAward)(req);
+ /**
+ * Helper GET function to get "active" awards per space. Returns observable with continues updates via Websocket.
+ *
+ * @param space
+ * @param startAfter
+ * @returns
+ */
getActiveLive = (space: string, startAfter?: string) => {
const params: GetManyAdvancedRequest = {
dataset: this.dataset,
@@ -52,6 +102,13 @@ export class AwardDataset extends DatasetClass {
return this.getManyAdvancedLive(params);
};
+ /**
+ * Helper GET function to get "completed" awards per space. Returns observable with continues updates via Websocket.
+ *
+ * @param space
+ * @param startAfter
+ * @returns
+ */
getCompletedLive = (space: string, startAfter?: string) => {
const params: GetManyAdvancedRequest = {
dataset: this.dataset,
@@ -62,7 +119,13 @@ export class AwardDataset extends DatasetClass {
};
return this.getManyAdvancedLive(params);
};
-
+ /**
+ * Helper GET function to get "draft" awards per space. Returns observable with continues updates via Websocket.
+ *
+ * @param space
+ * @param startAfter
+ * @returns
+ */
getDraftLive = (space: string, startAfter?: string) => {
const params: GetManyAdvancedRequest = {
dataset: this.dataset,
@@ -73,7 +136,13 @@ export class AwardDataset extends DatasetClass {
};
return this.getManyAdvancedLive(params);
};
-
+ /**
+ * Helper GET function to get "rejected" awards per space. Returns observable with continues updates via Websocket.
+ *
+ * @param space
+ * @param startAfter
+ * @returns
+ */
getRejectedLive = (space: string, startAfter?: string) => {
const params: GetManyAdvancedRequest = {
dataset: this.dataset,
@@ -85,6 +154,12 @@ export class AwardDataset extends DatasetClass {
return this.getManyAdvancedLive(params);
};
+ /**
+ * Helper GET function to get closest finishing awards. Returns observable with continues updates via Websocket.
+ *
+ * @param startAfter
+ * @returns
+ */
getLastActiveLive = (startAfter?: string) => {
const fieldName = ['endDate', 'completed', 'approved'];
const fieldValue = [new Date().toISOString(), false, true];
@@ -101,6 +176,12 @@ export class AwardDataset extends DatasetClass {
return this.getManyAdvancedLive(params);
};
+ /**
+ * Helper GET Award participants. Returns observable with continues updates via Websocket.
+ *
+ * @param startAfter
+ * @returns
+ */
getTopByMemberLive = (member: string, completed: boolean, startAfter?: string) => {
const members = (
this.subset(Subset.PARTICIPANTS) as SubsetType
diff --git a/packages/sdk/src/https/datasets/award/AwardOwnerSubset.ts b/packages/sdk/src/https/datasets/award/AwardOwnerSubset.ts
index 577c08ea03..cd74148050 100644
--- a/packages/sdk/src/https/datasets/award/AwardOwnerSubset.ts
+++ b/packages/sdk/src/https/datasets/award/AwardOwnerSubset.ts
@@ -1,4 +1,7 @@
import { AwardOwner } from '@build-5/interfaces';
import { SubsetClass } from '../Subset';
+/**
+ * Subset of Award's owners
+ */
export class AwardOwnerSubset extends SubsetClass {}
diff --git a/packages/sdk/src/https/datasets/award/AwardParticipantSubset.ts b/packages/sdk/src/https/datasets/award/AwardParticipantSubset.ts
index 0bf1cd9eeb..cb2390ebb5 100644
--- a/packages/sdk/src/https/datasets/award/AwardParticipantSubset.ts
+++ b/packages/sdk/src/https/datasets/award/AwardParticipantSubset.ts
@@ -1,7 +1,19 @@
import { AwardParticipant, GetManyAdvancedRequest, Opr } from '@build-5/interfaces';
import { SubsetClass } from '../Subset';
+/**
+ * Subset of Award's participatents
+ */
export class AwardParticpateSubset extends SubsetClass {
+ /**
+ * Get list of Award's participants. Live stream.
+ *
+ * @param award
+ * @param completed
+ * @param searchIds
+ * @param startAfter
+ * @returns
+ */
getParticipantsLive = (
award: string,
completed: boolean,
@@ -22,6 +34,14 @@ export class AwardParticpateSubset extends SubsetClass {
return this.getManyAdvancedLive(params);
};
+ /**
+ * Get Awards participants ordered by the most recent one.
+ *
+ * @param member
+ * @param completed
+ * @param startAfter
+ * @returns
+ */
getTopByMemberLive = (member: string, completed = true, startAfter?: string) => {
const params: GetManyAdvancedRequest = {
dataset: this.dataset,
diff --git a/packages/sdk/src/https/datasets/collection/CollectionDataset.ts b/packages/sdk/src/https/datasets/collection/CollectionDataset.ts
index 9cc062be8d..80f6ada3f8 100644
--- a/packages/sdk/src/https/datasets/collection/CollectionDataset.ts
+++ b/packages/sdk/src/https/datasets/collection/CollectionDataset.ts
@@ -1,4 +1,5 @@
import {
+ Build5Request,
Collection,
CollectionMintRequest,
CreateCollectionRequest,
@@ -16,21 +17,73 @@ import {
} from '@build-5/interfaces';
import { DatasetClass } from '../Dataset';
+/**
+ * NFT Collection Dataset
+ */
export class CollectionDataset extends DatasetClass {
- create = this.sendRequest(WEN_FUNC.createCollection);
-
- update = this.sendRequest(WEN_FUNC.updateCollection);
-
- updateMinted = this.sendRequest(WEN_FUNC.updateCollection);
-
- reject = this.sendRequest(WEN_FUNC.rejectCollection);
-
- mint = this.sendRequest(WEN_FUNC.mintCollection);
-
- vote = this.sendRequest(WEN_FUNC.voteController);
-
- rank = this.sendRequest(WEN_FUNC.rankController);
-
+ /**
+ * Create NFT Collection.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link CreateCollectionRequest}
+ * @returns
+ */
+ create = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.createCollection)(req);
+ /**
+ * Update NFT Collection.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link UpdateCollectionRequest}
+ * @returns
+ */
+ update = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.updateCollection)(req);
+ /**
+ * Update minted NFT Collection. Only certain fields are updated (typically those that are not immutable and stored on DLT)
+ *
+ * @param req Use {@link Build5Request} with data based on {@link UpdateCollectionRequest}
+ * @returns
+ */
+ updateMinted = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.updateCollection)(req);
+ /**
+ * Reject collection and hide it.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link RejectCollectionRequest}
+ * @returns
+ */
+ reject = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.rejectCollection)(req);
+ /**
+ * Mint collection on defined network.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link CollectionMintRequest}
+ * @returns
+ */
+ mint = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.mintCollection)(req);
+ /**
+ * Give collection a vote up or down.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link VoteRequest}
+ * @returns
+ */
+ vote = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.voteController)(req);
+ /**
+ * Rank collection. This typically is managed by Rank Moderators.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link RankRequest}
+ * @returns
+ */
+ rank = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.rankController)(req);
+ /**
+ * Get all pending collections per space. Real time stream.
+ *
+ * @param space
+ * @param startAfter
+ * @returns
+ */
getAllPendingLive = (space: string, startAfter?: string) => {
const params: GetManyAdvancedRequest = {
dataset: this.dataset,
@@ -43,7 +96,13 @@ export class CollectionDataset extends DatasetClass {
const params: GetManyAdvancedRequest = {
dataset: this.dataset,
@@ -56,7 +115,13 @@ export class CollectionDataset extends DatasetClass {
const params: GetManyAdvancedRequest = {
dataset: this.dataset,
diff --git a/packages/sdk/src/https/datasets/collection/CollectionStatsSubset.ts b/packages/sdk/src/https/datasets/collection/CollectionStatsSubset.ts
index fd5d59c7b2..ccec5f8c0f 100644
--- a/packages/sdk/src/https/datasets/collection/CollectionStatsSubset.ts
+++ b/packages/sdk/src/https/datasets/collection/CollectionStatsSubset.ts
@@ -1,4 +1,7 @@
import { CollectionStats } from '@build-5/interfaces';
import { SubsetClass } from '../Subset';
+/**
+ * Subset of Collection statistics.
+ */
export class CollectionStatsSubset extends SubsetClass {}
diff --git a/packages/sdk/src/https/datasets/milestone/MilestoneDataset.ts b/packages/sdk/src/https/datasets/milestone/MilestoneDataset.ts
index 2fb6546f28..fafbc6328f 100644
--- a/packages/sdk/src/https/datasets/milestone/MilestoneDataset.ts
+++ b/packages/sdk/src/https/datasets/milestone/MilestoneDataset.ts
@@ -1,4 +1,8 @@
import { Dataset, Milestone } from '@build-5/interfaces';
import { DatasetClass } from '../Dataset';
+/**
+ * Milestone Dataset
+ *
+ */
export class MilestoneDataset extends DatasetClass {}
diff --git a/packages/sdk/src/https/datasets/milestone/MilestoneTransactionSubset.ts b/packages/sdk/src/https/datasets/milestone/MilestoneTransactionSubset.ts
index 4be4f82fba..5302a3a215 100644
--- a/packages/sdk/src/https/datasets/milestone/MilestoneTransactionSubset.ts
+++ b/packages/sdk/src/https/datasets/milestone/MilestoneTransactionSubset.ts
@@ -1,4 +1,8 @@
import { MilestoneTransaction } from '@build-5/interfaces';
import { SubsetClass } from '../Subset';
+/**
+ * Milestone Transactions subset
+ *
+ */
export class MilestoneTransactionSubset extends SubsetClass {}
diff --git a/packages/sdk/src/https/datasets/proposal/ProposalDataset.ts b/packages/sdk/src/https/datasets/proposal/ProposalDataset.ts
index 2ffb106755..a3318a6a45 100644
--- a/packages/sdk/src/https/datasets/proposal/ProposalDataset.ts
+++ b/packages/sdk/src/https/datasets/proposal/ProposalDataset.ts
@@ -1,5 +1,6 @@
import {
ApproveProposalRequest,
+ Build5Request,
Dataset,
GetManyAdvancedRequest,
Opr,
@@ -12,15 +13,49 @@ import {
} from '@build-5/interfaces';
import { DatasetClass } from '../Dataset';
+/**
+ * Proposal Dataset
+ */
export class ProposalDataset extends DatasetClass {
- create = this.sendRequest(WEN_FUNC.createProposal);
-
- approve = this.sendRequest(WEN_FUNC.approveProposal);
-
- reject = this.sendRequest(WEN_FUNC.rejectProposal);
-
- vote = this.sendRequest(WEN_FUNC.voteOnProposal);
+ /**
+ * Method to create Proposal
+ *
+ * @param req Use {@link Build5Request} with data based on {@link ProposalCreateRequest}
+ * @returns
+ */
+ create = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.createProposal)(req);
+ /**
+ * Method to approve Proposal
+ *
+ * @param req Use {@link Build5Request} with data based on {@link ApproveProposalRequest}
+ * @returns
+ */
+ approve = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.approveProposal)(req);
+ /**
+ * Method to reject Proposal
+ *
+ * @param req Use {@link Build5Request} with data based on {@link RejectProposalRequest}
+ * @returns
+ */
+ reject = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.rejectProposal)(req);
+ /**
+ * Method to vote on Proposal
+ *
+ * @param req Use {@link Build5Request} with data based on {@link ProposalVoteRequest}
+ * @returns
+ */
+ vote = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.voteOnProposal)(req);
+ /**
+ * TODO
+ *
+ * @param startAfter
+ * @returns
+ */
getAllActiveLive = (startAfter?: string) => {
const params: GetManyAdvancedRequest = {
dataset: this.dataset,
@@ -33,7 +68,13 @@ export class ProposalDataset extends DatasetClass {
const params: GetManyAdvancedRequest = {
dataset: this.dataset,
@@ -46,7 +87,13 @@ export class ProposalDataset extends DatasetClass {
const params: GetManyAdvancedRequest = {
dataset: this.dataset,
@@ -59,7 +106,13 @@ export class ProposalDataset extends DatasetClass {
const params: GetManyAdvancedRequest = {
dataset: this.dataset,
@@ -72,7 +125,13 @@ export class ProposalDataset extends DatasetClass {
const params: GetManyAdvancedRequest = {
dataset: this.dataset,
diff --git a/packages/sdk/src/https/datasets/proposal/ProposalMemberSubset.ts b/packages/sdk/src/https/datasets/proposal/ProposalMemberSubset.ts
index c638135759..b787b0134c 100644
--- a/packages/sdk/src/https/datasets/proposal/ProposalMemberSubset.ts
+++ b/packages/sdk/src/https/datasets/proposal/ProposalMemberSubset.ts
@@ -1,7 +1,17 @@
import { GetManyAdvancedRequest, Opr, ProposalMember } from '@build-5/interfaces';
import { SubsetClass } from '../Subset';
+/**
+ * Proposal Member subset
+ */
export class ProposalMemberSubset extends SubsetClass {
+ /**
+ * TODO
+ *
+ * @param voted
+ * @param startAfter
+ * @returns
+ */
getVotingMembersLive = (voted: boolean, startAfter?: string) => {
const params: GetManyAdvancedRequest = {
dataset: this.dataset,
diff --git a/packages/sdk/src/https/datasets/proposal/ProposalOwnerSubset.ts b/packages/sdk/src/https/datasets/proposal/ProposalOwnerSubset.ts
index bd89a0d49f..cd8b94ba4b 100644
--- a/packages/sdk/src/https/datasets/proposal/ProposalOwnerSubset.ts
+++ b/packages/sdk/src/https/datasets/proposal/ProposalOwnerSubset.ts
@@ -1,4 +1,7 @@
import { ProposalMember } from '@build-5/interfaces';
import { SubsetClass } from '../Subset';
+/**
+ * Proposel Owner subset
+ */
export class ProposalOwnerSubset extends SubsetClass {}
diff --git a/packages/sdk/src/https/datasets/space/SpaceBlockedMemberSubset.ts b/packages/sdk/src/https/datasets/space/SpaceBlockedMemberSubset.ts
index b5ffb0515e..15f25dba83 100644
--- a/packages/sdk/src/https/datasets/space/SpaceBlockedMemberSubset.ts
+++ b/packages/sdk/src/https/datasets/space/SpaceBlockedMemberSubset.ts
@@ -1,4 +1,6 @@
import { SpaceMember } from '@build-5/interfaces';
import { SubsetClass } from '../Subset';
-
+/**
+ * Space Blocked Member subset
+ */
export class SpaceBlockedMemberSubset extends SubsetClass {}
diff --git a/packages/sdk/src/https/datasets/space/SpaceDataset.ts b/packages/sdk/src/https/datasets/space/SpaceDataset.ts
index e8fcd85851..b46c7a8629 100644
--- a/packages/sdk/src/https/datasets/space/SpaceDataset.ts
+++ b/packages/sdk/src/https/datasets/space/SpaceDataset.ts
@@ -1,5 +1,6 @@
import {
AddressValidationRequest,
+ Build5Request,
Dataset,
Proposal,
Space,
@@ -18,40 +19,116 @@ import { switchMap } from 'rxjs';
import { DatasetClass } from '../Dataset';
import { SubsetType } from '../common';
+/**
+ * Space Dataset
+ */
export class SpaceDataset extends DatasetClass {
- create = this.sendRequest(WEN_FUNC.createSpace);
-
- update = this.sendRequest(WEN_FUNC.updateSpace);
-
- join = this.sendRequest(WEN_FUNC.joinSpace);
-
- leave = this.sendRequest(WEN_FUNC.leaveSpace);
-
- blockMember = this.sendRequest(WEN_FUNC.blockMemberSpace);
-
- unblockMember = this.sendRequest(WEN_FUNC.unblockMemberSpace);
-
- acceptMember = this.sendRequest(WEN_FUNC.acceptMemberSpace)<
- SpaceMemberUpsertRequest,
- SpaceMember
- >;
-
- declineMember = this.sendRequest(WEN_FUNC.declineMemberSpace);
-
- addGuardian = this.sendRequest(WEN_FUNC.addGuardianSpace);
-
- removeGuardian = this.sendRequest(WEN_FUNC.removeGuardianSpace)<
- SpaceMemberUpsertRequest,
- Proposal
- >;
-
- claim = this.sendRequest(WEN_FUNC.claimSpace);
-
- validateAddress = this.sendRequest(WEN_FUNC.validateAddress)<
- AddressValidationRequest,
- Transaction
- >;
-
+ /**
+ * Create Space.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link SpaceCreateRequest}
+ * @returns
+ */
+ create = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.createSpace)(req);
+ /**
+ * Update Space.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link SpaceUpdateRequest}
+ * @returns
+ */
+ update = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.updateSpace)(req);
+ /**
+ * Join Space.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link SpaceJoinRequest}
+ * @returns
+ */
+ join = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.joinSpace)(req);
+ /**
+ * Leave Space.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link SpaceLeaveRequest}
+ * @returns
+ */
+ leave = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.leaveSpace)(req);
+ /**
+ * Block Member on Space.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link SpaceMemberUpsertRequest}
+ * @returns
+ */
+ blockMember = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.blockMemberSpace)(req);
+ /**
+ * Unblock Member on Space.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link SpaceMemberUpsertRequest}
+ * @returns
+ */
+ unblockMember = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.unblockMemberSpace)(req);
+ /**
+ * Accept Member on Space.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link SpaceMemberUpsertRequest}
+ * @returns
+ */
+ acceptMember = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.acceptMemberSpace)(req);
+ /**
+ * Decline member on Space.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link SpaceMemberUpsertRequest}
+ * @returns
+ */
+ declineMember = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.declineMemberSpace)(req);
+ /**
+ * Add Guardian on Space.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link SpaceMemberUpsertRequest}
+ * @returns
+ */
+ addGuardian = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.addGuardianSpace)(req);
+ /**
+ * Remove Guardian on Space.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link SpaceMemberUpsertRequest}
+ * @returns
+ */
+ removeGuardian = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.removeGuardianSpace)(req);
+ /**
+ * Claim Space.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link SpaceClaimRequest}
+ * @returns
+ */
+ claim = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.claimSpace)(req);
+ /**
+ * Validate address on Space.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link AddressValidationRequest}
+ * @returns
+ */
+ validateAddress = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.validateAddress)(req);
+ /**
+ * TODO
+ *
+ * @param member
+ * @param orderBy
+ * @param orderByDir
+ * @param startAfter
+ * @param limit
+ * @returns
+ */
getTopByMember = (
member: string,
orderBy = ['createdOn'],
@@ -67,7 +144,16 @@ export class SpaceDataset extends DatasetClass {
return (await Promise.all(promises)).map((s) => s!);
}),
);
-
+ /**
+ * TODO
+ *
+ * @param member
+ * @param orderBy
+ * @param orderByDir
+ * @param startAfter
+ * @param limit
+ * @returns
+ */
getPendingSpacesByMemberLive = (
member: string,
orderBy = ['createdOn'],
diff --git a/packages/sdk/src/https/datasets/space/SpaceGuardianSubset.ts b/packages/sdk/src/https/datasets/space/SpaceGuardianSubset.ts
index 9d4c2b2fd5..c9f333fab7 100644
--- a/packages/sdk/src/https/datasets/space/SpaceGuardianSubset.ts
+++ b/packages/sdk/src/https/datasets/space/SpaceGuardianSubset.ts
@@ -1,4 +1,7 @@
import { SpaceMember } from '@build-5/interfaces';
import { SubsetClass } from '../Subset';
+/**
+ * Space guardian subset
+ */
export class SpaceGuardianSubset extends SubsetClass {}
diff --git a/packages/sdk/src/https/datasets/space/SpaceKnockingMemberSubset.ts b/packages/sdk/src/https/datasets/space/SpaceKnockingMemberSubset.ts
index b70deaf196..b86064b935 100644
--- a/packages/sdk/src/https/datasets/space/SpaceKnockingMemberSubset.ts
+++ b/packages/sdk/src/https/datasets/space/SpaceKnockingMemberSubset.ts
@@ -1,4 +1,7 @@
import { SpaceMember } from '@build-5/interfaces';
import { SubsetClass } from '../Subset';
+/**
+ * Space knocking member subset
+ */
export class SpaceKnockingMemberSubset extends SubsetClass {}
diff --git a/packages/sdk/src/https/datasets/space/SpaceMemberSubset.ts b/packages/sdk/src/https/datasets/space/SpaceMemberSubset.ts
index 0d1efa9aee..ddc475a708 100644
--- a/packages/sdk/src/https/datasets/space/SpaceMemberSubset.ts
+++ b/packages/sdk/src/https/datasets/space/SpaceMemberSubset.ts
@@ -1,4 +1,7 @@
import { SpaceMember } from '@build-5/interfaces';
import { SubsetClass } from '../Subset';
+/**
+ * Space Member subset
+ */
export class SpaceMemberSubset extends SubsetClass {}
diff --git a/packages/sdk/src/https/datasets/token/AirdropDataset.ts b/packages/sdk/src/https/datasets/token/AirdropDataset.ts
index b3b3c8b7e0..8a02ba3f37 100644
--- a/packages/sdk/src/https/datasets/token/AirdropDataset.ts
+++ b/packages/sdk/src/https/datasets/token/AirdropDataset.ts
@@ -1,4 +1,5 @@
import {
+ Build5Request,
ClaimAirdroppedTokensRequest,
ClaimPreMintedAirdroppedTokensRequest,
CreateAirdropsRequest,
@@ -9,21 +10,45 @@ import {
} from '@build-5/interfaces';
import { DatasetClass } from '../Dataset';
+/**
+ * Airdrop dataset.
+ */
export class AirdropDataset extends DatasetClass {
- airdropToken = this.sendRequest(WEN_FUNC.airdropToken);
-
- airdropMintedToken = this.sendRequest(WEN_FUNC.airdropMintedToken)<
- CreateAirdropsRequest,
- Transaction
- >;
-
- claimMintedAirdrop = this.sendRequest(WEN_FUNC.claimMintedTokenOrder)<
- ClaimAirdroppedTokensRequest,
- Transaction
- >;
-
- claimAirdropped = this.sendRequest(WEN_FUNC.claimAirdroppedToken)<
- ClaimPreMintedAirdroppedTokensRequest,
- Transaction
- >;
+ /**
+ * Airdrop tokens.
+ *
+ * @param req Use {@link Build5Request} with data based on {@link CreateAirdropsRequest}
+ * @returns
+ */
+ airdropToken = (req: Build5Request) =>
+ this.sendRequest(WEN_FUNC.airdropToken) 
-