{"version":1,"pages":[{"id":"iXc0QZHqByUz9GPxlvJe","title":"Product and Features","pathname":"/","siteSpaceId":"sitesp_kM3HX","description":"","breadcrumbs":[{"label":"Chainvine"}]},{"id":"5aqSoA0uaqH9kluwyp5a","title":"Technical Overview","pathname":"/chainvine/technical-overview","siteSpaceId":"sitesp_kM3HX","description":"The developer documentation is split into 5 separate sections","breadcrumbs":[{"label":"Chainvine"}]},{"id":"31l4lnLJ37ybAOXLGp5I","title":"Use Cases","pathname":"/developers/use-cases","siteSpaceId":"sitesp_kM3HX","emoji":"1f528","description":"","breadcrumbs":[{"label":"Developers","emoji":"2699"}]},{"id":"7TBpzS6p8uRbKb9aBIrJ","title":"Leverage cookies","pathname":"/developers/use-cases/leverage-cookies","siteSpaceId":"sitesp_kM3HX","description":"In additional to the ChainvineClient operations, we offer a few global utility methods to assist in keeping track of referrals through the use of cookies.","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"Use Cases","emoji":"1f528"}]},{"id":"cZgXWpDNEMlZHVa3sLVb","title":"Link Claimer/Referrer","pathname":"/developers/use-cases/link-claimer-referrer","siteSpaceId":"sitesp_kM3HX","description":"For claimers to be referred directly to your website rather than first connecting their wallet on ChainVine, you will need to ensure any valid referral is “linked” upon wallet connection.","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"Use Cases","emoji":"1f528"}]},{"id":"lkovZCAKqk4Xhd8lld9O","title":"Record Link Click","pathname":"/developers/use-cases/record-link-click","siteSpaceId":"sitesp_kM3HX","description":"","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"Use Cases","emoji":"1f528"}]},{"id":"mDsMGCKBkHJyQ43e2mag","title":"Generate a Referrer Link","pathname":"/developers/use-cases/generate-a-referrer-link","siteSpaceId":"sitesp_kM3HX","description":"If you would like to bypass ChainVine and supply referrers with a referral URL directly on your webpage, you can generate a referral URL for a given wallet address using the \"url\" endpoint.","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"Use Cases","emoji":"1f528"}]},{"id":"WuYdFl9gj0sA43Oa5M3g","title":"Record a Transfer Event","pathname":"/developers/use-cases/record-a-transfer-event","siteSpaceId":"sitesp_kM3HX","description":"For when you intend to complete a requirement for a user programmatically.","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"Use Cases","emoji":"1f528"}]},{"id":"RUtWgTOGNPvh8lKK2pGO","title":"Complete a Requirement","pathname":"/developers/use-cases/complete-a-requirement","siteSpaceId":"sitesp_kM3HX","description":"For when you intend to complete a requirement for a user programmatically.","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"Use Cases","emoji":"1f528"}]},{"id":"RJTst8wBukkPJy5eK4bM","title":"Embedded Widget","pathname":"/developers/embedded-widget","siteSpaceId":"sitesp_kM3HX","emoji":"1f5bc","description":"Add ChainVine's widget to display your referral program's information on your Web3 site for your logged in user!","breadcrumbs":[{"label":"Developers","emoji":"2699"}]},{"id":"eNMcb292QNVhkoikmdA3","title":"Implementation","pathname":"/developers/embedded-widget/implementation","siteSpaceId":"sitesp_kM3HX","description":"Note: the Widget requires React 18+","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"Embedded Widget","emoji":"1f5bc"}]},{"id":"uhojhGUnR3Tbuwfd3Fak","title":"FAQ","pathname":"/developers/embedded-widget/faq","siteSpaceId":"sitesp_kM3HX","description":"","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"Embedded Widget","emoji":"1f5bc"}]},{"id":"e5eITZWyOwcaZiTx28nF","title":"SDK","pathname":"/developers/sdk","siteSpaceId":"sitesp_kM3HX","emoji":"1f9f0","description":"","breadcrumbs":[{"label":"Developers","emoji":"2699"}]},{"id":"1g1B4PnkvmYK9AVLqdxv","title":"Implementation","pathname":"/developers/sdk/implementation","siteSpaceId":"sitesp_kM3HX","description":"","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"}]},{"id":"vD3w8Kj7SzKcpmNYzW7g","title":"Configuring the Client","pathname":"/developers/sdk/configuring-the-client","siteSpaceId":"sitesp_kM3HX","description":"","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"}]},{"id":"ArBfTrSpaHxNrLHe5vWJ","title":"Classes and Functions","pathname":"/developers/sdk/classes-and-functions","siteSpaceId":"sitesp_kM3HX","description":"","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"}]},{"id":"7hUC45mKB94gLzpoQpH8","title":"Utility Methods","pathname":"/developers/sdk/classes-and-functions/utility-methods","siteSpaceId":"sitesp_kM3HX","description":"We expose a few useful utility methods to aid referrer ID storage when operating in a browser context.","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"},{"label":"Classes and Functions"}]},{"id":"LeAfKEkrc09x0NNVHm4q","title":"ChainvineClient","pathname":"/developers/sdk/classes-and-functions/chainvineclient","siteSpaceId":"sitesp_kM3HX","description":"","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"},{"label":"Classes and Functions"}]},{"id":"gpZWzo4gRRgHo1vAwNU1","title":"getReferralUrl(walletAddress)","pathname":"/developers/sdk/classes-and-functions/chainvineclient/getreferralurl-walletaddress","siteSpaceId":"sitesp_kM3HX","description":"Retrieves the referral URL for a given wallet address.","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"},{"label":"Classes and Functions"},{"label":"ChainvineClient"}]},{"id":"y86Ll7YRzPMmoo6pvxdt","title":"recordClick(referrer)","pathname":"/developers/sdk/classes-and-functions/chainvineclient/recordclick-referrer","siteSpaceId":"sitesp_kM3HX","description":"Logs a referral link click for stats tracking","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"},{"label":"Classes and Functions"},{"label":"ChainvineClient"}]},{"id":"Jk6uWJ9N93xMyYEVdrB3","title":"linkReferrer([payload,])","pathname":"/developers/sdk/classes-and-functions/chainvineclient/linkreferrer-payload","siteSpaceId":"sitesp_kM3HX","description":"Links a referrer using the provided referral link payload.","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"},{"label":"Classes and Functions"},{"label":"ChainvineClient"}]},{"id":"HeY0NoUSMBNw8TzvMTKo","title":"referralConversion([payload,])","pathname":"/developers/sdk/classes-and-functions/chainvineclient/referralconversion-payload","siteSpaceId":"sitesp_kM3HX","description":"Sends referral conversion event.","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"},{"label":"Classes and Functions"},{"label":"ChainvineClient"}]},{"id":"WYBX4dBYQtCKDXbedHYx","title":"syncUser(walletAddress)","pathname":"/developers/sdk/classes-and-functions/chainvineclient/syncuser-walletaddress","siteSpaceId":"sitesp_kM3HX","description":"Allows you to clone ChainvineClient instance scoped to a single wallet address without having to fetch your ClientConfig.","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"},{"label":"Classes and Functions"},{"label":"ChainvineClient"}]},{"id":"89jWrkdbBcQtJ9VlRHz4","title":"getCampaignReferralStats([payload,])","pathname":"/developers/sdk/classes-and-functions/chainvineclient/getcampaignreferralstats-payload","siteSpaceId":"sitesp_kM3HX","description":"We expose some useful campaign information via the SDK, this is accessible via the getCampaignReferralStats method","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"},{"label":"Classes and Functions"},{"label":"ChainvineClient"}]},{"id":"asPiluD7o4yftKAYJlIT","title":"ChainvineUser","pathname":"/developers/sdk/classes-and-functions/chainvineuser","siteSpaceId":"sitesp_kM3HX","description":"","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"},{"label":"Classes and Functions"}]},{"id":"UD1RhTsew7CVC6kNV655","title":"Initializing the client","pathname":"/developers/sdk/classes-and-functions/chainvineuser/initializing-the-client","siteSpaceId":"sitesp_kM3HX","description":"","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"},{"label":"Classes and Functions"},{"label":"ChainvineUser"}]},{"id":"Xg5GH4wUxcQ70kLrySNn","title":"joinCampaign([campaignParams,])","pathname":"/developers/sdk/classes-and-functions/chainvineuser/joincampaign-campaignparams","siteSpaceId":"sitesp_kM3HX","description":"Send a request to join a user to a referral program/campaign.","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"},{"label":"Classes and Functions"},{"label":"ChainvineUser"}]},{"id":"VnkqTbTToFqZXQnfeVrt","title":"getRequirement([payload,])","pathname":"/developers/sdk/classes-and-functions/chainvineuser/getrequirement-payload","siteSpaceId":"sitesp_kM3HX","description":"Fetches the completion status of a program requirement for the user","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"},{"label":"Classes and Functions"},{"label":"ChainvineUser"}]},{"id":"kibeXeexibWNlPUtbybJ","title":"getUserStats([payload,])","pathname":"/developers/sdk/classes-and-functions/chainvineuser/getuserstats-payload","siteSpaceId":"sitesp_kM3HX","description":"Fetches the completion status of a program requirement for the user","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"},{"label":"Classes and Functions"},{"label":"ChainvineUser"}]},{"id":"Yitk4vwMuX1gMNdStL33","title":"verifyRequirement([payload,])","pathname":"/developers/sdk/classes-and-functions/chainvineuser/verifyrequirement-payload","siteSpaceId":"sitesp_kM3HX","description":"Attempts to verify a requirement for the user","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"},{"label":"Classes and Functions"},{"label":"ChainvineUser"}]},{"id":"hHEZOrC94gjiYqzYphUF","title":"completeRequirement([payload,])","pathname":"/developers/sdk/classes-and-functions/chainvineuser/completerequirement-payload","siteSpaceId":"sitesp_kM3HX","description":"Mark a program/campaign requirement as completed for the user","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"},{"label":"Classes and Functions"},{"label":"ChainvineUser"}]},{"id":"lm2aRCse67DgRqEnxxqk","title":"claimEligibleEarnings([payload,])","pathname":"/developers/sdk/classes-and-functions/chainvineuser/claimeligibleearnings-payload","siteSpaceId":"sitesp_kM3HX","description":"Claim eligible cryptocurrency earnings for a user of your campaign","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"},{"label":"Classes and Functions"},{"label":"ChainvineUser"}]},{"id":"1J5GJ0CF4J0gNlwMgtRs","title":"transferEvent([payload,])","pathname":"/developers/sdk/classes-and-functions/chainvineuser/transferevent-payload","siteSpaceId":"sitesp_kM3HX","description":"","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"},{"label":"Classes and Functions"},{"label":"ChainvineUser"}]},{"id":"kZgcensbA5Xfg0dc7kEz","title":"referral([campaignParams,])","pathname":"/developers/sdk/classes-and-functions/chainvineuser/referral-campaignparams","siteSpaceId":"sitesp_kM3HX","description":"","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"},{"label":"Classes and Functions"},{"label":"ChainvineUser"}]},{"id":"j5I6bMKDd18p8GLqqbBd","title":"linkToReferrer(referrer)","pathname":"/developers/sdk/classes-and-functions/chainvineuser/referral-campaignparams/linktoreferrer-referrer","siteSpaceId":"sitesp_kM3HX","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"},{"label":"Classes and Functions"},{"label":"ChainvineUser"},{"label":"referral([campaignParams,])"}]},{"id":"VIFtrM4X6McAtAKyw0RH","title":"url()","pathname":"/developers/sdk/classes-and-functions/chainvineuser/referral-campaignparams/url","siteSpaceId":"sitesp_kM3HX","description":"","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"},{"label":"Classes and Functions"},{"label":"ChainvineUser"},{"label":"referral([campaignParams,])"}]},{"id":"iJd7ODyBizbxVqauDO8w","title":"setRewardTiersOverride([payload,])","pathname":"/developers/sdk/classes-and-functions/chainvineuser/setrewardtiersoverride-payload","siteSpaceId":"sitesp_kM3HX","description":"We allow tier percentage overriding should you wish to specify a custom percentage reward for specific users","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"},{"label":"Classes and Functions"},{"label":"ChainvineUser"}]},{"id":"BSRMLt2z0UcVT9LQWDIy","title":"Errors","pathname":"/developers/sdk/classes-and-functions/errors","siteSpaceId":"sitesp_kM3HX","description":"","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"},{"label":"Classes and Functions"}]},{"id":"PSYPUrxohCmz6YYnaMqN","title":"Authentication","pathname":"/developers/sdk/classes-and-functions/authentication","siteSpaceId":"sitesp_kM3HX","description":"","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"},{"label":"Classes and Functions"}]},{"id":"0x5XIQah2fsanV03d519","title":"Getting your API Key","pathname":"/developers/sdk/classes-and-functions/authentication/getting-your-api-key","siteSpaceId":"sitesp_kM3HX","description":"","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"},{"label":"Classes and Functions"},{"label":"Authentication"}]},{"id":"DoashqnqNhf5Ru3jwC6G","title":"Allow-listing a domain","pathname":"/developers/sdk/classes-and-functions/authentication/allow-listing-a-domain","siteSpaceId":"sitesp_kM3HX","description":"","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"},{"label":"Classes and Functions"},{"label":"Authentication"}]},{"id":"7x30D3o39HraIwerjVlr","title":"FAQ","pathname":"/developers/sdk/faq","siteSpaceId":"sitesp_kM3HX","description":"","breadcrumbs":[{"label":"Developers","emoji":"2699"},{"label":"SDK","emoji":"1f9f0"}]},{"id":"A0Zzs1C2qiCflOrQpSN4","title":"Webhooks","pathname":"/developers/webhooks","siteSpaceId":"sitesp_kM3HX","emoji":"1fa9d","description":"","breadcrumbs":[{"label":"Developers","emoji":"2699"}]},{"id":"CKz7pC70ra2l5ck0o0tW","title":"Open API Specification","pathname":"/developers/open-api-specification","siteSpaceId":"sitesp_kM3HX","emoji":"1f4d4","description":"","breadcrumbs":[{"label":"Developers","emoji":"2699"}]},{"id":"OGhSO6LJw4zLLXzwfMWc","title":"Claiming For Users","pathname":"/rewards/claiming-for-users","siteSpaceId":"sitesp_kM3HX","breadcrumbs":[{"label":"Rewards"}]},{"id":"q1FGEnadFwAAlQvupWit","title":"On ChainVine","pathname":"/rewards/claiming-for-users/on-chainvine","siteSpaceId":"sitesp_kM3HX","breadcrumbs":[{"label":"Rewards"},{"label":"Claiming For Users"}]}]}