Skip to content

Commit

Permalink
Update vocdoni-sdk docs by commit a78d294
Browse files Browse the repository at this point in the history
  • Loading branch information
marcvelmer authored and arabot-1 committed Sep 4, 2024
1 parent 8d46273 commit 7f88059
Show file tree
Hide file tree
Showing 304 changed files with 24,969 additions and 3,005 deletions.
47 changes: 47 additions & 0 deletions docs/sdk/reference/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,50 @@ 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.9.0] - 2024-09-04

### Added

- New `RemoteSigner` signer that can be handled by the client.
- New election type `QuadraticElection`.
- Added new count fields information for `AccountData`.
- New errors generated in the API.

### Changed

- [**BREAKING**] New pagination system and removed deprecated API functions.
- Better and new improvements to the SDK bundling system.

### Removed

- Removed archive functionality for elections and all their components.
- Removed deprecated `autoStart` field from elections.

## [0.8.3] - 2024-06-12

### Added

- Added new transaction for changing an election duration.
- Added new functions `changeElectionEndDate` and `changeElectionDuration`.
- Added new raw information when election data is not complete.

### Changed

- Census3 `getStrategyHolders` changed for using queues instead of direct endpoint call.

## [0.8.2] - 2024-06-12

### Added

- Added API fees calls functions for checking all fees and account fees.
- Added new function to modify an election maximum census size.
- Added new `delta` parameter when checking for next election identifiers.

### Changed

- Census publishing is done async to avoid 502 errors when uploading large censuses.
- Modified change census function to accept a new maximum census size.

## [0.8.1] - 2024-05-21

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

- First unstable version of the SDK for testing purposes

[0.9.0]: https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.9.0
[0.8.3]: https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.8.3
[0.8.2]: https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.8.2
[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
Expand Down
29 changes: 29 additions & 0 deletions docs/sdk/reference/classes/API.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
[@vocdoni/sdk](/sdk) / API

# Class: API

## Hierarchy

- **`API`**

[`AccountAPI`](AccountAPI)

[`CensusAPI`](CensusAPI)

[`ChainAPI`](ChainAPI)

[`ElectionAPI`](ElectionAPI)

[`FaucetAPI`](FaucetAPI)

[`FileAPI`](FileAPI)

[`VoteAPI`](VoteAPI)

[`WalletAPI`](WalletAPI)

[`CspAPI`](CspAPI)

[`ZkAPI`](ZkAPI)

[`RemoteSignerAPI`](RemoteSignerAPI)
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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L108)
[src/types/account.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/a78d29483c0d505bd487f45bf7f076ca488c6b86/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L112)
[src/types/account.ts:112](https://github.com/vocdoni/vocdoni-sdk/blob/a78d29483c0d505bd487f45bf7f076ca488c6b86/src/types/account.ts#L112)

___

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

#### Defined in

[types/account.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L92)
[src/types/account.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/a78d29483c0d505bd487f45bf7f076ca488c6b86/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L96)
[src/types/account.ts:96](https://github.com/vocdoni/vocdoni-sdk/blob/a78d29483c0d505bd487f45bf7f076ca488c6b86/src/types/account.ts#L96)

___

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

#### Defined in

[types/account.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L124)
[src/types/account.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/a78d29483c0d505bd487f45bf7f076ca488c6b86/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L128)
[src/types/account.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/a78d29483c0d505bd487f45bf7f076ca488c6b86/src/types/account.ts#L128)

___

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

#### Defined in

[types/account.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L100)
[src/types/account.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/a78d29483c0d505bd487f45bf7f076ca488c6b86/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L104)
[src/types/account.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/a78d29483c0d505bd487f45bf7f076ca488c6b86/src/types/account.ts#L104)

___

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

#### Defined in

[types/account.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L140)
[src/types/account.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/a78d29483c0d505bd487f45bf7f076ca488c6b86/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L144)
[src/types/account.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/a78d29483c0d505bd487f45bf7f076ca488c6b86/src/types/account.ts#L144)

___

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

#### Defined in

[types/account.ts:116](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L116)
[src/types/account.ts:116](https://github.com/vocdoni/vocdoni-sdk/blob/a78d29483c0d505bd487f45bf7f076ca488c6b86/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L120)
[src/types/account.ts:120](https://github.com/vocdoni/vocdoni-sdk/blob/a78d29483c0d505bd487f45bf7f076ca488c6b86/src/types/account.ts#L120)

___

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

#### Defined in

[types/account.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L132)
[src/types/account.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/a78d29483c0d505bd487f45bf7f076ca488c6b86/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L136)
[src/types/account.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/a78d29483c0d505bd487f45bf7f076ca488c6b86/src/types/account.ts#L136)

___

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

#### Defined in

[types/account.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L84)
[src/types/account.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/a78d29483c0d505bd487f45bf7f076ca488c6b86/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L88)
[src/types/account.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/a78d29483c0d505bd487f45bf7f076ca488c6b86/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L33)
[src/types/account.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/a78d29483c0d505bd487f45bf7f076ca488c6b86/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L65)
[src/types/account.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/a78d29483c0d505bd487f45bf7f076ca488c6b86/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L61)
[src/types/account.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/a78d29483c0d505bd487f45bf7f076ca488c6b86/src/types/account.ts#L61)
Loading

0 comments on commit 7f88059

Please sign in to comment.