The @atxp/base package provides a BaseAppAccount implementation for using ATXP with Base Mini Apps. This package handles wallet management, spend permissions, and payment processing specifically for the Base ecosystem.
Returns a promise that resolves when the data has been cleared.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"ATXP Docs","colors":{"primary":"#000000","light":"#FFFFFF","dark":"#FFFFFF"},"logo":{"light":"https://mintcdn.com/atxp/ZU8_z3YklIKBoP7v/logo/ATXP_logo_light_w-tagline.svg?fit=max\u0026auto=format\u0026n=ZU8_z3YklIKBoP7v\u0026q=85\u0026s=c392105d32ace0d22679f37b11234f17","dark":"https://mintcdn.com/atxp/ZU8_z3YklIKBoP7v/logo/ATXP_logo_dark_w-tagline.svg?fit=max\u0026auto=format\u0026n=ZU8_z3YklIKBoP7v\u0026q=85\u0026s=122b36077d7c9d1911fbc9336d194a5a","href":"https://atxp.ai"},"favicon":"https://mintcdn.com/atxp/h4YKkjv58t45yUT7/logo/ATXP_favicon.svg?fit=max\u0026auto=format\u0026n=h4YKkjv58t45yUT7\u0026q=85\u0026s=4988979e874ade319e91a6800fb13098","navbar":{},"footer":{"socials":{"x":"https://x.com/atxp_ai","github":"https://github.com/atxp-dev","linkedin":"https://linkedin.com/company/atxp"}},"seo":{"metatags":{"google-adsense-account":"ca-pub-7602870631624536"}},"fonts":{"family":"Readex Pro"},"integrations":{"ga4":{"measurementId":"G-7YVBRV9XVR"},"gtm":{"tagId":"GTM-PBDGRQK8"},"posthog":{"apiKey":"phc_lcPjjHwHzWygn19kSMMgqVzNQRS76Hw3XTyaIyAEAtN","apiHost":"https://app.posthog.com","sessionRecording":true}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Account","icon":"user","href":"https://accounts.atxp.ai"},{"anchor":"Documentation","icon":"book-open-cover","href":"https://docs.atxp.ai"},{"anchor":"Blog","icon":"pen-to-square","href":"https://atxp.ai/blog/"},{"anchor":"Contact","icon":"envelope","href":"mailto:support@atxp.ai?subject=ATXP%20Contact"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"atxp","hasAudioNarration":false,"actualSubdomain":"atxp","customDomains":["docs.atxp.ai"],"gitSource":{"type":"github","owner":"circuitandchisel","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e76f8d1fcd719df05553","collectionId":"6ee22cda-2a9f-4976-9f83-cebf178b3f5e","schemaVersion":"v2"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6a32eb7087dc5d9668931ec7:success","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"For Developers","count":22},{"language":"default","tag":"Tools","count":12},{"language":"default","tag":"API Reference","count":9},{"language":"default","tag":"For Agents","count":7},{"language":"default","tag":"Build Agents","count":5},{"language":"default","tag":"Monetize MCP Tools","count":5},{"language":"default","tag":"LLM Gateway","count":4},{"language":"default","tag":"Web and Data","count":4},{"language":"default","tag":"Getting Started","count":3},{"language":"default","tag":"Creative","count":3}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"editor-v7-file-tree","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":"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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"developers/api-reference/base","slug":"/developers/api-reference/base","pageMetadata":{"title":"@atxp/base","description":"API reference for the @atxp/base package","href":"/developers/api-reference/base"},"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: \"API reference for the @atxp/base package\"\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={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,ParamField,ResponseField}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`overview`,children:`Overview`}),`\n`,_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`@atxp/base`}),` package provides a `,_jsx(_components.code,{children:`BaseAppAccount`}),` implementation for using ATXP with Base Mini Apps. This package handles wallet management, spend permissions, and payment processing specifically for the Base ecosystem.`]}),`\n`,_jsx(Heading,{level:`2`,id:`installation`,children:`Installation`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,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:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`npm`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` install`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` @atxp/base`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`baseappaccount`,children:`BaseAppAccount`}),`\n`,_jsx(_components.p,{children:`The main class for managing Base Mini App accounts with ATXP.`}),`\n`,_jsx(Heading,{level:`3`,id:`functions`,children:`Functions`}),`\n`,_jsx(Heading,{level:`4`,id:`initialize`,children:`initialize`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`8`,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:`8`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`initialize`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` walletAddress:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` string`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` apiKey:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` string`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` appName:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` string`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` allowance?`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` bigint`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` periodInDays?`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` number`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` useEphemeralWallet?`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` boolean`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}): `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`Promise`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`\u003c`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`BaseAppAccount`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`>`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Creates and initializes a new BaseAppAccount instance for use with Base Mini Apps.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Arguments`})}),`\n`,_jsxs(Expandable,{title:`initialize arguments`,children:[_jsx(ParamField,{path:`walletAddress`,type:`string`,required:true,id:`param-wallet-address`,children:_jsx(_components.p,{children:`The user’s wallet address from wagmi or similar wallet connection library.`})}),_jsx(ParamField,{path:`apiKey`,type:`string`,required:true,id:`param-api-key`,children:_jsxs(_components.p,{children:[`Base mini app API key from the `,_jsx(_components.a,{href:`https://portal.cdp.coinbase.com/`,children:`Coinbase Developer Platform`}),`.`]})}),_jsx(ParamField,{path:`appName`,type:`string`,required:true,id:`param-app-name`,children:_jsx(_components.p,{children:`Display name for your mini app, shown to users during permission flows.`})}),_jsx(ParamField,{path:`allowance`,type:`bigint`,optional:true,id:`param-allowance`,children:_jsx(_components.p,{children:`Maximum USDC amount the ephemeral wallet can spend on behalf of the user. Specified in wei (1 USDC = 10^6 wei).`})}),_jsx(ParamField,{path:`periodInDays`,type:`number`,optional:true,id:`param-period-in-days`,children:_jsx(_components.p,{children:`Duration in days for which the spend permission remains valid.`})}),_jsx(ParamField,{path:`useEphemeralWallet`,type:`boolean`,default:`true`,id:`param-use-ephemeral-wallet`,children:_jsxs(_components.p,{children:[`Whether to use ephemeral wallet mode. Set to `,_jsx(_components.code,{children:`false`}),` to use the user’s main wallet directly (with degraded UX).`]})}),_jsx(ParamField,{path:`storage`,type:`IStorage\u003cstring>`,optional:true,id:`param-storage`,children:_jsx(_components.p,{children:`Storage mechanism to use for storing the account data in non-browser environments.`})})]}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Returns`})}),`\n`,_jsx(ResponseField,{name:`BaseAppAccount`,type:`Promise\u003cBaseAppAccount>`,id:`param-base-app-account`,children:_jsx(_components.p,{children:`Returns a configured BaseAppAccount instance ready for use with ATXP clients.`})}),`\n`,_jsx(Heading,{level:`4`,id:`clearallstoreddata`,children:`clearAllStoredData`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,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:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`clearAllStoredData`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` userWalletAddress:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` string`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` storage?`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` IStorage`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`\u003c`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`string`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`>`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}): `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`Promise`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`\u003c`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`void`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`>`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Clears all stored data for a specific wallet address.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Arguments`})}),`\n`,_jsx(Expandable,{title:`clearAllStoredData arguments`,children:_jsx(ParamField,{path:`userWalletAddress`,type:`string`,required:true,id:`param-user-wallet-address`,children:_jsx(_components.p,{children:`Wallet address to clear stored data for.`})})}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Returns`})}),`\n`,_jsx(ResponseField,{name:`void`,type:`Promise\u003cvoid>`,id:`param-void`,children:_jsx(_components.p,{children:`Returns a promise that resolves when the data has been cleared.`})})]})}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":"@atxp/base","description":"API reference for the @atxp/base package","href":"/developers/api-reference/base"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Overview","slug":"overview","depth":2,"children":[]},{"title":"Installation","slug":"installation","depth":2,"children":[]},{"title":"BaseAppAccount","slug":"baseappaccount","depth":2,"children":[{"title":"Functions","slug":"functions","depth":3,"children":[]},{"title":"initialize","slug":"initialize","depth":4,"children":[]},{"title":"clearAllStoredData","slug":"clearallstoreddata","depth":4,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"subdomain":"atxp","siteName":"ATXP Docs","title":"@atxp/base - ATXP Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-29T06:14:46.559Z","originalFileLocation":"developers/api-reference/base.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=\"API reference for the @atxp/base package\">\u003cmeta data-mint-head name=\"application-name\" content=\"ATXP 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/atxp/Y6ySgvzED_pQvuHL/_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/atxp/Y6ySgvzED_pQvuHL/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/atxp/Y6ySgvzED_pQvuHL/_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/atxp/Y6ySgvzED_pQvuHL/_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/atxp/Y6ySgvzED_pQvuHL/_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/atxp/Y6ySgvzED_pQvuHL/_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/atxp/Y6ySgvzED_pQvuHL/_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/atxp/Y6ySgvzED_pQvuHL/_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/atxp/Y6ySgvzED_pQvuHL/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"@atxp/base - ATXP Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"API reference for the @atxp/base package\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ATXP Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.atxp.ai/developers/api-reference/base\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://atxp.mintlify.app/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=%40atxp%2Fbase\u0026amp;description=API+reference+for+the+%40atxp%2Fbase+package\u0026amp;theme=edadc2fdc429b6c3246b3a03\u0026amp;signature=6bab298f609d387aacbfc7ad1b00e1f9170dd5612ff3828d61c27f4448448511\">\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=\"@atxp/base - ATXP Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"API reference for the @atxp/base package\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://atxp.mintlify.app/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=%40atxp%2Fbase\u0026amp;description=API+reference+for+the+%40atxp%2Fbase+package\u0026amp;theme=edadc2fdc429b6c3246b3a03\u0026amp;signature=6bab298f609d387aacbfc7ad1b00e1f9170dd5612ff3828d61c27f4448448511\">\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/atxp/Y6ySgvzED_pQvuHL/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ATXP Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003cmeta data-mint-head name=\"google-adsense-account\" content=\"ca-pub-7602870631624536\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.atxp.ai/developers/api-reference/base\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/developers/api-reference/base.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.atxp.ai/#organization\",\"name\":\"ATXP Docs\",\"url\":\"https://docs.atxp.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/atxp/ZU8_z3YklIKBoP7v/logo/ATXP_logo_light_w-tagline.svg?fit=max\u0026auto=format\u0026n=ZU8_z3YklIKBoP7v\u0026q=85\u0026s=c392105d32ace0d22679f37b11234f17\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.atxp.ai#website\",\"name\":\"ATXP Docs\",\"url\":\"https://docs.atxp.ai\",\"publisher\":{\"@id\":\"https://docs.atxp.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.atxp.ai/developers/api-reference/base#webpage\",\"url\":\"https://docs.atxp.ai/developers/api-reference/base\",\"name\":\"@atxp/base\",\"description\":\"API reference for the @atxp/base package\",\"dateModified\":\"2026-01-29T06:14:46.559Z\",\"isPartOf\":{\"@id\":\"https://docs.atxp.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.atxp.ai/developers/api-reference/base#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.atxp.ai/developers/api-reference/base#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.atxp.ai/developers/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"@atxp/base\",\"item\":\"https://docs.atxp.ai/developers/api-reference/base\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.atxp.ai/developers/api-reference/base#article\",\"headline\":\"@atxp/base\",\"name\":\"@atxp/base\",\"description\":\"API reference for the @atxp/base package\",\"url\":\"https://docs.atxp.ai/developers/api-reference/base\",\"mainEntityOfPage\":{\"@id\":\"https://docs.atxp.ai/developers/api-reference/base#webpage\"},\"dateModified\":\"2026-01-29T06:14:46.559Z\",\"publisher\":{\"@id\":\"https://docs.atxp.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.atxp.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ATXP Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"ATXP Docs","nav":{"global":{"anchors":[{"anchor":"Account","icon":"user","href":"https://accounts.atxp.ai"},{"anchor":"Documentation","icon":"book-open-cover","href":"https://docs.atxp.ai"},{"anchor":"Blog","icon":"pen-to-square","href":"https://atxp.ai/blog/"},{"anchor":"Contact","icon":"envelope","href":"mailto:support@atxp.ai?subject=ATXP%20Contact"}]},"tabs":[{"tab":"For Agents","pages":[{"title":"For Agents","href":"/agents"}]},{"tab":"Tools","pages":[{"title":"Tools","href":"/tools"}]},{"tab":"For Developers","groups":[{"group":"Overview","pages":[{"title":"For Developers","href":"/developers"}]},{"group":"Build Agents","pages":[{"title":"Agent quickstart","href":"/developers/build-agents/index"},{"title":"Create an ATXP account","href":"/developers/build-agents/create-account"},{"title":"Build a simple CLI client","href":"/developers/build-agents/tutorial"},{"title":"Build an agent with Vercel AI","href":"/developers/build-agents/integrations/vercel-ai"},{"title":"Build an agent with Cloudflare Agents","href":"/developers/build-agents/integrations/cloudflare"}]},{"group":"Monetize MCP Tools","pages":[{"title":"MCP server quickstart","href":"/developers/monetize/index"},{"title":"Create an ATXP account","href":"/developers/monetize/create-account"},{"title":"Build a paid MCP server","href":"/developers/monetize/tutorial"},{"title":"Batch Payments","href":"/developers/monetize/batch-payments"},{"title":"Build a paid MCP server on Cloudflare","href":"/developers/monetize/cloudflare-deploy"}]},{"group":"Developer Tools","pages":[{"title":"ATXP CLI","href":"/developers/cli"},{"title":"MCP Proxy","href":"/developers/proxy"}]},{"group":"API Reference","pages":[{"title":"ATXP SDK Overview","href":"/developers/api-reference/introduction"},{"title":"@atxp/client","href":"/developers/api-reference/client"},{"title":"@atxp/express","description":"Documentation for the @atxp/express package","href":"/developers/api-reference/express"},{"title":"@atxp/base","href":"/developers/api-reference/base"},{"title":"@atxp/common","description":"Documentation for the @atxp/common package","href":"/developers/api-reference/common"},{"title":"@atxp/redis","href":"/developers/api-reference/redis"},{"title":"@atxp/sqlite","href":"/developers/api-reference/sqlite"},{"title":"@atxp/server","href":"/developers/api-reference/server"},{"title":"@atxp/solana","href":"/developers/api-reference/solana"}]}]}]},"title":"@atxp/base - ATXP Docs","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":[],"chunks":[]}
