BeraVote.js

Overview

beravote.js is lightweight and structured JavaScript/Node.js client for interacting with the Beravote API, making it easier to fetch proposals, supported chains, networks, comments, and more.

Beravote.js repository

Get started

Installation

Node.js

To install beravote.js on Node.js, open your terminal and run:

npm i beravote.js

Browser

You can create an index.html file and include beravote.js with:

<script src="https://cdn.jsdelivr.net/gh/BeraVote/beravote.js/dist/beravote.min.js" integrity="sha384-5dVdSwcJ+Rj6EnGCGJRMWfP6d9qUe6Ly4t7SIjuxBZwQ/ytWbZA0ssqa5Pz01kIg" crossorigin="anonymous"></script>

Development

Install dependencies

yarn

Build package (frontend)

yarn build

Usage

Get Api Key

Init client

import ApiClient from 'beravote.js';

const baseUrl = 'https://beravote.com/api/';
const apiKey = 'xxx';
const client = new ApiClient(baseUrl, apiKey);

Available Methods

Chains & Networks

getChains()

Fetches all supported chains.

await client.getChains();

getNetworks()

Fetches all supported networks.

await client.getNetworks();

Popular Content

getPopularProposals()

Fetches the hottest proposals on the platform.

await client.getPopularProposals();

Proposals

getProposalsByCid(proposalCid)

Fetch a specific proposal by CID.

await client.getProposalsByCid('Qma9JvYhfYNfkGpiztiRBsMUWFFUtyau9m6Hm5nVu6JNaX');

getProposalLists(spaceName, { page, pageSize })

List proposals in a space.

await client.getProposalLists('beravote', { page: 1, pageSize: 10 });

getPendingProposals(spaceName, { page, pageSize })

Fetch proposals pending execution.

await client.getPendingProposals('beravote', { page: 1 });

getActiveProposals(spaceName, { page, pageSize })

List currently active proposals.

await client.getActiveProposals('beravote');

getClosedProposals(spaceName, { page, pageSize })

List closed (finished) proposals.

await client.getClosedProposals('beravote');

Comments & Votes

getProposalComments(proposalCid, { page, pageSize })

Fetch comments for a proposal.

await client.getProposalComments('Qma9JvYhfYNfkGpiztiRBsMUWFFUtyau9m6Hm5nVu6JNaX', { page: 1 });

getProposalVotes(proposalCid, { page, pageSize })

Fetch all votes on a proposal.

await client.getProposalVotes('Qma9JvYhfYNfkGpiztiRBsMUWFFUtyau9m6Hm5nVu6JNaX', { page: 1 });

getVotes(proposalCid, address)

Get vote by a specific address on a proposal.

await client.getVotes('Qma9JvYhfYNfkGpiztiRBsMUWFFUtyau9m6Hm5nVu6JNaX', '0x18a428ce0c31584a21cf8cefdb8849d8013e1994');

getFilterVotes(proposalCid, network, address)

Get filtered vote details by network and address.

await client.getFilterVotes('Qma9JvYhfYNfkGpiztiRBsMUWFFUtyau9m6Hm5nVu6JNaX', 'berachain-mainnet', '0x18a428ce0c31584a21cf8cefdb8849d8013e1994');

Stats & Balances

findProposalStats(proposalCid, network, address)

Get vote stats for a proposal by user and network.

await client.findProposalStats('Qma9JvYhfYNfkGpiztiRBsMUWFFUtyau9m6Hm5nVu6JNaX', 'berachain-mainnet', '0x18a428ce0c31584a21cf8cefdb8849d8013e1994');

getProposalVoterBalance(proposalCid, network, address)

Get voter balance on a proposal.

await client.getProposalVoterBalance('Qma9JvYhfYNfkGpiztiRBsMUWFFUtyau9m6Hm5nVu6JNaX', 'berachain-mainnet', '0x18a428ce0c31584a21cf8cefdb8849d8013e1994');

getSpaceStats(spaceName)

Stats for a given space.

await client.getSpaceStats('beravote');

Spaces

getJoinedSpaces(address)

Get spaces joined by a user.

await client.getJoinedSpaces('0x227d660c0dE72cd2480e0E831701C070e6741B3D');

getOwnerSpaces(address)

Get spaces owned by an address.

await client.getOwnerSpaces('0x227d660c0dE72cd2480e0E831701C070e6741B3D');

getSpaceMembers(spaceName)

List all members of a space.

await client.getSpaceMembers('beravote');

getSpaceDetails(spaceName)

Fetch metadata and settings for a space.

await client.getSpaceDetails('beravote');

getNetworkSpaces(network)

Get all spaces by network.

await client.getNetworkSpaces('berachain-mainnet');

getAllSpaces()

Fetch all visible spaces.

await client.getAllSpaces();

getAllSpacesWithoutFilter()

Fetch all raw spaces without filters.

await client.getAllSpacesWithoutFilter();