diff --git a/dist/Client/Client.d.ts b/dist/Client/Client.d.ts index 41a6ae2..141a940 100644 --- a/dist/Client/Client.d.ts +++ b/dist/Client/Client.d.ts @@ -1,2 +1,15 @@ import { Chain, PublicClient, Transport } from "viem"; +/** + * + * Returns a PublicClient instance that can be used to interact with the Allo v2 contracts. + * + * @remarks + * This is a wrapper around the viem PublicClient class that sets the correct chain ID and transport. + * + * @param chain - The chain ID to connect to (this is a Chain type from viem) + * @param rpc - The url of the RPC endpoint + * @returns - A PublicClient instance + * + * @beta + */ export declare const create: (chain: Chain, rpc?: string) => PublicClient; diff --git a/dist/Client/Client.js b/dist/Client/Client.js index 932fdd3..f208302 100644 --- a/dist/Client/Client.js +++ b/dist/Client/Client.js @@ -2,6 +2,19 @@ Object.defineProperty(exports, "__esModule", { value: true }); exports.create = void 0; const viem_1 = require("viem"); +/** + * + * Returns a PublicClient instance that can be used to interact with the Allo v2 contracts. + * + * @remarks + * This is a wrapper around the viem PublicClient class that sets the correct chain ID and transport. + * + * @param chain - The chain ID to connect to (this is a Chain type from viem) + * @param rpc - The url of the RPC endpoint + * @returns - A PublicClient instance + * + * @beta + */ const create = (chain, rpc) => { const client = (0, viem_1.createPublicClient)({ chain: chain, diff --git a/dist/__tests__/utils/utils.js b/dist/__tests__/utils/utils.js index 371af62..2d5ead4 100644 --- a/dist/__tests__/utils/utils.js +++ b/dist/__tests__/utils/utils.js @@ -2,7 +2,6 @@ Object.defineProperty(exports, "__esModule", { value: true }); exports.NATIVE = exports.makeBytes32 = exports.makeAddress = void 0; const viem_1 = require("viem"); -// import { Profile } from "../../Registry/types"; const makeAddress = (input) => { return (0, viem_1.keccak256)((0, viem_1.toHex)(input)).slice(0, 42); }; @@ -15,5 +14,3 @@ const NATIVE = () => { return "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE"; }; exports.NATIVE = NATIVE; -// export const createMockProfile = () => { -// const profile: diff --git a/docs/classes/Allo.html b/docs/classes/Allo.html index 53ce83e..c81efc5 100644 --- a/docs/classes/Allo.html +++ b/docs/classes/Allo.html @@ -1,4 +1,4 @@ -Allo | @allo-team/allo-v2-sdk

Class Allo

Constructors

constructor +Allo | @allo-team/allo-v2-sdk

Class Allo

Constructors

constructor

Properties

client contract

Methods

addPoolManager @@ -30,7 +30,7 @@ updatePoolMetadata updateRegistry updateTreasury -

Constructors

constructor

Properties

Private client

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) => Promise<GetProofReturnType>);
    getStorageAt: ((args) => Promise<GetStorageAtReturnType>);
    getTransaction: (<TBlockTag>(args) => Promise<GetTransactionReturnType<Chain, TBlockTag>>);
    getTransactionConfirmations: ((args) => Promise<bigint>);
    getTransactionCount: ((args) => Promise<number>);
    getTransactionReceipt: ((args) => Promise<TransactionReceipt>);
    key: string;
    multicall: (<TContracts, TAllowFailure>(args) => Promise<MulticallReturnType<TContracts, TAllowFailure>>);
    name: string;
    pollingInterval: number;
    prepareTransactionRequest: (<TChainOverride>(args) => Promise<PrepareTransactionRequestReturnType>);
    readContract: (<const TAbi, TFunctionName>(args) => Promise<ReadContractReturnType<TAbi, TFunctionName>>);
    request: EIP1193RequestFn<PublicRpcSchema>;
    sendRawTransaction: ((args) => Promise<`0x${string}`>);
    simulateContract: (<const TAbi, TFunctionName, TChainOverride>(args) => Promise<SimulateContractReturnType<TAbi, TFunctionName, Chain, TChainOverride>>);
    transport: TransportConfig<string, EIP1193RequestFn> & Record<string, any>;
    type: string;
    uid: string;
    uninstallFilter: ((args) => Promise<boolean>);
    verifyMessage: ((args) => Promise<boolean>);
    verifyTypedData: ((args) => Promise<boolean>);
    waitForTransactionReceipt: ((args) => Promise<TransactionReceipt>);
    watchBlockNumber: ((args) => WatchBlockNumberReturnType);
    watchBlocks: (<TIncludeTransactions, TBlockTag>(args) => WatchBlocksReturnType);
    watchContractEvent: (<const TAbi, TEventName, TStrict>(args) => WatchContractEventReturnType);
    watchEvent: (<const TAbiEvent, const TAbiEvents, TStrict>(args) => WatchEventReturnType);
    watchPendingTransactions: ((args) => WatchPendingTransactionsReturnType);
}

