feat: add referrals service client with store, retrieve, and list methods#3
Open
feat: add referrals service client with store, retrieve, and list methods#3
Conversation
- Updated links in ContractError, EncodingError, and ValidationError documentation to reflect the latest commit hash. - Adjusted links for utility functions such as bytesToHex, checksumAddress, and cidV0ToHex to point to the correct lines in the updated codebase. - Added missing documentation links for functions related to error handling and ABI encoding. - Included the referrals package in the TypeDoc configuration for better documentation coverage.
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces a new referrals service client to the Circles SDK, enabling users to store, retrieve, and list referral links via a dedicated backend. The main changes include adding the
@aboutcircles/sdk-referralspackage, integrating it into the main SDK, and updating configuration options to support referral functionalities.Referrals service client implementation:
@aboutcircles/sdk-referralspackage, includingpackage.json, TypeScript configuration, and implementation files for the referrals client and type definitions. [1] [2] [3] [4] [5]SDK integration:
@aboutcircles/sdk-referralsas a dependency in the main SDK package.Referralsclient inSdk.ts, conditionally based on the presence of a referrals service URL in the configuration. [1] [2] [3]New SDK API for referrals:
referralsproperty to the mainSdkclass, exposing methods for storing a referral, retrieving referral info, and listing referrals for the authenticated user, with appropriate error handling if the service is not configured.Configuration update:
CirclesConfiginterface to include an optionalreferralsServiceUrlproperty for enabling referral features.