https://docs.ignite.com/assets/js/b870847c.a41d8e35.js

1"use strict";(globalThis.webpackChunkmy_website=globalThis.webpackChunkmy_website||[]).push([[1690],{15680(e,t,n){n.d(t,{xA:()=>u,yg:()=>d});var a=n(96540);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?o(Object(n),!0).forEach((function(t){r(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):o(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function s(e,t){if(null==e)return{};var n,a,r=function(e,t){if(null==e)return{};var n,a,r={},o=Object.keys(e);for(a=0;a<o.length;a++)n=o[a],t.indexOf(n)>=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a<o.length;a++)n=o[a],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var c=a.createContext({}),l=function(e){var t=a.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},u=function(e){var t=l(e.components);return a.createElement(c.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,c=e.parentName,u=s(e,["components","mdxType","originalType","parentName"]),m=l(n),d=r,g=m["".concat(c,".").concat(d)]||m[d]||p[d]||o;return n?a.createElement(g,i(i({ref:t},u),{},{components:n})):a.createElement(g,i({ref:t},u))}));function d(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,i=new Array(o);i[0]=m;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s.mdxType="string"==typeof e?e:r,i[1]=s;for(var l=2;l<o;l++)i[l]=n[l];return a.createElement.apply(null,i)}return a.createElement.apply(null,n)}m.displayName="MDXCreateElement"},44483(e,t,n){n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>s,toc:()=>l});var a=n(58168),r=(n(96540),n(15680));const o={sidebar_position:5,title:"Token Faucet (cosmosfaucet)",slug:"/packages/cosmosfaucet"},i="Token Faucet (cosmosfaucet)",s={unversionedId:"packages/cosmosfaucet",id:"version-v29/packages/cosmosfaucet",title:"Token Faucet (cosmosfaucet)",description:"The cosmosfaucet package provides a local faucet service and client helpers to fund Cosmos accounts during development and tests.",source:"@site/versioned_docs/version-v29/07-packages/cosmosfaucet.md",sourceDirName:"07-packages",slug:"/packages/cosmosfaucet",permalink:"/v29/packages/cosmosfaucet",draft:!1,tags:[],version:"v29",sidebarPosition:5,frontMatter:{sidebar_position:5,title:"Token Faucet (cosmosfaucet)",slug:"/packages/cosmosfaucet"},sidebar:"tutorialSidebar",previous:{title:"Chain Command Runner (chaincmd/runner)",permalink:"/v29/packages/chaincmdrunner"},next:{title:"Chain Command Builder (chaincmd)",permalink:"/v29/packages/chaincmd"}},c={},l=[{value:"When to use",id:"when-to-use",level:2},{value:"Key APIs",id:"key-apis",level:2},{value:"Common Tasks",id:"common-tasks",level:2},{value:"Basic import",id:"basic-import",level:2}],u={toc:l};function p(e){let{components:t,...n}=e;return(0,r.yg)("wrapper",(0,a.A)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,r.yg)("h1",{id:"token-faucet-cosmosfaucet"},"Token Faucet (cosmosfaucet)"),(0,r.yg)("p",null,"The ",(0,r.yg)("inlineCode",{parentName:"p"},"cosmosfaucet")," package provides a local faucet service and client helpers to fund Cosmos accounts during development and tests."),(0,r.yg)("p",null,"For full API details, see the\n",(0,r.yg)("a",{parentName:"p",href:"https://pkg.go.dev/github.com/ignite/cli/v29/ignite/pkg/cosmosfaucet"},(0,r.yg)("inlineCode",{parentName:"a"},"cosmosfaucet")," Go package documentation"),"."),(0,r.yg)("h2",{id:"when-to-use"},"When to use"),(0,r.yg)("ul",null,(0,r.yg)("li",{parentName:"ul"},"Automatically fund accounts in local/devnet environments."),(0,r.yg)("li",{parentName:"ul"},"Expose a faucet HTTP endpoint backed by a chain key."),(0,r.yg)("li",{parentName:"ul"},"Request funds from an existing faucet endpoint from automation code.")),(0,r.yg)("h2",{id:"key-apis"},"Key APIs"),(0,r.yg)("ul",null,(0,r.yg)("li",{parentName:"ul"},(0,r.yg)("inlineCode",{parentName:"li"},"New(ctx context.Context, ccr chaincmdrunner.Runner, options ...Option) (Faucet, error)")),(0,r.yg)("li",{parentName:"ul"},(0,r.yg)("inlineCode",{parentName:"li"},"TryRetrieve(ctx context.Context, chainID, rpcAddress, faucetAddress, accountAddress string) (string, error)")),(0,r.yg)("li",{parentName:"ul"},(0,r.yg)("inlineCode",{parentName:"li"},"OpenAPI(apiAddress string) Option")),(0,r.yg)("li",{parentName:"ul"},(0,r.yg)("inlineCode",{parentName:"li"},"Coin(amount, maxAmount sdkmath.Int, denom string) Option")),(0,r.yg)("li",{parentName:"ul"},(0,r.yg)("inlineCode",{parentName:"li"},"FeeAmount(amount sdkmath.Int, denom string) Option")),(0,r.yg)("li",{parentName:"ul"},(0,r.yg)("inlineCode",{parentName:"li"},"RefreshWindow(refreshWindow time.Duration) Option")),(0,r.yg)("li",{parentName:"ul"},(0,r.yg)("inlineCode",{parentName:"li"}

1,"NewTransferRequest(accountAddress string, coins []string) TransferRequest"))),(0,r.yg)("h2",{id:"common-tasks"},"Common Tasks"),(0,r.yg)("ul",null,(0,r.yg)("li",{parentName:"ul"},"Construct a ",(0,r.yg)("inlineCode",{parentName:"li"},"Faucet")," with chain runner + options, then expose transfer endpoints for local users."),(0,r.yg)("li",{parentName:"ul"},"Use ",(0,r.yg)("inlineCode",{parentName:"li"},"TryRetrieve")," in tests before broadcasting txs to ensure accounts have spendable balance."),(0,r.yg)("li",{parentName:"ul"},"Tune coin amount, max amount, and refresh window to limit faucet abuse.")),(0,r.yg)("h2",{id:"basic-import"},"Basic import"),(0,r.yg)("pre",null,(0,r.yg)("code",{parentName:"pre",className:"language-go"},'import "github.com/ignite/cli/v29/ignite/pkg/cosmosfaucet"\n')))}p.isMDXComponent=!0}}]);