Skip to main content

Check Voting Rights

Check if an Address Can Vote in a Token Voting proposal

This function returns a boolean indicating whether an address can vote in a specific TokenVoting proposal.

import {
CanVoteParams,
TokenVotingClient,
VoteValues,
} from "@aragon/sdk-client";
import { context } from "../index";

// Create an TokenVoting client.
const tokenVotingClient: TokenVotingClient = new TokenVotingClient(
context,
);

const canVoteParams: CanVoteParams = {
proposalId: "0x1234567890123456789012345678901234567890_0x0",
voterAddressOrEns: "0x1234567890123456789012345678901234567890", // your-plugin.plugin.dao.eth
vote: VoteValues.YES, // alternatively, could be NO or ABSTAIN.
};

// Returns true or false depending on whether the address can vote in the specific proposal.
const canVote: boolean = await tokenVotingClient.methods.canVote(canVoteParams);
console.log(canVote);

Returns:

true
© 2024