Type declaration

  • account: undefined

    The Account of the Client.

    +

Constructors

constructor

Properties

Private client

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) => Promise<GetProofReturnType>);
    getStorageAt: ((args) => Promise<GetStorageAtReturnType>);
    getTransaction: (<TBlockTag>(args) => Promise<GetTransactionReturnType<Chain, TBlockTag>>);
    getTransactionConfirmations: ((args) => Promise<bigint>);
    getTransactionCount: ((args) => Promise<number>);
    getTransactionReceipt: ((args) => Promise<TransactionReceipt>);
    key: string;
    multicall: (<TContracts, TAllowFailure>(args) => Promise<MulticallReturnType<TContracts, TAllowFailure>>);
    name: string;
    pollingInterval: number;
    prepareTransactionRequest: (<TChainOverride>(args) => Promise<PrepareTransactionRequestReturnType>);
    readContract: (<const TAbi, TFunctionName>(args) => Promise<ReadContractReturnType<TAbi, TFunctionName>>);
    request: EIP1193RequestFn<PublicRpcSchema>;
    sendRawTransaction: ((args) => Promise<`0x${string}`>);
    simulateContract: (<const TAbi, TFunctionName, TChainOverride>(args) => Promise<SimulateContractReturnType<TAbi, TFunctionName, Chain, TChainOverride>>);
    transport: TransportConfig<string, EIP1193RequestFn> & Record<string, any>;
    type: string;
    uid: string;
    uninstallFilter: ((args) => Promise<boolean>);
    verifyMessage: ((args) => Promise<boolean>);
    verifyTypedData: ((args) => Promise<boolean>);
    waitForTransactionReceipt: ((args) => Promise<TransactionReceipt>);
    watchBlockNumber: ((args) => WatchBlockNumberReturnType);
    watchBlocks: (<TIncludeTransactions, TBlockTag>(args) => WatchBlocksReturnType);
    watchContractEvent: (<const TAbi, TEventName, TStrict>(args) => WatchContractEventReturnType);
    watchEvent: (<const TAbiEvent, const TAbiEvents, TStrict>(args) => WatchEventReturnType);
    watchPendingTransactions: ((args) => WatchPendingTransactionsReturnType);
}

Type declaration

  • account: undefined

    The Account of the Client.

  • Optional batch?: {
        multicall?: boolean | ({ batchSize?: number | undefined; wait?: number | undefined; });
    }

    Flags for batch settings.

    • Optional multicall?: boolean | ({ batchSize?: number | undefined; wait?: number | undefined; })

      Toggle to enable eth_call multicall aggregation.

  • cacheTime: number

    Time (in ms) that cached data will remain in memory.

    @@ -539,4 +539,4 @@

    Example

    import<
 
    Remarks
    This Action will batch up all the pending transactions found within the pollingInterval, and invoke them via onTransactions.
    
 
    Example
    import { createPublicClient, http } from 'viem'
    import { mainnet } from 'viem/chains'

    const client = createPublicClient({
      chain: mainnet,
      transport: http(),
    })
    const unwatch = await client.watchPendingTransactions({
      onTransactions: (hashes) => console.log(hashes),
    })
 
    
-

Private contract

contract: any

Methods

addPoolManager

  • addPoolManager(poolId, manager): TransactionData

  • Parameters

    • poolId: number
    • manager: string

    Returns TransactionData

