@allo-team/allo-v2-sdk

Version:

sdk for allo v2

33 lines • 461 kB

HTML

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Allo | @allo-team/allo-v2-sdk</title><meta name="description" content="Documentation for @allo-team/allo-v2-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@allo-team/allo-v2-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@allo-team/allo-v2-sdk</a></li><li><a href="Allo.html">Allo</a></li></ul><h1>Class Allo</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/allo-protocol/allo-v2-sdk/blob/7a58017/src/Allo/Allo.ts#L15">src/Allo/Allo.ts:15</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="Allo.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg>constructor</a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="Allo.html#client" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg>client</a> <a href="Allo.html#contract" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg>contract</a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="Allo.html#addPoolManager" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>addPoolManager</a> <a href="Allo.html#addToCloneableStrategies" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>addToCloneableStrategies</a> <a href="Allo.html#address" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>address</a> <a href="Allo.html#allocate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>allocate</a> <a href="Allo.html#batchAllocate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>batchAllocate</a> <a href="Allo.html#batchRegisterRecipient" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>batchRegisterRecipient</a> <a href="Allo.html#createPool" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>createPool</a> <a href="Allo.html#createPoolWithCustomStrategy" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>createPoolWithCustomStrategy</a> <a href="Allo.html#distribute" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>distribute</a> <a href="Allo.html#fundPool" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>fundPool</a> <a href="Allo.html#getBaseFee" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getBaseFee</a> <a href="Allo.html#getFeeDenominator" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getFeeDenominator</a> <a href="Allo.html#getPercentFee" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getPercentFee</a> <a href="Allo.html#getPool" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getPool</a> <a href="Allo.html#getRegistry" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getRegistry</a> <a href="Allo.html#getStrategy" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getStrategy</a> <a href="Allo.html#getTreasury" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getTreasury</a> <a href="Allo.html#isCloneableStrategy" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>isCloneableStrategy</a> <a href="Allo.html#isPoolAdmin" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>isPoolAdmin</a> <a href="Allo.html#isPoolManager" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>isPoolManager</a> <a href="Allo.html#recoverFunds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>recoverFunds</a> <a href="Allo.html#registerRecipient" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>registerRecipient</a> <a href="Allo.html#removeFromCloneableStrategies" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>removeFromCloneableStrategies</a> <a href="Allo.html#removePoolManager" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>removePoolManager</a> <a href="Allo.html#updateBaseFee" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>updateBaseFee</a> <a href="Allo.html#updatePercentFee" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>updatePercentFee</a> <a href="Allo.html#updatePoolMetadata" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>updatePoolMetadata</a> <a href="Allo.html#updateRegistry" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>updateRegistry</a> <a href="Allo.html#updateTreasury" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>updateTreasury</a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_Allo" class="tsd-anchor"></a>new Allo(__namedParameters): <a href="Allo.html" class="tsd-signature-type tsd-kind-class">Allo</a><a href="#constructor.new_Allo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5>__namedParameters: ConstructorArgs</h5></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Allo.html" class="tsd-signature-type tsd-kind-class">Allo</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/allo-protocol/allo-v2-sdk/blob/7a58017/src/Allo/Allo.ts#L19">src/Allo/Allo.ts:19</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="client" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> client<a href="#client" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature">client: { account: undefined; batch?: { multicall?: boolean | ({ batchSize?: number | undefined; wait?: number | undefined; }); }; cacheTime: number; call: ((parameters) => Promise<CallReturnType>); chain: Chain; createBlockFilter: (() => Promise<{ id: `0x${string}`; request: EIP1193RequestFn<readonly [{ Method: "eth_getFilterChanges"; Parameters: [filterId: `0x${string}`]; ReturnType: `0x${string}`[] | RpcLog[]; }, { Method: "eth_getFilterLogs"; Parameters: [filterId: `0x${string}`]; ReturnType: RpcLog[]; }, { Method: "eth_uninstallFilter"; Parameters: [filterId: `0x${string}`]; ReturnType: boolean; }]>; type: "block"; }>); createContractEventFilter: (<const TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>(args) => Promise<CreateContractEventFilterReturnType<TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>>); createEventFilter: (<const TAbiEvent, const TAbiEvents, TStrict, TFromBlock, TToBlock, _EventName, _Args>(args?) => Promise<({ [K in keyof Filter<"event", TAbiEvents, _EventName, _Args, TStrict, TFromBlock, TToBlock>]: Filter<"event", TAbiEvents, ... 4 more ..., TToBlock>[K]; })>); createPendingTransactionFilter: (() => Promise<{ id: `0x${string}`; request: EIP1193RequestFn<readonly [{ Method: "eth_getFilterChanges"; Parameters: [filterId: `0x${string}`]; ReturnType: `0x${string}`[] | RpcLog[]; }, { Method: "eth_getFilterLogs"; Parameters: [filterId: `0x${string}`]; ReturnType: RpcLog[]; }, { Method: "eth_uninstallFilter"; Parameters: [filterId: `0x${string}`]; ReturnType: boolean; }]>; type: "transaction"; }>); estimateContractGas: (<TChain, const TAbi, TFunctionName>(args) => Promise<bigint>); estimateFeesPerGas: (<TChainOverride, TType>(args?) => Promise<EstimateFeesPerGasReturnType>); estimateGas: ((args) => Promise<bigint>); estimateMaxPriorityFeePerGas: (<TChainOverride>(args?) => Promise<bigint>); extend: (<const client>(fn) => Client<Transport, Chain, undefined, PublicRpcSchema, ({ [K in keyof client]: client[K]; }) & PublicActions<Transport, Chain>>); getBalance: ((args) => Promise<bigint>); getBlock: (<TIncludeTransactions, TBlockTag>(args?) => Promise<GetBlockReturnType<Chain, TIncludeTransactions, TBlockTag>>); getBlockNumber: ((args?) => Promise<bigint>); getBlockTransactionCount: ((args?) => Promise<number>); getBytecode: ((args) => Promise<GetBytecodeReturnType>); getChainId: (() => Promise<number>); getContractEvents: (<const TAbi, TEventName, TStrict, TFromBlock, TToBlock>(args) => Promise<GetContractEventsReturnType<TAbi, TEventName, TStrict, TFromBlock, TToBlock>>); getEnsAddress: ((args) => Promise<GetEnsAddressReturnType>); getEnsAvatar: ((args) => Promise<GetEnsAvatarReturnType>); getEnsName: ((args) => Promise<GetEnsNameReturnType>); getEnsResolver: ((args) => Promise<`0x${string}`>); getEnsText: ((args) => Promise<GetEnsTextReturnType>); getFeeHistory: ((args) => Promise<GetFeeHistoryReturnType>); getFilterChanges: (<TFilterType, const TAbi, TEventName, TStrict, TFromBlock, TToBlock>(args) => Promise<GetFilterChangesReturnType<TFilterType, TAbi, TEventName, TStrict, TFromBlock, TToBlock>>); getFilterLogs: (<const TAbi, TEventName, TStrict, TFromBlock, TToBlock>(args) => Promise<GetFilterLogsReturnType<TAbi, TEventName, TStrict, TFromBlock, TToBlock>>); getGasPrice: (() => Promise<bigint>); getLogs: (<const TAbiEvent, const TAbiEvents, TStrict, TFromBlock, TToBlock>(args?) => Promise<GetLogsReturnType<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock>>); getProof: ((args</sp