@vocdoni/extended-sdk

Vocdoni is the first universally verifiable, censorship-resistant, anonymous, and self-sovereign governance protocol.
Our main aim is a trustless voting system where anyone can speak their voice and where everything is auditable.
We are engineering building blocks for a permissionless, private and censorship resistant democracy.
Explore the developer portal »

More About Us

Vocdoni Website | Web Application | Blockchain Explorer | MIT Law Publication | Contact Us

Key Repositories

Vocdoni Node | Vocdoni SDK | UI Components | Application UI | Census3

@vocdoni/extended-sdk

This package is an extension of the Vocdoni SDK client that implements some functions that are not included on the original SDK. These functions are related to Vochain statistics, blocks, transactions etc... Which are not intended to be used for common users.

To use it add the custom client on the provider like this:

import { ExtendedSDKClient } from '@vocdoni/extended-sdk';
import { ClientProvider } from '@vocdoni/chakra-components';

const VocdoniSdkProvider = ({ children }: { children: ReactNode }) => {
  const environment = VOCDONI_ENVIRONMENT as EnvOptions;

  const sdkClient = new ExtendedSDKClient({
    env: environment,
  });

  return (
      <ClientProvider client={sdkClient}>
        {children}
      </ClientProvider>
  );
};

And then, at places you want to use it, specify the client type like:

const { client } = useClient<ExtendedSDKClient>();

Disclaimer

This project is a WIP and is subject to continuous changes during its development. We encourage you to review this repository and the developer portal for any changes.

Contributing

While we welcome contributions from the community, we do not track all of our issues on Github and we may not have the resources to onboard developers and review complex pull requests. That being said, there are multiple ways you can get involved with the project.

Please review our development guidelines.

License

This repository is licensed under the GNU Affero General Public License v3.0.

Vocdoni UI React Components
Copyright (C) 2024 Vocdoni Association

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.