addToCloneableStrategies

  • addToCloneableStrategies(strategy): TransactionData

  • Parameters

    • strategy: string

    Returns TransactionData

address

allocate

  • allocate(poolId, strategyData): TransactionData

  • Parameters

    • poolId: number
    • strategyData: string

    Returns TransactionData

batchAllocate

  • batchAllocate(poolIds, strategyData): TransactionData

  • Parameters

    • poolIds: number[]
    • strategyData: string[]

    Returns TransactionData

batchRegisterRecipient

  • batchRegisterRecipient(poolIds, strategyData): TransactionData

  • Parameters

    • poolIds: number[]
    • strategyData: string[]

    Returns TransactionData

createPool

  • createPool(__namedParameters): TransactionData

  • Parameters

    • __namedParameters: CreatePoolArgs

    Returns TransactionData

createPoolWithCustomStrategy

  • createPoolWithCustomStrategy(__namedParameters): TransactionData

  • Parameters

    • __namedParameters: CreatePoolArgs

    Returns TransactionData

distribute

  • distribute(poolId, recipientId, strategyData): TransactionData

  • Parameters

    • poolId: number
    • recipientId: string[]
    • strategyData: string

    Returns TransactionData

fundPool

  • fundPool(poolId, amount): TransactionData

  • Parameters

    • poolId: number
    • amount: number

    Returns TransactionData

getBaseFee

getFeeDenominator

getPercentFee

getPool

  • getPool(poolId): Promise<Pool>

  • Parameters

    • poolId: number

    Returns Promise<Pool>

getRegistry

getStrategy

  • getStrategy(poolId): Promise<string>

  • Parameters

    • poolId: number

    Returns Promise<string>

getTreasury

isCloneableStrategy

isPoolAdmin

  • isPoolAdmin(poolId, address): Promise<boolean>

  • Parameters

    • poolId: number
    • address: string

    Returns Promise<boolean>

isPoolManager

  • isPoolManager(poolId, address): Promise<boolean>

  • Parameters

    • poolId: number
    • address: string

    Returns Promise<boolean>

recoverFunds

  • recoverFunds(token, recipient): TransactionData

  • Parameters

    • token: string
    • recipient: string

    Returns TransactionData

registerRecipient

  • registerRecipient(poolId, strategyData): TransactionData

  • Parameters

    • poolId: number
    • strategyData: string

    Returns TransactionData

removeFromCloneableStrategies

  • removeFromCloneableStrategies(strategy): TransactionData

  • Parameters

    • strategy: string

    Returns TransactionData

removePoolManager

  • removePoolManager(poolId, manager): TransactionData

  • Parameters

    • poolId: number
    • manager: string

    Returns TransactionData

updateBaseFee

  • updateBaseFee(percentage): TransactionData

  • Parameters

    • percentage: number

    Returns TransactionData

updatePercentFee

  • updatePercentFee(percentage): TransactionData

  • Parameters

    • percentage: number

    Returns TransactionData

updatePoolMetadata

  • updatePoolMetadata(__namedParameters): TransactionData

  • Parameters

    • __namedParameters: UpdateMetaDataArgs

    Returns TransactionData

updateRegistry

  • updateRegistry(registry): TransactionData

  • Parameters

    • registry: string

    Returns TransactionData

updateTreasury

  • updateTreasury(registry): TransactionData

  • Parameters

    • registry: string

    Returns TransactionData

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Private contract

contract: any

Methods

addPoolManager

  • addPoolManager(poolId, manager): TransactionData

  • Parameters

    • poolId: number
    • manager: string

    Returns TransactionData

addToCloneableStrategies

  • addToCloneableStrategies(strategy): TransactionData

  • Parameters

    • strategy: string

    Returns TransactionData

address

allocate

  • allocate(poolId, strategyData): TransactionData

  • Parameters

    • poolId: number
    • strategyData: string

    Returns TransactionData

batchAllocate

  • batchAllocate(poolIds, strategyData): TransactionData

  • Parameters

    • poolIds: number[]
    • strategyData: string[]

    Returns TransactionData

batchRegisterRecipient

  • batchRegisterRecipient(poolIds, strategyData): TransactionData

  • Parameters

    • poolIds: number[]
    • strategyData: string[]

    Returns TransactionData

