Merge pull request #1263 from hypercerts-org/feat/annoucements_in_docs

chore(docs): cleanup and add announcements

Author: bitbeckers

docs/docs/announcements/2024_01_16_An_Impactful_Year.md

@@ -0,0 +1,24 @@
+---
+title: An Impactful Year
+id: an-impactful-year.md
+---
+
+# Announcements
+
+### Hypercerts are a new token standard for tracking and rewarding positive impact.
+
+Gm gm. We’re wishing you an impactful 2024. We’re excited for the things ahead!
+
+2023 has been a year of maturing the foundations laid by the release of the protocol. Together with Grants Stack, Funding the Commons, da0, Zuzalu and many other partners, we’ve successfully run a set of hypercerts pilots. We are grateful for our partners and the enthusiasm of their communities about hypercerts. At every event, we feel the positive energy about hypercerts and about the value mechanism they can unlock.
+
+At the end of the year, we started developing the hypercert marketplace, which will be released on Sepolia later this week. The marketplace is a fork of LooksRare with modifications to add native support for hypercerts. Thanks to their high quality open source code we were able to use both their exchange contracts as well as the SDK. Special credits go to [Trust Security](https://x.com/trust__90) for not only thoroughly reviewing the changes we’ve made to the stack, but also for going beyond their scope to help us improve our protocol.
+
+To help developers get onboarded with our tec,h we’ve released a [Next.JS starter app](https://github.com/hypercerts-org/hypercert-nextjs-chakra-starter), a repo with minimal [demo apps](https://github.com/hypercerts-org/demo-apps) for JS, TS on both server and client side, and of course, the [hypercerts SDK v1](https://www.npmjs.com/package/@hypercerts-org/sdk). The SDK provides methods and utilities for minting and claiming hypercerts, validating datasets, and uploading to and fetching from IPFS.
+
+All of this work is supported by GG19, the first Octant epoch, Optimism’s retroPGF and of course Protocol Labs. A big thank you to all supporters.
+
+In the next months, we’ll work with close collaborators to build out the evaluation functionalities and provide support to projects that want to integrate hypercerts into their funding systems (similar to how we are integrating hypercerts with Gitcoin) or want to build new applications using hypercerts. If you want to build on top of the hypercerts protocol, please get in contact with us.
+
+Excited and grateful,
+
+The hypercerts team

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/d4ff8ba/sdk/src/types/errors.ts#L27)
+[sdk/src/types/errors.ts:27](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/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/d4ff8ba/sdk/src/types/errors.ts#L20)
+[sdk/src/types/errors.ts:20](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/types/errors.ts#L20)
 
 ---
 

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/d4ff8ba/sdk/src/types/errors.ts#L188)
+[sdk/src/types/errors.ts:188](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/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/d4ff8ba/sdk/src/types/errors.ts#L187)
+[sdk/src/types/errors.ts:187](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/types/errors.ts#L187)
 
 ---
 

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/d4ff8ba/sdk/src/types/errors.ts#L43)
+[sdk/src/types/errors.ts:43](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/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/d4ff8ba/sdk/src/types/errors.ts#L41)
+[sdk/src/types/errors.ts:41](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/types/errors.ts#L41)
 
 ---
 

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/d4ff8ba/sdk/src/types/errors.ts#L65)
+[sdk/src/types/errors.ts:65](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/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/d4ff8ba/sdk/src/types/errors.ts#L58)
+[sdk/src/types/errors.ts:58](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/types/errors.ts#L58)
 
 ---
 

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:58](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L58)
+[sdk/src/client.ts:58](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L58)
 
 ## Properties
 
@@ -64,7 +64,7 @@ Will throw a `ClientError` if the public client cannot be connected.
 
 #### Defined in
 
-[sdk/src/client.ts:41](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L41)
+[sdk/src/client.ts:41](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L41)
 
 ---
 
@@ -74,7 +74,7 @@ Will throw a `ClientError` if the public client cannot be connected.
 
 #### Defined in
 
-[sdk/src/client.ts:44](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L44)
+[sdk/src/client.ts:44](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L44)
 
 ---
 
@@ -84,7 +84,7 @@ Will throw a `ClientError` if the public client cannot be connected.
 
 #### Defined in
 
-[sdk/src/client.ts:45](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L45)
+[sdk/src/client.ts:45](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L45)
 
 ---
 
@@ -158,7 +158,7 @@ Will throw a `ClientError` if the public client cannot be connected.
 
 #### Defined in
 
-[sdk/src/client.ts:46](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L46)
+[sdk/src/client.ts:46](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L46)
 
 ---
 
@@ -168,7 +168,7 @@ Will throw a `ClientError` if the public client cannot be connected.
 
 #### Defined in
 
-[sdk/src/client.ts:42](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L42)
+[sdk/src/client.ts:42](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L42)
 
 ---
 
@@ -212,7 +212,7 @@ Will throw a `ClientError` if the public client cannot be connected.
 
 #### Defined in
 
-[sdk/src/client.ts:47](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L47)
+[sdk/src/client.ts:47](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L47)
 
 ---
 
@@ -228,7 +228,7 @@ Whether the client is in read-only mode.
 
 #### Defined in
 
-[sdk/src/client.ts:48](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L48)
+[sdk/src/client.ts:48](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L48)
 
 ## Accessors
 
@@ -246,7 +246,7 @@ The client config.
 
 #### Defined in
 
-[sdk/src/client.ts:82](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L82)
+[sdk/src/client.ts:82](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L82)
 
 ---
 
@@ -272,7 +272,7 @@ Use getDeployments instead.
 
 #### Defined in
 
-[sdk/src/client.ts:107](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L107)
+[sdk/src/client.ts:107](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L107)
 
 ---
 
@@ -294,7 +294,7 @@ The indexer.
 
 #### Defined in
 
-[sdk/src/client.ts:98](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L98)
+[sdk/src/client.ts:98](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L98)
 
 ---
 
@@ -316,7 +316,7 @@ The storage layer.
 
 #### Defined in
 
-[sdk/src/client.ts:90](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L90)
+[sdk/src/client.ts:90](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L90)
 
 ## Methods
 
@@ -355,7 +355,7 @@ Will throw an `InvalidOrMissingError` if any of the proofs are invalid.
 
 #### Defined in
 
-[sdk/src/client.ts:454](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L454)
+[sdk/src/client.ts:454](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L454)
 
 ---
 
@@ -388,7 +388,7 @@ A promise that resolves to the transaction hash.
 
 #### Defined in
 
-[sdk/src/client.ts:216](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L216)
+[sdk/src/client.ts:216](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L216)
 
 ---
 
@@ -425,7 +425,7 @@ Will throw a `ClientError` if the claim is not owned by the account.
 
 #### Defined in
 
-[sdk/src/client.ts:377](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L377)
+[sdk/src/client.ts:377](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L377)
 
 ---
 
@@ -466,7 +466,7 @@ Will throw a `MalformedDataError` if the provided allowlist or metadata is inval
 
 #### Defined in
 
-[sdk/src/client.ts:249](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L249)
+[sdk/src/client.ts:249](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L249)
 
 ---
 
@@ -486,7 +486,7 @@ Will throw a `MalformedDataError` if the provided allowlist or metadata is inval
 
 #### Defined in
 
-[sdk/src/client.ts:485](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L485)
+[sdk/src/client.ts:485](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L485)
 
 ---
 
@@ -506,7 +506,7 @@ Will throw a `MalformedDataError` if the provided allowlist or metadata is inval
 
 #### Defined in
 
-[sdk/src/client.ts:502](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L502)
+[sdk/src/client.ts:502](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L502)
 
 ---
 
@@ -520,7 +520,7 @@ Will throw a `MalformedDataError` if the provided allowlist or metadata is inval
 
 #### Defined in
 
-[sdk/src/client.ts:491](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L491)
+[sdk/src/client.ts:491](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L491)
 
 ---
 
@@ -552,7 +552,7 @@ Use getDeployments instead.
 
 #### Defined in
 
-[sdk/src/client.ts:120](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L120)
+[sdk/src/client.ts:120](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L120)
 
 ---
 
@@ -582,7 +582,7 @@ a Promise that resolves to the applicable transfer restrictions.
 
 #### Defined in
 
-[sdk/src/client.ts:168](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L168)
+[sdk/src/client.ts:168](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L168)
 
 ---
 
@@ -630,7 +630,7 @@ a Promise that resolves to the applicable transfer restrictions.
 
 #### Defined in
 
-[sdk/src/client.ts:512](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L512)
+[sdk/src/client.ts:512](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L512)
 
 ---
 
@@ -667,7 +667,7 @@ Will throw a `ClientError` if any of the fractions are not owned by the account.
 
 #### Defined in
 
-[sdk/src/client.ts:336](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L336)
+[sdk/src/client.ts:336](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L336)
 
 ---
 
@@ -707,7 +707,7 @@ Will throw a `MalformedDataError` if the provided metadata is invalid.
 
 #### Defined in
 
-[sdk/src/client.ts:139](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L139)
+[sdk/src/client.ts:139](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L139)
 
 ---
 
@@ -746,7 +746,7 @@ Will throw an `InvalidOrMissingError` if the proof is invalid.
 
 #### Defined in
 
-[sdk/src/client.ts:410](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L410)
+[sdk/src/client.ts:410](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L410)
 
 ---
 
@@ -769,7 +769,7 @@ Will throw an `InvalidOrMissingError` if the proof is invalid.
 
 #### Defined in
 
-[sdk/src/client.ts:522](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L522)
+[sdk/src/client.ts:522](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L522)
 
 ---
 
@@ -808,7 +808,7 @@ Will throw a `ClientError` if the fraction is not owned by the account or if the
 
 #### Defined in
 
-[sdk/src/client.ts:291](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L291)
+[sdk/src/client.ts:291](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L291)
 
 ---
 
@@ -838,7 +838,7 @@ Will throw a `ClientError` if the request fails.
 
 #### Defined in
 
-[sdk/src/client.ts:553](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L553)
+[sdk/src/client.ts:553](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L553)
 
 ---
 
@@ -871,4 +871,4 @@ A promise that resolves to the transaction hash.
 
 #### Defined in
 
-[sdk/src/client.ts:188](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/client.ts#L188)
+[sdk/src/client.ts:188](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/client.ts#L188)

docs/docs/developer/api/sdk/classes/HypercertsStorage.md

@@ -71,7 +71,7 @@ Note: The original implementation using the Web3 Storage client is currently com
 
 #### Defined in
 
-[sdk/src/storage.ts:128](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/storage.ts#L128)
+[sdk/src/storage.ts:128](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/storage.ts#L128)
 
 ---
 
@@ -106,7 +106,7 @@ Will throw a `MalformedDataError` if the retrieved data is invalid.
 
 #### Defined in
 
-[sdk/src/storage.ts:105](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/storage.ts#L105)
+[sdk/src/storage.ts:105](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/storage.ts#L105)
 
 ---
 
@@ -147,7 +147,7 @@ Will throw a `MalformedDataError` if the provided metadata is invalid.
 
 #### Defined in
 
-[sdk/src/storage.ts:34](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/storage.ts#L34)
+[sdk/src/storage.ts:34](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/storage.ts#L34)
 
 ---
 
@@ -187,4 +187,4 @@ Will throw a `MalformedDataError` if the provided metadata is invalid.
 
 #### Defined in
 
-[sdk/src/storage.ts:74](https://github.com/hypercerts-org/hypercerts/blob/d4ff8ba/sdk/src/storage.ts#L74)
+[sdk/src/storage.ts:74](https://github.com/hypercerts-org/hypercerts/blob/15d38fc/sdk/src/storage.ts#L74)