Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs with vocdoni-sdk repo changes #126

Merged
merged 1 commit into from
May 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/sdk/reference/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,29 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.8.1] - 2024-05-21

### Added

- Support for encrypted metadata for elections.
- Vote information for encrypted votes with the corresponding vote package.

## [0.8.0] - 2024-04-19

### Added

- Several new examples in `examples` folder for beginners.
- New Census3 function to estimate the time of creating a census based on a predicate.
- Added `StrategyCensus` type for representing census created in Census3 based on a complex strategy.

### Changed

- Internal usage of dates instead of blocks when creating an election.

### Fixed

- Fixed anonymous `voteHash` by using the `votePackage` to generate zk-inputs.

## [0.7.5] - 2024-02-15

### Added
Expand Down Expand Up @@ -450,6 +473,9 @@ which extend from the abstract `Election` class.

- First unstable version of the SDK for testing purposes

[0.8.1]: https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.8.1
[0.8.0]: https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.8.0
[0.7.5]: https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.7.5
[0.7.4]: https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.7.4
[0.7.3]: https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.7.3
[0.7.2]: https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.7.2
Expand Down
38 changes: 19 additions & 19 deletions docs/sdk/reference/classes/Account.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Represents an account

#### Defined in

[types/account.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/types/account.ts#L108)
[types/account.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L108)

• `set` **avatar**(`value`): `void`

Expand All @@ -54,7 +54,7 @@ Represents an account

#### Defined in

[types/account.ts:112](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/types/account.ts#L112)
[types/account.ts:112](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L112)

___

Expand All @@ -68,7 +68,7 @@ ___

#### Defined in

[types/account.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/types/account.ts#L92)
[types/account.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L92)

• `set` **description**(`value`): `void`

Expand All @@ -84,7 +84,7 @@ ___

#### Defined in

[types/account.ts:96](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/types/account.ts#L96)
[types/account.ts:96](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L96)

___

Expand All @@ -98,7 +98,7 @@ ___

#### Defined in

[types/account.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/types/account.ts#L124)
[types/account.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L124)

• `set` **feed**(`value`): `void`

Expand All @@ -114,7 +114,7 @@ ___

#### Defined in

[types/account.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/types/account.ts#L128)
[types/account.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L128)

___

Expand All @@ -128,7 +128,7 @@ ___

#### Defined in

[types/account.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/types/account.ts#L100)
[types/account.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L100)

• `set` **header**(`value`): `void`

Expand All @@ -144,7 +144,7 @@ ___

#### Defined in

[types/account.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/types/account.ts#L104)
[types/account.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L104)

___

Expand All @@ -158,7 +158,7 @@ ___

#### Defined in

[types/account.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/types/account.ts#L140)
[types/account.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L140)

• `set` **languages**(`value`): `void`

Expand All @@ -174,7 +174,7 @@ ___

#### Defined in

[types/account.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/types/account.ts#L144)
[types/account.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L144)

___

Expand All @@ -188,7 +188,7 @@ ___

#### Defined in

[types/account.ts:116](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/types/account.ts#L116)
[types/account.ts:116](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L116)

• `set` **logo**(`value`): `void`

Expand All @@ -204,7 +204,7 @@ ___

#### Defined in

[types/account.ts:120](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/types/account.ts#L120)
[types/account.ts:120](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L120)

___

Expand All @@ -218,7 +218,7 @@ ___

#### Defined in

[types/account.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/types/account.ts#L132)
[types/account.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L132)

• `set` **meta**(`value`): `void`

Expand All @@ -234,7 +234,7 @@ ___

#### Defined in

[types/account.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/types/account.ts#L136)
[types/account.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L136)

___

Expand All @@ -248,7 +248,7 @@ ___

#### Defined in

[types/account.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/types/account.ts#L84)
[types/account.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L84)

• `set` **name**(`value`): `void`

Expand All @@ -264,7 +264,7 @@ ___

#### Defined in

[types/account.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/types/account.ts#L88)
[types/account.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L88)

## Constructors

Expand All @@ -286,7 +286,7 @@ Constructs an account

#### Defined in

[types/account.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/types/account.ts#L33)
[types/account.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L33)

## Methods

Expand All @@ -300,7 +300,7 @@ Constructs an account

#### Defined in

[types/account.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/types/account.ts#L65)
[types/account.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L65)

___

Expand All @@ -322,4 +322,4 @@ Returns an account object

#### Defined in

[types/account.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/types/account.ts#L61)
[types/account.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L61)
16 changes: 8 additions & 8 deletions docs/sdk/reference/classes/AccountAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Returns the number of accounts

#### Defined in

[api/account.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/api/account.ts#L131)
[api/account.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/api/account.ts#L131)

___

Expand All @@ -65,7 +65,7 @@ Returns paginated list of elections for a specific account

#### Defined in

[api/account.ts:212](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/api/account.ts#L212)
[api/account.ts:212](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/api/account.ts#L212)

___

Expand All @@ -88,7 +88,7 @@ Fetches an Account information

#### Defined in

[api/account.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/api/account.ts#L144)
[api/account.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/api/account.ts#L144)

___

Expand All @@ -111,7 +111,7 @@ Returns paginated list of accounts

#### Defined in

[api/account.ts:119](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/api/account.ts#L119)
[api/account.ts:119](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/api/account.ts#L119)

___

Expand All @@ -134,7 +134,7 @@ Fetches the account metadata

#### Defined in

[api/account.ts:157](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/api/account.ts#L157)
[api/account.ts:157](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/api/account.ts#L157)

___

Expand All @@ -158,7 +158,7 @@ Sets Account information

#### Defined in

[api/account.ts:171](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/api/account.ts#L171)
[api/account.ts:171](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/api/account.ts#L171)

___

Expand All @@ -181,7 +181,7 @@ Returns the account's transfers count

#### Defined in

[api/account.ts:198](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/api/account.ts#L198)
[api/account.ts:198](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/api/account.ts#L198)

___

Expand All @@ -205,4 +205,4 @@ Returns paginated list of transfers for a specific account

#### Defined in

[api/account.ts:185](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/api/account.ts#L185)
[api/account.ts:185](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/api/account.ts#L185)
12 changes: 6 additions & 6 deletions docs/sdk/reference/classes/AccountService.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Service.constructor

#### Defined in

[services/account.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/services/account.ts#L45)
[services/account.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/services/account.ts#L45)

## Methods

Expand All @@ -75,7 +75,7 @@ Fetches account information.

#### Defined in

[services/account.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/services/account.ts#L55)
[services/account.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/services/account.ts#L55)

___

Expand All @@ -100,7 +100,7 @@ The transaction hash

#### Defined in

[services/account.ts:95](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/services/account.ts#L95)
[services/account.ts:95](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/services/account.ts#L95)

___

Expand All @@ -122,7 +122,7 @@ ___

#### Defined in

[services/account.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/services/account.ts#L100)
[services/account.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/services/account.ts#L100)

## Properties

Expand All @@ -136,7 +136,7 @@ AccountServiceProperties.chainService

#### Defined in

[services/account.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/services/account.ts#L38)
[services/account.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/services/account.ts#L38)

___

Expand All @@ -150,4 +150,4 @@ ___

#### Defined in

[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/66360b95227306027699be0e80826ca7975027a0/src/services/service.ts#L6)
[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/services/service.ts#L6)
Loading
Loading