createPool

  • createPool(__namedParameters): TransactionData

  • Parameters

    • __namedParameters: CreatePoolArgs

    Returns TransactionData

createPoolWithCustomStrategy

  • createPoolWithCustomStrategy(__namedParameters): TransactionData

  • Parameters

    • __namedParameters: CreatePoolArgs

    Returns TransactionData

distribute

  • distribute(poolId, recipientId, strategyData): TransactionData

  • Parameters

    • poolId: number
    • recipientId: string[]
    • strategyData: string

    Returns TransactionData

fundPool

  • fundPool(poolId, amount): TransactionData

  • Parameters

    • poolId: number
    • amount: number

    Returns TransactionData

getBaseFee

getFeeDenominator

getPercentFee

getPool

  • getPool(poolId): Promise<Pool>

  • Parameters

    • poolId: number

    Returns Promise<Pool>

getRegistry

getStrategy

  • getStrategy(poolId): Promise<string>

  • Parameters

    • poolId: number

    Returns Promise<string>

getTreasury

isCloneableStrategy

isPoolAdmin

  • isPoolAdmin(poolId, address): Promise<boolean>

  • Parameters

    • poolId: number
    • address: string

    Returns Promise<boolean>

isPoolManager

  • isPoolManager(poolId, address): Promise<boolean>

  • Parameters

    • poolId: number
    • address: string

    Returns Promise<boolean>

recoverFunds

  • recoverFunds(token, recipient): TransactionData

  • Parameters

    • token: string
    • recipient: string

    Returns TransactionData

registerRecipient

  • registerRecipient(poolId, strategyData): TransactionData

  • Parameters

    • poolId: number
    • strategyData: string

    Returns TransactionData

removeFromCloneableStrategies

  • removeFromCloneableStrategies(strategy): TransactionData

  • Parameters

    • strategy: string

    Returns TransactionData

removePoolManager

  • removePoolManager(poolId, manager): TransactionData

  • Parameters

    • poolId: number
    • manager: string

    Returns TransactionData

updateBaseFee

  • updateBaseFee(percentage): TransactionData

  • Parameters

    • percentage: number

    Returns TransactionData

updatePercentFee

  • updatePercentFee(percentage): TransactionData

  • Parameters

    • percentage: number

    Returns TransactionData

updatePoolMetadata

  • updatePoolMetadata(__namedParameters): TransactionData

  • Parameters

    • __namedParameters: UpdateMetaDataArgs

    Returns TransactionData

updateRegistry

  • updateRegistry(registry): TransactionData

  • Parameters

    • registry: string

    Returns TransactionData

updateTreasury

  • updateTreasury(registry): TransactionData

  • Parameters

    • registry: string

    Returns TransactionData

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/MicroGrantsStrategy.html b/docs/classes/MicroGrantsStrategy.html index 6c94d43..952b12b 100644 --- a/docs/classes/MicroGrantsStrategy.html +++ b/docs/classes/MicroGrantsStrategy.html @@ -1,4 +1,4 @@ -MicroGrantsStrategy | @allo-team/allo-v2-sdk

Class MicroGrantsStrategy

Constructors

constructor +MicroGrantsStrategy | @allo-team/allo-v2-sdk

Class MicroGrantsStrategy

Constructors

constructor

Properties

allo client contract @@ -44,7 +44,7 @@ setContract setPoolId useRegistryAnchor -

Constructors

constructor

Properties

Private allo

allo: Allo

