Learn about how to use the Boost Core contract with the SDK
The One-Time Actions docs are under active development and will be subject to changes.
Smart Contract
Read the smart contracts
Typedoc
See technical documentation
SDK Implementation
See the source
The Boost Core contract is the protocol’s main touchpoint for Boosts, exposing functionality to create and retrieve Boosts, and claim incentives.
Unless you’re an advanced user, you will likely never need to deploy your own core contract. The SDK comes preconfigured with the correct contract addresses for all deployed core implementations.
import { BoostCore } from '@boostxyz/sdk/BoostCore'// you can also access BoostCore from the root exportimport { BoostCore } from '@boostxyz/sdk'// Basic instantiationconst core = new BoostCore({ config: wagmiConfig })// In Node, you'll need to supply a viem local account https://viem.sh/docs/accounts/local.htmlconst core = new BoostCore({ config: wagmiConfig, ...(!!account && { account: viemLocalAccount }) })
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Boost Docs","description":"Documentation for Boost Time-Based Incentives, One-Time Actions, and API integrations.","colors":{"primary":"#202042","light":"#43e661","dark":"#202042"},"logo":{"light":"https://mintcdn.com/boost-b69a8212/8awWvH29Q4HvirwY/assets/boost-icon-black.svg?fit=max\u0026auto=format\u0026n=8awWvH29Q4HvirwY\u0026q=85\u0026s=37d5ec9610c332ffef9272be581b0c0f","dark":"https://mintcdn.com/boost-b69a8212/8awWvH29Q4HvirwY/assets/boost-icon-white.svg?fit=max\u0026auto=format\u0026n=8awWvH29Q4HvirwY\u0026q=85\u0026s=f1898e4885d18e584ae88147b48ffb9c"},"favicon":"https://mintcdn.com/boost-b69a8212/8awWvH29Q4HvirwY/assets/boost-icon-black.svg?fit=max\u0026auto=format\u0026n=8awWvH29Q4HvirwY\u0026q=85\u0026s=37d5ec9610c332ffef9272be581b0c0f","api":{"openapi":"https://api-v2.boost.xyz/openapi.json"},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"boost.xyz","href":"https://boost.xyz"}},"footer":{"socials":{"x":"https://x.com/boost_xyz","github":"https://github.com/orgs/boostxyz/repositories?type=source\u0026q=visibility%3Apublic+archived%3Afalse"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"boost-b69a8212","hasAudioNarration":false,"actualSubdomain":"boost-b69a8212","customDomains":["docs.boost.xyz"],"gitSource":{"type":"github","owner":"boostxyz","repo":"boost-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e64333a4518725aab547","collectionId":"c63c9871-afe3-4abb-974b-cddd3d03023f","schemaVersion":"v2"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ae920eefb1d10c3791d0b87:success","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"default","tag":"One-Time Actions","count":64},{"language":"default","tag":"SDK","count":40},{"language":"default","tag":"Reference","count":28},{"language":"default","tag":"One-Time Actions API","count":27},{"language":"default","tag":"Incentives","count":18},{"language":"default","tag":"Boost","count":12},{"language":"default","tag":"Action Creation","count":10},{"language":"default","tag":"Time-Based Incentives","count":9},{"language":"default","tag":"Developers","count":5},{"language":"default","tag":"Core Concepts","count":4}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"v2/boost-sdk/boost-core/overview","slug":"/v2/boost-sdk/boost-core/overview","pageMetadata":{"title":"Overview","description":"Learn about how to use the Boost Core contract with the SDK","href":"/v2/boost-sdk/boost-core/overview"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Learn about how to use the Boost Core contract with the SDK\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{Card,CardGroup,CodeBlock,Heading,Tip,Warning}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Tip)_missingMdxReference(`Tip`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Warning,{children:_jsx(_components.p,{children:`The One-Time Actions docs are under active development and will be subject to changes.`})}),`\n`,_jsxs(CardGroup,{cols:3,children:[_jsx(Card,{title:`Smart Contract`,icon:`file-contract`,href:`https://github.com/boostxyz/boost-protocol/blob/main/packages/evm/contracts/BoostCore.sol`,children:_jsx(_components.p,{children:`Read the smart contracts`})}),_jsx(Card,{title:`Typedoc`,icon:`file-lines`,href:`https://sdk.boost.xyz/classes/BoostCore.html`,children:_jsx(_components.p,{children:`See technical documentation`})}),_jsx(Card,{title:`SDK Implementation`,icon:`file-code`,href:`https://github.com/boostxyz/boost-protocol/blob/main/packages/sdk/src/BoostCore.ts`,children:_jsx(_components.p,{children:`See the source`})})]}),`\n`,_jsx(_components.p,{children:`The Boost Core contract is the protocol’s main touchpoint for Boosts, exposing functionality to create and retrieve Boosts, and claim incentives.`}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`Unless you’re an advanced user, you will likely never need to deploy your own `,_jsx(_components.code,{children:`core`}),` contract. The `,_jsx(_components.code,{children:`SDK`}),` comes preconfigured with the correct contract addresses for all deployed core implementations.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`usage`,children:`Usage`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`9`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`9`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`BoostCore`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` } `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '@boostxyz/sdk/BoostCore'`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// you can also access BoostCore from the root export`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`BoostCore`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` } `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '@boostxyz/sdk'`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// Basic instantiation`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` core`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` new`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` BoostCore`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`({ `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`config:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` wagmiConfig`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` })`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// In Node, you'll need to supply a viem local account https://viem.sh/docs/accounts/local.html`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` core`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` new`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` BoostCore`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`({ `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`config:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` wagmiConfig`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`...`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`!!`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`account`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` \u0026\u0026`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`account:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` viemLocalAccount`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }) })`})]}),`\n`]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Overview","description":"Learn about how to use the Boost Core contract with the SDK","href":"/v2/boost-sdk/boost-core/overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Usage","slug":"usage","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"boost-b69a8212","siteName":"Boost Docs","title":"Overview - Boost Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-29T16:59:58.556Z","originalFileLocation":"v2/boost-sdk/boost-core/overview.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Learn about how to use the Boost Core contract with the SDK\">\u003cmeta data-mint-head name=\"application-name\" content=\"Boost Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/boost-b69a8212/_qFsTjBsJi7OTb98/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/boost-b69a8212/_qFsTjBsJi7OTb98/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/boost-b69a8212/_qFsTjBsJi7OTb98/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/boost-b69a8212/_qFsTjBsJi7OTb98/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/boost-b69a8212/_qFsTjBsJi7OTb98/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/boost-b69a8212/_qFsTjBsJi7OTb98/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/boost-b69a8212/_qFsTjBsJi7OTb98/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/boost-b69a8212/_qFsTjBsJi7OTb98/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/boost-b69a8212/_qFsTjBsJi7OTb98/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Overview - Boost Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Learn about how to use the Boost Core contract with the SDK\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Boost Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.boost.xyz/v2/boost-sdk/boost-core/overview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://boost-b69a8212.mintlify.site/_mintlify/api/og/v2?division=Boost+Core\u0026amp;title=Overview\u0026amp;description=Learn+about+how+to+use+the+Boost+Core+contract+with+the+SDK\u0026amp;theme=335bc0a7a6d43dc58130bb5e\u0026amp;signature=423503d0c11bfb5b280003d6903ef7de0c88e134d9a633298f85f8ea512a5e41\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Overview - Boost Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Learn about how to use the Boost Core contract with the SDK\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://boost-b69a8212.mintlify.site/_mintlify/api/og/v2?division=Boost+Core\u0026amp;title=Overview\u0026amp;description=Learn+about+how+to+use+the+Boost+Core+contract+with+the+SDK\u0026amp;theme=335bc0a7a6d43dc58130bb5e\u0026amp;signature=423503d0c11bfb5b280003d6903ef7de0c88e134d9a633298f85f8ea512a5e41\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/boost-b69a8212/_qFsTjBsJi7OTb98/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Boost Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#202042\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.boost.xyz/v2/boost-sdk/boost-core/overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v2/boost-sdk/boost-core/overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.boost.xyz/#organization\",\"name\":\"Boost Docs\",\"url\":\"https://docs.boost.xyz\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/boost-b69a8212/8awWvH29Q4HvirwY/assets/boost-icon-black.svg?fit=max\u0026auto=format\u0026n=8awWvH29Q4HvirwY\u0026q=85\u0026s=37d5ec9610c332ffef9272be581b0c0f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.boost.xyz#website\",\"name\":\"Boost Docs\",\"url\":\"https://docs.boost.xyz\",\"publisher\":{\"@id\":\"https://docs.boost.xyz/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.boost.xyz/v2/boost-sdk/boost-core/overview#webpage\",\"url\":\"https://docs.boost.xyz/v2/boost-sdk/boost-core/overview\",\"name\":\"Overview\",\"description\":\"Learn about how to use the Boost Core contract with the SDK\",\"dateModified\":\"2026-04-29T16:59:58.556Z\",\"isPartOf\":{\"@id\":\"https://docs.boost.xyz#website\"},\"breadcrumb\":{\"@id\":\"https://docs.boost.xyz/v2/boost-sdk/boost-core/overview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.boost.xyz/v2/boost-sdk/boost-core/overview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"SDK\",\"item\":\"https://docs.boost.xyz/v2/boost-sdk/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Overview\",\"item\":\"https://docs.boost.xyz/v2/boost-sdk/boost-core/overview\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.boost.xyz/v2/boost-sdk/boost-core/overview#article\",\"headline\":\"Overview\",\"name\":\"Overview\",\"description\":\"Learn about how to use the Boost Core contract with the SDK\",\"url\":\"https://docs.boost.xyz/v2/boost-sdk/boost-core/overview\",\"mainEntityOfPage\":{\"@id\":\"https://docs.boost.xyz/v2/boost-sdk/boost-core/overview#webpage\"},\"dateModified\":\"2026-04-29T16:59:58.556Z\",\"publisher\":{\"@id\":\"https://docs.boost.xyz/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.boost.xyz#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Boost Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Boost Docs","nav":{"global":null,"tabs":[{"tab":"Boost","pages":[{"title":"Boost","href":"/platform/overview"}]},{"tab":"Time-Based Incentives","pages":[{"title":"Time-Based Incentives","href":"/tbi/introduction"}]},{"tab":"One-Time Actions","groups":[{"group":"Overview","pages":[{"title":"One-Time Actions","href":"/v2/documentation/overview/introduction"}]},{"group":"Getting Started","pages":[{"title":"Setting up Accounts","href":"/v2/documentation/getting-started/setting-up-accounts"},{"title":"Setting up an Action","href":"/v2/documentation/getting-started/setting-up-an-action"},{"title":"Deploying a One-Time Action","href":"/v2/documentation/getting-started/deploying-a-boost"},{"title":"Managing One-Time Actions","href":"/v2/documentation/getting-started/managing-boosts"}]},{"group":"Action Creation","pages":[{"title":"Introduction to Boost Action Creation","href":"/v2/documentation/action-creation/introduction"},{"title":"Getting Started with Etherscan","href":"/v2/documentation/action-creation/getting-started"},{"title":"Understanding Etherscan Data","href":"/v2/documentation/action-creation/understanding-etherscan-data"},{"title":"Understanding the Action Section","href":"/v2/documentation/action-creation/action-section"},{"title":"Identifying Claimant Information","href":"/v2/documentation/action-creation/claimant-information"},{"title":"Working with Parameter Filters","href":"/v2/documentation/action-creation/parameter-filters"},{"title":"Analyzing the Logs Section","href":"/v2/documentation/action-creation/logs-section"},{"title":"Advanced Techniques and Best Practices","href":"/v2/documentation/action-creation/advanced-techniques"},{"title":null,"href":"/v2/documentation/action-creation/effective-actions"},{"title":null,"href":"/v2/documentation/action-creation/practical-tips"}]},{"group":"Developers","pages":[{"title":"One-Time Actions Architecture","href":"/v2/documentation/architecture/core-boost-v2"},{"title":"Deployed Contracts","mode":"wide","href":"/v2/documentation/contract-deployments/contracts"},{"title":"Boost SDK","url":"/v2/boost-sdk/overview","icon":"code","href":"/v2/documentation/links/boost-sdk"},{"title":"Boost API","url":"/v2/boost-api/fetch-boosts","icon":"code","href":"/v2/documentation/links/boost-api"},{"title":"Boost API Reference","url":"v2/api-reference/openapi-json","icon":"code","href":"/v2/documentation/links/boost-api-reference"}]},{"group":"SDK","pages":[{"title":"Overview","href":"/v2/boost-sdk/overview"},{"title":"Installation","href":"/v2/boost-sdk/installation"},{"title":"Quick Start","href":"/v2/boost-sdk/quick-start"},{"title":"Usage With React","href":"/v2/boost-sdk/usage-with-react"},{"title":"Working with Events","href":"/v2/boost-sdk/working-with-events"},{"title":"Integrating your Protocol or DApp","href":"/v2/boost-sdk/integrating-your-contracts"},{"title":"Asset Retrieval","href":"/v2/boost-sdk/asset-retrieval"},{"title":"Protocol Fees","href":"/v2/boost-sdk/protocol-fees"},{"group":"Examples","pages":[{"title":"Boost an NFT Mint on Zora","href":"/v2/boost-sdk/examples/zora-mint"},{"title":"Boost a Vote on Agora","href":"/v2/boost-sdk/examples/agora-vote"},{"title":"Claim Rewards from a Boost","href":"/v2/boost-sdk/examples/claim-example"},{"title":"Deploy a Boost","href":"/v2/boost-sdk/examples/deploy-example"}]},{"group":"Boost Registry","pages":[{"title":"Overview","href":"/v2/boost-sdk/boost-registry/overview"},{"title":"Initializing Components","href":"/v2/boost-sdk/boost-registry/initializing-components"},{"title":"Cloned Components","description":null,"href":"/v2/boost-sdk/boost-registry/clones"}]},{"group":"Boost Core","pages":[{"title":"Overview","href":"/v2/boost-sdk/boost-core/overview"},{"title":"Get Boosts","description":null,"href":"/v2/boost-sdk/boost-core/get-boosts"},{"title":"Claiming Incentives","href":"/v2/boost-sdk/boost-core/claim-incentive"}]},{"group":"Managed Budget","pages":[{"title":"Overview","href":"/v2/boost-sdk/budgets/managed/overview"},{"title":"Authorization","href":"/v2/boost-sdk/budgets/managed/authorization"},{"title":"Funding","href":"/v2/boost-sdk/budgets/managed/funding"},{"title":"Retrieval","href":"/v2/boost-sdk/budgets/managed/retrieval"}]},{"group":"Incentives","pages":[{"group":"ERC20","pages":[{"title":"Overview","href":"/v2/boost-sdk/incentives/erc20/overview"},{"title":"Rewards","href":"/v2/boost-sdk/incentives/erc20/rewards"},{"title":"Claims","href":"/v2/boost-sdk/incentives/erc20/claims"}]},{"group":"ERC20 Pegged","pages":[{"title":"Overview","href":"/v2/boost-sdk/incentives/erc20-pegged/overview"},{"title":"Rewards","href":"/v2/boost-sdk/incentives/erc20-pegged/rewards"},{"title":"Claims","href":"/v2/boost-sdk/incentives/erc20-pegged/claims"}]},{"group":"ERC20 Variable","pages":[{"title":"Overview","href":"/v2/boost-sdk/incentives/erc20-variable/overview"},{"title":"Rewards","href":"/v2/boost-sdk/incentives/erc20-variable/rewards"},{"title":"Claims","href":"/v2/boost-sdk/incentives/erc20-variable/claims"}]},{"group":"ERC20 Variable Criteria","pages":[{"title":"Overview","href":"/v2/boost-sdk/incentives/erc20-variable-criteria/overview"},{"title":"Rewards","href":"/v2/boost-sdk/incentives/erc20-variable-criteria/rewards"},{"title":"Claims","href":"/v2/boost-sdk/incentives/erc20-variable-criteria/claims"}]},{"group":"ERC20 Pegged Variable Criteria","pages":[{"title":"Overview","href":"/v2/boost-sdk/incentives/erc20-pegged-variable-criteria/overview"},{"title":"Rewards","href":"/v2/boost-sdk/incentives/erc20-pegged-variable-criteria/rewards"},{"title":"Claims","href":"/v2/boost-sdk/incentives/erc20-pegged-variable-criteria/claims"}]},{"group":"Gradual Dutch Auction","pages":[{"title":"Overview","href":"/v2/boost-sdk/incentives/cgda/overview"},{"title":"Rewards","href":"/v2/boost-sdk/incentives/cgda/rewards"},{"title":"Claims","href":"/v2/boost-sdk/incentives/cgda/claims"}]}]}]},{"group":"API Guides","pages":[{"group":"Campaigns","pages":[{"title":"Fetch Boosts","href":"/v2/boost-api/fetch-boosts"},{"title":"Boost Details","href":"/v2/boost-api/boost-details"},{"title":"Boost Activity","href":"/v2/boost-api/boost-activity"}]},{"group":"Claiming","pages":[{"title":"Get Claim Signature","href":"/v2/boost-api/get-signature"}]}]}]},{"tab":"Reference","pages":[{"title":"Reference","href":"/reference/tbi-api"}]}]},"basePath":"","title":"Overview - Boost Docs","buildId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","deploymentId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","dynamics":[],"chunks":[]}
