@allo-team/allo-v2-sdk

Version:

sdk for allo v2

47 lines • 494 kB

HTML

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MicroGrantsStrategy | @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="MicroGrantsStrategy.html">MicroGrantsStrategy</a></li></ul><h1>Class MicroGrantsStrategy</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/allo-protocol/allo-v2-sdk/blob/7a58017/src/strategies/MicroGrantsStrategy/MicroGrantsStrategy.ts#L48">src/strategies/MicroGrantsStrategy/MicroGrantsStrategy.ts:48</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="MicroGrantsStrategy.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="MicroGrantsStrategy.html#allo" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg>allo</a> <a href="MicroGrantsStrategy.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="MicroGrantsStrategy.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> <a href="MicroGrantsStrategy.html#poolId" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg>poolId</a> <a href="MicroGrantsStrategy.html#strategy" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg>strategy</a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="MicroGrantsStrategy.html#allocated" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>allocated</a> <a href="MicroGrantsStrategy.html#allocationEndTime" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>allocationEndTime</a> <a href="MicroGrantsStrategy.html#allocationStartTime" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>allocationStartTime</a> <a href="MicroGrantsStrategy.html#allocator" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>allocator</a> <a href="MicroGrantsStrategy.html#approvalThreshold" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>approvalThreshold</a> <a href="MicroGrantsStrategy.html#checkPoolId" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>checkPoolId</a> <a href="MicroGrantsStrategy.html#checkStrategy" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>checkStrategy</a> <a href="MicroGrantsStrategy.html#getAllo" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getAllo</a> <a href="MicroGrantsStrategy.html#getAllocationData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getAllocationData</a> <a href="MicroGrantsStrategy.html#getBatchAllocationData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getBatchAllocationData</a> <a href="MicroGrantsStrategy.html#getBatchRegisterRecipientData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getBatchRegisterRecipientData</a> <a href="MicroGrantsStrategy.html#getBatchSetAllocatorData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getBatchSetAllocatorData</a> <a href="MicroGrantsStrategy.html#getDeployParams" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getDeployParams</a> <a href="MicroGrantsStrategy.html#getGovAddress" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getGovAddress</a> <a href="MicroGrantsStrategy.html#getHatId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getHatId</a> <a href="MicroGrantsStrategy.html#getHatsAddress" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getHatsAddress</a> <a href="MicroGrantsStrategy.html#getIncreasemaxRequestedAmountData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getIncreasemaxRequestedAmountData</a> <a href="MicroGrantsStrategy.html#getInitializeData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getInitializeData</a> <a href="MicroGrantsStrategy.html#getInitializeDataGov" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getInitializeDataGov</a> <a href="MicroGrantsStrategy.html#getInitializeDataHats" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getInitializeDataHats</a> <a href="MicroGrantsStrategy.html#getMinimumVotePower" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getMinimumVotePower</a> <a href="MicroGrantsStrategy.html#getNative" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getNative</a> <a href="MicroGrantsStrategy.html#getPayouts" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getPayouts</a> <a href="MicroGrantsStrategy.html#getPoolAmount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getPoolAmount</a> <a href="MicroGrantsStrategy.html#getPoolId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getPoolId</a> <a href="MicroGrantsStrategy.html#getRecipient" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getRecipient</a> <a href="MicroGrantsStrategy.html#getRecipientStatus" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getRecipientStatus</a> <a href="MicroGrantsStrategy.html#getRegisterRecipientData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getRegisterRecipientData</a> <a href="MicroGrantsStrategy.html#getSetAllocatorData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getSetAllocatorData</a> <a href="MicroGrantsStrategy.html#getSnapshotReference" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getSnapshotReference</a> <a href="MicroGrantsStrategy.html#getStrategyContractId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getStrategyContractId</a> <a href="MicroGrantsStrategy.html#getStrategyId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getStrategyId</a> <a href="MicroGrantsStrategy.html#getUpdatePoolTimestampsData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>getUpdatePoolTimestampsData</a> <a href="MicroGrantsStrategy.html#isPoolActive" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>isPoolActive</a> <a href="MicroGrantsStrategy.html#isValidAllocator" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>isValidAllocator</a> <a href="MicroGrantsStrategy.html#maxRequestedAmount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>maxRequestedAmount</a> <a href="MicroGrantsStrategy.html#recipientAllocations" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>recipientAllocations</a> <a href="MicroGrantsStrategy.html#setContract" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>setContract</a> <a href="MicroGrantsStrategy.html#setPoolId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>setPoolId</a> <a href="MicroGrantsStrategy.html#useRegistryAnchor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg>useRegistryAnchor</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_MicroGrantsStrategy" class="tsd-anchor"></a>new MicroGrantsStrategy(__namedParameters): <a href="MicroGrantsStrategy.html" class="tsd-signature-type tsd-kind-class">MicroGrantsStrategy</a><a href="#constructor.new_MicroGrantsStrategy" 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="MicroGrantsStrategy.html" class="tsd-signature-type tsd-kind-class">MicroGrantsStrategy</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/allo-protocol/allo-v2-sdk/blob/7a58017/src/strategies/MicroGrantsStrategy/MicroGrantsStrategy.ts#L57">src/strategies/MicroGrantsStrategy/MicroGrantsStrategy.ts:57</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="allo" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> allo<a href="#allo" 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">allo: <a href="Allo.html" class="tsd-signature-type tsd-kind-class">Allo</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/allo-protocol/allo-v2-sdk/blob/7a58017/src/strategies/MicroGrantsStrategy/MicroGrantsStrategy.ts#L55">src/strategies/MicroGrantsStrategy/MicroGrantsStrategy.ts:55</a></li></ul></aside></section><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>>); </s