Private client

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) => Promise<GetProofReturnType>);
    getStorageAt: ((args) => Promise<GetStorageAtReturnType>);
    getTransaction: (<TBlockTag>(args) => Promise<GetTransactionReturnType<Chain, TBlockTag>>);
    getTransactionConfirmations: ((args) => Promise<bigint>);
    getTransactionCount: ((args) => Promise<number>);
    getTransactionReceipt: ((args) => Promise<TransactionReceipt>);
    key: string;
    multicall: (<TContracts, TAllowFailure>(args) => Promise<MulticallReturnType<TContracts, TAllowFailure>>);
    name: string;
    pollingInterval: number;
    prepareTransactionRequest: (<TChainOverride>(args) => Promise<PrepareTransactionRequestReturnType>);
    readContract: (<const TAbi, TFunctionName>(args) => Promise<ReadContractReturnType<TAbi, TFunctionName>>);
    request: EIP1193RequestFn<PublicRpcSchema>;
    sendRawTransaction: ((args) => Promise<`0x${string}`>);
    simulateContract: (<const TAbi, TFunctionName, TChainOverride>(args) => Promise<SimulateContractReturnType<TAbi, TFunctionName, Chain, TChainOverride>>);
    transport: TransportConfig<string, EIP1193RequestFn> & Record<string, any>;
    type: string;
    uid: string;
    uninstallFilter: ((args) => Promise<boolean>);
    verifyMessage: ((args) => Promise<boolean>);
    verifyTypedData: ((args) => Promise<boolean>);
    waitForTransactionReceipt: ((args) => Promise<TransactionReceipt>);
    watchBlockNumber: ((args) => WatchBlockNumberReturnType);
    watchBlocks: (<TIncludeTransactions, TBlockTag>(args) => WatchBlocksReturnType);
    watchContractEvent: (<const TAbi, TEventName, TStrict>(args) => WatchContractEventReturnType);
    watchEvent: (<const TAbiEvent, const TAbiEvents, TStrict>(args) => WatchEventReturnType);
    watchPendingTransactions: ((args) => WatchPendingTransactionsReturnType);
}

Type declaration

  • account: undefined

    The Account of the Client.

    +

Constructors

constructor

Properties

Private allo

allo: Allo

Private client

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) => Promise<GetProofReturnType>);
    getStorageAt: ((args) => Promise<GetStorageAtReturnType>);
    getTransaction: (<TBlockTag>(args) => Promise<GetTransactionReturnType<Chain, TBlockTag>>);
    getTransactionConfirmations: ((args) => Promise<bigint>);
    getTransactionCount: ((args) => Promise<number>);
    getTransactionReceipt: ((args) => Promise<TransactionReceipt>);
    key: string;
    multicall: (<TContracts, TAllowFailure>(args) => Promise<MulticallReturnType<TContracts, TAllowFailure>>);
    name: string;
    pollingInterval: number;
    prepareTransactionRequest: (<TChainOverride>(args) => Promise<PrepareTransactionRequestReturnType>);
    readContract: (<const TAbi, TFunctionName>(args) => Promise<ReadContractReturnType<TAbi, TFunctionName>>);
    request: EIP1193RequestFn<PublicRpcSchema>;
    sendRawTransaction: ((args) => Promise<`0x${string}`>);
    simulateContract: (<const TAbi, TFunctionName, TChainOverride>(args) => Promise<SimulateContractReturnType<TAbi, TFunctionName, Chain, TChainOverride>>);
    transport: TransportConfig<string, EIP1193RequestFn> & Record<string, any>;
    type: string;
    uid: string;
    uninstallFilter: ((args) => Promise<boolean>);
    verifyMessage: ((args) => Promise<boolean>);
    verifyTypedData: ((args) => Promise<boolean>);
    waitForTransactionReceipt: ((args) => Promise<TransactionReceipt>);
    watchBlockNumber: ((args) => WatchBlockNumberReturnType);
    watchBlocks: (<TIncludeTransactions, TBlockTag>(args) => WatchBlocksReturnType);
    watchContractEvent: (<const TAbi, TEventName, TStrict>(args) => WatchContractEventReturnType);
    watchEvent: (<const TAbiEvent, const TAbiEvents, TStrict>(args) => WatchEventReturnType);
    watchPendingTransactions: ((args) => WatchPendingTransactionsReturnType);
}

Type declaration

  • account: undefined

    The Account of the Client.

  • Optional batch?: {
        multicall?: boolean | ({ batchSize?: number | undefined; wait?: number | undefined; });
    }

    Flags for batch settings.

    • Optional multicall?: boolean | ({ batchSize?: number | undefined; wait?: number | undefined; })

      Toggle to enable eth_call multicall aggregation.

  • cacheTime: number

    Time (in ms) that cached data will remain in memory.

    @@ -553,4 +553,4 @@

    Example

    import<
 
    Remarks
    This Action will batch up all the pending transactions found within the pollingInterval, and invoke them via onTransactions.
    
 
    Example
    import { createPublicClient, http } from 'viem'
    import { mainnet } from 'viem/chains'

    const client = createPublicClient({
      chain: mainnet,
      transport: http(),
    })
    const unwatch = await client.watchPendingTransactions({
      onTransactions: (hashes) => console.log(hashes),
    })
 
    
