From 001e7d0a35965947452c72c4e7d7ef32c50fde52 Mon Sep 17 00:00:00 2001 From: bitbeckers Date: Tue, 11 Jun 2024 13:58:23 +0200 Subject: [PATCH] chore(gha): cleanup env vars --- .github/workflows/ci-default.yml | 4 +- .../contracts/marketplace/TransferManager.md | 8 + .../interfaces/IHypercert1155Token.md | 72 +++++++ .../developer/api/sdk/classes/ClientError.md | 4 +- .../api/sdk/classes/ConfigurationError.md | 4 +- .../api/sdk/classes/ContractError.md | 4 +- .../developer/api/sdk/classes/FetchError.md | 4 +- .../api/sdk/classes/HypercertClient.md | 83 +++++--- .../api/sdk/classes/HypercertsStorage.md | 8 +- .../api/sdk/classes/InvalidOrMissingError.md | 4 +- .../api/sdk/classes/MalformedDataError.md | 4 +- .../developer/api/sdk/classes/MintingError.md | 4 +- .../developer/api/sdk/classes/StorageError.md | 4 +- .../api/sdk/classes/UnknownSchemaError.md | 4 +- .../api/sdk/classes/UnsupportedChainError.md | 4 +- docs/docs/developer/api/sdk/index.md | 24 +-- .../api/sdk/interfaces/CustomError.md | 2 +- .../api/sdk/interfaces/DuplicateEvaluation.md | 8 +- .../api/sdk/interfaces/EASEvaluation.md | 8 +- .../api/sdk/interfaces/HypercertClaimdata.md | 12 +- .../interfaces/HypercertClientInterface.md | 59 ++++-- .../sdk/interfaces/HypercertClientMethods.md | 49 ++++- .../sdk/interfaces/HypercertClientState.md | 6 +- .../interfaces/HypercertEvaluationSchema.md | 6 +- .../interfaces/HypercertIndexerInterface.md | 30 ++- .../api/sdk/interfaces/HypercertMetadata.md | 18 +- .../api/sdk/interfaces/HypercertPointer.md | 6 +- .../interfaces/HypercertStorageInterface.md | 8 +- .../api/sdk/interfaces/IPFSEvaluation.md | 4 +- .../sdk/interfaces/SimpleTextEvaluation.md | 6 +- docs/docs/developer/api/sdk/modules.md | 197 +++++++++++------- 31 files changed, 441 insertions(+), 217 deletions(-) create mode 100644 docs/docs/developer/api/contracts/marketplace/interfaces/IHypercert1155Token.md diff --git a/.github/workflows/ci-default.yml b/.github/workflows/ci-default.yml index 93a0e242..d51e1f94 100644 --- a/.github/workflows/ci-default.yml +++ b/.github/workflows/ci-default.yml @@ -7,15 +7,13 @@ env: NEXT_PUBLIC_DEFAULT_CHAIN_ID: ${{ vars.NEXT_PUBLIC_DEFAULT_CHAIN_ID }} NEXT_PUBLIC_CONTRACT_ADDRESS: ${{ vars.NEXT_PUBLIC_CONTRACT_ADDRESS }} NEXT_PUBLIC_GRAPH_URL: ${{ vars.NEXT_PUBLIC_GRAPH_URL }} - NFT_STORAGE_TOKEN: ${{ secrets.NEXT_PUBLIC_NFT_STORAGE_TOKEN }} - WEB3_STORAGE_TOKEN: ${{ secrets.NEXT_PUBLIC_NFT_STORAGE_TOKEN }} NEXT_PUBLIC_NFT_STORAGE_TOKEN: ${{ secrets.NEXT_PUBLIC_NFT_STORAGE_TOKEN }} NEXT_PUBLIC_WEB3_STORAGE_TOKEN: ${{ secrets.NEXT_PUBLIC_NFT_STORAGE_TOKEN }} NEXT_PUBLIC_SUPABASE_URL: ${{ vars.NEXT_PUBLIC_SUPABASE_URL }} NEXT_PUBLIC_SUPABASE_ANON_KEY: ${{ secrets.NEXT_PUBLIC_SUPABASE_ANON_KEY }} NEXT_PUBLIC_SUPABASE_TABLE: ${{ vars.NEXT_PUBLIC_SUPABASE_TABLE }} NEXT_PUBLIC_WALLETCONNECT_ID: ${{ secrets.NEXT_PUBLIC_WALLETCONNECT_ID }} - INFURA_API_KEY: ${{ vars.INFURA_API_KEY }} + INFURA_API_KEY: ${{ secrets.INFURA_API_KEY }} ALCHEMY_API_KEY: ${{ secrets.ALCHEMY_API_KEY }} DOCKER_PLATFORM: "amd64" diff --git a/docs/docs/developer/api/contracts/marketplace/TransferManager.md b/docs/docs/developer/api/contracts/marketplace/TransferManager.md index f042e290..991b849c 100644 --- a/docs/docs/developer/api/contracts/marketplace/TransferManager.md +++ b/docs/docs/developer/api/contracts/marketplace/TransferManager.md @@ -512,6 +512,14 @@ error OperatorNotApprovedByUser() It is returned if the operator to revoke has not been previously approved by the user. +### OrderInvalid + +```solidity +error OrderInvalid() +``` + +It is returned if the order is permanently invalid. There may be an issue with the order formatting. + ### RenouncementNotInProgress ```solidity diff --git a/docs/docs/developer/api/contracts/marketplace/interfaces/IHypercert1155Token.md b/docs/docs/developer/api/contracts/marketplace/interfaces/IHypercert1155Token.md new file mode 100644 index 00000000..249c98d8 --- /dev/null +++ b/docs/docs/developer/api/contracts/marketplace/interfaces/IHypercert1155Token.md @@ -0,0 +1,72 @@ +# IHypercert1155Token + +## Methods + +### isApprovedForAll + +```solidity +function isApprovedForAll(address account, address operator) external view returns (bool) +``` + +#### Parameters + +| Name | Type | Description | +| -------- | ------- | ----------- | +| account | address | undefined | +| operator | address | undefined | + +#### Returns + +| Name | Type | Description | +| ---- | ---- | ----------- | +| \_0 | bool | undefined | + +### ownerOf + +```solidity +function ownerOf(uint256 tokenId) external view returns (address) +``` + +#### Parameters + +| Name | Type | Description | +| ------- | ------- | ----------- | +| tokenId | uint256 | undefined | + +#### Returns + +| Name | Type | Description | +| ---- | ------- | ----------- | +| \_0 | address | undefined | + +### splitFraction + +```solidity +function splitFraction(address to, uint256 tokenID, uint256[] _values) external nonpayable +``` + +#### Parameters + +| Name | Type | Description | +| -------- | --------- | ----------- | +| to | address | undefined | +| tokenID | uint256 | undefined | +| \_values | uint256[] | undefined | + +### unitsOf + +```solidity +function unitsOf(uint256 tokenId) external view returns (uint256) +``` + +#### Parameters + +| Name | Type | Description | +| ------- | ------- | ----------- | +| tokenId | uint256 | undefined | + +#### Returns + +| Name | Type | Description | +| ---- | ------- | ----------- | +| \_0 | uint256 | undefined | diff --git a/docs/docs/developer/api/sdk/classes/ClientError.md b/docs/docs/developer/api/sdk/classes/ClientError.md index 83664672..8958c83b 100644 --- a/docs/docs/developer/api/sdk/classes/ClientError.md +++ b/docs/docs/developer/api/sdk/classes/ClientError.md @@ -43,7 +43,7 @@ Error.constructor #### Defined in -[sdk/src/types/errors.ts:27](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/errors.ts#L27) +[sdk/src/types/errors.ts:27](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L27) ## Properties @@ -105,7 +105,7 @@ Additional error payload. #### Defined in -[sdk/src/types/errors.ts:20](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/errors.ts#L20) +[sdk/src/types/errors.ts:20](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L20) --- diff --git a/docs/docs/developer/api/sdk/classes/ConfigurationError.md b/docs/docs/developer/api/sdk/classes/ConfigurationError.md index 7d40d8b9..e29844e2 100644 --- a/docs/docs/developer/api/sdk/classes/ConfigurationError.md +++ b/docs/docs/developer/api/sdk/classes/ConfigurationError.md @@ -41,7 +41,7 @@ Error.constructor #### Defined in -[sdk/src/types/errors.ts:188](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/errors.ts#L188) +[sdk/src/types/errors.ts:188](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L188) ## Properties @@ -103,7 +103,7 @@ Additional error payload. #### Defined in -[sdk/src/types/errors.ts:187](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/errors.ts#L187) +[sdk/src/types/errors.ts:187](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L187) --- diff --git a/docs/docs/developer/api/sdk/classes/ContractError.md b/docs/docs/developer/api/sdk/classes/ContractError.md index a1a50a4c..5a2712c1 100644 --- a/docs/docs/developer/api/sdk/classes/ContractError.md +++ b/docs/docs/developer/api/sdk/classes/ContractError.md @@ -42,7 +42,7 @@ Error.constructor #### Defined in -[sdk/src/types/errors.ts:43](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/errors.ts#L43) +[sdk/src/types/errors.ts:43](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L43) ## Properties @@ -104,7 +104,7 @@ Additional error payload. #### Defined in -[sdk/src/types/errors.ts:41](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/errors.ts#L41) +[sdk/src/types/errors.ts:41](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L41) --- diff --git a/docs/docs/developer/api/sdk/classes/FetchError.md b/docs/docs/developer/api/sdk/classes/FetchError.md index 60154918..4a80b56b 100644 --- a/docs/docs/developer/api/sdk/classes/FetchError.md +++ b/docs/docs/developer/api/sdk/classes/FetchError.md @@ -43,7 +43,7 @@ Error.constructor #### Defined in -[sdk/src/types/errors.ts:65](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/errors.ts#L65) +[sdk/src/types/errors.ts:65](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L65) ## Properties @@ -105,7 +105,7 @@ Additional error payload. #### Defined in -[sdk/src/types/errors.ts:58](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/errors.ts#L58) +[sdk/src/types/errors.ts:58](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L58) --- diff --git a/docs/docs/developer/api/sdk/classes/HypercertClient.md b/docs/docs/developer/api/sdk/classes/HypercertClient.md index 5ac108d9..0e538e5b 100644 --- a/docs/docs/developer/api/sdk/classes/HypercertClient.md +++ b/docs/docs/developer/api/sdk/classes/HypercertClient.md @@ -54,7 +54,7 @@ Will throw a `ClientError` if the public client cannot be connected. #### Defined in -[sdk/src/client.ts:65](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L65) +[sdk/src/client.ts:59](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L59) ## Properties @@ -64,7 +64,7 @@ Will throw a `ClientError` if the public client cannot be connected. #### Defined in -[sdk/src/client.ts:48](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L48) +[sdk/src/client.ts:42](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L42) --- @@ -74,7 +74,7 @@ Will throw a `ClientError` if the public client cannot be connected. #### Defined in -[sdk/src/client.ts:51](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L51) +[sdk/src/client.ts:45](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L45) --- @@ -84,7 +84,7 @@ Will throw a `ClientError` if the public client cannot be connected. #### Defined in -[sdk/src/client.ts:52](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L52) +[sdk/src/client.ts:46](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L46) --- @@ -160,7 +160,7 @@ Will throw a `ClientError` if the public client cannot be connected. #### Defined in -[sdk/src/client.ts:53](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L53) +[sdk/src/client.ts:47](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L47) --- @@ -170,7 +170,7 @@ Will throw a `ClientError` if the public client cannot be connected. #### Defined in -[sdk/src/client.ts:49](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L49) +[sdk/src/client.ts:43](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L43) --- @@ -215,7 +215,7 @@ Will throw a `ClientError` if the public client cannot be connected. #### Defined in -[sdk/src/client.ts:54](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L54) +[sdk/src/client.ts:48](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L48) --- @@ -231,7 +231,7 @@ Whether the client is in read-only mode. #### Defined in -[sdk/src/client.ts:55](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L55) +[sdk/src/client.ts:49](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L49) ## Accessors @@ -249,7 +249,7 @@ The client config. #### Defined in -[sdk/src/client.ts:89](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L89) +[sdk/src/client.ts:88](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L88) --- @@ -271,7 +271,7 @@ The indexer. #### Defined in -[sdk/src/client.ts:105](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L105) +[sdk/src/client.ts:104](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L104) --- @@ -293,7 +293,7 @@ The storage layer. #### Defined in -[sdk/src/client.ts:97](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L97) +[sdk/src/client.ts:96](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L96) ## Methods @@ -332,7 +332,7 @@ Will throw an `InvalidOrMissingError` if any of the proofs are invalid. #### Defined in -[sdk/src/client.ts:449](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L449) +[sdk/src/client.ts:448](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L448) --- @@ -365,7 +365,7 @@ A promise that resolves to the transaction hash. #### Defined in -[sdk/src/client.ts:209](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L209) +[sdk/src/client.ts:208](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L208) --- @@ -402,7 +402,7 @@ Will throw a `ClientError` if the claim is not owned by the account. #### Defined in -[sdk/src/client.ts:372](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L372) +[sdk/src/client.ts:371](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L371) --- @@ -443,7 +443,7 @@ Will throw a `MalformedDataError` if the provided allowlist or metadata is inval #### Defined in -[sdk/src/client.ts:242](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L242) +[sdk/src/client.ts:241](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L241) --- @@ -463,7 +463,7 @@ Will throw a `MalformedDataError` if the provided allowlist or metadata is inval #### Defined in -[sdk/src/client.ts:480](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L480) +[sdk/src/client.ts:479](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L479) --- @@ -483,7 +483,7 @@ Will throw a `MalformedDataError` if the provided allowlist or metadata is inval #### Defined in -[sdk/src/client.ts:497](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L497) +[sdk/src/client.ts:496](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L496) --- @@ -508,7 +508,7 @@ Will throw a `MalformedDataError` if the provided allowlist or metadata is inval #### Defined in -[sdk/src/client.ts:486](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L486) +[sdk/src/client.ts:485](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L485) --- @@ -536,7 +536,7 @@ The addresses, graph name and graph url. #### Defined in -[sdk/src/client.ts:113](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L113) +[sdk/src/client.ts:112](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L112) --- @@ -566,7 +566,7 @@ a Promise that resolves to the applicable transfer restrictions. #### Defined in -[sdk/src/client.ts:161](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L161) +[sdk/src/client.ts:160](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L160) --- @@ -615,7 +615,34 @@ a Promise that resolves to the applicable transfer restrictions. #### Defined in -[sdk/src/client.ts:507](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L507) +[sdk/src/client.ts:506](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L506) + +--- + +### isClaimOrFractionOnConnectedChain + +▸ **isClaimOrFractionOnConnectedChain**(`claimOrFractionId`): `boolean` + +Check if a claim or fraction is on the chain that the Hypercertclient +is currently connected to + +#### Parameters + +| Name | Type | Description | +| :------------------ | :------- | :---------------------------------------- | +| `claimOrFractionId` | `string` | The ID of the claim or fraction to check. | + +#### Returns + +`boolean` + +#### Implementation of + +[HypercertClientInterface](../interfaces/HypercertClientInterface.md).[isClaimOrFractionOnConnectedChain](../interfaces/HypercertClientInterface.md#isclaimorfractiononconnectedchain) + +#### Defined in + +[sdk/src/client.ts:79](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L79) --- @@ -652,7 +679,7 @@ Will throw a `ClientError` if any of the fractions are not owned by the account. #### Defined in -[sdk/src/client.ts:331](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L331) +[sdk/src/client.ts:330](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L330) --- @@ -692,7 +719,7 @@ Will throw a `MalformedDataError` if the provided metadata is invalid. #### Defined in -[sdk/src/client.ts:132](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L132) +[sdk/src/client.ts:131](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L131) --- @@ -731,7 +758,7 @@ Will throw an `InvalidOrMissingError` if the proof is invalid. #### Defined in -[sdk/src/client.ts:405](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L405) +[sdk/src/client.ts:404](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L404) --- @@ -754,7 +781,7 @@ Will throw an `InvalidOrMissingError` if the proof is invalid. #### Defined in -[sdk/src/client.ts:517](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L517) +[sdk/src/client.ts:516](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L516) --- @@ -793,7 +820,7 @@ Will throw a `ClientError` if the fraction is not owned by the account or if the #### Defined in -[sdk/src/client.ts:286](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L286) +[sdk/src/client.ts:285](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L285) --- @@ -823,7 +850,7 @@ Will throw a `ClientError` if the request fails. #### Defined in -[sdk/src/client.ts:553](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L553) +[sdk/src/client.ts:551](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L551) --- @@ -856,4 +883,4 @@ A promise that resolves to the transaction hash. #### Defined in -[sdk/src/client.ts:181](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/client.ts#L181) +[sdk/src/client.ts:180](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/client.ts#L180) diff --git a/docs/docs/developer/api/sdk/classes/HypercertsStorage.md b/docs/docs/developer/api/sdk/classes/HypercertsStorage.md index e02a7312..f26c02ff 100644 --- a/docs/docs/developer/api/sdk/classes/HypercertsStorage.md +++ b/docs/docs/developer/api/sdk/classes/HypercertsStorage.md @@ -72,7 +72,7 @@ Note: The original implementation using the Web3 Storage client is currently com #### Defined in -[sdk/src/storage.ts:145](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/storage.ts#L145) +[sdk/src/storage.ts:145](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/storage.ts#L145) --- @@ -108,7 +108,7 @@ Will throw a `MalformedDataError` if the retrieved data is invalid. #### Defined in -[sdk/src/storage.ts:118](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/storage.ts#L118) +[sdk/src/storage.ts:118](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/storage.ts#L118) --- @@ -149,7 +149,7 @@ Will throw a `MalformedDataError` if the provided metadata is invalid. #### Defined in -[sdk/src/storage.ts:36](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/storage.ts#L36) +[sdk/src/storage.ts:36](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/storage.ts#L36) --- @@ -189,4 +189,4 @@ Will throw a `MalformedDataError` if the provided metadata is invalid. #### Defined in -[sdk/src/storage.ts:83](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/storage.ts#L83) +[sdk/src/storage.ts:83](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/storage.ts#L83) diff --git a/docs/docs/developer/api/sdk/classes/InvalidOrMissingError.md b/docs/docs/developer/api/sdk/classes/InvalidOrMissingError.md index 1afe756d..91b6fab3 100644 --- a/docs/docs/developer/api/sdk/classes/InvalidOrMissingError.md +++ b/docs/docs/developer/api/sdk/classes/InvalidOrMissingError.md @@ -43,7 +43,7 @@ Error.constructor #### Defined in -[sdk/src/types/errors.ts:83](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/errors.ts#L83) +[sdk/src/types/errors.ts:83](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L83) ## Properties @@ -105,7 +105,7 @@ Additional error payload. #### Defined in -[sdk/src/types/errors.ts:76](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/errors.ts#L76) +[sdk/src/types/errors.ts:76](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L76) --- diff --git a/docs/docs/developer/api/sdk/classes/MalformedDataError.md b/docs/docs/developer/api/sdk/classes/MalformedDataError.md index 0de91938..d11a0869 100644 --- a/docs/docs/developer/api/sdk/classes/MalformedDataError.md +++ b/docs/docs/developer/api/sdk/classes/MalformedDataError.md @@ -43,7 +43,7 @@ Error.constructor #### Defined in -[sdk/src/types/errors.ts:155](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/errors.ts#L155) +[sdk/src/types/errors.ts:155](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L155) ## Properties @@ -105,7 +105,7 @@ Additional error payload. #### Defined in -[sdk/src/types/errors.ts:148](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/errors.ts#L148) +[sdk/src/types/errors.ts:148](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L148) --- diff --git a/docs/docs/developer/api/sdk/classes/MintingError.md b/docs/docs/developer/api/sdk/classes/MintingError.md index 12ad336a..6c66e904 100644 --- a/docs/docs/developer/api/sdk/classes/MintingError.md +++ b/docs/docs/developer/api/sdk/classes/MintingError.md @@ -43,7 +43,7 @@ Error.constructor #### Defined in -[sdk/src/types/errors.ts:101](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/errors.ts#L101) +[sdk/src/types/errors.ts:101](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L101) ## Properties @@ -105,7 +105,7 @@ Additional error payload. #### Defined in -[sdk/src/types/errors.ts:94](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/errors.ts#L94) +[sdk/src/types/errors.ts:94](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L94) --- diff --git a/docs/docs/developer/api/sdk/classes/StorageError.md b/docs/docs/developer/api/sdk/classes/StorageError.md index 9bf362a9..096b4a4e 100644 --- a/docs/docs/developer/api/sdk/classes/StorageError.md +++ b/docs/docs/developer/api/sdk/classes/StorageError.md @@ -43,7 +43,7 @@ Error.constructor #### Defined in -[sdk/src/types/errors.ts:119](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/errors.ts#L119) +[sdk/src/types/errors.ts:119](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L119) ## Properties @@ -105,7 +105,7 @@ Additional error payload. #### Defined in -[sdk/src/types/errors.ts:112](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/errors.ts#L112) +[sdk/src/types/errors.ts:112](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L112) --- diff --git a/docs/docs/developer/api/sdk/classes/UnknownSchemaError.md b/docs/docs/developer/api/sdk/classes/UnknownSchemaError.md index 2ba0903b..928c8071 100644 --- a/docs/docs/developer/api/sdk/classes/UnknownSchemaError.md +++ b/docs/docs/developer/api/sdk/classes/UnknownSchemaError.md @@ -44,7 +44,7 @@ Error.constructor #### Defined in -[sdk/src/types/errors.ts:137](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/errors.ts#L137) +[sdk/src/types/errors.ts:137](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L137) ## Properties @@ -108,7 +108,7 @@ Additional error payload. #### Defined in -[sdk/src/types/errors.ts:130](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/errors.ts#L130) +[sdk/src/types/errors.ts:130](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L130) --- diff --git a/docs/docs/developer/api/sdk/classes/UnsupportedChainError.md b/docs/docs/developer/api/sdk/classes/UnsupportedChainError.md index 9bb9e830..789bf68c 100644 --- a/docs/docs/developer/api/sdk/classes/UnsupportedChainError.md +++ b/docs/docs/developer/api/sdk/classes/UnsupportedChainError.md @@ -45,7 +45,7 @@ Error.constructor #### Defined in -[sdk/src/types/errors.ts:174](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/errors.ts#L174) +[sdk/src/types/errors.ts:174](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L174) ## Properties @@ -109,7 +109,7 @@ Additional error payload. #### Defined in -[sdk/src/types/errors.ts:167](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/errors.ts#L167) +[sdk/src/types/errors.ts:167](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L167) --- diff --git a/docs/docs/developer/api/sdk/index.md b/docs/docs/developer/api/sdk/index.md index 9009c901..6e5c33b0 100644 --- a/docs/docs/developer/api/sdk/index.md +++ b/docs/docs/developer/api/sdk/index.md @@ -71,18 +71,18 @@ HypercertClientConfig is a configuration object used when initializing a new ins you to customize the client by setting your own providers or deployments. At it's simplest, you only need to provide `chain.id` to initalize the client in `readonly` mode. -| Field | Type | Description | -| --------------------------- | ------- | ---------------------------------------------------------------------------------------------- | -| `chain` | Object | Partial configuration for the blockchain network. | -| `contractAddress` | String | The address of the deployed contract. | -| `graphUrl` | String | The URL to the subgraph that indexes the contract events. Override for localized testing. | -| `graphName` | String | The name of the subgraph. | -| `easContractAddress` | String | The address of the EAS contract. | -| `publicClient` | Object | The PublicClient is inherently read-only and is used for reading data from the blockchain. | -| `walletClient` | Object | The WalletClient is used for signing and sending transactions. | -| `unsafeForceOverrideConfig` | Boolean | Boolean to force the use of overridden values. | -| `readOnly` | Boolean | Boolean to assert if the client is in read-only mode. | -| `readOnlyReason` | String | Reason for read-only mode. This is optional and can be used for logging or debugging purposes. | +| Field | Type | Description | +| --------------------------- | --------------------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------- | +| `chain` | Object | Partial configuration for the blockchain network. | +| `contractAddress` | String | The address of the deployed contract. | +| `graphName` | String | The name of the subgraph. | +| `easContractAddress` | String | The address of the EAS contract. | +| `publicClient` | Object | The PublicClient is inherently read-only and is used for reading data from the blockchain. | +| `walletClient` | Object | The WalletClient is used for signing and sending transactions. | +| `unsafeForceOverrideConfig` | Boolean | Boolean to force the use of overridden values. | +| `readOnly` | Boolean | Boolean to assert if the client is in read-only mode. | +| `readOnlyReason` | String | Reason for read-only mode. This is optional and can be used for logging or debugging purposes. | +| `indexerEnvironment` | `'test' \| 'production' \| 'all'` | Determines which graphs should be read out when querying | The environment of the indexer. | ### Read-only mode diff --git a/docs/docs/developer/api/sdk/interfaces/CustomError.md b/docs/docs/developer/api/sdk/interfaces/CustomError.md index 5e5afc63..392d17e9 100644 --- a/docs/docs/developer/api/sdk/interfaces/CustomError.md +++ b/docs/docs/developer/api/sdk/interfaces/CustomError.md @@ -35,4 +35,4 @@ Additional error payload. #### Defined in -[sdk/src/types/errors.ts:10](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/errors.ts#L10) +[sdk/src/types/errors.ts:10](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L10) diff --git a/docs/docs/developer/api/sdk/interfaces/DuplicateEvaluation.md b/docs/docs/developer/api/sdk/interfaces/DuplicateEvaluation.md index 5aa6b7ae..b2d63435 100644 --- a/docs/docs/developer/api/sdk/interfaces/DuplicateEvaluation.md +++ b/docs/docs/developer/api/sdk/interfaces/DuplicateEvaluation.md @@ -18,7 +18,7 @@ custom_edit_url: null #### Defined in -[sdk/src/types/evaluation.d.ts:22](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/evaluation.d.ts#L22) +[sdk/src/types/evaluation.d.ts:22](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L22) --- @@ -28,7 +28,7 @@ custom_edit_url: null #### Defined in -[sdk/src/types/evaluation.d.ts:24](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/evaluation.d.ts#L24) +[sdk/src/types/evaluation.d.ts:24](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L24) --- @@ -38,7 +38,7 @@ custom_edit_url: null #### Defined in -[sdk/src/types/evaluation.d.ts:23](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/evaluation.d.ts#L23) +[sdk/src/types/evaluation.d.ts:23](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L23) --- @@ -48,4 +48,4 @@ custom_edit_url: null #### Defined in -[sdk/src/types/evaluation.d.ts:21](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/evaluation.d.ts#L21) +[sdk/src/types/evaluation.d.ts:21](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L21) diff --git a/docs/docs/developer/api/sdk/interfaces/EASEvaluation.md b/docs/docs/developer/api/sdk/interfaces/EASEvaluation.md index 7ca1a54e..a68f6cce 100644 --- a/docs/docs/developer/api/sdk/interfaces/EASEvaluation.md +++ b/docs/docs/developer/api/sdk/interfaces/EASEvaluation.md @@ -18,7 +18,7 @@ custom_edit_url: null #### Defined in -[sdk/src/types/evaluation.d.ts:41](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/evaluation.d.ts#L41) +[sdk/src/types/evaluation.d.ts:41](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L41) --- @@ -28,7 +28,7 @@ custom_edit_url: null #### Defined in -[sdk/src/types/evaluation.d.ts:42](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/evaluation.d.ts#L42) +[sdk/src/types/evaluation.d.ts:42](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L42) --- @@ -38,7 +38,7 @@ custom_edit_url: null #### Defined in -[sdk/src/types/evaluation.d.ts:40](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/evaluation.d.ts#L40) +[sdk/src/types/evaluation.d.ts:40](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L40) --- @@ -48,4 +48,4 @@ custom_edit_url: null #### Defined in -[sdk/src/types/evaluation.d.ts:43](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/evaluation.d.ts#L43) +[sdk/src/types/evaluation.d.ts:43](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L43) diff --git a/docs/docs/developer/api/sdk/interfaces/HypercertClaimdata.md b/docs/docs/developer/api/sdk/interfaces/HypercertClaimdata.md index 8927ec3e..c309d77d 100644 --- a/docs/docs/developer/api/sdk/interfaces/HypercertClaimdata.md +++ b/docs/docs/developer/api/sdk/interfaces/HypercertClaimdata.md @@ -34,7 +34,7 @@ Contributors #### Defined in -[sdk/src/types/claimdata.d.ts:53](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/claimdata.d.ts#L53) +[sdk/src/types/claimdata.d.ts:53](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/claimdata.d.ts#L53) --- @@ -59,7 +59,7 @@ Scopes of impact #### Defined in -[sdk/src/types/claimdata.d.ts:15](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/claimdata.d.ts#L15) +[sdk/src/types/claimdata.d.ts:15](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/claimdata.d.ts#L15) --- @@ -83,7 +83,7 @@ Impact time period. The value is UNIX time in seconds from epoch. #### Defined in -[sdk/src/types/claimdata.d.ts:44](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/claimdata.d.ts#L44) +[sdk/src/types/claimdata.d.ts:44](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/claimdata.d.ts#L44) --- @@ -108,7 +108,7 @@ Rights #### Defined in -[sdk/src/types/claimdata.d.ts:62](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/claimdata.d.ts#L62) +[sdk/src/types/claimdata.d.ts:62](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/claimdata.d.ts#L62) --- @@ -133,7 +133,7 @@ Scopes of work #### Defined in -[sdk/src/types/claimdata.d.ts:25](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/claimdata.d.ts#L25) +[sdk/src/types/claimdata.d.ts:25](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/claimdata.d.ts#L25) --- @@ -157,4 +157,4 @@ Work time period. The value is UNIX time in seconds from epoch. #### Defined in -[sdk/src/types/claimdata.d.ts:35](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/claimdata.d.ts#L35) +[sdk/src/types/claimdata.d.ts:35](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/claimdata.d.ts#L35) diff --git a/docs/docs/developer/api/sdk/interfaces/HypercertClientInterface.md b/docs/docs/developer/api/sdk/interfaces/HypercertClientInterface.md index 7ae6754b..2045e99e 100644 --- a/docs/docs/developer/api/sdk/interfaces/HypercertClientInterface.md +++ b/docs/docs/developer/api/sdk/interfaces/HypercertClientInterface.md @@ -62,7 +62,7 @@ The order of the arrays must be equal. #### Defined in -[sdk/src/types/client.ts:282](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L282) +[sdk/src/types/client.ts:291](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L291) --- @@ -96,7 +96,7 @@ A Promise that resolves to the transaction hash #### Defined in -[sdk/src/types/client.ts:216](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L216) +[sdk/src/types/client.ts:225](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L225) --- @@ -128,7 +128,7 @@ A Promise that resolves to the transaction hash #### Defined in -[sdk/src/types/client.ts:257](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L257) +[sdk/src/types/client.ts:266](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L266) --- @@ -163,7 +163,7 @@ A Promise that resolves to the transaction hash #### Defined in -[sdk/src/types/client.ts:230](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L230) +[sdk/src/types/client.ts:239](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L239) --- @@ -195,7 +195,7 @@ The addresses, graph name and graph url. #### Defined in -[sdk/src/types/client.ts:174](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L174) +[sdk/src/types/client.ts:183](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L183) --- @@ -227,7 +227,7 @@ A Promise that resolves to the applicable transfer restrictions. #### Defined in -[sdk/src/types/client.ts:194](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L194) +[sdk/src/types/client.ts:203](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L203) --- @@ -243,7 +243,38 @@ The indexer used by the client. #### Defined in -[sdk/src/types/client.ts:163](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L163) +[sdk/src/types/client.ts:172](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L172) + +--- + +### isClaimOrFractionOnConnectedChain + +• **isClaimOrFractionOnConnectedChain**: (`claimOrFractionId`: `string`) => `boolean` + +#### Type declaration + +▸ (`claimOrFractionId`): `boolean` + +Check if a claim or fraction is on the chain that the Hypercertclient +is currently connected to + +##### Parameters + +| Name | Type | Description | +| :------------------ | :------- | :---------------------------------------- | +| `claimOrFractionId` | `string` | The ID of the claim or fraction to check. | + +##### Returns + +`boolean` + +#### Inherited from + +[HypercertClientMethods](HypercertClientMethods.md).[isClaimOrFractionOnConnectedChain](HypercertClientMethods.md#isclaimorfractiononconnectedchain) + +#### Defined in + +[sdk/src/types/client.ts:302](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L302) --- @@ -275,7 +306,7 @@ A Promise that resolves to the transaction hash #### Defined in -[sdk/src/types/client.ts:250](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L250) +[sdk/src/types/client.ts:259](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L259) --- @@ -309,7 +340,7 @@ A Promise that resolves to the transaction hash #### Defined in -[sdk/src/types/client.ts:183](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L183) +[sdk/src/types/client.ts:192](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L192) --- @@ -343,7 +374,7 @@ A Promise that resolves to the transaction hash #### Defined in -[sdk/src/types/client.ts:266](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L266) +[sdk/src/types/client.ts:275](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L275) --- @@ -359,7 +390,7 @@ Whether the client is in read-only mode. #### Defined in -[sdk/src/types/client.ts:159](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L159) +[sdk/src/types/client.ts:168](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L168) --- @@ -392,7 +423,7 @@ A Promise that resolves to the transaction hash #### Defined in -[sdk/src/types/client.ts:243](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L243) +[sdk/src/types/client.ts:252](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L252) --- @@ -408,7 +439,7 @@ The storage layer used by the client. #### Defined in -[sdk/src/types/client.ts:161](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L161) +[sdk/src/types/client.ts:170](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L170) --- @@ -442,4 +473,4 @@ A Promise that resolves to the transaction hash #### Defined in -[sdk/src/types/client.ts:203](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L203) +[sdk/src/types/client.ts:212](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L212) diff --git a/docs/docs/developer/api/sdk/interfaces/HypercertClientMethods.md b/docs/docs/developer/api/sdk/interfaces/HypercertClientMethods.md index 05e837ec..be54b2af 100644 --- a/docs/docs/developer/api/sdk/interfaces/HypercertClientMethods.md +++ b/docs/docs/developer/api/sdk/interfaces/HypercertClientMethods.md @@ -52,7 +52,7 @@ The order of the arrays must be equal. #### Defined in -[sdk/src/types/client.ts:282](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L282) +[sdk/src/types/client.ts:291](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L291) --- @@ -82,7 +82,7 @@ A Promise that resolves to the transaction hash #### Defined in -[sdk/src/types/client.ts:216](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L216) +[sdk/src/types/client.ts:225](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L225) --- @@ -110,7 +110,7 @@ A Promise that resolves to the transaction hash #### Defined in -[sdk/src/types/client.ts:257](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L257) +[sdk/src/types/client.ts:266](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L266) --- @@ -141,7 +141,7 @@ A Promise that resolves to the transaction hash #### Defined in -[sdk/src/types/client.ts:230](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L230) +[sdk/src/types/client.ts:239](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L239) --- @@ -169,7 +169,7 @@ The addresses, graph name and graph url. #### Defined in -[sdk/src/types/client.ts:174](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L174) +[sdk/src/types/client.ts:183](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L183) --- @@ -197,7 +197,34 @@ A Promise that resolves to the applicable transfer restrictions. #### Defined in -[sdk/src/types/client.ts:194](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L194) +[sdk/src/types/client.ts:203](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L203) + +--- + +### isClaimOrFractionOnConnectedChain + +• **isClaimOrFractionOnConnectedChain**: (`claimOrFractionId`: `string`) => `boolean` + +#### Type declaration + +▸ (`claimOrFractionId`): `boolean` + +Check if a claim or fraction is on the chain that the Hypercertclient +is currently connected to + +##### Parameters + +| Name | Type | Description | +| :------------------ | :------- | :---------------------------------------- | +| `claimOrFractionId` | `string` | The ID of the claim or fraction to check. | + +##### Returns + +`boolean` + +#### Defined in + +[sdk/src/types/client.ts:302](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L302) --- @@ -225,7 +252,7 @@ A Promise that resolves to the transaction hash #### Defined in -[sdk/src/types/client.ts:250](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L250) +[sdk/src/types/client.ts:259](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L259) --- @@ -255,7 +282,7 @@ A Promise that resolves to the transaction hash #### Defined in -[sdk/src/types/client.ts:183](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L183) +[sdk/src/types/client.ts:192](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L192) --- @@ -285,7 +312,7 @@ A Promise that resolves to the transaction hash #### Defined in -[sdk/src/types/client.ts:266](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L266) +[sdk/src/types/client.ts:275](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L275) --- @@ -314,7 +341,7 @@ A Promise that resolves to the transaction hash #### Defined in -[sdk/src/types/client.ts:243](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L243) +[sdk/src/types/client.ts:252](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L252) --- @@ -344,4 +371,4 @@ A Promise that resolves to the transaction hash #### Defined in -[sdk/src/types/client.ts:203](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L203) +[sdk/src/types/client.ts:212](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L212) diff --git a/docs/docs/developer/api/sdk/interfaces/HypercertClientState.md b/docs/docs/developer/api/sdk/interfaces/HypercertClientState.md index ec6e3e2e..dd0967ce 100644 --- a/docs/docs/developer/api/sdk/interfaces/HypercertClientState.md +++ b/docs/docs/developer/api/sdk/interfaces/HypercertClientState.md @@ -24,7 +24,7 @@ The indexer used by the client. #### Defined in -[sdk/src/types/client.ts:163](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L163) +[sdk/src/types/client.ts:172](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L172) --- @@ -36,7 +36,7 @@ Whether the client is in read-only mode. #### Defined in -[sdk/src/types/client.ts:159](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L159) +[sdk/src/types/client.ts:168](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L168) --- @@ -48,4 +48,4 @@ The storage layer used by the client. #### Defined in -[sdk/src/types/client.ts:161](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L161) +[sdk/src/types/client.ts:170](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L170) diff --git a/docs/docs/developer/api/sdk/interfaces/HypercertEvaluationSchema.md b/docs/docs/developer/api/sdk/interfaces/HypercertEvaluationSchema.md index 4baf5531..9bbd00a4 100644 --- a/docs/docs/developer/api/sdk/interfaces/HypercertEvaluationSchema.md +++ b/docs/docs/developer/api/sdk/interfaces/HypercertEvaluationSchema.md @@ -20,7 +20,7 @@ Schema for evaluating Hypercerts across different sources and evaluation types #### Defined in -[sdk/src/types/evaluation.d.ts:15](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/evaluation.d.ts#L15) +[sdk/src/types/evaluation.d.ts:15](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L15) --- @@ -30,7 +30,7 @@ Schema for evaluating Hypercerts across different sources and evaluation types #### Defined in -[sdk/src/types/evaluation.d.ts:16](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/evaluation.d.ts#L16) +[sdk/src/types/evaluation.d.ts:16](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L16) --- @@ -40,4 +40,4 @@ Schema for evaluating Hypercerts across different sources and evaluation types #### Defined in -[sdk/src/types/evaluation.d.ts:17](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/evaluation.d.ts#L17) +[sdk/src/types/evaluation.d.ts:17](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L17) diff --git a/docs/docs/developer/api/sdk/interfaces/HypercertIndexerInterface.md b/docs/docs/developer/api/sdk/interfaces/HypercertIndexerInterface.md index 08e975fd..91826145 100644 --- a/docs/docs/developer/api/sdk/interfaces/HypercertIndexerInterface.md +++ b/docs/docs/developer/api/sdk/interfaces/HypercertIndexerInterface.md @@ -28,7 +28,7 @@ custom_edit_url: null #### Defined in -[sdk/src/types/indexer.ts:20](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/indexer.ts#L20) +[sdk/src/types/indexer.ts:23](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/indexer.ts#L23) --- @@ -53,7 +53,7 @@ custom_edit_url: null #### Defined in -[sdk/src/types/indexer.ts:19](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/indexer.ts#L19) +[sdk/src/types/indexer.ts:22](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/indexer.ts#L22) --- @@ -77,7 +77,7 @@ custom_edit_url: null #### Defined in -[sdk/src/types/indexer.ts:21](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/indexer.ts#L21) +[sdk/src/types/indexer.ts:24](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/indexer.ts#L24) --- @@ -101,7 +101,7 @@ custom_edit_url: null #### Defined in -[sdk/src/types/indexer.ts:24](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/indexer.ts#L24) +[sdk/src/types/indexer.ts:27](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/indexer.ts#L27) --- @@ -126,7 +126,7 @@ custom_edit_url: null #### Defined in -[sdk/src/types/indexer.ts:23](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/indexer.ts#L23) +[sdk/src/types/indexer.ts:26](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/indexer.ts#L26) --- @@ -151,14 +151,24 @@ custom_edit_url: null #### Defined in -[sdk/src/types/indexer.ts:22](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/indexer.ts#L22) +[sdk/src/types/indexer.ts:25](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/indexer.ts#L25) ---- +## Methods + +### getGraphClient + +▸ **getGraphClient**(`chainId`): `Client` + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `chainId` | `number` | -### graphClient +#### Returns -• **graphClient**: `Client` +`Client` #### Defined in -[sdk/src/types/indexer.ts:18](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/indexer.ts#L18) +[sdk/src/types/indexer.ts:21](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/indexer.ts#L21) diff --git a/docs/docs/developer/api/sdk/interfaces/HypercertMetadata.md b/docs/docs/developer/api/sdk/interfaces/HypercertMetadata.md index 2afcbdca..2df42b6a 100644 --- a/docs/docs/developer/api/sdk/interfaces/HypercertMetadata.md +++ b/docs/docs/developer/api/sdk/interfaces/HypercertMetadata.md @@ -18,7 +18,7 @@ A CID pointer to the merke tree proof json on ipfs #### Defined in -[sdk/src/types/metadata.d.ts:39](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/metadata.d.ts#L39) +[sdk/src/types/metadata.d.ts:39](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/metadata.d.ts#L39) --- @@ -30,7 +30,7 @@ Describes the asset to which this token represents #### Defined in -[sdk/src/types/metadata.d.ts:19](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/metadata.d.ts#L19) +[sdk/src/types/metadata.d.ts:19](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/metadata.d.ts#L19) --- @@ -42,7 +42,7 @@ An url pointing to the external website of the project #### Defined in -[sdk/src/types/metadata.d.ts:23](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/metadata.d.ts#L23) +[sdk/src/types/metadata.d.ts:23](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/metadata.d.ts#L23) --- @@ -52,7 +52,7 @@ An url pointing to the external website of the project #### Defined in -[sdk/src/types/metadata.d.ts:45](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/metadata.d.ts#L45) +[sdk/src/types/metadata.d.ts:45](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/metadata.d.ts#L45) --- @@ -64,7 +64,7 @@ A URI pointing to a resource with mime type image/\* representing the asset to w #### Defined in -[sdk/src/types/metadata.d.ts:27](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/metadata.d.ts#L27) +[sdk/src/types/metadata.d.ts:27](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/metadata.d.ts#L27) --- @@ -76,7 +76,7 @@ Identifies the asset to which this token represents #### Defined in -[sdk/src/types/metadata.d.ts:15](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/metadata.d.ts#L15) +[sdk/src/types/metadata.d.ts:15](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/metadata.d.ts#L15) --- @@ -86,7 +86,7 @@ Identifies the asset to which this token represents #### Defined in -[sdk/src/types/metadata.d.ts:40](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/metadata.d.ts#L40) +[sdk/src/types/metadata.d.ts:40](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/metadata.d.ts#L40) --- @@ -98,7 +98,7 @@ Describes the asset to which this token represents #### Defined in -[sdk/src/types/metadata.d.ts:35](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/metadata.d.ts#L35) +[sdk/src/types/metadata.d.ts:35](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/metadata.d.ts#L35) --- @@ -110,4 +110,4 @@ The version of Hypercert schema used to describe this hypercert #### Defined in -[sdk/src/types/metadata.d.ts:31](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/metadata.d.ts#L31) +[sdk/src/types/metadata.d.ts:31](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/metadata.d.ts#L31) diff --git a/docs/docs/developer/api/sdk/interfaces/HypercertPointer.md b/docs/docs/developer/api/sdk/interfaces/HypercertPointer.md index 165f0139..0d6489e6 100644 --- a/docs/docs/developer/api/sdk/interfaces/HypercertPointer.md +++ b/docs/docs/developer/api/sdk/interfaces/HypercertPointer.md @@ -18,7 +18,7 @@ custom_edit_url: null #### Defined in -[sdk/src/types/evaluation.d.ts:28](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/evaluation.d.ts#L28) +[sdk/src/types/evaluation.d.ts:28](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L28) --- @@ -28,7 +28,7 @@ custom_edit_url: null #### Defined in -[sdk/src/types/evaluation.d.ts:30](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/evaluation.d.ts#L30) +[sdk/src/types/evaluation.d.ts:30](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L30) --- @@ -38,4 +38,4 @@ custom_edit_url: null #### Defined in -[sdk/src/types/evaluation.d.ts:29](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/evaluation.d.ts#L29) +[sdk/src/types/evaluation.d.ts:29](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L29) diff --git a/docs/docs/developer/api/sdk/interfaces/HypercertStorageInterface.md b/docs/docs/developer/api/sdk/interfaces/HypercertStorageInterface.md index c1c5abdb..ddf9e9dc 100644 --- a/docs/docs/developer/api/sdk/interfaces/HypercertStorageInterface.md +++ b/docs/docs/developer/api/sdk/interfaces/HypercertStorageInterface.md @@ -39,7 +39,7 @@ A Promise that resolves to the retrieved data. #### Defined in -[sdk/src/types/client.ts:138](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L138) +[sdk/src/types/client.ts:147](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L147) --- @@ -68,7 +68,7 @@ A Promise that resolves to the retrieved metadata. #### Defined in -[sdk/src/types/client.ts:130](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L130) +[sdk/src/types/client.ts:139](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L139) --- @@ -98,7 +98,7 @@ A Promise that resolves to the CID of the stored metadata. #### Defined in -[sdk/src/types/client.ts:114](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L114) +[sdk/src/types/client.ts:123](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L123) --- @@ -127,4 +127,4 @@ A Promise that resolves to the CID of the stored metadata. #### Defined in -[sdk/src/types/client.ts:122](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L122) +[sdk/src/types/client.ts:131](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L131) diff --git a/docs/docs/developer/api/sdk/interfaces/IPFSEvaluation.md b/docs/docs/developer/api/sdk/interfaces/IPFSEvaluation.md index 18fa4e05..ec56fab6 100644 --- a/docs/docs/developer/api/sdk/interfaces/IPFSEvaluation.md +++ b/docs/docs/developer/api/sdk/interfaces/IPFSEvaluation.md @@ -18,7 +18,7 @@ custom_edit_url: null #### Defined in -[sdk/src/types/evaluation.d.ts:48](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/evaluation.d.ts#L48) +[sdk/src/types/evaluation.d.ts:48](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L48) --- @@ -28,4 +28,4 @@ custom_edit_url: null #### Defined in -[sdk/src/types/evaluation.d.ts:47](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/evaluation.d.ts#L47) +[sdk/src/types/evaluation.d.ts:47](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L47) diff --git a/docs/docs/developer/api/sdk/interfaces/SimpleTextEvaluation.md b/docs/docs/developer/api/sdk/interfaces/SimpleTextEvaluation.md index efb05435..812c8a29 100644 --- a/docs/docs/developer/api/sdk/interfaces/SimpleTextEvaluation.md +++ b/docs/docs/developer/api/sdk/interfaces/SimpleTextEvaluation.md @@ -18,7 +18,7 @@ custom_edit_url: null #### Defined in -[sdk/src/types/evaluation.d.ts:35](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/evaluation.d.ts#L35) +[sdk/src/types/evaluation.d.ts:35](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L35) --- @@ -28,7 +28,7 @@ custom_edit_url: null #### Defined in -[sdk/src/types/evaluation.d.ts:36](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/evaluation.d.ts#L36) +[sdk/src/types/evaluation.d.ts:36](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L36) --- @@ -38,4 +38,4 @@ custom_edit_url: null #### Defined in -[sdk/src/types/evaluation.d.ts:34](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/evaluation.d.ts#L34) +[sdk/src/types/evaluation.d.ts:34](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L34) diff --git a/docs/docs/developer/api/sdk/modules.md b/docs/docs/developer/api/sdk/modules.md index 917357b7..6e6bc4e2 100644 --- a/docs/docs/developer/api/sdk/modules.md +++ b/docs/docs/developer/api/sdk/modules.md @@ -55,7 +55,7 @@ Represents an entry in an allowlist. #### Defined in -[sdk/src/types/hypercerts.ts:24](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/hypercerts.ts#L24) +[sdk/src/types/hypercerts.ts:24](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/hypercerts.ts#L24) --- @@ -80,7 +80,7 @@ Represents an entry in an allowlist. #### Defined in -[sdk/src/indexer/gql/graphql.ts:205](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/indexer/gql/graphql.ts#L205) +[sdk/src/indexer/gql/graphql.ts:205](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/graphql.ts#L205) --- @@ -97,7 +97,7 @@ Represents an entry in an allowlist. #### Defined in -[sdk/src/indexer/gql/graphql.ts:1179](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/indexer/gql/graphql.ts#L1179) +[sdk/src/indexer/gql/graphql.ts:1179](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/graphql.ts#L1179) --- @@ -119,7 +119,7 @@ Represents an entry in an allowlist. #### Defined in -[sdk/src/indexer/gql/graphql.ts:218](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/indexer/gql/graphql.ts#L218) +[sdk/src/indexer/gql/graphql.ts:218](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/graphql.ts#L218) --- @@ -136,7 +136,7 @@ Represents an entry in an allowlist. #### Defined in -[sdk/src/indexer/gql/graphql.ts:1206](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/indexer/gql/graphql.ts#L1206) +[sdk/src/indexer/gql/graphql.ts:1206](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/graphql.ts#L1206) --- @@ -153,7 +153,7 @@ Represents an entry in an allowlist. #### Defined in -[sdk/src/indexer/gql/graphql.ts:1199](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/indexer/gql/graphql.ts#L1199) +[sdk/src/indexer/gql/graphql.ts:1199](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/graphql.ts#L1199) --- @@ -170,7 +170,7 @@ Represents an entry in an allowlist. #### Defined in -[sdk/src/indexer/gql/graphql.ts:1189](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/indexer/gql/graphql.ts#L1189) +[sdk/src/indexer/gql/graphql.ts:1189](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/graphql.ts#L1189) --- @@ -187,7 +187,7 @@ Represents an entry in an allowlist. #### Defined in -[sdk/src/indexer/gql/graphql.ts:1163](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/indexer/gql/graphql.ts#L1163) +[sdk/src/indexer/gql/graphql.ts:1163](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/graphql.ts#L1163) --- @@ -219,7 +219,7 @@ The gas limit to use for the transaction (in wei). #### Defined in -[sdk/src/types/client.ts:26](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L26) +[sdk/src/types/client.ts:25](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L25) --- @@ -229,7 +229,7 @@ The gas limit to use for the transaction (in wei). #### Defined in -[sdk/src/types/client.ts:41](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L41) +[sdk/src/types/client.ts:40](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L40) --- @@ -247,10 +247,11 @@ Represents a deployment of a contract on a specific network. | `chain` | `Partial`<`Chain`\> | - | | `graphName` | `string` | - | | `graphUrl` | `string` | The url to the subgraph that indexes the contract events. Override for localized testing | +| `isTestnet` | `boolean` | - | #### Defined in -[sdk/src/types/client.ts:59](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L59) +[sdk/src/types/client.ts:58](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L58) --- @@ -266,7 +267,7 @@ Represents a deployment of a contract on a specific network. #### Defined in -[sdk/src/indexer/gql/gql.ts:47](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/indexer/gql/gql.ts#L47) +[sdk/src/indexer/gql/gql.ts:47](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/gql.ts#L47) --- @@ -280,7 +281,7 @@ and run json-schema-to-typescript to regenerate this file. #### Defined in -[sdk/src/types/evaluation.d.ts:8](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/evaluation.d.ts#L8) +[sdk/src/types/evaluation.d.ts:8](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L8) --- @@ -290,7 +291,7 @@ and run json-schema-to-typescript to regenerate this file. #### Defined in -[sdk/src/types/evaluation.d.ts:9](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/evaluation.d.ts#L9) +[sdk/src/types/evaluation.d.ts:9](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/evaluation.d.ts#L9) --- @@ -306,19 +307,19 @@ and run json-schema-to-typescript to regenerate this file. #### Defined in -[sdk/src/indexer/gql/fragment-masking.ts:6](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/indexer/gql/fragment-masking.ts#L6) +[sdk/src/indexer/gql/fragment-masking.ts:6](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/fragment-masking.ts#L6) --- ### HypercertClientConfig -Ƭ **HypercertClientConfig**: [`Deployment`](modules.md#deployment) & [`HypercertStorageConfig`](modules.md#hypercertstorageconfig) & [`HypercertEvaluatorConfig`](modules.md#hypercertevaluatorconfig) & \{ `publicClient`: `PublicClient` ; `readOnly`: `boolean` ; `readOnlyReason?`: `string` ; `unsafeForceOverrideConfig?`: `boolean` ; `walletClient`: `WalletClient` } +Ƭ **HypercertClientConfig**: `Pick`<[`Deployment`](modules.md#deployment), `"addresses"` \| `"chain"`\> & [`HypercertStorageConfig`](modules.md#hypercertstorageconfig) & [`HypercertEvaluatorConfig`](modules.md#hypercertevaluatorconfig) & \{ `indexerEnvironment`: [`IndexerEnvironment`](modules.md#indexerenvironment) ; `publicClient`: `PublicClient` ; `readOnly`: `boolean` ; `readOnlyReason?`: `string` ; `unsafeForceOverrideConfig?`: `boolean` ; `walletClient`: `WalletClient` } Configuration options for the Hypercert client. #### Defined in -[sdk/src/types/client.ts:71](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L71) +[sdk/src/types/client.ts:71](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L71) --- @@ -336,7 +337,7 @@ The props for the Hypercert client. #### Defined in -[sdk/src/types/client.ts:144](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L144) +[sdk/src/types/client.ts:153](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L153) --- @@ -352,7 +353,7 @@ The signer is required for submitting evaluations. #### Defined in -[sdk/src/types/client.ts:100](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L100) +[sdk/src/types/client.ts:109](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L109) --- @@ -378,7 +379,7 @@ nft.storage and web3.storage are no longer used #### Defined in -[sdk/src/types/client.ts:91](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L91) +[sdk/src/types/client.ts:100](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L100) --- @@ -388,7 +389,21 @@ nft.storage and web3.storage are no longer used #### Defined in -[sdk/src/types/errors.ts:195](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/errors.ts#L195) +[sdk/src/types/errors.ts:195](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/errors.ts#L195) + +--- + +### IndexerEnvironment + +Ƭ **IndexerEnvironment**: `"production"` \| `"test"` \| `"all"` + +The environment to run the indexer in. +Production will run against all mainnet chains, while test will run against testnet chains. +All will run against both + +#### Defined in + +[sdk/src/types/client.ts:92](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L92) --- @@ -410,7 +425,17 @@ nft.storage and web3.storage are no longer used #### Defined in -[sdk/src/types/indexer.ts:10](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/indexer.ts#L10) +[sdk/src/types/indexer.ts:11](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/indexer.ts#L11) + +--- + +### QueryParamsWithChainId + +Ƭ **QueryParamsWithChainId**: [`QueryParams`](modules.md#queryparams) & \{ `chainId?`: `number` } + +#### Defined in + +[sdk/src/types/indexer.ts:18](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/indexer.ts#L18) --- @@ -427,7 +452,7 @@ nft.storage and web3.storage are no longer used #### Defined in -[sdk/src/indexer/gql/graphql.ts:1172](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/indexer/gql/graphql.ts#L1172) +[sdk/src/indexer/gql/graphql.ts:1172](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/graphql.ts#L1172) --- @@ -449,7 +474,7 @@ The timeout (im ms) for the HTTP request; for example for uploading metadata or #### Defined in -[sdk/src/types/client.ts:36](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L36) +[sdk/src/types/client.ts:35](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L35) --- @@ -465,7 +490,7 @@ Enum to verify the supported chainIds #### Defined in -[sdk/src/types/client.ts:15](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L15) +[sdk/src/types/client.ts:14](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L14) --- @@ -475,7 +500,7 @@ Enum to verify the supported chainIds #### Defined in -[sdk/src/types/client.ts:17](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/client.ts#L17) +[sdk/src/types/client.ts:16](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/client.ts#L16) --- @@ -485,9 +510,9 @@ Enum to verify the supported chainIds #### Defined in -[sdk/src/types/hypercerts.ts:9](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/hypercerts.ts#L9) +[sdk/src/types/hypercerts.ts:9](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/hypercerts.ts#L9) -[sdk/src/types/hypercerts.ts:15](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/hypercerts.ts#L15) +[sdk/src/types/hypercerts.ts:15](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/hypercerts.ts#L15) ## Variables @@ -497,7 +522,7 @@ Enum to verify the supported chainIds #### Defined in -node_modules/.pnpm/@hypercerts-org+contracts@1.1.2_ts-node@10.9.1_typescript@5.3.2/node_modules/@hypercerts-org/contracts/dist/index.d.ts:5790 +node*modules/.pnpm/@hypercerts-org+contracts@1.1.2_bufferutil@4.0.8_ts-node@10.9.1*@types+node@18.18.7_typescrip_eax5b4m2ds4kxb2pavx44azaaq/node_modules/@hypercerts-org/contracts/dist/index.d.ts:5790 --- @@ -507,7 +532,7 @@ node_modules/.pnpm/@hypercerts-org+contracts@1.1.2_ts-node@10.9.1_typescript@5.3 #### Defined in -node_modules/.pnpm/@hypercerts-org+contracts@1.1.2_ts-node@10.9.1_typescript@5.3.2/node_modules/@hypercerts-org/contracts/dist/index.d.ts:6914 +node*modules/.pnpm/@hypercerts-org+contracts@1.1.2_bufferutil@4.0.8_ts-node@10.9.1*@types+node@18.18.7_typescrip_eax5b4m2ds4kxb2pavx44azaaq/node_modules/@hypercerts-org/contracts/dist/index.d.ts:6914 --- @@ -517,7 +542,7 @@ node_modules/.pnpm/@hypercerts-org+contracts@1.1.2_ts-node@10.9.1_typescript@5.3 #### Defined in -node_modules/.pnpm/@hypercerts-org+contracts@1.1.2_ts-node@10.9.1_typescript@5.3.2/node_modules/@hypercerts-org/contracts/dist/index.d.ts:1234 +node*modules/.pnpm/@hypercerts-org+contracts@1.1.2_bufferutil@4.0.8_ts-node@10.9.1*@types+node@18.18.7_typescrip_eax5b4m2ds4kxb2pavx44azaaq/node_modules/@hypercerts-org/contracts/dist/index.d.ts:1234 --- @@ -527,7 +552,7 @@ node_modules/.pnpm/@hypercerts-org+contracts@1.1.2_ts-node@10.9.1_typescript@5.3 #### Defined in -node_modules/.pnpm/@hypercerts-org+contracts@1.1.2_ts-node@10.9.1_typescript@5.3.2/node_modules/@hypercerts-org/contracts/dist/index.d.ts:43 +node*modules/.pnpm/@hypercerts-org+contracts@1.1.2_bufferutil@4.0.8_ts-node@10.9.1*@types+node@18.18.7_typescrip_eax5b4m2ds4kxb2pavx44azaaq/node_modules/@hypercerts-org/contracts/dist/index.d.ts:43 --- @@ -537,7 +562,7 @@ node_modules/.pnpm/@hypercerts-org+contracts@1.1.2_ts-node@10.9.1_typescript@5.3 #### Defined in -node_modules/.pnpm/@hypercerts-org+contracts@1.1.2_ts-node@10.9.1_typescript@5.3.2/node_modules/@hypercerts-org/contracts/dist/index.d.ts:3079 +node*modules/.pnpm/@hypercerts-org+contracts@1.1.2_bufferutil@4.0.8_ts-node@10.9.1*@types+node@18.18.7_typescrip_eax5b4m2ds4kxb2pavx44azaaq/node_modules/@hypercerts-org/contracts/dist/index.d.ts:3079 --- @@ -547,7 +572,7 @@ node_modules/.pnpm/@hypercerts-org+contracts@1.1.2_ts-node@10.9.1_typescript@5.3 #### Defined in -node_modules/.pnpm/@hypercerts-org+contracts@1.1.2_ts-node@10.9.1_typescript@5.3.2/node_modules/@hypercerts-org/contracts/dist/index.d.ts:4593 +node*modules/.pnpm/@hypercerts-org+contracts@1.1.2_bufferutil@4.0.8_ts-node@10.9.1*@types+node@18.18.7_typescrip_eax5b4m2ds4kxb2pavx44azaaq/node_modules/@hypercerts-org/contracts/dist/index.d.ts:4593 --- @@ -557,7 +582,7 @@ node_modules/.pnpm/@hypercerts-org+contracts@1.1.2_ts-node@10.9.1_typescript@5.3 #### Defined in -node_modules/.pnpm/@hypercerts-org+contracts@1.1.2_ts-node@10.9.1_typescript@5.3.2/node_modules/@hypercerts-org/contracts/dist/index.d.ts:5118 +node*modules/.pnpm/@hypercerts-org+contracts@1.1.2_bufferutil@4.0.8_ts-node@10.9.1*@types+node@18.18.7_typescrip_eax5b4m2ds4kxb2pavx44azaaq/node_modules/@hypercerts-org/contracts/dist/index.d.ts:5118 --- @@ -567,7 +592,7 @@ node_modules/.pnpm/@hypercerts-org+contracts@1.1.2_ts-node@10.9.1_typescript@5.3 #### Defined in -node_modules/.pnpm/@hypercerts-org+contracts@1.1.2_ts-node@10.9.1_typescript@5.3.2/node_modules/@hypercerts-org/contracts/dist/index.d.ts:5863 +node*modules/.pnpm/@hypercerts-org+contracts@1.1.2_bufferutil@4.0.8_ts-node@10.9.1*@types+node@18.18.7_typescrip_eax5b4m2ds4kxb2pavx44azaaq/node_modules/@hypercerts-org/contracts/dist/index.d.ts:5863 --- @@ -577,7 +602,7 @@ node_modules/.pnpm/@hypercerts-org+contracts@1.1.2_ts-node@10.9.1_typescript@5.3 #### Defined in -node_modules/.pnpm/@hypercerts-org+contracts@1.1.2_ts-node@10.9.1_typescript@5.3.2/node_modules/@hypercerts-org/contracts/dist/index.d.ts:6388 +node*modules/.pnpm/@hypercerts-org+contracts@1.1.2_bufferutil@4.0.8_ts-node@10.9.1*@types+node@18.18.7_typescrip_eax5b4m2ds4kxb2pavx44azaaq/node_modules/@hypercerts-org/contracts/dist/index.d.ts:6388 --- @@ -587,7 +612,7 @@ node_modules/.pnpm/@hypercerts-org+contracts@1.1.2_ts-node@10.9.1_typescript@5.3 #### Defined in -node_modules/.pnpm/@hypercerts-org+contracts@1.1.2_ts-node@10.9.1_typescript@5.3.2/node_modules/@hypercerts-org/contracts/dist/index.d.ts:5387 +node*modules/.pnpm/@hypercerts-org+contracts@1.1.2_bufferutil@4.0.8_ts-node@10.9.1*@types+node@18.18.7_typescrip_eax5b4m2ds4kxb2pavx44azaaq/node_modules/@hypercerts-org/contracts/dist/index.d.ts:5387 --- @@ -597,7 +622,7 @@ node_modules/.pnpm/@hypercerts-org+contracts@1.1.2_ts-node@10.9.1_typescript@5.3 #### Defined in -node_modules/.pnpm/@hypercerts-org+contracts@1.1.2_ts-node@10.9.1_typescript@5.3.2/node_modules/@hypercerts-org/contracts/dist/index.d.ts:6657 +node*modules/.pnpm/@hypercerts-org+contracts@1.1.2_bufferutil@4.0.8_ts-node@10.9.1*@types+node@18.18.7_typescrip_eax5b4m2ds4kxb2pavx44azaaq/node_modules/@hypercerts-org/contracts/dist/index.d.ts:6657 --- @@ -607,7 +632,7 @@ node_modules/.pnpm/@hypercerts-org+contracts@1.1.2_ts-node@10.9.1_typescript@5.3 #### Defined in -node_modules/.pnpm/@hypercerts-org+contracts@1.1.2_ts-node@10.9.1_typescript@5.3.2/node_modules/@hypercerts-org/contracts/dist/index.d.ts:3516 +node*modules/.pnpm/@hypercerts-org+contracts@1.1.2_bufferutil@4.0.8_ts-node@10.9.1*@types+node@18.18.7_typescrip_eax5b4m2ds4kxb2pavx44azaaq/node_modules/@hypercerts-org/contracts/dist/index.d.ts:3516 --- @@ -617,7 +642,7 @@ node_modules/.pnpm/@hypercerts-org+contracts@1.1.2_ts-node@10.9.1_typescript@5.3 #### Defined in -node_modules/.pnpm/@hypercerts-org+contracts@1.1.2_ts-node@10.9.1_typescript@5.3.2/node_modules/@hypercerts-org/contracts/dist/index.d.ts:3982 +node*modules/.pnpm/@hypercerts-org+contracts@1.1.2_bufferutil@4.0.8_ts-node@10.9.1*@types+node@18.18.7_typescrip_eax5b4m2ds4kxb2pavx44azaaq/node_modules/@hypercerts-org/contracts/dist/index.d.ts:3982 --- @@ -637,9 +662,9 @@ Represents the possible transfer restrictions of a claim matching the hypercerts #### Defined in -[sdk/src/types/hypercerts.ts:9](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/hypercerts.ts#L9) +[sdk/src/types/hypercerts.ts:9](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/hypercerts.ts#L9) -[sdk/src/types/hypercerts.ts:15](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/types/hypercerts.ts#L15) +[sdk/src/types/hypercerts.ts:15](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/types/hypercerts.ts#L15) --- @@ -653,7 +678,7 @@ Represents the possible transfer restrictions of a claim matching the hypercerts #### Defined in -[sdk/src/constants.ts:12](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/constants.ts#L12) +[sdk/src/constants.ts:13](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/constants.ts#L13) --- @@ -663,7 +688,7 @@ Represents the possible transfer restrictions of a claim matching the hypercerts #### Defined in -[sdk/src/constants.ts:18](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/constants.ts#L18) +[sdk/src/constants.ts:19](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/constants.ts#L19) --- @@ -682,7 +707,7 @@ Represents the possible transfer restrictions of a claim matching the hypercerts #### Defined in -[sdk/src/utils/logger.ts:24](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/utils/logger.ts#L24) +[sdk/src/utils/logger.ts:24](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/utils/logger.ts#L24) ## Functions @@ -721,7 +746,7 @@ Formats input data to an object containing HypercertMetadata including appropria #### Defined in -[sdk/src/utils/formatter.ts:27](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/utils/formatter.ts#L27) +[sdk/src/utils/formatter.ts:27](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/utils/formatter.ts#L27) --- @@ -811,7 +836,7 @@ This method is a wrapper around basic viem utilties to parse ClaimStored(uint256 #### Defined in -[sdk/src/utils/txParser.ts:26](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/utils/txParser.ts#L26) +[sdk/src/utils/txParser.ts:26](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/utils/txParser.ts#L26) --- @@ -845,7 +870,7 @@ Will throw a `StoragjeError` if the data cannot be fetched from either gateway. #### Defined in -[sdk/src/utils/fetchers.ts:17](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/utils/fetchers.ts#L17) +[sdk/src/utils/fetchers.ts:17](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/utils/fetchers.ts#L17) --- @@ -880,7 +905,7 @@ Will throw an error if the Merkle tree cannot be fetched. #### Defined in -[sdk/src/utils/allowlist.ts:43](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/utils/allowlist.ts#L43) +[sdk/src/utils/allowlist.ts:43](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/utils/allowlist.ts#L43) --- @@ -919,7 +944,7 @@ Please regenerate the types. #### Defined in -[sdk/src/indexer/gql/gql.ts:32](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/indexer/gql/gql.ts#L32) +[sdk/src/indexer/gql/gql.ts:32](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/gql.ts#L32) ▸ **graphql**(`source`): typeof `documents`[``"query ClaimsByOwner($owner: Bytes = \"\", $orderDirection: OrderDirection, $first: Int, $skip: Int) {\n claims(\n where: {owner: $owner}\n skip: $skip\n first: $first\n orderDirection: $orderDirection\n ) {\n contract\n tokenID\n creator\n id\n owner\n totalUnits\n uri\n }\n}\n\nquery RecentClaims($orderDirection: OrderDirection, $first: Int, $skip: Int) {\n claims(orderDirection: $orderDirection, orderBy: creation, first: $first) {\n contract\n tokenID\n creator\n id\n owner\n totalUnits\n uri\n }\n}\n\nquery ClaimById($id: ID!) {\n claim(id: $id) {\n contract\n tokenID\n creator\n id\n owner\n totalUnits\n uri\n }\n}"``] @@ -937,7 +962,7 @@ typeof `documents`[``"query ClaimsByOwner($owner: Bytes = \"\", $orderDirection: #### Defined in -[sdk/src/indexer/gql/gql.ts:37](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/indexer/gql/gql.ts#L37) +[sdk/src/indexer/gql/gql.ts:37](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/gql.ts#L37) ▸ **graphql**(`source`): typeof `documents`[``"query ClaimTokensByOwner($owner: Bytes = \"\", $orderDirection: OrderDirection, $first: Int, $skip: Int) {\n claimTokens(\n where: {owner: $owner}\n skip: $skip\n first: $first\n orderDirection: $orderDirection\n ) {\n id\n owner\n tokenID\n units\n claim {\n id\n creation\n uri\n totalUnits\n }\n }\n}\n\nquery ClaimTokensByClaim($claimId: String!, $orderDirection: OrderDirection, $first: Int, $skip: Int) {\n claimTokens(\n where: {claim: $claimId}\n skip: $skip\n first: $first\n orderDirection: $orderDirection\n ) {\n id\n owner\n tokenID\n units\n }\n}\n\nquery ClaimTokenById($claimTokenId: ID!) {\n claimToken(id: $claimTokenId) {\n id\n owner\n tokenID\n units\n claim {\n id\n creation\n uri\n totalUnits\n }\n }\n}"``] @@ -955,7 +980,7 @@ typeof `documents`[``"query ClaimTokensByOwner($owner: Bytes = \"\", $orderDirec #### Defined in -[sdk/src/indexer/gql/gql.ts:41](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/indexer/gql/gql.ts#L41) +[sdk/src/indexer/gql/gql.ts:41](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/gql.ts#L41) --- @@ -975,7 +1000,7 @@ typeof `documents`[``"query ClaimTokensByOwner($owner: Bytes = \"\", $orderDirec #### Defined in -[sdk/src/utils/errors.ts:39](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/utils/errors.ts#L39) +[sdk/src/utils/errors.ts:39](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/utils/errors.ts#L39) --- @@ -997,7 +1022,7 @@ Method to catch errors and log them #### Defined in -[sdk/src/utils/errors.ts:22](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/utils/errors.ts#L22) +[sdk/src/utils/errors.ts:22](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/utils/errors.ts#L22) --- @@ -1026,7 +1051,7 @@ data is [TFrag] extends [Object] ? TKey extends string ? Object : never : never #### Defined in -[sdk/src/indexer/gql/fragment-masking.ts:51](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/indexer/gql/fragment-masking.ts#L51) +[sdk/src/indexer/gql/fragment-masking.ts:51](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/fragment-masking.ts#L51) --- @@ -1054,7 +1079,7 @@ data is [TFrag] extends [Object] ? TKey extends string ? Object : never : never #### Defined in -[sdk/src/indexer/gql/fragment-masking.ts:45](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/indexer/gql/fragment-masking.ts#L45) +[sdk/src/indexer/gql/fragment-masking.ts:45](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/fragment-masking.ts#L45) --- @@ -1074,7 +1099,33 @@ data is [TFrag] extends [Object] ? TKey extends string ? Object : never : never #### Defined in -[sdk/src/utils/allowlist.ts:6](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/utils/allowlist.ts#L6) +[sdk/src/utils/allowlist.ts:6](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/utils/allowlist.ts#L6) + +--- + +### parseClaimOrFractionId + +▸ **parseClaimOrFractionId**(`claimId`): `Object` + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `claimId` | `string` | + +#### Returns + +`Object` + +| Name | Type | +| :---------------- | :--------------- | +| `chainId` | `number` | +| `contractAddress` | \`0x$\{string}\` | +| `id` | `bigint` | + +#### Defined in + +[sdk/src/utils/parsing.ts:3](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/utils/parsing.ts#L3) --- @@ -1166,7 +1217,7 @@ An ethers.js `Provider` instance, or `undefined` if no chain is found in the `Pu #### Defined in -[sdk/src/utils/adapters.ts:19](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/utils/adapters.ts#L19) +[sdk/src/utils/adapters.ts:19](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/utils/adapters.ts#L19) --- @@ -1191,7 +1242,7 @@ The response data from the API. #### Defined in -[sdk/src/utils/apis.ts:52](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/utils/apis.ts#L52) +[sdk/src/utils/apis.ts:52](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/utils/apis.ts#L52) --- @@ -1216,7 +1267,7 @@ The response data from the API. #### Defined in -[sdk/src/utils/apis.ts:34](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/utils/apis.ts#L34) +[sdk/src/utils/apis.ts:34](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/utils/apis.ts#L34) --- @@ -1243,7 +1294,7 @@ The response data from the API. #### Defined in -[sdk/src/indexer/gql/fragment-masking.ts:18](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/indexer/gql/fragment-masking.ts#L18) +[sdk/src/indexer/gql/fragment-masking.ts:18](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/fragment-masking.ts#L18) ▸ **useFragment**<`TType`\>(`_documentNode`, `fragmentType`): `TType` \| `null` \| `undefined` @@ -1266,7 +1317,7 @@ The response data from the API. #### Defined in -[sdk/src/indexer/gql/fragment-masking.ts:23](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/indexer/gql/fragment-masking.ts#L23) +[sdk/src/indexer/gql/fragment-masking.ts:23](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/fragment-masking.ts#L23) ▸ **useFragment**<`TType`\>(`_documentNode`, `fragmentType`): `ReadonlyArray`<`TType`\> @@ -1289,7 +1340,7 @@ The response data from the API. #### Defined in -[sdk/src/indexer/gql/fragment-masking.ts:28](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/indexer/gql/fragment-masking.ts#L28) +[sdk/src/indexer/gql/fragment-masking.ts:28](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/fragment-masking.ts#L28) ▸ **useFragment**<`TType`\>(`_documentNode`, `fragmentType`): `ReadonlyArray`<`TType`\> \| `null` \| `undefined` @@ -1312,7 +1363,7 @@ The response data from the API. #### Defined in -[sdk/src/indexer/gql/fragment-masking.ts:33](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/indexer/gql/fragment-masking.ts#L33) +[sdk/src/indexer/gql/fragment-masking.ts:33](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/indexer/gql/fragment-masking.ts#L33) --- @@ -1340,7 +1391,7 @@ An object that includes a validity flag and any errors that occurred during vali #### Defined in -[sdk/src/validator/index.ts:108](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/validator/index.ts#L108) +[sdk/src/validator/index.ts:108](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/validator/index.ts#L108) --- @@ -1368,7 +1419,7 @@ An object that includes a validity flag and any errors that occurred during vali #### Defined in -[sdk/src/validator/index.ts:77](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/validator/index.ts#L77) +[sdk/src/validator/index.ts:77](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/validator/index.ts#L77) --- @@ -1396,7 +1447,7 @@ An object that includes a validity flag and any errors that occurred during vali #### Defined in -[sdk/src/validator/index.ts:143](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/validator/index.ts#L143) +[sdk/src/validator/index.ts:143](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/validator/index.ts#L143) --- @@ -1424,7 +1475,7 @@ An object that includes a validity flag and any errors that occurred during vali #### Defined in -[sdk/src/validator/index.ts:46](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/validator/index.ts#L46) +[sdk/src/validator/index.ts:46](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/validator/index.ts#L46) --- @@ -1452,7 +1503,7 @@ An object that includes a validity flag and any errors that occurred during vali #### Defined in -[sdk/src/validator/index.ts:173](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/validator/index.ts#L173) +[sdk/src/validator/index.ts:173](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/validator/index.ts#L173) --- @@ -1484,7 +1535,7 @@ Will throw a `MintingError` if the signer address is invalid or if the Merkle pr #### Defined in -[sdk/src/validator/index.ts:205](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/validator/index.ts#L205) +[sdk/src/validator/index.ts:205](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/validator/index.ts#L205) --- @@ -1516,7 +1567,7 @@ Will throw a `MintingError` if the lengths of the input arrays are not equal or #### Defined in -[sdk/src/validator/index.ts:228](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/validator/index.ts#L228) +[sdk/src/validator/index.ts:228](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/validator/index.ts#L228) --- @@ -1576,4 +1627,4 @@ An ethers.js `Signer` instance, or `undefined` if no chain is found in the `Wall #### Defined in -[sdk/src/utils/adapters.ts:51](https://github.com/hypercerts-org/hypercerts/blob/ffe5811/sdk/src/utils/adapters.ts#L51) +[sdk/src/utils/adapters.ts:51](https://github.com/hypercerts-org/hypercerts/blob/473cc51/sdk/src/utils/adapters.ts#L51)