-

Private contract

contract: any

Private poolId

poolId: number

Private strategy

strategy: undefined | `0x${string}`

Methods

allocated

allocationEndTime

allocationStartTime

allocator

approvalThreshold

Private checkPoolId

Private checkStrategy

getAllo

getAllocationData

getBatchAllocationData

getBatchRegisterRecipientData

getBatchSetAllocatorData

getDeployParams

getGovAddress

getHatId

getHatsAddress

getIncreasemaxRequestedAmountData

getInitializeData

getInitializeDataGov

getInitializeDataHats

getMinimumVotePower

getNative

getPayouts

getPoolAmount

getPoolId

getRecipient

getRecipientStatus

getRegisterRecipientData

getSetAllocatorData

getSnapshotReference

getStrategyContractId

getStrategyId

getUpdatePoolTimestampsData

isPoolActive

isValidAllocator

maxRequestedAmount

recipientAllocations

setContract

setPoolId

useRegistryAnchor

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Private contract

contract: any

Private poolId

poolId: number

Private strategy

strategy: undefined | `0x${string}`

Methods

allocated

allocationEndTime

allocationStartTime

allocator

approvalThreshold

Private checkPoolId

Private checkStrategy

getAllo

getAllocationData

getBatchAllocationData

getBatchRegisterRecipientData

getBatchSetAllocatorData

getDeployParams

getGovAddress

getHatId

getHatsAddress

getIncreasemaxRequestedAmountData

getInitializeData

getInitializeDataGov

getInitializeDataHats

getMinimumVotePower

getNative

getPayouts

getPoolAmount

getPoolId

getRecipient

getRecipientStatus

getRegisterRecipientData

getSetAllocatorData

getSnapshotReference

getStrategyContractId

getStrategyId

getUpdatePoolTimestampsData

isPoolActive

isValidAllocator

maxRequestedAmount

recipientAllocations

setContract

setPoolId

useRegistryAnchor

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/Registry.html b/docs/classes/Registry.html index 4737e40..8b18d91 100644 --- a/docs/classes/Registry.html +++ b/docs/classes/Registry.html @@ -1,4 +1,4 @@ -Registry | @allo-team/allo-v2-sdk

Class Registry

Constructors

constructor +Registry | @allo-team/allo-v2-sdk

Class Registry

Constructors

constructor

Properties

client contract

Methods

acceptProfileOwnership @@ -21,7 +21,7 @@ updateProfileMetadata updateProfileName updateProfilePendingOwner -

Constructors

constructor

Properties

Private client

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) => Promise<GetProofReturnType>);
    getStorageAt: ((args) => Promise<GetStorageAtReturnType>);
    getTransaction: (<TBlockTag>(args) => Promise<GetTransactionReturnType<Chain, TBlockTag>>);
    getTransactionConfirmations: ((args) => Promise<bigint>);
    getTransactionCount: ((args) => Promise<number>);
    getTransactionReceipt: ((args) => Promise<TransactionReceipt>);
    key: string;
    multicall: (<TContracts, TAllowFailure>(args) => Promise<MulticallReturnType<TContracts, TAllowFailure>>);
    name: string;
    pollingInterval: number;
    prepareTransactionRequest: (<TChainOverride>(args) => Promise<PrepareTransactionRequestReturnType>);
    readContract: (<const TAbi, TFunctionName>(args) => Promise<ReadContractReturnType<TAbi, TFunctionName>>);
    request: EIP1193RequestFn<PublicRpcSchema>;
    sendRawTransaction: ((args) => Promise<`0x${string}`>);
    simulateContract: (<const TAbi, TFunctionName, TChainOverride>(args) => Promise<SimulateContractReturnType<TAbi, TFunctionName, Chain, TChainOverride>>);
    transport: TransportConfig<string, EIP1193RequestFn> & Record<string, any>;
    type: string;
    uid: string;
    uninstallFilter: ((args) => Promise<boolean>);
    verifyMessage: ((args) => Promise<boolean>);
    verifyTypedData: ((args) => Promise<boolean>);
    waitForTransactionReceipt: ((args) => Promise<TransactionReceipt>);
    watchBlockNumber: ((args) => WatchBlockNumberReturnType);
    watchBlocks: (<TIncludeTransactions, TBlockTag>(args) => WatchBlocksReturnType);
    watchContractEvent: (<const TAbi, TEventName, TStrict>(args) => WatchContractEventReturnType);
    watchEvent: (<const TAbiEvent, const TAbiEvents, TStrict>(args) => WatchEventReturnType);
    watchPendingTransactions: ((args) => WatchPendingTransactionsReturnType);
}

Type declaration

  • account: undefined

    The Account of the Client.

    +

Constructors

constructor

Properties

Private client

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) => Promise<GetProofReturnType>);
    getStorageAt: ((args) => Promise<GetStorageAtReturnType>);
    getTransaction: (<TBlockTag>(args) => Promise<GetTransactionReturnType<Chain, TBlockTag>>);
    getTransactionConfirmations: ((args) => Promise<bigint>);
    getTransactionCount: ((args) => Promise<number>);
    getTransactionReceipt: ((args) => Promise<TransactionReceipt>);
    key: string;
    multicall: (<TContracts, TAllowFailure>(args) => Promise<MulticallReturnType<TContracts, TAllowFailure>>);
    name: string;
    pollingInterval: number;
    prepareTransactionRequest: (<TChainOverride>(args) => Promise<PrepareTransactionRequestReturnType>);
    readContract: (<const TAbi, TFunctionName>(args) => Promise<ReadContractReturnType<TAbi, TFunctionName>>);
    request: EIP1193RequestFn<PublicRpcSchema>;
    sendRawTransaction: ((args) => Promise<`0x${string}`>);
    simulateContract: (<const TAbi, TFunctionName, TChainOverride>(args) => Promise<SimulateContractReturnType<TAbi, TFunctionName, Chain, TChainOverride>>);
    transport: TransportConfig<string, EIP1193RequestFn> & Record<string, any>;
    type: string;
    uid: string;
    uninstallFilter: ((args) => Promise<boolean>);
    verifyMessage: ((args) => Promise<boolean>);
    verifyTypedData: ((args) => Promise<boolean>);
    waitForTransactionReceipt: ((args) => Promise<TransactionReceipt>);
    watchBlockNumber: ((args) => WatchBlockNumberReturnType);
    watchBlocks: (<TIncludeTransactions, TBlockTag>(args) => WatchBlocksReturnType);
    watchContractEvent: (<const TAbi, TEventName, TStrict>(args) => WatchContractEventReturnType);
    watchEvent: (<const TAbiEvent, const TAbiEvents, TStrict>(args) => WatchEventReturnType);
    watchPendingTransactions: ((args) => WatchPendingTransactionsReturnType);
}

Type declaration

  • account: undefined

    The Account of the Client.

  • Optional batch?: {
        multicall?: boolean | ({ batchSize?: number | undefined; wait?: number | undefined; });
    }

    Flags for batch settings.

    • Optional multicall?: boolean | ({ batchSize?: number | undefined; wait?: number | undefined; })

      Toggle to enable eth_call multicall aggregation.

  • cacheTime: number

    Time (in ms) that cached data will remain in memory.

    @@ -530,4 +530,4 @@

    Example

    import<
 
    Remarks
    This Action will batch up all the pending transactions found within the pollingInterval, and invoke them via onTransactions.
    
 
    Example
    import { createPublicClient, http } from 'viem'
    import { mainnet } from 'viem/chains'

    const client = createPublicClient({
      chain: mainnet,
      transport: http(),
    })
    const unwatch = await client.watchPendingTransactions({
      onTransactions: (hashes) => console.log(hashes),
    })
 
    
-

Private contract

contract: any

Methods

acceptProfileOwnership

addMembers

  • addMembers(__namedParameters): TransactionData

  • Parameters

    • __namedParameters: MemberArgs

    Returns TransactionData

createProfile

  • createProfile(__namedParameters): TransactionData

  • Parameters

    • __namedParameters: CreateProfileArgs

    Returns TransactionData

getAlloOwner

getAnchorToProfileId

getDefaultAdminRole

getNative

getProfileByAnchor

getProfileById

getRoleAdmin

hasRole

  • hasRole(__namedParameters): Promise<boolean>

  • Parameters

    • __namedParameters: HasRoleArgs

    Returns Promise<boolean>

isMemberOfProfile

  • isMemberOfProfile(__namedParameters): Promise<boolean>

  • Parameters

    • __namedParameters: ProfileAndAddressArgs

    Returns Promise<boolean>

isOwnerOfProfile

  • isOwnerOfProfile(__namedParameters): Promise<boolean>

  • Parameters

    • __namedParameters: ProfileAndAddressArgs

    Returns Promise<boolean>

isOwnerOrMemberOfProfile

  • isOwnerOrMemberOfProfile(__namedParameters): Promise<boolean>

  • Parameters

    • __namedParameters: ProfileAndAddressArgs

    Returns Promise<boolean>

profileIdToPendingOwner

  • profileIdToPendingOwner(profileId): Promise<string>

  • Parameters

    • profileId: string

    Returns Promise<string>

profilesById

removeMembers

  • removeMembers(__namedParameters): TransactionData

  • Parameters

    • __namedParameters: MemberArgs

    Returns TransactionData

updateProfileMetadata

  • updateProfileMetadata(__namedParameters): TransactionData

  • Parameters

    • __namedParameters: ProfileMetadataArgs

    Returns TransactionData

updateProfileName

  • updateProfileName(__namedParameters): TransactionData

  • Parameters

    • __namedParameters: ProfileNameArgs

    Returns TransactionData

updateProfilePendingOwner

  • updateProfilePendingOwner(__namedParameters): TransactionData

  • Parameters

    • __namedParameters: ProfileAndAddressArgs

    Returns TransactionData

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Private contract

contract: any

Methods

acceptProfileOwnership

addMembers

  • addMembers(__namedParameters): TransactionData

  • Parameters

    • __namedParameters: MemberArgs

    Returns TransactionData

createProfile

  • createProfile(__namedParameters): TransactionData

  • Parameters

    • __namedParameters: CreateProfileArgs

    Returns TransactionData

getAlloOwner

getAnchorToProfileId

getDefaultAdminRole

getNative

getProfileByAnchor

getProfileById

getRoleAdmin

hasRole

  • hasRole(__namedParameters): Promise<boolean>

  • Parameters

    • __namedParameters: HasRoleArgs

    Returns Promise<boolean>

isMemberOfProfile

  • isMemberOfProfile(__namedParameters): Promise<boolean>

  • Parameters

    • __namedParameters: ProfileAndAddressArgs

    Returns Promise<boolean>

isOwnerOfProfile

  • isOwnerOfProfile(__namedParameters): Promise<boolean>

  • Parameters

    • __namedParameters: ProfileAndAddressArgs

    Returns Promise<boolean>

isOwnerOrMemberOfProfile

  • isOwnerOrMemberOfProfile(__namedParameters): Promise<boolean>

  • Parameters

    • __namedParameters: ProfileAndAddressArgs

    Returns Promise<boolean>

profileIdToPendingOwner

  • profileIdToPendingOwner(profileId): Promise<string>

  • Parameters

    • profileId: string

    Returns Promise<string>

profilesById

removeMembers

  • removeMembers(__namedParameters): TransactionData

  • Parameters

    • __namedParameters: MemberArgs

    Returns TransactionData

updateProfileMetadata

  • updateProfileMetadata(__namedParameters): TransactionData

  • Parameters

    • __namedParameters: ProfileMetadataArgs

    Returns TransactionData

updateProfileName

  • updateProfileName(__namedParameters): TransactionData

  • Parameters

    • __namedParameters: ProfileNameArgs

    Returns TransactionData

updateProfilePendingOwner

  • updateProfilePendingOwner(__namedParameters): TransactionData

  • Parameters

    • __namedParameters: ProfileAndAddressArgs

    Returns TransactionData

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/package.json b/package.json index 8d7967c..1a209d5 100644 --- a/package.json +++ b/package.json @@ -6,6 +6,7 @@ "types": "dist/index.d.ts", "license": "MIT", "scripts": { + "docs": "typedoc --out docs src", "test": "jest --no-cache", "test:dev": "jest --watch --no-cache", "build": "tsc",