From aaccbca722b213d6e1d1c69b1d0722406409a772 Mon Sep 17 00:00:00 2001 From: NateWilliams2 Date: Thu, 28 Mar 2024 14:58:30 -0400 Subject: [PATCH] TypeDoc: update typedoc.json --- docs/protocol/ballot-protocol.md | 8 +- docs/sdk/index.md | 2 +- docs/sdk/reference/classes/Account.md | 181 +--- docs/sdk/reference/classes/AccountAPI.md | 93 +- docs/sdk/reference/classes/AccountService.md | 82 +- .../sdk/reference/classes/AnonymousService.md | 240 ++--- docs/sdk/reference/classes/AnonymousVote.md | 99 +- .../sdk/reference/classes/ApprovalElection.md | 351 ++----- .../sdk/reference/classes/ArchivedElection.md | 349 ++----- docs/sdk/reference/classes/BudgetElection.md | 393 ++----- docs/sdk/reference/classes/Census.md | 114 +- .../sdk/reference/classes/Census3CensusAPI.md | 110 +- .../reference/classes/Census3ServiceAPI.md | 104 +- .../reference/classes/Census3StrategyAPI.md | 128 +-- docs/sdk/reference/classes/Census3TokenAPI.md | 116 +-- docs/sdk/reference/classes/CensusAPI.md | 97 +- docs/sdk/reference/classes/CensusService.md | 177 ++-- docs/sdk/reference/classes/ChainAPI.md | 109 +- docs/sdk/reference/classes/ChainService.md | 148 +-- docs/sdk/reference/classes/CspCensus.md | 136 +-- docs/sdk/reference/classes/CspService.md | 86 +- docs/sdk/reference/classes/CspVote.md | 99 +- docs/sdk/reference/classes/Election.md | 217 +--- docs/sdk/reference/classes/ElectionAPI.md | 97 +- docs/sdk/reference/classes/ElectionService.md | 210 ++-- docs/sdk/reference/classes/FaucetAPI.md | 79 +- docs/sdk/reference/classes/FaucetService.md | 80 +- docs/sdk/reference/classes/FileAPI.md | 79 +- docs/sdk/reference/classes/FileService.md | 44 +- docs/sdk/reference/classes/InvalidElection.md | 64 +- .../reference/classes/MultiChoiceElection.md | 374 ++----- docs/sdk/reference/classes/OffchainCensus.md | 176 +--- docs/sdk/reference/classes/PlainCensus.md | 191 +--- docs/sdk/reference/classes/PublishedCensus.md | 142 +-- .../reference/classes/PublishedElection.md | 492 ++------- docs/sdk/reference/classes/Service.md | 24 +- docs/sdk/reference/classes/TokenCensus.md | 165 +-- .../reference/classes/UnpublishedElection.md | 391 ++----- .../reference/classes/VocdoniCensus3Client.md | 140 +-- .../sdk/reference/classes/VocdoniSDKClient.md | 974 ++++++++---------- docs/sdk/reference/classes/Vote.md | 66 +- docs/sdk/reference/classes/VoteAPI.md | 83 +- docs/sdk/reference/classes/VoteService.md | 80 +- docs/sdk/reference/classes/WalletAPI.md | 79 +- docs/sdk/reference/classes/WeightedCensus.md | 191 +--- docs/sdk/reference/enums/CensusOrigin.md | 22 +- docs/sdk/reference/enums/CensusType.md | 10 +- docs/sdk/reference/enums/CensusTypeEnum.md | 20 +- docs/sdk/reference/enums/CspProofType.md | 10 +- .../reference/enums/ElectionCreationSteps.md | 18 +- .../enums/ElectionResultsTypeNames.md | 10 +- docs/sdk/reference/enums/ElectionStatus.md | 16 +- .../reference/enums/ElectionStatusReady.md | 4 +- docs/sdk/reference/enums/EnvOptions.md | 8 +- docs/sdk/reference/enums/TransactionType.md | 24 +- docs/sdk/reference/enums/TxType.md | 52 +- docs/sdk/reference/enums/VoteSteps.md | 16 +- .../reference/interfaces/AccountMetadata.md | 16 +- docs/sdk/reference/interfaces/AdminTx.md | 20 +- .../sdk/reference/interfaces/CircuitInputs.md | 26 +- .../reference/interfaces/CollectFaucetTx.md | 8 +- .../reference/interfaces/ElectionMetadata.md | 18 +- .../interfaces/FetchElectionsParameters.md | 6 +- docs/sdk/reference/interfaces/IAccount.md | 18 +- .../IAccountTransfersCountResponse.md | 4 +- .../interfaces/IAccountsCountResponse.md | 4 +- .../interfaces/IAccountsListResponse.md | 6 +- .../interfaces/IApprovalElectionParameters.md | 30 +- .../interfaces/IBlockTransactionsResponse.md | 8 +- .../IBudgetElectionParametersInfo.md | 34 +- .../IBudgetElectionParametersWithBudget.md | 38 +- ...udgetElectionParametersWithCensusWeight.md | 36 +- docs/sdk/reference/interfaces/ICensus.md | 12 +- .../interfaces/ICensus3CensusListResponse.md | 4 +- .../interfaces/ICensus3CensusQueueResponse.md | 10 +- .../interfaces/ICensus3CensusResponse.md | 18 +- .../interfaces/ICensus3ServiceInfoResponse.md | 4 +- .../ICensus3StrategiesListResponse.md | 6 +- ...ICensus3StrategiesListResponsePaginated.md | 8 +- .../interfaces/ICensus3StrategiesOperator.md | 6 +- .../ICensus3StrategiesOperatorsResponse.md | 4 +- .../ICensus3StrategyCreateResponse.md | 4 +- ...ICensus3StrategyEstimationQueueResponse.md | 10 +- .../ICensus3StrategyHoldersResponse.md | 4 +- ...Census3StrategyHoldersResponsePaginated.md | 6 +- .../ICensus3StrategyImportQueueResponse.md | 12 +- .../interfaces/ICensus3StrategyToken.md | 10 +- .../interfaces/ICensus3SupportedChain.md | 8 +- .../interfaces/ICensus3TokenHolderResponse.md | 4 +- .../interfaces/ICensus3TokenListResponse.md | 6 +- .../ICensus3TokenListResponsePaginated.md | 8 +- .../interfaces/ICensus3TokenTypesResponse.md | 4 +- .../ICensus3ValidatePredicateChild.md | 6 +- .../ICensus3ValidatePredicateResponse.md | 4 +- .../ICensus3ValidatePredicateToken.md | 4 +- .../interfaces/ICensusExportResponse.md | 10 +- .../interfaces/ICensusImportResponse.md | 2 +- .../interfaces/ICensusParticipant.md | 6 +- .../interfaces/ICensusProofResponse.md | 14 +- .../interfaces/ICensusPublishResponse.md | 6 +- .../interfaces/IChainBlockInfoResponse.md | 12 +- .../interfaces/IChainGetCircuitResponse.md | 20 +- .../interfaces/IChainGetCostsResponse.md | 8 +- .../interfaces/IChainGetInfoResponse.md | 28 +- .../IChainOrganizationCountResponse.md | 4 +- .../IChainOrganizationListResponse.md | 4 +- .../interfaces/IChainOrganizationResponse.md | 6 +- .../interfaces/IChainSubmitTxResponse.md | 8 +- .../interfaces/IChainTxCountResponse.md | 4 +- .../interfaces/IChainTxListResponse.md | 4 +- .../reference/interfaces/IChainTxReference.md | 12 +- .../reference/interfaces/IChainValidator.md | 10 +- .../IChainValidatorsListResponse.md | 4 +- docs/sdk/reference/interfaces/IChoice.md | 10 +- .../interfaces/IElectionCreateResponse.md | 8 +- .../interfaces/IElectionInfoResponse.md | 38 +- .../interfaces/IElectionKeysResponse.md | 6 +- .../interfaces/IElectionListFilter.md | 10 +- .../interfaces/IElectionListResponse.md | 4 +- .../sdk/reference/interfaces/IElectionMode.md | 12 +- .../interfaces/IElectionNextIdResponse.md | 4 +- .../interfaces/IElectionParameters.md | 30 +- .../reference/interfaces/IElectionSummary.md | 16 +- .../sdk/reference/interfaces/IElectionType.md | 12 +- .../sdk/reference/interfaces/IElectionVote.md | 12 +- .../interfaces/IElectionVoteListResponse.md | 4 +- .../reference/interfaces/IEncryptionKey.md | 6 +- .../interfaces/IInvalidElectionParameters.md | 4 +- .../IMultiChoiceElectionParameters.md | 36 +- .../IPublishedElectionParameters.md | 60 +- docs/sdk/reference/interfaces/IQuestion.md | 10 +- docs/sdk/reference/interfaces/ITallyMode.md | 12 +- .../reference/interfaces/IVoteInfoResponse.md | 22 +- docs/sdk/reference/interfaces/IVoteMode.md | 12 +- .../interfaces/IVoteSubmitResponse.md | 6 +- docs/sdk/reference/interfaces/IVoteType.md | 16 +- docs/sdk/reference/interfaces/MintTokensTx.md | 10 +- docs/sdk/reference/interfaces/NewProcessTx.md | 8 +- docs/sdk/reference/interfaces/Process.md | 64 +- docs/sdk/reference/interfaces/Proof.md | 4 +- .../sdk/reference/interfaces/RegisterKeyTx.md | 12 +- docs/sdk/reference/interfaces/SendTokensTx.md | 12 +- .../reference/interfaces/ServiceProperties.md | 4 +- docs/sdk/reference/interfaces/SetAccountTx.md | 14 +- docs/sdk/reference/interfaces/SetProcessTx.md | 20 +- .../interfaces/SetTransactionCostsTx.md | 8 +- docs/sdk/reference/interfaces/Tx.md | 6 +- docs/sdk/reference/interfaces/VoteEnvelope.md | 14 +- .../{modules.md => sdk-reference.md} | 718 +++++++------ package.json | 6 +- sidebar.js | 43 +- 151 files changed, 3004 insertions(+), 6755 deletions(-) rename docs/sdk/reference/{modules.md => sdk-reference.md} (75%) diff --git a/docs/protocol/ballot-protocol.md b/docs/protocol/ballot-protocol.md index 59938e28b..64bf7bbc8 100644 --- a/docs/protocol/ballot-protocol.md +++ b/docs/protocol/ballot-protocol.md @@ -22,7 +22,7 @@ The protocol is composed by a set of numeric and boolean variables that restrict - `uint8 maxCount` Max number of fields per ballot. 1 <= maxCount <= 100. - `uint8 maxValue` -Determines the acceptable maximum value for all fields. If `maxValue` is set to `0`, the results are aggregated. +Determines the acceptable maximum value for all fields. If `maxValue` is set to 0, the results are aggregated. - `uint8 minValue` Determines the acceptable minimum value for all fields. - `bool uniqueValues` @@ -37,9 +37,9 @@ Minimum limit on the total sum of all ballot fields' values (if applicable). The exponent that will be used to compute the "cost" of the field values. - `totalCost = Σ (value[i] ^ costExponent) <= maxTotalCost` - `costExponent` is represented as `exp * 10000` so: -- 0 => 0.0000 -- 10000 => 1.0000 -- 65535 => 6.5535 + - 0 => 0.0000 + - 10000 => 1.0000 + - 65535 => 6.5535 ![https://blog.vocdoni.io/_next/image?url=https%3A%2F%2Fstorage.googleapis.com%2Fpapyrus_images%2Fb8d920f2d64cf347ff2f47f7e34a3340.png&w=1920&q=75](https://blog.vocdoni.io/_next/image?url=https%3A%2F%2Fstorage.googleapis.com%2Fpapyrus_images%2Fb8d920f2d64cf347ff2f47f7e34a3340.png&w=1920&q=75) diff --git a/docs/sdk/index.md b/docs/sdk/index.md index 1225fbeb2..261c6c17c 100644 --- a/docs/sdk/index.md +++ b/docs/sdk/index.md @@ -52,7 +52,7 @@ This SDK is licensed under the [GNU Affero General Public License v3.0][license] [builddocs]: https://github.com/vocdoni/vocdoni-sdk/blob/main/docs/README.md [chat]: https://chat.vocdoni.io [esm-gif]: https://raw.githubusercontent.com/vocdoni/vocdoni-sdk/main/examples/esm/esm.gif -[reference]: /sdk/reference/modules +[reference]: /sdk/reference/sdk-reference [tutorial]: /sdk/tutorial [vocdoni-api]: /vocdoni-api/vocdoni-api [license]: https://github.com/vocdoni/vocdoni-sdk/blob/main/LICENSE \ No newline at end of file diff --git a/docs/sdk/reference/classes/Account.md b/docs/sdk/reference/classes/Account.md index 6974d4223..5b9dc9da0 100644 --- a/docs/sdk/reference/classes/Account.md +++ b/docs/sdk/reference/classes/Account.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / Account +[@vocdoni/sdk](/sdk) / Account # Class: Account @@ -6,21 +6,6 @@ Represents an account ## Table of contents -### Constructors - -- [constructor](Account#constructor) - -### Properties - -- [\_avatar](Account.md#_avatar) -- [\_description](Account.md#_description) -- [\_feed](Account.md#_feed) -- [\_header](Account.md#_header) -- [\_languages](Account.md#_languages) -- [\_logo](Account.md#_logo) -- [\_meta](Account.md#_meta) -- [\_name](Account.md#_name) - ### Accessors - [avatar](Account#avatar) @@ -32,113 +17,15 @@ Represents an account - [meta](Account#meta) - [name](Account#name) +### Constructors + +- [constructor](Account#constructor) + ### Methods - [generateMetadata](Account#generatemetadata) - [build](Account#build) -## Constructors - -### constructor - -• **new Account**(`params?`): [`Account`](Account) - -Constructs an account - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params?` | [`IAccount`](../interfaces/IAccount) | Account parameters | - -#### Returns - -[`Account`](Account) - -#### Defined in - -[types/account.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L33) - -## Properties - -### \_avatar - -• `Private` **\_avatar**: `string` - -#### Defined in - -[types/account.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L24) - -___ - -### \_description - -• `Private` **\_description**: `MultiLanguage`\<`string`\> - -#### Defined in - -[types/account.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L21) - -___ - -### \_feed - -• `Private` **\_feed**: `MultiLanguage`\<`string`\> - -#### Defined in - -[types/account.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L22) - -___ - -### \_header - -• `Private` **\_header**: `string` - -#### Defined in - -[types/account.ts:23](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L23) - -___ - -### \_languages - -• `Private` **\_languages**: `string`[] - -#### Defined in - -[types/account.ts:19](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L19) - -___ - -### \_logo - -• `Private` **\_logo**: `string` - -#### Defined in - -[types/account.ts:25](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L25) - -___ - -### \_meta - -• `Private` **\_meta**: \{ `key`: `string` ; `value`: `any` }[] - -#### Defined in - -[types/account.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L26) - -___ - -### \_name - -• `Private` **\_name**: `MultiLanguage`\<`string`\> - -#### Defined in - -[types/account.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L20) - ## Accessors ### avatar @@ -151,7 +38,7 @@ ___ #### Defined in -[types/account.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L108) +[types/account.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L108) • `set` **avatar**(`value`): `void` @@ -167,7 +54,7 @@ ___ #### Defined in -[types/account.ts:112](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L112) +[types/account.ts:112](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L112) ___ @@ -181,7 +68,7 @@ ___ #### Defined in -[types/account.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L92) +[types/account.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L92) • `set` **description**(`value`): `void` @@ -197,7 +84,7 @@ ___ #### Defined in -[types/account.ts:96](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L96) +[types/account.ts:96](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L96) ___ @@ -211,7 +98,7 @@ ___ #### Defined in -[types/account.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L124) +[types/account.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L124) • `set` **feed**(`value`): `void` @@ -227,7 +114,7 @@ ___ #### Defined in -[types/account.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L128) +[types/account.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L128) ___ @@ -241,7 +128,7 @@ ___ #### Defined in -[types/account.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L100) +[types/account.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L100) • `set` **header**(`value`): `void` @@ -257,7 +144,7 @@ ___ #### Defined in -[types/account.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L104) +[types/account.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L104) ___ @@ -271,7 +158,7 @@ ___ #### Defined in -[types/account.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L140) +[types/account.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L140) • `set` **languages**(`value`): `void` @@ -287,7 +174,7 @@ ___ #### Defined in -[types/account.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L144) +[types/account.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L144) ___ @@ -301,7 +188,7 @@ ___ #### Defined in -[types/account.ts:116](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L116) +[types/account.ts:116](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L116) • `set` **logo**(`value`): `void` @@ -317,7 +204,7 @@ ___ #### Defined in -[types/account.ts:120](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L120) +[types/account.ts:120](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L120) ___ @@ -331,7 +218,7 @@ ___ #### Defined in -[types/account.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L132) +[types/account.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L132) • `set` **meta**(`value`): `void` @@ -347,7 +234,7 @@ ___ #### Defined in -[types/account.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L136) +[types/account.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L136) ___ @@ -361,7 +248,7 @@ ___ #### Defined in -[types/account.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L84) +[types/account.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L84) • `set` **name**(`value`): `void` @@ -377,7 +264,29 @@ ___ #### Defined in -[types/account.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L88) +[types/account.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L88) + +## Constructors + +### constructor + +• **new Account**(`params?`): [`Account`](Account) + +Constructs an account + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `params?` | [`IAccount`](../interfaces/IAccount) | Account parameters | + +#### Returns + +[`Account`](Account) + +#### Defined in + +[types/account.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L33) ## Methods @@ -391,7 +300,7 @@ ___ #### Defined in -[types/account.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L65) +[types/account.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L65) ___ @@ -413,4 +322,4 @@ Returns an account object #### Defined in -[types/account.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L61) +[types/account.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L61) diff --git a/docs/sdk/reference/classes/AccountAPI.md b/docs/sdk/reference/classes/AccountAPI.md index 2c90ec5db..7fc5d6971 100644 --- a/docs/sdk/reference/classes/AccountAPI.md +++ b/docs/sdk/reference/classes/AccountAPI.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / AccountAPI +[@vocdoni/sdk](/sdk) / AccountAPI # Class: AccountAPI @@ -10,43 +10,17 @@ ## Table of contents -### Constructors - -- [constructor](AccountAPI#constructor) - ### Methods - [count](AccountAPI#count) - [electionsList](AccountAPI#electionslist) - [info](AccountAPI#info) -- [isApiError](AccountAPI#isapierror) -- [isUndefinedError](AccountAPI#isundefinederror) - [list](AccountAPI#list) - [metadata](AccountAPI#metadata) - [setInfo](AccountAPI#setinfo) - [transfersCount](AccountAPI#transferscount) - [transfersList](AccountAPI#transferslist) -## Constructors - -### constructor - -• **new AccountAPI**(): [`AccountAPI`](AccountAPI) - -Cannot be constructed. - -#### Returns - -[`AccountAPI`](AccountAPI) - -#### Overrides - -API.constructor - -#### Defined in - -[api/account.ts:109](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/account.ts#L109) - ## Methods ### count @@ -67,7 +41,7 @@ Returns the number of accounts #### Defined in -[api/account.ts:133](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/account.ts#L133) +[api/account.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/account.ts#L131) ___ @@ -91,7 +65,7 @@ Returns paginated list of elections for a specific account #### Defined in -[api/account.ts:220](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/account.ts#L220) +[api/account.ts:212](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/account.ts#L212) ___ @@ -114,56 +88,7 @@ Fetches an Account information #### Defined in -[api/account.ts:147](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/account.ts#L147) - -___ - -### isApiError - -▸ **isApiError**(`error`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `AxiosError`\<`unknown`, `any`\> | - -#### Returns - -`never` - -#### Inherited from - -API.isApiError - -#### Defined in - -[api/api.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/api.ts#L21) - -___ - -### isUndefinedError - -▸ **isUndefinedError**(`error`, `message?`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `AxiosError`\<`unknown`, `any`\> | -| `message?` | `string` | - -#### Returns - -`never` - -#### Inherited from - -API.isUndefinedError - -#### Defined in - -[api/api.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/api.ts#L64) +[api/account.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/account.ts#L144) ___ @@ -186,7 +111,7 @@ Returns paginated list of accounts #### Defined in -[api/account.ts:120](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/account.ts#L120) +[api/account.ts:119](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/account.ts#L119) ___ @@ -209,7 +134,7 @@ Fetches the account metadata #### Defined in -[api/account.ts:161](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/account.ts#L161) +[api/account.ts:157](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/account.ts#L157) ___ @@ -233,7 +158,7 @@ Sets Account information #### Defined in -[api/account.ts:176](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/account.ts#L176) +[api/account.ts:171](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/account.ts#L171) ___ @@ -256,7 +181,7 @@ Returns the account's transfers count #### Defined in -[api/account.ts:205](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/account.ts#L205) +[api/account.ts:198](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/account.ts#L198) ___ @@ -280,4 +205,4 @@ Returns paginated list of transfers for a specific account #### Defined in -[api/account.ts:191](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/account.ts#L191) +[api/account.ts:185](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/account.ts#L185) diff --git a/docs/sdk/reference/classes/AccountService.md b/docs/sdk/reference/classes/AccountService.md index 6d3732440..bf9412ac5 100644 --- a/docs/sdk/reference/classes/AccountService.md +++ b/docs/sdk/reference/classes/AccountService.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / AccountService +[@vocdoni/sdk](/sdk) / AccountService # Class: AccountService @@ -18,17 +18,17 @@ - [constructor](AccountService#constructor) -### Properties - -- [chainService](AccountService#chainservice) -- [url](AccountService#url) - ### Methods - [fetchAccountInfo](AccountService#fetchaccountinfo) - [setInfo](AccountService#setinfo) - [signTransaction](AccountService#signtransaction) +### Properties + +- [chainService](AccountService#chainservice) +- [url](AccountService#url) + ## Constructors ### constructor @@ -49,45 +49,17 @@ Instantiate the election service. #### Overrides -[Service](Service.md).[constructor](Service#constructor) - -#### Defined in - -[services/account.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/account.ts#L45) - -## Properties - -### chainService - -• **chainService**: [`ChainService`](ChainService) - -#### Implementation of - -AccountServiceProperties.chainService - -#### Defined in - -[services/account.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/account.ts#L38) - -___ - -### url - -• **url**: `string` - -#### Inherited from - -[Service](Service.md).[url](Service#url) +Service.constructor #### Defined in -[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/service.ts#L6) +[services/account.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/account.ts#L45) ## Methods ### fetchAccountInfo -▸ **fetchAccountInfo**(`address`): `Promise`\<[`AccountData`](../modules.md#accountdata) \| [`ArchivedAccountData`](../modules#archivedaccountdata)\> +▸ **fetchAccountInfo**(`address`): `Promise`\<[`AccountData`](../sdk-reference.md#accountdata) \| [`ArchivedAccountData`](../sdk-reference#archivedaccountdata)\> Fetches account information. @@ -99,11 +71,11 @@ Fetches account information. #### Returns -`Promise`\<[`AccountData`](../modules.md#accountdata) \| [`ArchivedAccountData`](../modules#archivedaccountdata)\> +`Promise`\<[`AccountData`](../sdk-reference.md#accountdata) \| [`ArchivedAccountData`](../sdk-reference#archivedaccountdata)\> #### Defined in -[services/account.ts:56](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/account.ts#L56) +[services/account.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/account.ts#L55) ___ @@ -128,7 +100,7 @@ The transaction hash #### Defined in -[services/account.ts:96](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/account.ts#L96) +[services/account.ts:95](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/account.ts#L95) ___ @@ -150,4 +122,32 @@ ___ #### Defined in -[services/account.ts:101](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/account.ts#L101) +[services/account.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/account.ts#L100) + +## Properties + +### chainService + +• **chainService**: [`ChainService`](ChainService) + +#### Implementation of + +AccountServiceProperties.chainService + +#### Defined in + +[services/account.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/account.ts#L38) + +___ + +### url + +• **url**: `string` + +#### Inherited from + +[Service](Service.md).[url](Service#url) + +#### Defined in + +[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/service.ts#L6) diff --git a/docs/sdk/reference/classes/AnonymousService.md b/docs/sdk/reference/classes/AnonymousService.md index d9d4b7596..af4a82a09 100644 --- a/docs/sdk/reference/classes/AnonymousService.md +++ b/docs/sdk/reference/classes/AnonymousService.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / AnonymousService +[@vocdoni/sdk](/sdk) / AnonymousService # Class: AnonymousService @@ -18,14 +18,6 @@ - [constructor](AnonymousService#constructor) -### Properties - -- [chainCircuits](AnonymousService#chaincircuits) -- [url](AnonymousService#url) -- [arbo\_utils](AnonymousService.md#arbo_utils) -- [ff\_utils](AnonymousService.md#ff_utils) -- [hex\_utils](AnonymousService.md#hex_utils) - ### Methods - [checkCircuitsHashes](AnonymousService#checkcircuitshashes) @@ -44,6 +36,14 @@ - [prepareCircuitInputs](AnonymousService#preparecircuitinputs) - [signatureToVocdoniSikSignature](AnonymousService#signaturetovocdonisiksignature) +### Properties + +- [chainCircuits](AnonymousService#chaincircuits) +- [url](AnonymousService#url) +- [arbo\_utils](AnonymousService.md#arbo_utils) +- [ff\_utils](AnonymousService.md#ff_utils) +- [hex\_utils](AnonymousService.md#hex_utils) + ## Constructors ### constructor @@ -64,111 +64,29 @@ Instantiate the anonymous service. #### Overrides -[Service](Service.md).[constructor](Service#constructor) - -#### Defined in - -[services/anonymous.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L71) - -## Properties - -### chainCircuits - -• **chainCircuits**: [`ChainCircuits`](../modules#chaincircuits) - -#### Implementation of - -AnonymousServiceProperties.chainCircuits - -#### Defined in - -[services/anonymous.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L64) - -___ - -### url - -• **url**: `string` - -#### Inherited from - -[Service](Service.md).[url](Service#url) - -#### Defined in - -[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/service.ts#L6) - -___ - -### arbo\_utils - -▪ `Static` **arbo\_utils**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `toBigInt` | (`str`: `string`) => `bigint` | -| `toHash` | (`input`: `string`) => `Promise`\<`string`[]\> | -| `toString` | (`n`: `bigint`) => `string` | - -#### Defined in - -[services/anonymous.ts:277](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L277) - -___ - -### ff\_utils - -▪ `Static` **ff\_utils**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `bigIntToFF` | (`bi`: `bigint`) => `bigint` | -| `hexToFFBigInt` | (`hexStr`: `string`) => `bigint` | -| `q` | `bigint` | - -#### Defined in - -[services/anonymous.ts:329](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L329) - -___ - -### hex\_utils - -▪ `Static` **hex\_utils**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `fromArrayBuffer` | (`input`: `Uint8Array`) => `string` | -| `fromBigInt` | (`bi`: `bigint`) => `string` | -| `toArrayBuffer` | (`input`: `string`) => `Uint8Array` | +Service.constructor #### Defined in -[services/anonymous.ts:304](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L304) +[services/anonymous.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L71) ## Methods ### checkCircuitsHashes -▸ **checkCircuitsHashes**(): [`ChainCircuits`](../modules#chaincircuits) +▸ **checkCircuitsHashes**(): [`ChainCircuits`](../sdk-reference#chaincircuits) Checks circuit hashes #### Returns -[`ChainCircuits`](../modules#chaincircuits) +[`ChainCircuits`](../sdk-reference#chaincircuits) The checked circuit parameters #### Defined in -[services/anonymous.ts:107](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L107) +[services/anonymous.ts:107](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L107) ___ @@ -188,13 +106,13 @@ ___ #### Defined in -[services/anonymous.ts:82](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L82) +[services/anonymous.ts:82](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L82) ___ ### fetchCircuits -▸ **fetchCircuits**(`circuits?`): `Promise`\<[`ChainCircuits`](../modules#chaincircuits)\> +▸ **fetchCircuits**(`circuits?`): `Promise`\<[`ChainCircuits`](../sdk-reference#chaincircuits)\> Fetches circuits for anonymous voting @@ -202,15 +120,15 @@ Fetches circuits for anonymous voting | Name | Type | Description | | :------ | :------ | :------ | -| `circuits?` | `Omit`\<[`ChainCircuits`](../modules#chaincircuits), ``"zKeyData"`` \| ``"vKeyData"`` \| ``"wasmData"``\> | Additional options for custom circuits | +| `circuits?` | `Omit`\<[`ChainCircuits`](../sdk-reference#chaincircuits), ``"zKeyData"`` \| ``"vKeyData"`` \| ``"wasmData"``\> | Additional options for custom circuits | #### Returns -`Promise`\<[`ChainCircuits`](../modules#chaincircuits)\> +`Promise`\<[`ChainCircuits`](../sdk-reference#chaincircuits)\> #### Defined in -[services/anonymous.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L131) +[services/anonymous.ts:130](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L130) ___ @@ -230,13 +148,13 @@ ___ #### Defined in -[services/anonymous.ts:93](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L93) +[services/anonymous.ts:93](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L93) ___ ### generateZkProof -▸ **generateZkProof**(`inputs`): `Promise`\<[`ZkProof`](../modules#zkproof)\> +▸ **generateZkProof**(`inputs`): `Promise`\<[`ZkProof`](../sdk-reference#zkproof)\> #### Parameters @@ -246,11 +164,11 @@ ___ #### Returns -`Promise`\<[`ZkProof`](../modules#zkproof)\> +`Promise`\<[`ZkProof`](../sdk-reference#zkproof)\> #### Defined in -[services/anonymous.ts:76](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L76) +[services/anonymous.ts:76](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L76) ___ @@ -272,13 +190,13 @@ ___ #### Defined in -[services/anonymous.ts:87](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L87) +[services/anonymous.ts:87](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L87) ___ ### setCircuits -▸ **setCircuits**(`circuits`): [`ChainCircuits`](../modules#chaincircuits) +▸ **setCircuits**(`circuits`): [`ChainCircuits`](../sdk-reference#chaincircuits) Sets circuits for anonymous voting @@ -286,15 +204,15 @@ Sets circuits for anonymous voting | Name | Type | Description | | :------ | :------ | :------ | -| `circuits` | [`ChainCircuits`](../modules#chaincircuits) | Custom circuits | +| `circuits` | [`ChainCircuits`](../sdk-reference#chaincircuits) | Custom circuits | #### Returns -[`ChainCircuits`](../modules#chaincircuits) +[`ChainCircuits`](../sdk-reference#chaincircuits) #### Defined in -[services/anonymous.ts:187](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L187) +[services/anonymous.ts:185](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L185) ___ @@ -314,7 +232,7 @@ ___ #### Defined in -[services/anonymous.ts:98](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L98) +[services/anonymous.ts:98](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L98) ___ @@ -336,7 +254,7 @@ ___ #### Defined in -[services/anonymous.ts:234](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L234) +[services/anonymous.ts:232](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L232) ___ @@ -358,7 +276,7 @@ ___ #### Defined in -[services/anonymous.ts:247](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L247) +[services/anonymous.ts:245](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L245) ___ @@ -380,7 +298,7 @@ ___ #### Defined in -[services/anonymous.ts:257](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L257) +[services/anonymous.ts:255](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L255) ___ @@ -402,13 +320,13 @@ ___ #### Defined in -[services/anonymous.ts:251](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L251) +[services/anonymous.ts:249](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L249) ___ ### generateGroth16Proof -▸ **generateGroth16Proof**(`inputs`, `circuitPath`, `provingKey`): `Promise`\<[`ZkProof`](../modules#zkproof)\> +▸ **generateGroth16Proof**(`inputs`, `circuitPath`, `provingKey`): `Promise`\<[`ZkProof`](../sdk-reference#zkproof)\> #### Parameters @@ -420,11 +338,11 @@ ___ #### Returns -`Promise`\<[`ZkProof`](../modules#zkproof)\> +`Promise`\<[`ZkProof`](../sdk-reference#zkproof)\> #### Defined in -[services/anonymous.ts:192](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L192) +[services/anonymous.ts:190](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L190) ___ @@ -454,7 +372,7 @@ ___ #### Defined in -[services/anonymous.ts:200](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L200) +[services/anonymous.ts:198](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L198) ___ @@ -474,4 +392,86 @@ ___ #### Defined in -[services/anonymous.ts:270](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L270) +[services/anonymous.ts:268](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L268) + +## Properties + +### chainCircuits + +• **chainCircuits**: [`ChainCircuits`](../sdk-reference#chaincircuits) + +#### Implementation of + +AnonymousServiceProperties.chainCircuits + +#### Defined in + +[services/anonymous.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L64) + +___ + +### url + +• **url**: `string` + +#### Inherited from + +[Service](Service.md).[url](Service#url) + +#### Defined in + +[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/service.ts#L6) + +___ + +### arbo\_utils + +▪ `Static` **arbo\_utils**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `toBigInt` | (`str`: `string`) => `bigint` | +| `toHash` | (`input`: `string`) => `Promise`\<`string`[]\> | +| `toString` | (`n`: `bigint`) => `string` | + +#### Defined in + +[services/anonymous.ts:275](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L275) + +___ + +### ff\_utils + +▪ `Static` **ff\_utils**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `bigIntToFF` | (`bi`: `bigint`) => `bigint` | +| `hexToFFBigInt` | (`hexStr`: `string`) => `bigint` | +| `q` | `bigint` | + +#### Defined in + +[services/anonymous.ts:327](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L327) + +___ + +### hex\_utils + +▪ `Static` **hex\_utils**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `fromArrayBuffer` | (`input`: `Uint8Array`) => `string` | +| `fromBigInt` | (`bi`: `bigint`) => `string` | +| `toArrayBuffer` | (`input`: `string`) => `Uint8Array` | + +#### Defined in + +[services/anonymous.ts:302](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L302) diff --git a/docs/sdk/reference/classes/AnonymousVote.md b/docs/sdk/reference/classes/AnonymousVote.md index dea8f14ec..d26bd7f1e 100644 --- a/docs/sdk/reference/classes/AnonymousVote.md +++ b/docs/sdk/reference/classes/AnonymousVote.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / AnonymousVote +[@vocdoni/sdk](/sdk) / AnonymousVote # Class: AnonymousVote @@ -12,68 +12,15 @@ Represents a vote ## Table of contents -### Constructors - -- [constructor](AnonymousVote#constructor) - -### Properties - -- [\_password](AnonymousVote.md#_password) -- [\_signature](AnonymousVote.md#_signature) - ### Accessors - [password](AnonymousVote#password) - [signature](AnonymousVote#signature) - [votes](AnonymousVote#votes) -## Constructors - -### constructor - -• **new AnonymousVote**(`votes`, `signature?`, `password?`): [`AnonymousVote`](AnonymousVote) - -Constructs a csp vote - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `votes` | (`number` \| `bigint`)[] | `undefined` | The list of votes values | -| `signature?` | `string` | `undefined` | The signature of the payload | -| `password` | `string` | `'0'` | The password of the anonymous vote | - -#### Returns - -[`AnonymousVote`](AnonymousVote) - -#### Overrides - -[Vote](Vote.md).[constructor](Vote#constructor) - -#### Defined in - -[types/vote/anonymous.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/vote/anonymous.ts#L14) - -## Properties - -### \_password - -• `Private` **\_password**: `string` - -#### Defined in - -[types/vote/anonymous.ts:4](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/vote/anonymous.ts#L4) - -___ - -### \_signature - -• `Private` **\_signature**: `string` - -#### Defined in +### Constructors -[types/vote/anonymous.ts:5](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/vote/anonymous.ts#L5) +- [constructor](AnonymousVote#constructor) ## Accessors @@ -87,7 +34,7 @@ ___ #### Defined in -[types/vote/anonymous.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/vote/anonymous.ts#L20) +[types/vote/anonymous.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/vote/anonymous.ts#L20) • `set` **password**(`value`): `void` @@ -103,7 +50,7 @@ ___ #### Defined in -[types/vote/anonymous.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/vote/anonymous.ts#L24) +[types/vote/anonymous.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/vote/anonymous.ts#L24) ___ @@ -117,7 +64,7 @@ ___ #### Defined in -[types/vote/anonymous.ts:28](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/vote/anonymous.ts#L28) +[types/vote/anonymous.ts:28](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/vote/anonymous.ts#L28) • `set` **signature**(`value`): `void` @@ -133,7 +80,7 @@ ___ #### Defined in -[types/vote/anonymous.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/vote/anonymous.ts#L32) +[types/vote/anonymous.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/vote/anonymous.ts#L32) ___ @@ -151,7 +98,7 @@ Vote.votes #### Defined in -[types/vote/vote.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/vote/vote.ts#L16) +[types/vote/vote.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/vote/vote.ts#L16) • `set` **votes**(`value`): `void` @@ -171,4 +118,32 @@ Vote.votes #### Defined in -[types/vote/vote.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/vote/vote.ts#L20) +[types/vote/vote.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/vote/vote.ts#L20) + +## Constructors + +### constructor + +• **new AnonymousVote**(`votes`, `signature?`, `password?`): [`AnonymousVote`](AnonymousVote) + +Constructs an anonymous vote + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `votes` | (`number` \| `bigint`)[] | `undefined` | The list of votes values | +| `signature?` | `string` | `undefined` | The signature of the payload | +| `password` | `string` | `'0'` | The password of the anonymous vote | + +#### Returns + +[`AnonymousVote`](AnonymousVote) + +#### Overrides + +[Vote](Vote.md).[constructor](Vote#constructor) + +#### Defined in + +[types/vote/anonymous.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/vote/anonymous.ts#L14) diff --git a/docs/sdk/reference/classes/ApprovalElection.md b/docs/sdk/reference/classes/ApprovalElection.md index 48e50c414..ab83bfab1 100644 --- a/docs/sdk/reference/classes/ApprovalElection.md +++ b/docs/sdk/reference/classes/ApprovalElection.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ApprovalElection +[@vocdoni/sdk](/sdk) / ApprovalElection # Class: ApprovalElection @@ -12,27 +12,6 @@ Represents an approval election ## Table of contents -### Constructors - -- [constructor](ApprovalElection#constructor) - -### Properties - -- [\_addSDKVersion](ApprovalElection.md#_addsdkversion) -- [\_census](ApprovalElection.md#_census) -- [\_description](ApprovalElection.md#_description) -- [\_electionType](ApprovalElection.md#_electiontype) -- [\_endDate](ApprovalElection.md#_enddate) -- [\_header](ApprovalElection.md#_header) -- [\_maxCensusSize](ApprovalElection.md#_maxcensussize) -- [\_meta](ApprovalElection.md#_meta) -- [\_questions](ApprovalElection.md#_questions) -- [\_startDate](ApprovalElection.md#_startdate) -- [\_streamUri](ApprovalElection.md#_streamuri) -- [\_temporarySecretIdentity](ApprovalElection.md#_temporarysecretidentity) -- [\_title](ApprovalElection.md#_title) -- [\_voteType](ApprovalElection.md#_votetype) - ### Accessors - [addSDKVersion](ApprovalElection#addsdkversion) @@ -51,6 +30,10 @@ Represents an approval election - [title](ApprovalElection#title) - [voteType](ApprovalElection#votetype) +### Constructors + +- [constructor](ApprovalElection#constructor) + ### Methods - [addQuestion](ApprovalElection#addquestion) @@ -63,228 +46,6 @@ Represents an approval election - [checkVote](ApprovalElection#checkvote) - [from](ApprovalElection#from) -## Constructors - -### constructor - -• **new ApprovalElection**(`params`): [`ApprovalElection`](ApprovalElection) - -Constructs an approval election - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`IApprovalElectionParameters`](../interfaces/IApprovalElectionParameters) | Approval election parameters | - -#### Returns - -[`ApprovalElection`](ApprovalElection) - -#### Overrides - -[UnpublishedElection](UnpublishedElection.md).[constructor](UnpublishedElection#constructor) - -#### Defined in - -[types/election/approval.ts:18](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/approval.ts#L18) - -## Properties - -### \_addSDKVersion - -• `Protected` **\_addSDKVersion**: `boolean` - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_addSDKVersion](UnpublishedElection.md#_addsdkversion) - -#### Defined in - -[types/election/election.ts:175](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L175) - -___ - -### \_census - -• `Protected` **\_census**: [`Census`](Census) - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_census](UnpublishedElection.md#_census) - -#### Defined in - -[types/election/election.ts:172](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L172) - -___ - -### \_description - -• `Protected` **\_description**: `MultiLanguage`\<`string`\> - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_description](UnpublishedElection.md#_description) - -#### Defined in - -[types/election/election.ts:163](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L163) - -___ - -### \_electionType - -• `Protected` **\_electionType**: [`IElectionType`](../interfaces/IElectionType) - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_electionType](UnpublishedElection.md#_electiontype) - -#### Defined in - -[types/election/election.ts:169](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L169) - -___ - -### \_endDate - -• `Protected` **\_endDate**: `Date` - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_endDate](UnpublishedElection.md#_enddate) - -#### Defined in - -[types/election/election.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L168) - -___ - -### \_header - -• `Protected` **\_header**: `string` - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_header](UnpublishedElection.md#_header) - -#### Defined in - -[types/election/election.ts:164](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L164) - -___ - -### \_maxCensusSize - -• `Protected` **\_maxCensusSize**: `number` - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_maxCensusSize](UnpublishedElection.md#_maxcensussize) - -#### Defined in - -[types/election/election.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L173) - -___ - -### \_meta - -• `Protected` **\_meta**: `any` - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_meta](UnpublishedElection.md#_meta) - -#### Defined in - -[types/election/election.ts:166](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L166) - -___ - -### \_questions - -• `Protected` **\_questions**: [`IQuestion`](../interfaces/IQuestion)[] - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_questions](UnpublishedElection.md#_questions) - -#### Defined in - -[types/election/election.ts:171](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L171) - -___ - -### \_startDate - -• `Protected` **\_startDate**: `Date` - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_startDate](UnpublishedElection.md#_startdate) - -#### Defined in - -[types/election/election.ts:167](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L167) - -___ - -### \_streamUri - -• `Protected` **\_streamUri**: `string` - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_streamUri](UnpublishedElection.md#_streamuri) - -#### Defined in - -[types/election/election.ts:165](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L165) - -___ - -### \_temporarySecretIdentity - -• `Protected` **\_temporarySecretIdentity**: `boolean` - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_temporarySecretIdentity](UnpublishedElection.md#_temporarysecretidentity) - -#### Defined in - -[types/election/election.ts:174](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L174) - -___ - -### \_title - -• `Protected` **\_title**: `MultiLanguage`\<`string`\> - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_title](UnpublishedElection.md#_title) - -#### Defined in - -[types/election/election.ts:162](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L162) - -___ - -### \_voteType - -• `Protected` **\_voteType**: [`IVoteType`](../interfaces/IVoteType) - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_voteType](UnpublishedElection.md#_votetype) - -#### Defined in - -[types/election/election.ts:170](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L170) - ## Accessors ### addSDKVersion @@ -301,7 +62,7 @@ UnpublishedElection.addSDKVersion #### Defined in -[types/election/unpublished.ts:275](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L275) +[types/election/unpublished.ts:275](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L275) • `set` **addSDKVersion**(`value`): `void` @@ -321,7 +82,7 @@ UnpublishedElection.addSDKVersion #### Defined in -[types/election/unpublished.ts:279](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L279) +[types/election/unpublished.ts:279](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L279) ___ @@ -339,7 +100,7 @@ UnpublishedElection.census #### Defined in -[types/election/unpublished.ts:249](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L249) +[types/election/unpublished.ts:249](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L249) • `set` **census**(`value`): `void` @@ -359,7 +120,7 @@ UnpublishedElection.census #### Defined in -[types/election/unpublished.ts:253](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L253) +[types/election/unpublished.ts:253](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L253) ___ @@ -377,7 +138,7 @@ UnpublishedElection.description #### Defined in -[types/election/unpublished.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L173) +[types/election/unpublished.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L173) • `set` **description**(`value`): `void` @@ -397,7 +158,7 @@ UnpublishedElection.description #### Defined in -[types/election/unpublished.ts:177](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L177) +[types/election/unpublished.ts:177](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L177) ___ @@ -415,7 +176,7 @@ UnpublishedElection.duration #### Defined in -[types/election/unpublished.ts:138](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L138) +[types/election/unpublished.ts:138](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L138) ___ @@ -433,7 +194,7 @@ UnpublishedElection.electionType #### Defined in -[types/election/unpublished.ts:225](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L225) +[types/election/unpublished.ts:225](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L225) • `set` **electionType**(`value`): `void` @@ -453,7 +214,7 @@ UnpublishedElection.electionType #### Defined in -[types/election/unpublished.ts:229](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L229) +[types/election/unpublished.ts:229](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L229) ___ @@ -471,7 +232,7 @@ UnpublishedElection.endDate #### Defined in -[types/election/unpublished.ts:215](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L215) +[types/election/unpublished.ts:215](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L215) • `set` **endDate**(`value`): `void` @@ -491,7 +252,7 @@ UnpublishedElection.endDate #### Defined in -[types/election/unpublished.ts:219](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L219) +[types/election/unpublished.ts:219](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L219) ___ @@ -509,7 +270,7 @@ UnpublishedElection.header #### Defined in -[types/election/unpublished.ts:181](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L181) +[types/election/unpublished.ts:181](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L181) • `set` **header**(`value`): `void` @@ -529,7 +290,7 @@ UnpublishedElection.header #### Defined in -[types/election/unpublished.ts:185](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L185) +[types/election/unpublished.ts:185](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L185) ___ @@ -547,7 +308,7 @@ UnpublishedElection.maxCensusSize #### Defined in -[types/election/unpublished.ts:258](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L258) +[types/election/unpublished.ts:258](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L258) • `set` **maxCensusSize**(`value`): `void` @@ -567,7 +328,7 @@ UnpublishedElection.maxCensusSize #### Defined in -[types/election/unpublished.ts:262](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L262) +[types/election/unpublished.ts:262](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L262) ___ @@ -585,7 +346,7 @@ UnpublishedElection.meta #### Defined in -[types/election/unpublished.ts:197](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L197) +[types/election/unpublished.ts:197](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L197) • `set` **meta**(`value`): `void` @@ -605,7 +366,7 @@ UnpublishedElection.meta #### Defined in -[types/election/unpublished.ts:201](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L201) +[types/election/unpublished.ts:201](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L201) ___ @@ -623,7 +384,7 @@ UnpublishedElection.questions #### Defined in -[types/election/unpublished.ts:241](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L241) +[types/election/unpublished.ts:241](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L241) • `set` **questions**(`value`): `void` @@ -643,7 +404,7 @@ UnpublishedElection.questions #### Defined in -[types/election/unpublished.ts:245](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L245) +[types/election/unpublished.ts:245](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L245) ___ @@ -661,7 +422,7 @@ UnpublishedElection.startDate #### Defined in -[types/election/unpublished.ts:206](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L206) +[types/election/unpublished.ts:206](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L206) • `set` **startDate**(`value`): `void` @@ -681,7 +442,7 @@ UnpublishedElection.startDate #### Defined in -[types/election/unpublished.ts:210](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L210) +[types/election/unpublished.ts:210](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L210) ___ @@ -699,7 +460,7 @@ UnpublishedElection.streamUri #### Defined in -[types/election/unpublished.ts:189](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L189) +[types/election/unpublished.ts:189](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L189) • `set` **streamUri**(`value`): `void` @@ -719,7 +480,7 @@ UnpublishedElection.streamUri #### Defined in -[types/election/unpublished.ts:193](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L193) +[types/election/unpublished.ts:193](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L193) ___ @@ -737,7 +498,7 @@ UnpublishedElection.temporarySecretIdentity #### Defined in -[types/election/unpublished.ts:267](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L267) +[types/election/unpublished.ts:267](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L267) • `set` **temporarySecretIdentity**(`value`): `void` @@ -757,7 +518,7 @@ UnpublishedElection.temporarySecretIdentity #### Defined in -[types/election/unpublished.ts:271](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L271) +[types/election/unpublished.ts:271](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L271) ___ @@ -775,7 +536,7 @@ UnpublishedElection.title #### Defined in -[types/election/unpublished.ts:164](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L164) +[types/election/unpublished.ts:164](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L164) • `set` **title**(`value`): `void` @@ -795,7 +556,7 @@ UnpublishedElection.title #### Defined in -[types/election/unpublished.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L168) +[types/election/unpublished.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L168) ___ @@ -813,7 +574,7 @@ UnpublishedElection.voteType #### Defined in -[types/election/unpublished.ts:233](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L233) +[types/election/unpublished.ts:233](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L233) • `set` **voteType**(`value`): `void` @@ -833,7 +594,33 @@ UnpublishedElection.voteType #### Defined in -[types/election/unpublished.ts:237](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L237) +[types/election/unpublished.ts:237](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L237) + +## Constructors + +### constructor + +• **new ApprovalElection**(`params`): [`ApprovalElection`](ApprovalElection) + +Constructs an approval election + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `params` | [`IApprovalElectionParameters`](../interfaces/IApprovalElectionParameters) | Approval election parameters | + +#### Returns + +[`ApprovalElection`](ApprovalElection) + +#### Overrides + +[UnpublishedElection](UnpublishedElection.md).[constructor](UnpublishedElection#constructor) + +#### Defined in + +[types/election/approval.ts:18](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/approval.ts#L18) ## Methods @@ -859,7 +646,7 @@ UnpublishedElection.voteType #### Defined in -[types/election/approval.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/approval.ts#L26) +[types/election/approval.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/approval.ts#L26) ___ @@ -877,7 +664,7 @@ ___ #### Defined in -[types/election/approval.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/approval.ts#L55) +[types/election/approval.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/approval.ts#L55) ___ @@ -895,7 +682,7 @@ ___ #### Defined in -[types/election/approval.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/approval.ts#L65) +[types/election/approval.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/approval.ts#L65) ___ @@ -913,7 +700,7 @@ ___ #### Defined in -[types/election/unpublished.ts:154](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L154) +[types/election/unpublished.ts:154](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L154) ___ @@ -931,7 +718,7 @@ ___ #### Defined in -[types/election/approval.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/approval.ts#L45) +[types/election/approval.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/approval.ts#L45) ___ @@ -955,7 +742,7 @@ ___ #### Defined in -[types/election/election.ts:266](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L266) +[types/election/election.ts:266](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L266) ___ @@ -979,7 +766,7 @@ ___ #### Defined in -[types/election/unpublished.ts:60](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L60) +[types/election/unpublished.ts:60](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L60) ___ @@ -1000,7 +787,7 @@ ___ #### Defined in -[types/election/approval.ts:79](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/approval.ts#L79) +[types/election/approval.ts:79](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/approval.ts#L79) ___ @@ -1026,4 +813,4 @@ Returns an unpublished election object #### Defined in -[types/election/approval.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/approval.ts#L22) +[types/election/approval.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/approval.ts#L22) diff --git a/docs/sdk/reference/classes/ArchivedElection.md b/docs/sdk/reference/classes/ArchivedElection.md index c7e0ef054..8090a5d17 100644 --- a/docs/sdk/reference/classes/ArchivedElection.md +++ b/docs/sdk/reference/classes/ArchivedElection.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ArchivedElection +[@vocdoni/sdk](/sdk) / ArchivedElection # Class: ArchivedElection @@ -12,27 +12,6 @@ Represents a published election ## Table of contents -### Constructors - -- [constructor](ArchivedElection#constructor) - -### Properties - -- [\_addSDKVersion](ArchivedElection.md#_addsdkversion) -- [\_census](ArchivedElection.md#_census) -- [\_description](ArchivedElection.md#_description) -- [\_electionType](ArchivedElection.md#_electiontype) -- [\_endDate](ArchivedElection.md#_enddate) -- [\_header](ArchivedElection.md#_header) -- [\_maxCensusSize](ArchivedElection.md#_maxcensussize) -- [\_meta](ArchivedElection.md#_meta) -- [\_questions](ArchivedElection.md#_questions) -- [\_startDate](ArchivedElection.md#_startdate) -- [\_streamUri](ArchivedElection.md#_streamuri) -- [\_temporarySecretIdentity](ArchivedElection.md#_temporarysecretidentity) -- [\_title](ArchivedElection.md#_title) -- [\_voteType](ArchivedElection.md#_votetype) - ### Accessors - [addSDKVersion](ArchivedElection#addsdkversion) @@ -64,6 +43,10 @@ Represents a published election - [voteCount](ArchivedElection#votecount) - [voteType](ArchivedElection#votetype) +### Constructors + +- [constructor](ArchivedElection#constructor) + ### Methods - [checkVote](ArchivedElection#checkvote) @@ -73,228 +56,6 @@ Represents a published election - [from](ArchivedElection#from) - [getStatus](ArchivedElection#getstatus) -## Constructors - -### constructor - -• **new ArchivedElection**(`params`): [`ArchivedElection`](ArchivedElection) - -Constructs an archived election - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`IPublishedElectionParameters`](../interfaces/IPublishedElectionParameters) | Election parameters | - -#### Returns - -[`ArchivedElection`](ArchivedElection) - -#### Overrides - -[PublishedElection](PublishedElection.md).[constructor](PublishedElection#constructor) - -#### Defined in - -[types/election/archived.ts:13](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/archived.ts#L13) - -## Properties - -### \_addSDKVersion - -• `Protected` **\_addSDKVersion**: `boolean` - -#### Inherited from - -[PublishedElection](PublishedElection).[_addSDKVersion](PublishedElection.md#_addsdkversion) - -#### Defined in - -[types/election/election.ts:175](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L175) - -___ - -### \_census - -• `Protected` **\_census**: [`Census`](Census) - -#### Inherited from - -[PublishedElection](PublishedElection).[_census](PublishedElection.md#_census) - -#### Defined in - -[types/election/election.ts:172](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L172) - -___ - -### \_description - -• `Protected` **\_description**: `MultiLanguage`\<`string`\> - -#### Inherited from - -[PublishedElection](PublishedElection).[_description](PublishedElection.md#_description) - -#### Defined in - -[types/election/election.ts:163](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L163) - -___ - -### \_electionType - -• `Protected` **\_electionType**: [`IElectionType`](../interfaces/IElectionType) - -#### Inherited from - -[PublishedElection](PublishedElection).[_electionType](PublishedElection.md#_electiontype) - -#### Defined in - -[types/election/election.ts:169](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L169) - -___ - -### \_endDate - -• `Protected` **\_endDate**: `Date` - -#### Inherited from - -[PublishedElection](PublishedElection).[_endDate](PublishedElection.md#_enddate) - -#### Defined in - -[types/election/election.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L168) - -___ - -### \_header - -• `Protected` **\_header**: `string` - -#### Inherited from - -[PublishedElection](PublishedElection).[_header](PublishedElection.md#_header) - -#### Defined in - -[types/election/election.ts:164](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L164) - -___ - -### \_maxCensusSize - -• `Protected` **\_maxCensusSize**: `number` - -#### Inherited from - -[PublishedElection](PublishedElection).[_maxCensusSize](PublishedElection.md#_maxcensussize) - -#### Defined in - -[types/election/election.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L173) - -___ - -### \_meta - -• `Protected` **\_meta**: `any` - -#### Inherited from - -[PublishedElection](PublishedElection).[_meta](PublishedElection.md#_meta) - -#### Defined in - -[types/election/election.ts:166](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L166) - -___ - -### \_questions - -• `Protected` **\_questions**: [`IQuestion`](../interfaces/IQuestion)[] - -#### Inherited from - -[PublishedElection](PublishedElection).[_questions](PublishedElection.md#_questions) - -#### Defined in - -[types/election/election.ts:171](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L171) - -___ - -### \_startDate - -• `Protected` **\_startDate**: `Date` - -#### Inherited from - -[PublishedElection](PublishedElection).[_startDate](PublishedElection.md#_startdate) - -#### Defined in - -[types/election/election.ts:167](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L167) - -___ - -### \_streamUri - -• `Protected` **\_streamUri**: `string` - -#### Inherited from - -[PublishedElection](PublishedElection).[_streamUri](PublishedElection.md#_streamuri) - -#### Defined in - -[types/election/election.ts:165](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L165) - -___ - -### \_temporarySecretIdentity - -• `Protected` **\_temporarySecretIdentity**: `boolean` - -#### Inherited from - -[PublishedElection](PublishedElection).[_temporarySecretIdentity](PublishedElection.md#_temporarysecretidentity) - -#### Defined in - -[types/election/election.ts:174](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L174) - -___ - -### \_title - -• `Protected` **\_title**: `MultiLanguage`\<`string`\> - -#### Inherited from - -[PublishedElection](PublishedElection).[_title](PublishedElection.md#_title) - -#### Defined in - -[types/election/election.ts:162](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L162) - -___ - -### \_voteType - -• `Protected` **\_voteType**: [`IVoteType`](../interfaces/IVoteType) - -#### Inherited from - -[PublishedElection](PublishedElection).[_voteType](PublishedElection.md#_votetype) - -#### Defined in - -[types/election/election.ts:170](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L170) - ## Accessors ### addSDKVersion @@ -311,7 +72,7 @@ PublishedElection.addSDKVersion #### Defined in -[types/election/election.ts:262](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L262) +[types/election/election.ts:262](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L262) ___ @@ -329,7 +90,7 @@ PublishedElection.census #### Defined in -[types/election/archived.ts:17](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/archived.ts#L17) +[types/election/archived.ts:17](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/archived.ts#L17) ___ @@ -347,7 +108,7 @@ PublishedElection.chainId #### Defined in -[types/election/published.ts:219](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L219) +[types/election/published.ts:219](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L219) ___ @@ -365,7 +126,7 @@ PublishedElection.creationTime #### Defined in -[types/election/published.ts:223](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L223) +[types/election/published.ts:223](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L223) ___ @@ -383,7 +144,7 @@ PublishedElection.description #### Defined in -[types/election/published.ts:147](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L147) +[types/election/published.ts:147](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L147) ___ @@ -401,7 +162,7 @@ PublishedElection.electionType #### Defined in -[types/election/published.ts:167](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L167) +[types/election/published.ts:167](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L167) ___ @@ -419,7 +180,7 @@ PublishedElection.endDate #### Defined in -[types/election/published.ts:163](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L163) +[types/election/published.ts:163](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L163) ___ @@ -437,7 +198,7 @@ PublishedElection.finalResults #### Defined in -[types/election/published.ts:203](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L203) +[types/election/published.ts:203](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L203) ___ @@ -455,7 +216,7 @@ PublishedElection.fromArchive #### Defined in -[types/election/published.ts:215](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L215) +[types/election/published.ts:215](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L215) ___ @@ -473,7 +234,7 @@ PublishedElection.header #### Defined in -[types/election/published.ts:151](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L151) +[types/election/published.ts:151](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L151) ___ @@ -491,7 +252,7 @@ PublishedElection.id #### Defined in -[types/election/published.ts:187](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L187) +[types/election/published.ts:187](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L187) ___ @@ -509,7 +270,7 @@ PublishedElection.isValid #### Defined in -[types/election/published.ts:239](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L239) +[types/election/published.ts:239](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L239) ___ @@ -527,7 +288,7 @@ PublishedElection.manuallyEnded #### Defined in -[types/election/published.ts:211](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L211) +[types/election/published.ts:211](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L211) ___ @@ -545,7 +306,7 @@ PublishedElection.maxCensusSize #### Defined in -[types/election/published.ts:183](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L183) +[types/election/published.ts:183](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L183) ___ @@ -563,7 +324,7 @@ PublishedElection.meta #### Defined in -[types/election/election.ts:226](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L226) +[types/election/election.ts:226](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L226) ___ @@ -581,7 +342,7 @@ PublishedElection.metadataURL #### Defined in -[types/election/published.ts:227](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L227) +[types/election/published.ts:227](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L227) ___ @@ -599,7 +360,7 @@ PublishedElection.organizationId #### Defined in -[types/election/published.ts:191](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L191) +[types/election/published.ts:191](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L191) ___ @@ -617,7 +378,7 @@ PublishedElection.questions #### Defined in -[types/election/published.ts:175](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L175) +[types/election/published.ts:175](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L175) ___ @@ -635,7 +396,7 @@ PublishedElection.raw #### Defined in -[types/election/published.ts:235](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L235) +[types/election/published.ts:235](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L235) ___ @@ -653,17 +414,17 @@ PublishedElection.results #### Defined in -[types/election/published.ts:207](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L207) +[types/election/published.ts:207](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L207) ___ ### resultsType -• `get` **resultsType**(): [`ElectionResultsType`](../modules#electionresultstype) +• `get` **resultsType**(): [`ElectionResultsType`](../sdk-reference#electionresultstype) #### Returns -[`ElectionResultsType`](../modules#electionresultstype) +[`ElectionResultsType`](../sdk-reference#electionresultstype) #### Inherited from @@ -671,7 +432,7 @@ PublishedElection.resultsType #### Defined in -[types/election/published.ts:231](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L231) +[types/election/published.ts:231](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L231) ___ @@ -689,7 +450,7 @@ PublishedElection.startDate #### Defined in -[types/election/published.ts:159](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L159) +[types/election/published.ts:159](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L159) ___ @@ -707,7 +468,7 @@ PublishedElection.status #### Defined in -[types/election/published.ts:195](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L195) +[types/election/published.ts:195](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L195) ___ @@ -725,7 +486,7 @@ PublishedElection.streamUri #### Defined in -[types/election/published.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L155) +[types/election/published.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L155) ___ @@ -743,7 +504,7 @@ PublishedElection.temporarySecretIdentity #### Defined in -[types/election/election.ts:258](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L258) +[types/election/election.ts:258](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L258) ___ @@ -761,7 +522,7 @@ PublishedElection.title #### Defined in -[types/election/published.ts:143](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L143) +[types/election/published.ts:143](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L143) ___ @@ -779,7 +540,7 @@ PublishedElection.voteCount #### Defined in -[types/election/published.ts:199](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L199) +[types/election/published.ts:199](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L199) ___ @@ -797,7 +558,33 @@ PublishedElection.voteType #### Defined in -[types/election/published.ts:171](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L171) +[types/election/published.ts:171](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L171) + +## Constructors + +### constructor + +• **new ArchivedElection**(`params`): [`ArchivedElection`](ArchivedElection) + +Constructs an archived election + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `params` | [`IPublishedElectionParameters`](../interfaces/IPublishedElectionParameters) | Election parameters | + +#### Returns + +[`ArchivedElection`](ArchivedElection) + +#### Overrides + +[PublishedElection](PublishedElection.md).[constructor](PublishedElection#constructor) + +#### Defined in + +[types/election/archived.ts:13](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/archived.ts#L13) ## Methods @@ -821,7 +608,7 @@ PublishedElection.voteType #### Defined in -[types/election/published.ts:113](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L113) +[types/election/published.ts:113](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L113) ___ @@ -845,7 +632,7 @@ ___ #### Defined in -[types/election/election.ts:266](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L266) +[types/election/election.ts:266](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L266) ___ @@ -871,7 +658,7 @@ Returns a published election object #### Defined in -[types/election/published.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L100) +[types/election/published.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L100) ___ @@ -896,7 +683,7 @@ ___ #### Defined in -[types/election/published.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L127) +[types/election/published.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L127) ___ @@ -922,7 +709,7 @@ Returns an unpublished election object #### Defined in -[types/election/election.ts:206](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L206) +[types/election/election.ts:206](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L206) ___ @@ -934,7 +721,7 @@ ___ | Name | Type | | :------ | :------ | -| `status` | [`AllElectionStatus`](../modules#allelectionstatus) | +| `status` | [`AllElectionStatus`](../sdk-reference#allelectionstatus) | | `startDate` | `Date` | #### Returns @@ -947,4 +734,4 @@ ___ #### Defined in -[types/election/published.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L104) +[types/election/published.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L104) diff --git a/docs/sdk/reference/classes/BudgetElection.md b/docs/sdk/reference/classes/BudgetElection.md index 34e82b47b..abfac541d 100644 --- a/docs/sdk/reference/classes/BudgetElection.md +++ b/docs/sdk/reference/classes/BudgetElection.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / BudgetElection +[@vocdoni/sdk](/sdk) / BudgetElection # Class: BudgetElection @@ -12,29 +12,6 @@ Represents a budget election ## Table of contents -### Constructors - -- [constructor](BudgetElection#constructor) - -### Properties - -- [\_addSDKVersion](BudgetElection.md#_addsdkversion) -- [\_census](BudgetElection.md#_census) -- [\_description](BudgetElection.md#_description) -- [\_electionType](BudgetElection.md#_electiontype) -- [\_endDate](BudgetElection.md#_enddate) -- [\_forceFullBudget](BudgetElection.md#_forcefullbudget) -- [\_header](BudgetElection.md#_header) -- [\_maxCensusSize](BudgetElection.md#_maxcensussize) -- [\_meta](BudgetElection.md#_meta) -- [\_minStep](BudgetElection.md#_minstep) -- [\_questions](BudgetElection.md#_questions) -- [\_startDate](BudgetElection.md#_startdate) -- [\_streamUri](BudgetElection.md#_streamuri) -- [\_temporarySecretIdentity](BudgetElection.md#_temporarysecretidentity) -- [\_title](BudgetElection.md#_title) -- [\_voteType](BudgetElection.md#_votetype) - ### Accessors - [addSDKVersion](BudgetElection#addsdkversion) @@ -57,6 +34,10 @@ Represents a budget election - [useCensusWeightAsBudget](BudgetElection#usecensusweightasbudget) - [voteType](BudgetElection#votetype) +### Constructors + +- [constructor](BudgetElection#constructor) + ### Methods - [addQuestion](BudgetElection#addquestion) @@ -69,248 +50,6 @@ Represents a budget election - [checkVote](BudgetElection#checkvote) - [from](BudgetElection#from) -## Constructors - -### constructor - -• **new BudgetElection**(`params`): [`BudgetElection`](BudgetElection) - -Constructs a budget election - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`IBudgetElectionParameters`](../modules#ibudgetelectionparameters) | Budget election parameters | - -#### Returns - -[`BudgetElection`](BudgetElection) - -#### Overrides - -[UnpublishedElection](UnpublishedElection.md).[constructor](UnpublishedElection#constructor) - -#### Defined in - -[types/election/budget.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/budget.ts#L35) - -## Properties - -### \_addSDKVersion - -• `Protected` **\_addSDKVersion**: `boolean` - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_addSDKVersion](UnpublishedElection.md#_addsdkversion) - -#### Defined in - -[types/election/election.ts:175](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L175) - -___ - -### \_census - -• `Protected` **\_census**: [`Census`](Census) - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_census](UnpublishedElection.md#_census) - -#### Defined in - -[types/election/election.ts:172](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L172) - -___ - -### \_description - -• `Protected` **\_description**: `MultiLanguage`\<`string`\> - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_description](UnpublishedElection.md#_description) - -#### Defined in - -[types/election/election.ts:163](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L163) - -___ - -### \_electionType - -• `Protected` **\_electionType**: [`IElectionType`](../interfaces/IElectionType) - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_electionType](UnpublishedElection.md#_electiontype) - -#### Defined in - -[types/election/election.ts:169](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L169) - -___ - -### \_endDate - -• `Protected` **\_endDate**: `Date` - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_endDate](UnpublishedElection.md#_enddate) - -#### Defined in - -[types/election/election.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L168) - -___ - -### \_forceFullBudget - -• `Private` **\_forceFullBudget**: `boolean` - -#### Defined in - -[types/election/budget.ts:28](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/budget.ts#L28) - -___ - -### \_header - -• `Protected` **\_header**: `string` - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_header](UnpublishedElection.md#_header) - -#### Defined in - -[types/election/election.ts:164](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L164) - -___ - -### \_maxCensusSize - -• `Protected` **\_maxCensusSize**: `number` - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_maxCensusSize](UnpublishedElection.md#_maxcensussize) - -#### Defined in - -[types/election/election.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L173) - -___ - -### \_meta - -• `Protected` **\_meta**: `any` - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_meta](UnpublishedElection.md#_meta) - -#### Defined in - -[types/election/election.ts:166](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L166) - -___ - -### \_minStep - -• `Private` **\_minStep**: `number` - -#### Defined in - -[types/election/budget.ts:27](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/budget.ts#L27) - -___ - -### \_questions - -• `Protected` **\_questions**: [`IQuestion`](../interfaces/IQuestion)[] - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_questions](UnpublishedElection.md#_questions) - -#### Defined in - -[types/election/election.ts:171](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L171) - -___ - -### \_startDate - -• `Protected` **\_startDate**: `Date` - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_startDate](UnpublishedElection.md#_startdate) - -#### Defined in - -[types/election/election.ts:167](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L167) - -___ - -### \_streamUri - -• `Protected` **\_streamUri**: `string` - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_streamUri](UnpublishedElection.md#_streamuri) - -#### Defined in - -[types/election/election.ts:165](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L165) - -___ - -### \_temporarySecretIdentity - -• `Protected` **\_temporarySecretIdentity**: `boolean` - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_temporarySecretIdentity](UnpublishedElection.md#_temporarysecretidentity) - -#### Defined in - -[types/election/election.ts:174](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L174) - -___ - -### \_title - -• `Protected` **\_title**: `MultiLanguage`\<`string`\> - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_title](UnpublishedElection.md#_title) - -#### Defined in - -[types/election/election.ts:162](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L162) - -___ - -### \_voteType - -• `Protected` **\_voteType**: [`IVoteType`](../interfaces/IVoteType) - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_voteType](UnpublishedElection.md#_votetype) - -#### Defined in - -[types/election/election.ts:170](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L170) - ## Accessors ### addSDKVersion @@ -327,7 +66,7 @@ UnpublishedElection.addSDKVersion #### Defined in -[types/election/unpublished.ts:275](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L275) +[types/election/unpublished.ts:275](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L275) • `set` **addSDKVersion**(`value`): `void` @@ -347,7 +86,7 @@ UnpublishedElection.addSDKVersion #### Defined in -[types/election/unpublished.ts:279](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L279) +[types/election/unpublished.ts:279](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L279) ___ @@ -365,7 +104,7 @@ UnpublishedElection.census #### Defined in -[types/election/unpublished.ts:249](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L249) +[types/election/unpublished.ts:249](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L249) • `set` **census**(`value`): `void` @@ -385,7 +124,7 @@ UnpublishedElection.census #### Defined in -[types/election/unpublished.ts:253](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L253) +[types/election/unpublished.ts:253](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L253) ___ @@ -403,7 +142,7 @@ UnpublishedElection.description #### Defined in -[types/election/unpublished.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L173) +[types/election/unpublished.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L173) • `set` **description**(`value`): `void` @@ -423,7 +162,7 @@ UnpublishedElection.description #### Defined in -[types/election/unpublished.ts:177](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L177) +[types/election/unpublished.ts:177](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L177) ___ @@ -441,7 +180,7 @@ UnpublishedElection.duration #### Defined in -[types/election/unpublished.ts:138](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L138) +[types/election/unpublished.ts:138](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L138) ___ @@ -459,7 +198,7 @@ UnpublishedElection.electionType #### Defined in -[types/election/unpublished.ts:225](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L225) +[types/election/unpublished.ts:225](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L225) • `set` **electionType**(`value`): `void` @@ -479,7 +218,7 @@ UnpublishedElection.electionType #### Defined in -[types/election/unpublished.ts:229](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L229) +[types/election/unpublished.ts:229](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L229) ___ @@ -497,7 +236,7 @@ UnpublishedElection.endDate #### Defined in -[types/election/unpublished.ts:215](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L215) +[types/election/unpublished.ts:215](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L215) • `set` **endDate**(`value`): `void` @@ -517,7 +256,7 @@ UnpublishedElection.endDate #### Defined in -[types/election/unpublished.ts:219](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L219) +[types/election/unpublished.ts:219](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L219) ___ @@ -531,7 +270,7 @@ ___ #### Defined in -[types/election/budget.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/budget.ts#L132) +[types/election/budget.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/budget.ts#L132) • `set` **forceFullBudget**(`value`): `void` @@ -547,7 +286,7 @@ ___ #### Defined in -[types/election/budget.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/budget.ts#L136) +[types/election/budget.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/budget.ts#L136) ___ @@ -565,7 +304,7 @@ UnpublishedElection.header #### Defined in -[types/election/unpublished.ts:181](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L181) +[types/election/unpublished.ts:181](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L181) • `set` **header**(`value`): `void` @@ -585,7 +324,7 @@ UnpublishedElection.header #### Defined in -[types/election/unpublished.ts:185](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L185) +[types/election/unpublished.ts:185](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L185) ___ @@ -599,7 +338,7 @@ ___ #### Defined in -[types/election/budget.ts:148](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/budget.ts#L148) +[types/election/budget.ts:148](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/budget.ts#L148) • `set` **maxBudget**(`value`): `void` @@ -615,7 +354,7 @@ ___ #### Defined in -[types/election/budget.ts:152](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/budget.ts#L152) +[types/election/budget.ts:152](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/budget.ts#L152) ___ @@ -633,7 +372,7 @@ UnpublishedElection.maxCensusSize #### Defined in -[types/election/unpublished.ts:258](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L258) +[types/election/unpublished.ts:258](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L258) • `set` **maxCensusSize**(`value`): `void` @@ -653,7 +392,7 @@ UnpublishedElection.maxCensusSize #### Defined in -[types/election/unpublished.ts:262](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L262) +[types/election/unpublished.ts:262](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L262) ___ @@ -671,7 +410,7 @@ UnpublishedElection.meta #### Defined in -[types/election/unpublished.ts:197](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L197) +[types/election/unpublished.ts:197](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L197) • `set` **meta**(`value`): `void` @@ -691,7 +430,7 @@ UnpublishedElection.meta #### Defined in -[types/election/unpublished.ts:201](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L201) +[types/election/unpublished.ts:201](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L201) ___ @@ -705,7 +444,7 @@ ___ #### Defined in -[types/election/budget.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/budget.ts#L124) +[types/election/budget.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/budget.ts#L124) • `set` **minStep**(`value`): `void` @@ -721,7 +460,7 @@ ___ #### Defined in -[types/election/budget.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/budget.ts#L128) +[types/election/budget.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/budget.ts#L128) ___ @@ -739,7 +478,7 @@ UnpublishedElection.questions #### Defined in -[types/election/unpublished.ts:241](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L241) +[types/election/unpublished.ts:241](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L241) • `set` **questions**(`value`): `void` @@ -759,7 +498,7 @@ UnpublishedElection.questions #### Defined in -[types/election/unpublished.ts:245](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L245) +[types/election/unpublished.ts:245](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L245) ___ @@ -777,7 +516,7 @@ UnpublishedElection.startDate #### Defined in -[types/election/unpublished.ts:206](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L206) +[types/election/unpublished.ts:206](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L206) • `set` **startDate**(`value`): `void` @@ -797,7 +536,7 @@ UnpublishedElection.startDate #### Defined in -[types/election/unpublished.ts:210](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L210) +[types/election/unpublished.ts:210](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L210) ___ @@ -815,7 +554,7 @@ UnpublishedElection.streamUri #### Defined in -[types/election/unpublished.ts:189](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L189) +[types/election/unpublished.ts:189](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L189) • `set` **streamUri**(`value`): `void` @@ -835,7 +574,7 @@ UnpublishedElection.streamUri #### Defined in -[types/election/unpublished.ts:193](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L193) +[types/election/unpublished.ts:193](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L193) ___ @@ -853,7 +592,7 @@ UnpublishedElection.temporarySecretIdentity #### Defined in -[types/election/unpublished.ts:267](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L267) +[types/election/unpublished.ts:267](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L267) • `set` **temporarySecretIdentity**(`value`): `void` @@ -873,7 +612,7 @@ UnpublishedElection.temporarySecretIdentity #### Defined in -[types/election/unpublished.ts:271](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L271) +[types/election/unpublished.ts:271](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L271) ___ @@ -891,7 +630,7 @@ UnpublishedElection.title #### Defined in -[types/election/unpublished.ts:164](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L164) +[types/election/unpublished.ts:164](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L164) • `set` **title**(`value`): `void` @@ -911,7 +650,7 @@ UnpublishedElection.title #### Defined in -[types/election/unpublished.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L168) +[types/election/unpublished.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L168) ___ @@ -925,7 +664,7 @@ ___ #### Defined in -[types/election/budget.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/budget.ts#L140) +[types/election/budget.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/budget.ts#L140) • `set` **useCensusWeightAsBudget**(`value`): `void` @@ -941,7 +680,7 @@ ___ #### Defined in -[types/election/budget.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/budget.ts#L144) +[types/election/budget.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/budget.ts#L144) ___ @@ -959,7 +698,7 @@ UnpublishedElection.voteType #### Defined in -[types/election/unpublished.ts:233](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L233) +[types/election/unpublished.ts:233](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L233) • `set` **voteType**(`value`): `void` @@ -979,7 +718,33 @@ UnpublishedElection.voteType #### Defined in -[types/election/unpublished.ts:237](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L237) +[types/election/unpublished.ts:237](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L237) + +## Constructors + +### constructor + +• **new BudgetElection**(`params`): [`BudgetElection`](BudgetElection) + +Constructs a budget election + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `params` | [`IBudgetElectionParameters`](../sdk-reference#ibudgetelectionparameters) | Budget election parameters | + +#### Returns + +[`BudgetElection`](BudgetElection) + +#### Overrides + +[UnpublishedElection](UnpublishedElection.md).[constructor](UnpublishedElection#constructor) + +#### Defined in + +[types/election/budget.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/budget.ts#L35) ## Methods @@ -1005,7 +770,7 @@ UnpublishedElection.voteType #### Defined in -[types/election/budget.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/budget.ts#L49) +[types/election/budget.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/budget.ts#L49) ___ @@ -1023,7 +788,7 @@ ___ #### Defined in -[types/election/budget.ts:78](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/budget.ts#L78) +[types/election/budget.ts:78](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/budget.ts#L78) ___ @@ -1041,7 +806,7 @@ ___ #### Defined in -[types/election/budget.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/budget.ts#L88) +[types/election/budget.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/budget.ts#L88) ___ @@ -1059,7 +824,7 @@ ___ #### Defined in -[types/election/unpublished.ts:154](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L154) +[types/election/unpublished.ts:154](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L154) ___ @@ -1077,7 +842,7 @@ ___ #### Defined in -[types/election/budget.ts:68](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/budget.ts#L68) +[types/election/budget.ts:68](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/budget.ts#L68) ___ @@ -1101,7 +866,7 @@ ___ #### Defined in -[types/election/election.ts:266](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L266) +[types/election/election.ts:266](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L266) ___ @@ -1125,7 +890,7 @@ ___ #### Defined in -[types/election/unpublished.ts:60](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L60) +[types/election/unpublished.ts:60](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L60) ___ @@ -1138,7 +903,7 @@ ___ | Name | Type | | :------ | :------ | | `vote` | [`Vote`](Vote) | -| `resultsType` | [`ElectionResultsType`](../modules#electionresultstype) | +| `resultsType` | [`ElectionResultsType`](../sdk-reference#electionresultstype) | | `voteType` | [`IVoteType`](../interfaces/IVoteType) | #### Returns @@ -1147,7 +912,7 @@ ___ #### Defined in -[types/election/budget.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/budget.ts#L104) +[types/election/budget.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/budget.ts#L104) ___ @@ -1161,7 +926,7 @@ Returns an unpublished election object | Name | Type | Description | | :------ | :------ | :------ | -| `params` | [`IBudgetElectionParameters`](../modules#ibudgetelectionparameters) | Unpublished Election parameters | +| `params` | [`IBudgetElectionParameters`](../sdk-reference#ibudgetelectionparameters) | Unpublished Election parameters | #### Returns @@ -1173,4 +938,4 @@ Returns an unpublished election object #### Defined in -[types/election/budget.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/budget.ts#L45) +[types/election/budget.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/budget.ts#L45) diff --git a/docs/sdk/reference/classes/Census.md b/docs/sdk/reference/classes/Census.md index 253d0078a..fd669272b 100644 --- a/docs/sdk/reference/classes/Census.md +++ b/docs/sdk/reference/classes/Census.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / Census +[@vocdoni/sdk](/sdk) / Census # Class: Census @@ -16,18 +16,6 @@ Represents a generic census ## Table of contents -### Constructors - -- [constructor](Census#constructor) - -### Properties - -- [\_censusId](Census.md#_censusid) -- [\_censusURI](Census.md#_censusuri) -- [\_size](Census.md#_size) -- [\_type](Census.md#_type) -- [\_weight](Census.md#_weight) - ### Accessors - [censusId](Census#censusid) @@ -41,82 +29,6 @@ Represents a generic census - [censusTypeFromCensusOrigin](Census#censustypefromcensusorigin) -## Constructors - -### constructor - -• **new Census**(`censusId?`, `censusURI?`, `type?`, `size?`, `weight?`): [`Census`](Census) - -Constructs a generic census - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `censusId?` | `string` | The id of the census | -| `censusURI?` | `string` | The URI of the census | -| `type?` | [`CensusType`](../enums/CensusType) | The type of the census | -| `size?` | `number` | The size of the census | -| `weight?` | `bigint` | The weight of the census | - -#### Returns - -[`Census`](Census) - -#### Defined in - -[types/census/census.ts:27](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L27) - -## Properties - -### \_censusId - -• `Protected` **\_censusId**: `string` - -#### Defined in - -[types/census/census.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L12) - -___ - -### \_censusURI - -• `Protected` **\_censusURI**: `string` - -#### Defined in - -[types/census/census.ts:13](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L13) - -___ - -### \_size - -• `Private` **\_size**: `number` - -#### Defined in - -[types/census/census.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L15) - -___ - -### \_type - -• `Protected` **\_type**: [`CensusType`](../enums/CensusType) - -#### Defined in - -[types/census/census.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L14) - -___ - -### \_weight - -• `Private` **\_weight**: `bigint` - -#### Defined in - -[types/census/census.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L16) - ## Accessors ### censusId @@ -129,7 +41,7 @@ ___ #### Defined in -[types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L35) +[types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L35) • `set` **censusId**(`value`): `void` @@ -145,7 +57,7 @@ ___ #### Defined in -[types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L39) +[types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L39) ___ @@ -159,7 +71,7 @@ ___ #### Defined in -[types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L43) +[types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L43) • `set` **censusURI**(`value`): `void` @@ -175,7 +87,7 @@ ___ #### Defined in -[types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L47) +[types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L47) ___ @@ -189,7 +101,7 @@ ___ #### Defined in -[types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L75) +[types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L75) ___ @@ -203,7 +115,7 @@ ___ #### Defined in -[types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L59) +[types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L59) • `set` **size**(`value`): `void` @@ -219,7 +131,7 @@ ___ #### Defined in -[types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L63) +[types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L63) ___ @@ -233,7 +145,7 @@ ___ #### Defined in -[types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L51) +[types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L51) • `set` **type**(`value`): `void` @@ -249,7 +161,7 @@ ___ #### Defined in -[types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L55) +[types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L55) ___ @@ -263,7 +175,7 @@ ___ #### Defined in -[types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L67) +[types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L67) • `set` **weight**(`value`): `void` @@ -279,7 +191,7 @@ ___ #### Defined in -[types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L71) +[types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L71) ## Methods @@ -300,4 +212,4 @@ ___ #### Defined in -[types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L81) +[types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L81) diff --git a/docs/sdk/reference/classes/Census3CensusAPI.md b/docs/sdk/reference/classes/Census3CensusAPI.md index 06781bedd..4da560466 100644 --- a/docs/sdk/reference/classes/Census3CensusAPI.md +++ b/docs/sdk/reference/classes/Census3CensusAPI.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / Census3CensusAPI +[@vocdoni/sdk](/sdk) / Census3CensusAPI # Class: Census3CensusAPI @@ -10,39 +10,12 @@ ## Table of contents -### Constructors - -- [constructor](Census3CensusAPI#constructor) - ### Methods - [census](Census3CensusAPI#census) - [create](Census3CensusAPI#create) -- [isApiError](Census3CensusAPI#isapierror) -- [isUndefinedError](Census3CensusAPI#isundefinederror) - [list](Census3CensusAPI#list) - [queue](Census3CensusAPI#queue) -- [serializePagination](Census3CensusAPI#serializepagination) - -## Constructors - -### constructor - -• **new Census3CensusAPI**(): [`Census3CensusAPI`](Census3CensusAPI) - -Cannot be constructed. - -#### Returns - -[`Census3CensusAPI`](Census3CensusAPI) - -#### Overrides - -Census3API.constructor - -#### Defined in - -[api/census3/census.ts:96](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/census.ts#L96) ## Methods @@ -65,7 +38,7 @@ Returns the information of the census #### Defined in -[api/census3/census.ts:121](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/census.ts#L121) +[api/census3/census.ts:119](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/census.ts#L119) ___ @@ -91,56 +64,7 @@ The queue identifier #### Defined in -[api/census3/census.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/census.ts#L150) - -___ - -### isApiError - -▸ **isApiError**(`error`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `AxiosError`\<`unknown`, `any`\> | - -#### Returns - -`never` - -#### Inherited from - -Census3API.isApiError - -#### Defined in - -[api/census3/api.ts:101](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/api.ts#L101) - -___ - -### isUndefinedError - -▸ **isUndefinedError**(`error`, `message?`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `AxiosError`\<`unknown`, `any`\> | -| `message?` | `string` | - -#### Returns - -`never` - -#### Inherited from - -Census3API.isUndefinedError - -#### Defined in - -[api/api.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/api.ts#L64) +[api/census3/census.ts:147](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/census.ts#L147) ___ @@ -163,7 +87,7 @@ Fetches list of census based on given strategy #### Defined in -[api/census3/census.ts:107](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/census.ts#L107) +[api/census3/census.ts:106](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/census.ts#L106) ___ @@ -186,28 +110,4 @@ Returns the information of the census queue #### Defined in -[api/census3/census.ts:135](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/census.ts#L135) - -___ - -### serializePagination - -▸ **serializePagination**(`pagination?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `pagination?` | `Census3Pagination` | - -#### Returns - -`string` - -#### Inherited from - -Census3API.serializePagination - -#### Defined in - -[api/census3/api.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/api.ts#L92) +[api/census3/census.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/census.ts#L132) diff --git a/docs/sdk/reference/classes/Census3ServiceAPI.md b/docs/sdk/reference/classes/Census3ServiceAPI.md index 7824b1234..97c2e28b0 100644 --- a/docs/sdk/reference/classes/Census3ServiceAPI.md +++ b/docs/sdk/reference/classes/Census3ServiceAPI.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / Census3ServiceAPI +[@vocdoni/sdk](/sdk) / Census3ServiceAPI # Class: Census3ServiceAPI @@ -10,36 +10,9 @@ ## Table of contents -### Constructors - -- [constructor](Census3ServiceAPI#constructor) - ### Methods - [info](Census3ServiceAPI#info) -- [isApiError](Census3ServiceAPI#isapierror) -- [isUndefinedError](Census3ServiceAPI#isundefinederror) -- [serializePagination](Census3ServiceAPI#serializepagination) - -## Constructors - -### constructor - -• **new Census3ServiceAPI**(): [`Census3ServiceAPI`](Census3ServiceAPI) - -Cannot be constructed. - -#### Returns - -[`Census3ServiceAPI`](Census3ServiceAPI) - -#### Overrides - -Census3API.constructor - -#### Defined in - -[api/census3/service.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/service.ts#L36) ## Methods @@ -61,77 +34,4 @@ Fetches supported chains from the service #### Defined in -[api/census3/service.ts:46](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/service.ts#L46) - -___ - -### isApiError - -▸ **isApiError**(`error`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `AxiosError`\<`unknown`, `any`\> | - -#### Returns - -`never` - -#### Inherited from - -Census3API.isApiError - -#### Defined in - -[api/census3/api.ts:101](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/api.ts#L101) - -___ - -### isUndefinedError - -▸ **isUndefinedError**(`error`, `message?`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `AxiosError`\<`unknown`, `any`\> | -| `message?` | `string` | - -#### Returns - -`never` - -#### Inherited from - -Census3API.isUndefinedError - -#### Defined in - -[api/api.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/api.ts#L64) - -___ - -### serializePagination - -▸ **serializePagination**(`pagination?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `pagination?` | `Census3Pagination` | - -#### Returns - -`string` - -#### Inherited from - -Census3API.serializePagination - -#### Defined in - -[api/census3/api.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/api.ts#L92) +[api/census3/service.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/service.ts#L45) diff --git a/docs/sdk/reference/classes/Census3StrategyAPI.md b/docs/sdk/reference/classes/Census3StrategyAPI.md index ce110856a..6ccc4b445 100644 --- a/docs/sdk/reference/classes/Census3StrategyAPI.md +++ b/docs/sdk/reference/classes/Census3StrategyAPI.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / Census3StrategyAPI +[@vocdoni/sdk](/sdk) / Census3StrategyAPI # Class: Census3StrategyAPI @@ -10,10 +10,6 @@ ## Table of contents -### Constructors - -- [constructor](Census3StrategyAPI#constructor) - ### Methods - [create](Census3StrategyAPI#create) @@ -22,35 +18,12 @@ - [holders](Census3StrategyAPI#holders) - [import](Census3StrategyAPI#import) - [importQueue](Census3StrategyAPI#importqueue) -- [isApiError](Census3StrategyAPI#isapierror) -- [isUndefinedError](Census3StrategyAPI#isundefinederror) - [list](Census3StrategyAPI#list) - [listByToken](Census3StrategyAPI#listbytoken) - [operators](Census3StrategyAPI#operators) -- [serializePagination](Census3StrategyAPI#serializepagination) - [strategy](Census3StrategyAPI#strategy) - [validatePredicate](Census3StrategyAPI#validatepredicate) -## Constructors - -### constructor - -• **new Census3StrategyAPI**(): [`Census3StrategyAPI`](Census3StrategyAPI) - -Cannot be constructed. - -#### Returns - -[`Census3StrategyAPI`](Census3StrategyAPI) - -#### Overrides - -Census3API.constructor - -#### Defined in - -[api/census3/strategy.ts:264](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L264) - ## Methods ### create @@ -76,7 +49,7 @@ The identifier of the created strategy #### Defined in -[api/census3/strategy.ts:422](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L422) +[api/census3/strategy.ts:416](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L416) ___ @@ -102,7 +75,7 @@ The queue identifier #### Defined in -[api/census3/strategy.ts:352](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L352) +[api/census3/strategy.ts:348](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L348) ___ @@ -126,7 +99,7 @@ Returns the information of the strategy estimation queue #### Defined in -[api/census3/strategy.ts:369](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L369) +[api/census3/strategy.ts:364](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L364) ___ @@ -150,7 +123,7 @@ Fetches list of holders by strategy #### Defined in -[api/census3/strategy.ts:292](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L292) +[api/census3/strategy.ts:290](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L290) ___ @@ -175,7 +148,7 @@ The queue identifier #### Defined in -[api/census3/strategy.ts:406](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L406) +[api/census3/strategy.ts:400](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L400) ___ @@ -198,56 +171,7 @@ Returns the information of the strategy import queue #### Defined in -[api/census3/strategy.ts:390](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L390) - -___ - -### isApiError - -▸ **isApiError**(`error`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `AxiosError`\<`unknown`, `any`\> | - -#### Returns - -`never` - -#### Inherited from - -Census3API.isApiError - -#### Defined in - -[api/census3/api.ts:101](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/api.ts#L101) - -___ - -### isUndefinedError - -▸ **isUndefinedError**(`error`, `message?`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `AxiosError`\<`unknown`, `any`\> | -| `message?` | `string` | - -#### Returns - -`never` - -#### Inherited from - -Census3API.isUndefinedError - -#### Defined in - -[api/api.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/api.ts#L64) +[api/census3/strategy.ts:384](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L384) ___ @@ -270,7 +194,7 @@ Fetches list of strategies #### Defined in -[api/census3/strategy.ts:275](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L275) +[api/census3/strategy.ts:274](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L274) ___ @@ -295,7 +219,7 @@ Fetches list of strategies based on given token #### Defined in -[api/census3/strategy.ts:314](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L314) +[api/census3/strategy.ts:311](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L311) ___ @@ -317,37 +241,13 @@ Returns the list of supported operators to build strategy predicates. #### Defined in -[api/census3/strategy.ts:454](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L454) - -___ - -### serializePagination - -▸ **serializePagination**(`pagination?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `pagination?` | `Census3Pagination` | - -#### Returns - -`string` - -#### Inherited from - -Census3API.serializePagination - -#### Defined in - -[api/census3/api.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/api.ts#L92) +[api/census3/strategy.ts:447](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L447) ___ ### strategy -▸ **strategy**(`url`, `id`): `Promise`\<[`Census3Strategy`](../modules#census3strategy)\> +▸ **strategy**(`url`, `id`): `Promise`\<[`Census3Strategy`](../sdk-reference#census3strategy)\> Returns the information of the strategy @@ -360,11 +260,11 @@ Returns the information of the strategy #### Returns -`Promise`\<[`Census3Strategy`](../modules#census3strategy)\> +`Promise`\<[`Census3Strategy`](../sdk-reference#census3strategy)\> #### Defined in -[api/census3/strategy.ts:337](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L337) +[api/census3/strategy.ts:333](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L333) ___ @@ -389,4 +289,4 @@ Parsed version of the predicate #### Defined in -[api/census3/strategy.ts:441](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L441) +[api/census3/strategy.ts:435](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L435) diff --git a/docs/sdk/reference/classes/Census3TokenAPI.md b/docs/sdk/reference/classes/Census3TokenAPI.md index 076170001..3d8328cf2 100644 --- a/docs/sdk/reference/classes/Census3TokenAPI.md +++ b/docs/sdk/reference/classes/Census3TokenAPI.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / Census3TokenAPI +[@vocdoni/sdk](/sdk) / Census3TokenAPI # Class: Census3TokenAPI @@ -10,41 +10,14 @@ ## Table of contents -### Constructors - -- [constructor](Census3TokenAPI#constructor) - ### Methods - [create](Census3TokenAPI#create) - [holder](Census3TokenAPI#holder) -- [isApiError](Census3TokenAPI#isapierror) -- [isUndefinedError](Census3TokenAPI#isundefinederror) - [list](Census3TokenAPI#list) -- [serializePagination](Census3TokenAPI#serializepagination) - [token](Census3TokenAPI#token) - [types](Census3TokenAPI#types) -## Constructors - -### constructor - -• **new Census3TokenAPI**(): [`Census3TokenAPI`](Census3TokenAPI) - -Cannot be constructed. - -#### Returns - -[`Census3TokenAPI`](Census3TokenAPI) - -#### Overrides - -Census3API.constructor - -#### Defined in - -[api/census3/token.ts:138](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/token.ts#L138) - ## Methods ### create @@ -72,7 +45,7 @@ promised IFileCIDResponse #### Defined in -[api/census3/token.ts:229](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/token.ts#L229) +[api/census3/token.ts:226](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/token.ts#L226) ___ @@ -100,56 +73,7 @@ The balance of holder #### Defined in -[api/census3/token.ts:199](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/token.ts#L199) - -___ - -### isApiError - -▸ **isApiError**(`error`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `AxiosError`\<`unknown`, `any`\> | - -#### Returns - -`never` - -#### Inherited from - -Census3API.isApiError - -#### Defined in - -[api/census3/api.ts:101](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/api.ts#L101) - -___ - -### isUndefinedError - -▸ **isUndefinedError**(`error`, `message?`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `AxiosError`\<`unknown`, `any`\> | -| `message?` | `string` | - -#### Returns - -`never` - -#### Inherited from - -Census3API.isUndefinedError - -#### Defined in - -[api/api.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/api.ts#L64) +[api/census3/token.ts:196](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/token.ts#L196) ___ @@ -172,37 +96,13 @@ Fetches list of already added tokens #### Defined in -[api/census3/token.ts:149](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/token.ts#L149) - -___ - -### serializePagination - -▸ **serializePagination**(`pagination?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `pagination?` | `Census3Pagination` | - -#### Returns - -`string` - -#### Inherited from - -Census3API.serializePagination - -#### Defined in - -[api/census3/api.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/api.ts#L92) +[api/census3/token.ts:148](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/token.ts#L148) ___ ### token -▸ **token**(`url`, `tokenId`, `chainId`, `externalId?`): `Promise`\<[`Census3Token`](../modules#census3token)\> +▸ **token**(`url`, `tokenId`, `chainId`, `externalId?`): `Promise`\<[`Census3Token`](../sdk-reference#census3token)\> Fetch the full token information @@ -217,11 +117,11 @@ Fetch the full token information #### Returns -`Promise`\<[`Census3Token`](../modules#census3token)\> +`Promise`\<[`Census3Token`](../sdk-reference#census3token)\> #### Defined in -[api/census3/token.ts:178](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/token.ts#L178) +[api/census3/token.ts:175](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/token.ts#L175) ___ @@ -243,4 +143,4 @@ Fetches list of tokens types #### Defined in -[api/census3/token.ts:162](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/token.ts#L162) +[api/census3/token.ts:160](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/token.ts#L160) diff --git a/docs/sdk/reference/classes/CensusAPI.md b/docs/sdk/reference/classes/CensusAPI.md index 93fa7f879..68a635880 100644 --- a/docs/sdk/reference/classes/CensusAPI.md +++ b/docs/sdk/reference/classes/CensusAPI.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / CensusAPI +[@vocdoni/sdk](/sdk) / CensusAPI # Class: CensusAPI @@ -10,10 +10,6 @@ ## Table of contents -### Constructors - -- [constructor](CensusAPI#constructor) - ### Methods - [add](CensusAPI#add) @@ -21,34 +17,12 @@ - [delete](CensusAPI#delete) - [export](CensusAPI#export) - [import](CensusAPI#import) -- [isApiError](CensusAPI#isapierror) -- [isUndefinedError](CensusAPI#isundefinederror) - [proof](CensusAPI#proof) - [publish](CensusAPI#publish) - [size](CensusAPI#size) - [type](CensusAPI#type) - [weight](CensusAPI#weight) -## Constructors - -### constructor - -• **new CensusAPI**(): [`CensusAPI`](CensusAPI) - -Cannot be constructed. - -#### Returns - -[`CensusAPI`](CensusAPI) - -#### Overrides - -API.constructor - -#### Defined in - -[api/census.ts:121](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census.ts#L121) - ## Methods ### add @@ -72,7 +46,7 @@ Adds participants to a census #### Defined in -[api/census.ts:153](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census.ts#L153) +[api/census.ts:151](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census.ts#L151) ___ @@ -96,7 +70,7 @@ Create's a new census in the API. #### Defined in -[api/census.ts:133](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census.ts#L133) +[api/census.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census.ts#L132) ___ @@ -122,7 +96,7 @@ on success #### Defined in -[api/census.ts:275](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census.ts#L275) +[api/census.ts:273](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census.ts#L273) ___ @@ -148,7 +122,7 @@ on success #### Defined in -[api/census.ts:223](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census.ts#L223) +[api/census.ts:221](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census.ts#L221) ___ @@ -177,56 +151,7 @@ on success #### Defined in -[api/census.ts:245](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census.ts#L245) - -___ - -### isApiError - -▸ **isApiError**(`error`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `AxiosError`\<`unknown`, `any`\> | - -#### Returns - -`never` - -#### Inherited from - -API.isApiError - -#### Defined in - -[api/api.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/api.ts#L21) - -___ - -### isUndefinedError - -▸ **isUndefinedError**(`error`, `message?`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `AxiosError`\<`unknown`, `any`\> | -| `message?` | `string` | - -#### Returns - -`never` - -#### Inherited from - -API.isUndefinedError - -#### Defined in - -[api/api.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/api.ts#L64) +[api/census.ts:243](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census.ts#L243) ___ @@ -252,7 +177,7 @@ on success #### Defined in -[api/census.ts:208](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census.ts#L208) +[api/census.ts:206](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census.ts#L206) ___ @@ -278,7 +203,7 @@ on success #### Defined in -[api/census.ts:189](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census.ts#L189) +[api/census.ts:187](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census.ts#L187) ___ @@ -301,7 +226,7 @@ Returns the size of a given census #### Defined in -[api/census.ts:293](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census.ts#L293) +[api/census.ts:290](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census.ts#L290) ___ @@ -324,7 +249,7 @@ Returns the type of given census #### Defined in -[api/census.ts:321](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census.ts#L321) +[api/census.ts:316](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census.ts#L316) ___ @@ -347,4 +272,4 @@ Returns the weight of a given census #### Defined in -[api/census.ts:307](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census.ts#L307) +[api/census.ts:303](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census.ts#L303) diff --git a/docs/sdk/reference/classes/CensusService.md b/docs/sdk/reference/classes/CensusService.md index 414d61575..6d951bb47 100644 --- a/docs/sdk/reference/classes/CensusService.md +++ b/docs/sdk/reference/classes/CensusService.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / CensusService +[@vocdoni/sdk](/sdk) / CensusService # Class: CensusService @@ -18,19 +18,11 @@ - [constructor](CensusService#constructor) -### Properties - -- [auth](CensusService#auth) -- [chunk\_size](CensusService.md#chunk_size) -- [url](CensusService#url) - ### Methods - [add](CensusService#add) -- [addParallel](CensusService#addparallel) - [create](CensusService#create) - [createCensus](CensusService#createcensus) -- [createCensusParallel](CensusService#createcensusparallel) - [delete](CensusService#delete) - [export](CensusService#export) - [fetchAccountToken](CensusService#fetchaccounttoken) @@ -39,6 +31,12 @@ - [import](CensusService#import) - [publish](CensusService#publish) +### Properties + +- [auth](CensusService#auth) +- [chunk\_size](CensusService.md#chunk_size) +- [url](CensusService#url) + ## Constructors ### constructor @@ -59,53 +57,11 @@ Instantiate the census service. #### Overrides -[Service](Service.md).[constructor](Service#constructor) - -#### Defined in - -[services/census.ts:73](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/census.ts#L73) - -## Properties - -### auth - -• **auth**: `CensusAuth` - -#### Implementation of - -CensusServiceProperties.auth +Service.constructor #### Defined in -[services/census.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/census.ts#L65) - -___ - -### chunk\_size - -• **chunk\_size**: `number` - -#### Implementation of - -CensusServiceProperties.chunk\_size - -#### Defined in - -[services/census.ts:66](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/census.ts#L66) - -___ - -### url - -• **url**: `string` - -#### Inherited from - -[Service](Service.md).[url](Service#url) - -#### Defined in - -[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/service.ts#L6) +[services/census.ts:73](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/census.ts#L73) ## Methods @@ -126,28 +82,7 @@ ___ #### Defined in -[services/census.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/census.ts#L145) - -___ - -### addParallel - -▸ **addParallel**(`censusId`, `participants`): `Promise`\<`ICensusAddResponse`\>[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `censusId` | `string` | -| `participants` | [`ICensusParticipant`](../interfaces/ICensusParticipant)[] | - -#### Returns - -`Promise`\<`ICensusAddResponse`\>[] - -#### Defined in - -[services/census.ts:169](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/census.ts#L169) +[services/census.ts:142](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/census.ts#L142) ___ @@ -167,7 +102,7 @@ ___ #### Defined in -[services/census.ts:137](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/census.ts#L137) +[services/census.ts:134](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/census.ts#L134) ___ @@ -189,29 +124,7 @@ Publishes the given census. #### Defined in -[services/census.ts:232](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/census.ts#L232) - -___ - -### createCensusParallel - -▸ **createCensusParallel**(`census`): `Promise`\<`void`\> - -Publishes the given census. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `census` | [`PlainCensus`](PlainCensus.md) \| [`WeightedCensus`](WeightedCensus) | The census to be published. | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[services/census.ts:254](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/census.ts#L254) +[services/census.ts:228](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/census.ts#L228) ___ @@ -233,13 +146,13 @@ Deletes the given census. #### Defined in -[services/census.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/census.ts#L110) +[services/census.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/census.ts#L108) ___ ### export -▸ **export**(`censusId`): `Promise`\<[`CensusImportExport`](../modules#censusimportexport)\> +▸ **export**(`censusId`): `Promise`\<[`CensusImportExport`](../sdk-reference#censusimportexport)\> Exports the given census identifier. @@ -251,11 +164,11 @@ Exports the given census identifier. #### Returns -`Promise`\<[`CensusImportExport`](../modules#censusimportexport)\> +`Promise`\<[`CensusImportExport`](../sdk-reference#censusimportexport)\> #### Defined in -[services/census.ts:206](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/census.ts#L206) +[services/census.ts:203](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/census.ts#L203) ___ @@ -271,13 +184,13 @@ Fetches the specific account token auth and sets it to the current instance. #### Defined in -[services/census.ts:275](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/census.ts#L275) +[services/census.ts:269](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/census.ts#L269) ___ ### fetchProof -▸ **fetchProof**(`censusId`, `key`): `Promise`\<[`CensusProof`](../modules#censusproof)\> +▸ **fetchProof**(`censusId`, `key`): `Promise`\<[`CensusProof`](../sdk-reference#censusproof)\> Fetches proof that an address is part of the specified census. @@ -290,11 +203,11 @@ Fetches proof that an address is part of the specified census. #### Returns -`Promise`\<[`CensusProof`](../modules#censusproof)\> +`Promise`\<[`CensusProof`](../sdk-reference#censusproof)\> #### Defined in -[services/census.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/census.ts#L124) +[services/census.ts:121](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/census.ts#L121) ___ @@ -316,7 +229,7 @@ Fetches the information of a given census. #### Defined in -[services/census.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/census.ts#L84) +[services/census.ts:83](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/census.ts#L83) ___ @@ -331,7 +244,7 @@ Imports data into the given census identifier. | Name | Type | Description | | :------ | :------ | :------ | | `censusId` | `string` | The census identifier | -| `data` | [`CensusImportExport`](../modules#censusimportexport) | The census data | +| `data` | [`CensusImportExport`](../sdk-reference#censusimportexport) | The census data | #### Returns @@ -339,7 +252,7 @@ Imports data into the given census identifier. #### Defined in -[services/census.ts:219](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/census.ts#L219) +[services/census.ts:216](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/census.ts#L216) ___ @@ -361,4 +274,46 @@ Publishes the given census identifier. #### Defined in -[services/census.ts:194](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/census.ts#L194) +[services/census.ts:191](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/census.ts#L191) + +## Properties + +### auth + +• **auth**: `CensusAuth` + +#### Implementation of + +CensusServiceProperties.auth + +#### Defined in + +[services/census.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/census.ts#L65) + +___ + +### chunk\_size + +• **chunk\_size**: `number` + +#### Implementation of + +CensusServiceProperties.chunk\_size + +#### Defined in + +[services/census.ts:66](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/census.ts#L66) + +___ + +### url + +• **url**: `string` + +#### Inherited from + +[Service](Service.md).[url](Service#url) + +#### Defined in + +[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/service.ts#L6) diff --git a/docs/sdk/reference/classes/ChainAPI.md b/docs/sdk/reference/classes/ChainAPI.md index d5bcf62fb..b927f994f 100644 --- a/docs/sdk/reference/classes/ChainAPI.md +++ b/docs/sdk/reference/classes/ChainAPI.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ChainAPI +[@vocdoni/sdk](/sdk) / ChainAPI # Class: ChainAPI @@ -10,10 +10,6 @@ ## Table of contents -### Constructors - -- [constructor](ChainAPI#constructor) - ### Methods - [blockByHash](ChainAPI#blockbyhash) @@ -25,8 +21,6 @@ - [costs](ChainAPI#costs) - [dateToBlock](ChainAPI#datetoblock) - [info](ChainAPI#info) -- [isApiError](ChainAPI#isapierror) -- [isUndefinedError](ChainAPI#isundefinederror) - [organizationCount](ChainAPI#organizationcount) - [organizationList](ChainAPI#organizationlist) - [submitTx](ChainAPI#submittx) @@ -35,26 +29,6 @@ - [txList](ChainAPI#txlist) - [validatorsList](ChainAPI#validatorslist) -## Constructors - -### constructor - -• **new ChainAPI**(): [`ChainAPI`](ChainAPI) - -Cannot be constructed. - -#### Returns - -[`ChainAPI`](ChainAPI) - -#### Overrides - -API.constructor - -#### Defined in - -[api/chain.ts:358](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L358) - ## Methods ### blockByHash @@ -76,7 +50,7 @@ Get block information by hash #### Defined in -[api/chain.ts:556](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L556) +[api/chain.ts:543](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L543) ___ @@ -99,7 +73,7 @@ Get block information by height #### Defined in -[api/chain.ts:529](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L529) +[api/chain.ts:518](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L518) ___ @@ -122,7 +96,7 @@ Return approximate date by a given block height. #### Defined in -[api/chain.ts:600](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L600) +[api/chain.ts:585](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L585) ___ @@ -146,7 +120,7 @@ Get paginated list of transactions registered on specific block #### Defined in -[api/chain.ts:571](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L571) +[api/chain.ts:557](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L557) ___ @@ -168,7 +142,7 @@ Fetches a circuit. #### Defined in -[api/chain.ts:407](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L407) +[api/chain.ts:403](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L403) ___ @@ -190,7 +164,7 @@ Fetches info about the blockchain anonymous circuits. #### Defined in -[api/chain.ts:394](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L394) +[api/chain.ts:391](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L391) ___ @@ -212,7 +186,7 @@ Fetches info about the blockchain costs. #### Defined in -[api/chain.ts:381](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L381) +[api/chain.ts:379](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L379) ___ @@ -235,7 +209,7 @@ By a given date give the estimate block for the current Vochain. #### Defined in -[api/chain.ts:586](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L586) +[api/chain.ts:571](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L571) ___ @@ -257,56 +231,7 @@ Fetches info about the blockchain status. #### Defined in -[api/chain.ts:368](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L368) - -___ - -### isApiError - -▸ **isApiError**(`error`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `AxiosError`\<`unknown`, `any`\> | - -#### Returns - -`never` - -#### Inherited from - -API.isApiError - -#### Defined in - -[api/api.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/api.ts#L21) - -___ - -### isUndefinedError - -▸ **isUndefinedError**(`error`, `message?`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `AxiosError`\<`unknown`, `any`\> | -| `message?` | `string` | - -#### Returns - -`never` - -#### Inherited from - -API.isUndefinedError - -#### Defined in - -[api/api.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/api.ts#L64) +[api/chain.ts:367](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L367) ___ @@ -328,7 +253,7 @@ Returns the number of organizations #### Defined in -[api/chain.ts:488](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L488) +[api/chain.ts:479](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L479) ___ @@ -352,7 +277,7 @@ Returns the list of organizations by page #### Defined in -[api/chain.ts:503](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L503) +[api/chain.ts:493](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L493) ___ @@ -375,7 +300,7 @@ Submits a transaction to the blockchain #### Defined in -[api/chain.ts:461](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L461) +[api/chain.ts:454](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L454) ___ @@ -398,7 +323,7 @@ Fetches information about a transaction from the blockchain. #### Defined in -[api/chain.ts:421](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L421) +[api/chain.ts:416](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L416) ___ @@ -422,7 +347,7 @@ Fetches information about a transaction by its containing block an index on the #### Defined in -[api/chain.ts:441](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L441) +[api/chain.ts:435](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L435) ___ @@ -445,7 +370,7 @@ Returns the list of transactions by page #### Defined in -[api/chain.ts:475](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L475) +[api/chain.ts:467](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L467) ___ @@ -467,4 +392,4 @@ Returns the list of validators #### Defined in -[api/chain.ts:542](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L542) +[api/chain.ts:530](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L530) diff --git a/docs/sdk/reference/classes/ChainService.md b/docs/sdk/reference/classes/ChainService.md index 391e8c4a1..ae5d0bc0e 100644 --- a/docs/sdk/reference/classes/ChainService.md +++ b/docs/sdk/reference/classes/ChainService.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ChainService +[@vocdoni/sdk](/sdk) / ChainService # Class: ChainService @@ -18,13 +18,6 @@ - [constructor](ChainService#constructor) -### Properties - -- [chainCosts](ChainService#chaincosts) -- [chainData](ChainService#chaindata) -- [txWait](ChainService#txwait) -- [url](ChainService#url) - ### Methods - [dateToBlock](ChainService#datetoblock) @@ -34,6 +27,13 @@ - [txInfo](ChainService#txinfo) - [waitForTransaction](ChainService#waitfortransaction) +### Properties + +- [chainCosts](ChainService#chaincosts) +- [chainData](ChainService#chaindata) +- [txWait](ChainService#txwait) +- [url](ChainService#url) + ## Constructors ### constructor @@ -54,67 +54,11 @@ Instantiate the chain service. #### Overrides -[Service](Service.md).[constructor](Service#constructor) - -#### Defined in - -[services/chain.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/chain.ts#L47) - -## Properties - -### chainCosts - -• **chainCosts**: [`IChainGetCostsResponse`](../interfaces/IChainGetCostsResponse) - -#### Implementation of - -ChainServiceProperties.chainCosts - -#### Defined in - -[services/chain.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/chain.ts#L38) - -___ - -### chainData - -• **chainData**: [`ChainData`](../modules#chaindata) - -#### Implementation of - -ChainServiceProperties.chainData - -#### Defined in - -[services/chain.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/chain.ts#L39) - -___ - -### txWait - -• **txWait**: [`TxWaitOptions`](../modules#txwaitoptions) - -#### Implementation of - -ChainServiceProperties.txWait - -#### Defined in - -[services/chain.ts:40](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/chain.ts#L40) - -___ - -### url - -• **url**: `string` - -#### Inherited from - -[Service](Service.md).[url](Service#url) +Service.constructor #### Defined in -[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/service.ts#L6) +[services/chain.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/chain.ts#L47) ## Methods @@ -138,7 +82,7 @@ The block number #### Defined in -[services/chain.ts:114](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/chain.ts#L114) +[services/chain.ts:112](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/chain.ts#L112) ___ @@ -154,23 +98,23 @@ Fetches blockchain costs information if needed. #### Defined in -[services/chain.ts:74](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/chain.ts#L74) +[services/chain.ts:72](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/chain.ts#L72) ___ ### fetchChainData -▸ **fetchChainData**(): `Promise`\<[`ChainData`](../modules#chaindata)\> +▸ **fetchChainData**(): `Promise`\<[`ChainData`](../sdk-reference#chaindata)\> Fetches blockchain information if needed. #### Returns -`Promise`\<[`ChainData`](../modules#chaindata)\> +`Promise`\<[`ChainData`](../sdk-reference#chaindata)\> #### Defined in -[services/chain.ts:57](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/chain.ts#L57) +[services/chain.ts:56](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/chain.ts#L56) ___ @@ -194,7 +138,7 @@ The transaction hash #### Defined in -[services/chain.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/chain.ts#L92) +[services/chain.ts:90](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/chain.ts#L90) ___ @@ -218,7 +162,7 @@ The chain transaction #### Defined in -[services/chain.ts:103](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/chain.ts#L103) +[services/chain.ts:101](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/chain.ts#L101) ___ @@ -244,4 +188,60 @@ it fails. #### Defined in -[services/chain.ts:129](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/chain.ts#L129) +[services/chain.ts:126](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/chain.ts#L126) + +## Properties + +### chainCosts + +• **chainCosts**: [`IChainGetCostsResponse`](../interfaces/IChainGetCostsResponse) + +#### Implementation of + +ChainServiceProperties.chainCosts + +#### Defined in + +[services/chain.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/chain.ts#L38) + +___ + +### chainData + +• **chainData**: [`ChainData`](../sdk-reference#chaindata) + +#### Implementation of + +ChainServiceProperties.chainData + +#### Defined in + +[services/chain.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/chain.ts#L39) + +___ + +### txWait + +• **txWait**: [`TxWaitOptions`](../sdk-reference#txwaitoptions) + +#### Implementation of + +ChainServiceProperties.txWait + +#### Defined in + +[services/chain.ts:40](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/chain.ts#L40) + +___ + +### url + +• **url**: `string` + +#### Inherited from + +[Service](Service.md).[url](Service#url) + +#### Defined in + +[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/service.ts#L6) diff --git a/docs/sdk/reference/classes/CspCensus.md b/docs/sdk/reference/classes/CspCensus.md index 9a0adc8d3..1e0a18f3a 100644 --- a/docs/sdk/reference/classes/CspCensus.md +++ b/docs/sdk/reference/classes/CspCensus.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / CspCensus +[@vocdoni/sdk](/sdk) / CspCensus # Class: CspCensus @@ -12,16 +12,6 @@ Represents a published census ## Table of contents -### Constructors - -- [constructor](CspCensus#constructor) - -### Properties - -- [\_censusId](CspCensus.md#_censusid) -- [\_censusURI](CspCensus.md#_censusuri) -- [\_type](CspCensus.md#_type) - ### Accessors - [censusId](CspCensus#censusid) @@ -31,78 +21,13 @@ Represents a published census - [type](CspCensus#type) - [weight](CspCensus#weight) -### Methods - -- [censusTypeFromCensusOrigin](CspCensus#censustypefromcensusorigin) - -## Constructors - -### constructor - -• **new CspCensus**(`publicKey`, `cspURI`): [`CspCensus`](CspCensus) - -Constructs a CSP census - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `publicKey` | `string` | The public | -| `cspURI` | `string` | The URI of the CSP server | - -#### Returns - -[`CspCensus`](CspCensus) - -#### Overrides - -[Census](Census.md).[constructor](Census#constructor) - -#### Defined in - -[types/census/csp.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/csp.ts#L14) - -## Properties - -### \_censusId - -• `Protected` **\_censusId**: `string` - -#### Inherited from - -[Census](Census).[_censusId](Census.md#_censusid) - -#### Defined in - -[types/census/census.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L12) - -___ - -### \_censusURI - -• `Protected` **\_censusURI**: `string` - -#### Inherited from - -[Census](Census).[_censusURI](Census.md#_censusuri) - -#### Defined in - -[types/census/census.ts:13](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L13) - -___ - -### \_type - -• `Protected` **\_type**: [`CensusType`](../enums/CensusType) - -#### Inherited from +### Constructors -[Census](Census).[_type](Census.md#_type) +- [constructor](CspCensus#constructor) -#### Defined in +### Methods -[types/census/census.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L14) +- [censusTypeFromCensusOrigin](CspCensus#censustypefromcensusorigin) ## Accessors @@ -120,7 +45,7 @@ Census.censusId #### Defined in -[types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L35) +[types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L35) • `set` **censusId**(`value`): `void` @@ -140,7 +65,7 @@ Census.censusId #### Defined in -[types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L39) +[types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L39) ___ @@ -158,7 +83,7 @@ Census.censusURI #### Defined in -[types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L43) +[types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L43) • `set` **censusURI**(`value`): `void` @@ -178,7 +103,7 @@ Census.censusURI #### Defined in -[types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L47) +[types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L47) ___ @@ -196,7 +121,7 @@ Census.isPublished #### Defined in -[types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L75) +[types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L75) ___ @@ -214,7 +139,7 @@ Census.size #### Defined in -[types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L59) +[types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L59) • `set` **size**(`value`): `void` @@ -234,7 +159,7 @@ Census.size #### Defined in -[types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L63) +[types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L63) ___ @@ -252,7 +177,7 @@ Census.type #### Defined in -[types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L51) +[types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L51) • `set` **type**(`value`): `void` @@ -272,7 +197,7 @@ Census.type #### Defined in -[types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L55) +[types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L55) ___ @@ -290,7 +215,7 @@ Census.weight #### Defined in -[types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L67) +[types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L67) • `set` **weight**(`value`): `void` @@ -310,7 +235,34 @@ Census.weight #### Defined in -[types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L71) +[types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L71) + +## Constructors + +### constructor + +• **new CspCensus**(`publicKey`, `cspURI`): [`CspCensus`](CspCensus) + +Constructs a CSP census + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `publicKey` | `string` | The public | +| `cspURI` | `string` | The URI of the CSP server | + +#### Returns + +[`CspCensus`](CspCensus) + +#### Overrides + +Census.constructor + +#### Defined in + +[types/census/csp.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/csp.ts#L14) ## Methods @@ -335,4 +287,4 @@ Census.weight #### Defined in -[types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L81) +[types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L81) diff --git a/docs/sdk/reference/classes/CspService.md b/docs/sdk/reference/classes/CspService.md index e5d5caab2..321ce2a36 100644 --- a/docs/sdk/reference/classes/CspService.md +++ b/docs/sdk/reference/classes/CspService.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / CspService +[@vocdoni/sdk](/sdk) / CspService # Class: CspService @@ -18,11 +18,6 @@ - [constructor](CspService#constructor) -### Properties - -- [info](CspService#info) -- [url](CspService#url) - ### Methods - [cspSign](CspService#cspsign) @@ -33,6 +28,11 @@ - [cspVote](CspService.md#cspvote-1) - [fetchUrlFromElection](CspService#fetchurlfromelection) +### Properties + +- [info](CspService#info) +- [url](CspService#url) + ## Constructors ### constructor @@ -53,39 +53,11 @@ Instantiate the CSP service. #### Overrides -[Service](Service.md).[constructor](Service#constructor) - -#### Defined in - -[services/csp.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/csp.ts#L29) - -## Properties - -### info - -• **info**: `ICspInfoResponse` - -#### Implementation of - -CspServiceProperties.info - -#### Defined in - -[services/csp.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/csp.ts#L22) - -___ - -### url - -• **url**: `string` - -#### Inherited from - -[Service](Service.md).[url](Service#url) +Service.constructor #### Defined in -[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/service.ts#L6) +[services/csp.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/csp.ts#L29) ## Methods @@ -107,7 +79,7 @@ ___ #### Defined in -[services/csp.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/csp.ts#L64) +[services/csp.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/csp.ts#L64) ___ @@ -130,7 +102,7 @@ ___ #### Defined in -[services/csp.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/csp.ts#L49) +[services/csp.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/csp.ts#L49) ___ @@ -152,7 +124,7 @@ ___ #### Defined in -[services/csp.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/csp.ts#L75) +[services/csp.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/csp.ts#L75) ___ @@ -166,7 +138,7 @@ ___ #### Defined in -[services/csp.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/csp.ts#L43) +[services/csp.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/csp.ts#L43) ___ @@ -186,7 +158,7 @@ ___ #### Defined in -[services/csp.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/csp.ts#L39) +[services/csp.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/csp.ts#L39) ___ @@ -208,7 +180,7 @@ ___ #### Defined in -[services/csp.ts:79](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/csp.ts#L79) +[services/csp.ts:79](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/csp.ts#L79) ___ @@ -228,4 +200,32 @@ ___ #### Defined in -[services/csp.ts:34](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/csp.ts#L34) +[services/csp.ts:34](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/csp.ts#L34) + +## Properties + +### info + +• **info**: `ICspInfoResponse` + +#### Implementation of + +CspServiceProperties.info + +#### Defined in + +[services/csp.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/csp.ts#L22) + +___ + +### url + +• **url**: `string` + +#### Inherited from + +[Service](Service.md).[url](Service#url) + +#### Defined in + +[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/service.ts#L6) diff --git a/docs/sdk/reference/classes/CspVote.md b/docs/sdk/reference/classes/CspVote.md index 7aa1023e2..f830621b4 100644 --- a/docs/sdk/reference/classes/CspVote.md +++ b/docs/sdk/reference/classes/CspVote.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / CspVote +[@vocdoni/sdk](/sdk) / CspVote # Class: CspVote @@ -12,68 +12,15 @@ Represents a vote ## Table of contents -### Constructors - -- [constructor](CspVote#constructor) - -### Properties - -- [\_proof\_type](CspVote.md#_proof_type) -- [\_signature](CspVote.md#_signature) - ### Accessors - [proof\_type](CspVote.md#proof_type) - [signature](CspVote#signature) - [votes](CspVote#votes) -## Constructors - -### constructor - -• **new CspVote**(`votes`, `signature`, `proof_type?`): [`CspVote`](CspVote) - -Constructs a csp vote - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `votes` | (`number` \| `bigint`)[] | The list of votes values | -| `signature` | `string` | The CSP signature | -| `proof_type?` | [`CspProofType`](../enums/CspProofType) | The CSP proof type | - -#### Returns - -[`CspVote`](CspVote) - -#### Overrides - -[Vote](Vote.md).[constructor](Vote#constructor) - -#### Defined in - -[types/vote/csp.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/vote/csp.ts#L15) - -## Properties - -### \_proof\_type - -• `Private` **\_proof\_type**: [`CspProofType`](../enums/CspProofType) - -#### Defined in - -[types/vote/csp.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/vote/csp.ts#L6) - -___ - -### \_signature - -• `Private` **\_signature**: `string` - -#### Defined in +### Constructors -[types/vote/csp.ts:5](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/vote/csp.ts#L5) +- [constructor](CspVote#constructor) ## Accessors @@ -87,7 +34,7 @@ ___ #### Defined in -[types/vote/csp.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/vote/csp.ts#L29) +[types/vote/csp.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/vote/csp.ts#L29) • `set` **proof_type**(`value`): `void` @@ -103,7 +50,7 @@ ___ #### Defined in -[types/vote/csp.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/vote/csp.ts#L33) +[types/vote/csp.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/vote/csp.ts#L33) ___ @@ -117,7 +64,7 @@ ___ #### Defined in -[types/vote/csp.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/vote/csp.ts#L21) +[types/vote/csp.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/vote/csp.ts#L21) • `set` **signature**(`value`): `void` @@ -133,7 +80,7 @@ ___ #### Defined in -[types/vote/csp.ts:25](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/vote/csp.ts#L25) +[types/vote/csp.ts:25](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/vote/csp.ts#L25) ___ @@ -151,7 +98,7 @@ Vote.votes #### Defined in -[types/vote/vote.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/vote/vote.ts#L16) +[types/vote/vote.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/vote/vote.ts#L16) • `set` **votes**(`value`): `void` @@ -171,4 +118,32 @@ Vote.votes #### Defined in -[types/vote/vote.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/vote/vote.ts#L20) +[types/vote/vote.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/vote/vote.ts#L20) + +## Constructors + +### constructor + +• **new CspVote**(`votes`, `signature`, `proof_type?`): [`CspVote`](CspVote) + +Constructs a csp vote + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `votes` | (`number` \| `bigint`)[] | The list of votes values | +| `signature` | `string` | The CSP signature | +| `proof_type?` | [`CspProofType`](../enums/CspProofType) | - | + +#### Returns + +[`CspVote`](CspVote) + +#### Overrides + +[Vote](Vote.md).[constructor](Vote#constructor) + +#### Defined in + +[types/vote/csp.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/vote/csp.ts#L15) diff --git a/docs/sdk/reference/classes/Election.md b/docs/sdk/reference/classes/Election.md index a50de2672..42f100ce5 100644 --- a/docs/sdk/reference/classes/Election.md +++ b/docs/sdk/reference/classes/Election.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / Election +[@vocdoni/sdk](/sdk) / Election # Class: Election @@ -14,27 +14,6 @@ Represents an election ## Table of contents -### Constructors - -- [constructor](Election#constructor) - -### Properties - -- [\_addSDKVersion](Election.md#_addsdkversion) -- [\_census](Election.md#_census) -- [\_description](Election.md#_description) -- [\_electionType](Election.md#_electiontype) -- [\_endDate](Election.md#_enddate) -- [\_header](Election.md#_header) -- [\_maxCensusSize](Election.md#_maxcensussize) -- [\_meta](Election.md#_meta) -- [\_questions](Election.md#_questions) -- [\_startDate](Election.md#_startdate) -- [\_streamUri](Election.md#_streamuri) -- [\_temporarySecretIdentity](Election.md#_temporarysecretidentity) -- [\_title](Election.md#_title) -- [\_voteType](Election.md#_votetype) - ### Accessors - [addSDKVersion](Election#addsdkversion) @@ -57,168 +36,6 @@ Represents an election - [get](Election#get) - [from](Election#from) -## Constructors - -### constructor - -• **new Election**(`params?`): [`Election`](Election) - -Constructs an election - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params?` | [`IElectionParameters`](../interfaces/IElectionParameters) | Election parameters | - -#### Returns - -[`Election`](Election) - -#### Defined in - -[types/election/election.ts:182](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L182) - -## Properties - -### \_addSDKVersion - -• `Protected` **\_addSDKVersion**: `boolean` - -#### Defined in - -[types/election/election.ts:175](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L175) - -___ - -### \_census - -• `Protected` **\_census**: [`Census`](Census) - -#### Defined in - -[types/election/election.ts:172](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L172) - -___ - -### \_description - -• `Protected` **\_description**: `MultiLanguage`\<`string`\> - -#### Defined in - -[types/election/election.ts:163](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L163) - -___ - -### \_electionType - -• `Protected` **\_electionType**: [`IElectionType`](../interfaces/IElectionType) - -#### Defined in - -[types/election/election.ts:169](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L169) - -___ - -### \_endDate - -• `Protected` **\_endDate**: `Date` - -#### Defined in - -[types/election/election.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L168) - -___ - -### \_header - -• `Protected` **\_header**: `string` - -#### Defined in - -[types/election/election.ts:164](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L164) - -___ - -### \_maxCensusSize - -• `Protected` **\_maxCensusSize**: `number` - -#### Defined in - -[types/election/election.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L173) - -___ - -### \_meta - -• `Protected` **\_meta**: `any` - -#### Defined in - -[types/election/election.ts:166](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L166) - -___ - -### \_questions - -• `Protected` **\_questions**: [`IQuestion`](../interfaces/IQuestion)[] - -#### Defined in - -[types/election/election.ts:171](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L171) - -___ - -### \_startDate - -• `Protected` **\_startDate**: `Date` - -#### Defined in - -[types/election/election.ts:167](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L167) - -___ - -### \_streamUri - -• `Protected` **\_streamUri**: `string` - -#### Defined in - -[types/election/election.ts:165](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L165) - -___ - -### \_temporarySecretIdentity - -• `Protected` **\_temporarySecretIdentity**: `boolean` - -#### Defined in - -[types/election/election.ts:174](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L174) - -___ - -### \_title - -• `Protected` **\_title**: `MultiLanguage`\<`string`\> - -#### Defined in - -[types/election/election.ts:162](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L162) - -___ - -### \_voteType - -• `Protected` **\_voteType**: [`IVoteType`](../interfaces/IVoteType) - -#### Defined in - -[types/election/election.ts:170](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L170) - ## Accessors ### addSDKVersion @@ -231,7 +48,7 @@ ___ #### Defined in -[types/election/election.ts:262](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L262) +[types/election/election.ts:262](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L262) ___ @@ -245,7 +62,7 @@ ___ #### Defined in -[types/election/election.ts:250](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L250) +[types/election/election.ts:250](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L250) ___ @@ -259,7 +76,7 @@ ___ #### Defined in -[types/election/election.ts:214](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L214) +[types/election/election.ts:214](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L214) ___ @@ -273,7 +90,7 @@ ___ #### Defined in -[types/election/election.ts:238](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L238) +[types/election/election.ts:238](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L238) ___ @@ -287,7 +104,7 @@ ___ #### Defined in -[types/election/election.ts:234](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L234) +[types/election/election.ts:234](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L234) ___ @@ -301,7 +118,7 @@ ___ #### Defined in -[types/election/election.ts:218](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L218) +[types/election/election.ts:218](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L218) ___ @@ -315,7 +132,7 @@ ___ #### Defined in -[types/election/election.ts:254](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L254) +[types/election/election.ts:254](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L254) ___ @@ -329,7 +146,7 @@ ___ #### Defined in -[types/election/election.ts:226](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L226) +[types/election/election.ts:226](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L226) ___ @@ -343,7 +160,7 @@ ___ #### Defined in -[types/election/election.ts:246](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L246) +[types/election/election.ts:246](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L246) ___ @@ -357,7 +174,7 @@ ___ #### Defined in -[types/election/election.ts:230](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L230) +[types/election/election.ts:230](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L230) ___ @@ -371,7 +188,7 @@ ___ #### Defined in -[types/election/election.ts:222](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L222) +[types/election/election.ts:222](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L222) ___ @@ -385,7 +202,7 @@ ___ #### Defined in -[types/election/election.ts:258](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L258) +[types/election/election.ts:258](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L258) ___ @@ -399,7 +216,7 @@ ___ #### Defined in -[types/election/election.ts:210](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L210) +[types/election/election.ts:210](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L210) ___ @@ -413,7 +230,7 @@ ___ #### Defined in -[types/election/election.ts:242](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L242) +[types/election/election.ts:242](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L242) ## Methods @@ -433,7 +250,7 @@ ___ #### Defined in -[types/election/election.ts:266](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L266) +[types/election/election.ts:266](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L266) ___ @@ -455,4 +272,4 @@ Returns an unpublished election object #### Defined in -[types/election/election.ts:206](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L206) +[types/election/election.ts:206](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L206) diff --git a/docs/sdk/reference/classes/ElectionAPI.md b/docs/sdk/reference/classes/ElectionAPI.md index d5989d1f5..4cc315c6b 100644 --- a/docs/sdk/reference/classes/ElectionAPI.md +++ b/docs/sdk/reference/classes/ElectionAPI.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ElectionAPI +[@vocdoni/sdk](/sdk) / ElectionAPI # Class: ElectionAPI @@ -10,43 +10,17 @@ ## Table of contents -### Constructors - -- [constructor](ElectionAPI#constructor) - ### Methods - [create](ElectionAPI#create) - [electionsList](ElectionAPI#electionslist) - [info](ElectionAPI#info) -- [isApiError](ElectionAPI#isapierror) -- [isUndefinedError](ElectionAPI#isundefinederror) - [keys](ElectionAPI#keys) - [nextElectionId](ElectionAPI#nextelectionid) - [price](ElectionAPI#price) - [votesCount](ElectionAPI#votescount) - [votesList](ElectionAPI#voteslist) -## Constructors - -### constructor - -• **new ElectionAPI**(): [`ElectionAPI`](ElectionAPI) - -Cannot be constructed. - -#### Returns - -[`ElectionAPI`](ElectionAPI) - -#### Overrides - -API.constructor - -#### Defined in - -[api/election.ts:373](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L373) - ## Methods ### create @@ -69,13 +43,13 @@ Creates a new election. #### Defined in -[api/election.ts:413](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L413) +[api/election.ts:410](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L410) ___ ### electionsList -▸ **electionsList**(`url`, `page?`, `«destructured»?`): `Promise`\<[`IElectionListResponse`](../interfaces/IElectionListResponse)\> +▸ **electionsList**(`url`, `page?`, `filter?`): `Promise`\<[`IElectionListResponse`](../interfaces/IElectionListResponse)\> Return list of all elections in the chain @@ -85,7 +59,7 @@ Return list of all elections in the chain | :------ | :------ | :------ | :------ | | `url` | `string` | `undefined` | API endpoint URL | | `page` | `number` | `0` | The page number | -| `«destructured»` | [`IElectionListFilter`](../interfaces/IElectionListFilter) | `{}` | - | +| `filter` | [`IElectionListFilter`](../interfaces/IElectionListFilter) | `{}` | Search by organizationId, electionId, withResults, and status | #### Returns @@ -93,7 +67,7 @@ Return list of all elections in the chain #### Defined in -[api/election.ts:487](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L487) +[api/election.ts:477](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L477) ___ @@ -116,56 +90,7 @@ Fetches info about the specified process. #### Defined in -[api/election.ts:384](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L384) - -___ - -### isApiError - -▸ **isApiError**(`error`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `AxiosError`\<`unknown`, `any`\> | - -#### Returns - -`never` - -#### Inherited from - -API.isApiError - -#### Defined in - -[api/api.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/api.ts#L21) - -___ - -### isUndefinedError - -▸ **isUndefinedError**(`error`, `message?`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `AxiosError`\<`unknown`, `any`\> | -| `message?` | `string` | - -#### Returns - -`never` - -#### Inherited from - -API.isUndefinedError - -#### Defined in - -[api/api.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/api.ts#L64) +[api/election.ts:383](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L383) ___ @@ -188,7 +113,7 @@ Fetches the encryption keys from the specified process. #### Defined in -[api/election.ts:398](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L398) +[api/election.ts:396](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L396) ___ @@ -213,7 +138,7 @@ Returns the next election id. #### Defined in -[api/election.ts:429](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L429) +[api/election.ts:425](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L425) ___ @@ -240,7 +165,7 @@ Calculates the election price. #### Defined in -[api/election.ts:520](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L520) +[api/election.ts:509](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L509) ___ @@ -263,7 +188,7 @@ Returns the number of votes of a given election #### Defined in -[api/election.ts:452](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L452) +[api/election.ts:447](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L447) ___ @@ -287,4 +212,4 @@ Returns the list of votes for a given election #### Defined in -[api/election.ts:467](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L467) +[api/election.ts:461](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L461) diff --git a/docs/sdk/reference/classes/ElectionService.md b/docs/sdk/reference/classes/ElectionService.md index 7a9e3ddc2..a2f8ef529 100644 --- a/docs/sdk/reference/classes/ElectionService.md +++ b/docs/sdk/reference/classes/ElectionService.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ElectionService +[@vocdoni/sdk](/sdk) / ElectionService # Class: ElectionService @@ -18,19 +18,9 @@ - [constructor](ElectionService#constructor) -### Properties - -- [censusService](ElectionService#censusservice) -- [chainService](ElectionService#chainservice) -- [url](ElectionService#url) - ### Methods -- [buildCensus](ElectionService#buildcensus) -- [buildPublishedCensus](ElectionService#buildpublishedcensus) -- [calculateChoiceResults](ElectionService#calculatechoiceresults) - [calculateElectionCost](ElectionService#calculateelectioncost) -- [calculateMultichoiceAbstains](ElectionService#calculatemultichoiceabstains) - [create](ElectionService#create) - [estimateElectionCost](ElectionService#estimateelectioncost) - [fetchElection](ElectionService#fetchelection) @@ -41,6 +31,12 @@ - [nextElectionId](ElectionService#nextelectionid) - [signTransaction](ElectionService#signtransaction) +### Properties + +- [censusService](ElectionService#censusservice) +- [chainService](ElectionService#chainservice) +- [url](ElectionService#url) + ## Constructors ### constructor @@ -61,119 +57,14 @@ Instantiate the election service. #### Overrides -[Service](Service.md).[constructor](Service#constructor) - -#### Defined in - -[services/election.ts:69](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L69) - -## Properties - -### censusService - -• **censusService**: [`CensusService`](CensusService) - -#### Implementation of - -ElectionServiceProperties.censusService - -#### Defined in - -[services/election.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L61) - -___ - -### chainService - -• **chainService**: [`ChainService`](ChainService) - -#### Implementation of - -ElectionServiceProperties.chainService +Service.constructor #### Defined in -[services/election.ts:62](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L62) - -___ - -### url - -• **url**: `string` - -#### Inherited from - -[Service](Service.md).[url](Service#url) - -#### Defined in - -[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/service.ts#L6) +[services/election.ts:69](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/election.ts#L69) ## Methods -### buildCensus - -▸ **buildCensus**(`electionInfo`): `Promise`\<[`PublishedCensus`](PublishedCensus) \| `ArchivedCensus`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `electionInfo` | `any` | - -#### Returns - -`Promise`\<[`PublishedCensus`](PublishedCensus) \| `ArchivedCensus`\> - -#### Defined in - -[services/election.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L100) - -___ - -### buildPublishedCensus - -▸ **buildPublishedCensus**(`electionInfo`): `Promise`\<[`PublishedCensus`](PublishedCensus)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `electionInfo` | `any` | - -#### Returns - -`Promise`\<[`PublishedCensus`](PublishedCensus)\> - -#### Defined in - -[services/election.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L84) - -___ - -### calculateChoiceResults - -▸ **calculateChoiceResults**(`electionType`, `result`, `qIndex`, `cIndex`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `electionType` | `any` | -| `result` | `any` | -| `qIndex` | `any` | -| `cIndex` | `any` | - -#### Returns - -`any` - -#### Defined in - -[services/election.ts:180](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L180) - -___ - ### calculateElectionCost ▸ **calculateElectionCost**(`election`): `Promise`\<`number`\> @@ -194,28 +85,7 @@ The cost in tokens. #### Defined in -[services/election.ts:338](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L338) - -___ - -### calculateMultichoiceAbstains - -▸ **calculateMultichoiceAbstains**(`electionType`, `result`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `electionType` | `any` | -| `result` | `any` | - -#### Returns - -`string` - -#### Defined in - -[services/election.ts:203](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L203) +[services/election.ts:336](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/election.ts#L336) ___ @@ -240,7 +110,7 @@ The created election information #### Defined in -[services/election.ts:257](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L257) +[services/election.ts:256](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/election.ts#L256) ___ @@ -264,7 +134,7 @@ The cost in tokens. #### Defined in -[services/election.ts:325](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L325) +[services/election.ts:323](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/election.ts#L323) ___ @@ -286,7 +156,7 @@ Fetches info about an election. #### Defined in -[services/election.ts:115](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L115) +[services/election.ts:114](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/election.ts#L114) ___ @@ -306,7 +176,7 @@ ___ #### Defined in -[services/election.ts:222](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L222) +[services/election.ts:221](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/election.ts#L221) ___ @@ -331,7 +201,7 @@ The election salt #### Defined in -[services/election.ts:288](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L288) +[services/election.ts:287](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/election.ts#L287) ___ @@ -355,7 +225,7 @@ The numeric identifier #### Defined in -[services/election.ts:302](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L302) +[services/election.ts:301](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/election.ts#L301) ___ @@ -377,7 +247,7 @@ Fetches the encryption keys from the specified process. #### Defined in -[services/election.ts:315](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L315) +[services/election.ts:313](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/election.ts#L313) ___ @@ -402,7 +272,7 @@ The next election identifier #### Defined in -[services/election.ts:269](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L269) +[services/election.ts:268](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/election.ts#L268) ___ @@ -424,4 +294,46 @@ ___ #### Defined in -[services/election.ts:74](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L74) +[services/election.ts:74](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/election.ts#L74) + +## Properties + +### censusService + +• **censusService**: [`CensusService`](CensusService) + +#### Implementation of + +ElectionServiceProperties.censusService + +#### Defined in + +[services/election.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/election.ts#L61) + +___ + +### chainService + +• **chainService**: [`ChainService`](ChainService) + +#### Implementation of + +ElectionServiceProperties.chainService + +#### Defined in + +[services/election.ts:62](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/election.ts#L62) + +___ + +### url + +• **url**: `string` + +#### Inherited from + +[Service](Service.md).[url](Service#url) + +#### Defined in + +[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/service.ts#L6) diff --git a/docs/sdk/reference/classes/FaucetAPI.md b/docs/sdk/reference/classes/FaucetAPI.md index fa0410a74..8e0421859 100644 --- a/docs/sdk/reference/classes/FaucetAPI.md +++ b/docs/sdk/reference/classes/FaucetAPI.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / FaucetAPI +[@vocdoni/sdk](/sdk) / FaucetAPI # Class: FaucetAPI @@ -10,35 +10,9 @@ ## Table of contents -### Constructors - -- [constructor](FaucetAPI#constructor) - ### Methods - [collect](FaucetAPI#collect) -- [isApiError](FaucetAPI#isapierror) -- [isUndefinedError](FaucetAPI#isundefinederror) - -## Constructors - -### constructor - -• **new FaucetAPI**(): [`FaucetAPI`](FaucetAPI) - -Cannot be constructed. - -#### Returns - -[`FaucetAPI`](FaucetAPI) - -#### Overrides - -API.constructor - -#### Defined in - -[api/faucet.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/faucet.ts#L24) ## Methods @@ -61,53 +35,4 @@ Calls the collect tokens method. #### Defined in -[api/faucet.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/faucet.ts#L35) - -___ - -### isApiError - -▸ **isApiError**(`error`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `AxiosError`\<`unknown`, `any`\> | - -#### Returns - -`never` - -#### Inherited from - -API.isApiError - -#### Defined in - -[api/api.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/api.ts#L21) - -___ - -### isUndefinedError - -▸ **isUndefinedError**(`error`, `message?`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `AxiosError`\<`unknown`, `any`\> | -| `message?` | `string` | - -#### Returns - -`never` - -#### Inherited from - -API.isUndefinedError - -#### Defined in - -[api/api.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/api.ts#L64) +[api/faucet.ts:34](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/faucet.ts#L34) diff --git a/docs/sdk/reference/classes/FaucetService.md b/docs/sdk/reference/classes/FaucetService.md index dc0ff68a5..8a80aee2e 100644 --- a/docs/sdk/reference/classes/FaucetService.md +++ b/docs/sdk/reference/classes/FaucetService.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / FaucetService +[@vocdoni/sdk](/sdk) / FaucetService # Class: FaucetService @@ -18,16 +18,16 @@ - [constructor](FaucetService#constructor) -### Properties - -- [token\_limit](FaucetService.md#token_limit) -- [url](FaucetService#url) - ### Methods - [fetchPayload](FaucetService#fetchpayload) - [parseFaucetPackage](FaucetService#parsefaucetpackage) +### Properties + +- [token\_limit](FaucetService.md#token_limit) +- [url](FaucetService#url) + ## Constructors ### constructor @@ -48,39 +48,11 @@ Instantiate the chain service. #### Overrides -[Service](Service.md).[constructor](Service#constructor) - -#### Defined in - -[services/faucet.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/faucet.ts#L38) - -## Properties - -### token\_limit - -• **token\_limit**: `number` - -#### Implementation of - -FaucetServiceProperties.token\_limit - -#### Defined in - -[services/faucet.ts:31](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/faucet.ts#L31) - -___ - -### url - -• **url**: `string` - -#### Inherited from - -[Service](Service.md).[url](Service#url) +Service.constructor #### Defined in -[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/service.ts#L6) +[services/faucet.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/faucet.ts#L38) ## Methods @@ -104,13 +76,13 @@ The encoded faucet package #### Defined in -[services/faucet.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/faucet.ts#L49) +[services/faucet.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/faucet.ts#L49) ___ ### parseFaucetPackage -▸ **parseFaucetPackage**(`faucetPackage`): [`FaucetPackage`](../modules#faucetpackage) +▸ **parseFaucetPackage**(`faucetPackage`): [`FaucetPackage`](../sdk-reference#faucetpackage) Parses a faucet package. @@ -122,8 +94,36 @@ Parses a faucet package. #### Returns -[`FaucetPackage`](../modules#faucetpackage) +[`FaucetPackage`](../sdk-reference#faucetpackage) + +#### Defined in + +[services/faucet.ts:58](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/faucet.ts#L58) + +## Properties + +### token\_limit + +• **token\_limit**: `number` + +#### Implementation of + +FaucetServiceProperties.token\_limit + +#### Defined in + +[services/faucet.ts:31](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/faucet.ts#L31) + +___ + +### url + +• **url**: `string` + +#### Inherited from + +[Service](Service.md).[url](Service#url) #### Defined in -[services/faucet.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/faucet.ts#L59) +[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/service.ts#L6) diff --git a/docs/sdk/reference/classes/FileAPI.md b/docs/sdk/reference/classes/FileAPI.md index a17f4b518..1d317ef38 100644 --- a/docs/sdk/reference/classes/FileAPI.md +++ b/docs/sdk/reference/classes/FileAPI.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / FileAPI +[@vocdoni/sdk](/sdk) / FileAPI # Class: FileAPI @@ -10,35 +10,9 @@ ## Table of contents -### Constructors - -- [constructor](FileAPI#constructor) - ### Methods - [cid](FileAPI#cid) -- [isApiError](FileAPI#isapierror) -- [isUndefinedError](FileAPI#isundefinederror) - -## Constructors - -### constructor - -• **new FileAPI**(): [`FileAPI`](FileAPI) - -Cannot be constructed. - -#### Returns - -[`FileAPI`](FileAPI) - -#### Overrides - -API.constructor - -#### Defined in - -[api/file.ts:19](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/file.ts#L19) ## Methods @@ -63,53 +37,4 @@ promised IFileCIDResponse #### Defined in -[api/file.ts:30](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/file.ts#L30) - -___ - -### isApiError - -▸ **isApiError**(`error`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `AxiosError`\<`unknown`, `any`\> | - -#### Returns - -`never` - -#### Inherited from - -API.isApiError - -#### Defined in - -[api/api.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/api.ts#L21) - -___ - -### isUndefinedError - -▸ **isUndefinedError**(`error`, `message?`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `AxiosError`\<`unknown`, `any`\> | -| `message?` | `string` | - -#### Returns - -`never` - -#### Inherited from - -API.isUndefinedError - -#### Defined in - -[api/api.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/api.ts#L64) +[api/file.ts:30](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/file.ts#L30) diff --git a/docs/sdk/reference/classes/FileService.md b/docs/sdk/reference/classes/FileService.md index 9a3d83cb2..8a34011c3 100644 --- a/docs/sdk/reference/classes/FileService.md +++ b/docs/sdk/reference/classes/FileService.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / FileService +[@vocdoni/sdk](/sdk) / FileService # Class: FileService @@ -18,14 +18,14 @@ - [constructor](FileService#constructor) -### Properties - -- [url](FileService#url) - ### Methods - [calculateCID](FileService#calculatecid) +### Properties + +- [url](FileService#url) + ## Constructors ### constructor @@ -46,25 +46,11 @@ Instantiate the election service. #### Overrides -[Service](Service.md).[constructor](Service#constructor) - -#### Defined in - -[services/file.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/file.ts#L16) - -## Properties - -### url - -• **url**: `string` - -#### Inherited from - -[Service](Service.md).[url](Service#url) +Service.constructor #### Defined in -[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/service.ts#L6) +[services/file.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/file.ts#L16) ## Methods @@ -88,4 +74,18 @@ Resulting CID #### Defined in -[services/file.ts:27](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/file.ts#L27) +[services/file.ts:27](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/file.ts#L27) + +## Properties + +### url + +• **url**: `string` + +#### Inherited from + +[Service](Service.md).[url](Service#url) + +#### Defined in + +[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/service.ts#L6) diff --git a/docs/sdk/reference/classes/InvalidElection.md b/docs/sdk/reference/classes/InvalidElection.md index 90965d9e8..2f01aa70a 100644 --- a/docs/sdk/reference/classes/InvalidElection.md +++ b/docs/sdk/reference/classes/InvalidElection.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / InvalidElection +[@vocdoni/sdk](/sdk) / InvalidElection # Class: InvalidElection @@ -6,75 +6,61 @@ Represents an invalid election ## Table of contents -### Constructors - -- [constructor](InvalidElection#constructor) - -### Properties - -- [\_id](InvalidElection.md#_id) - ### Accessors - [id](InvalidElection#id) - [isValid](InvalidElection#isvalid) -## Constructors - -### constructor +### Constructors -• **new InvalidElection**(`params`): [`InvalidElection`](InvalidElection) +- [constructor](InvalidElection#constructor) -Constructs an invalid election +## Accessors -#### Parameters +### id -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`IInvalidElectionParameters`](../interfaces/IInvalidElectionParameters) | Election parameters | +• `get` **id**(): `string` #### Returns -[`InvalidElection`](InvalidElection) +`string` #### Defined in -[types/election/invalid.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/invalid.ts#L16) +[types/election/invalid.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/invalid.ts#L20) -## Properties - -### \_id - -• `Private` `Readonly` **\_id**: `string` +___ -#### Defined in +### isValid -[types/election/invalid.ts:9](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/invalid.ts#L9) +• `get` **isValid**(): `boolean` -## Accessors +#### Returns -### id +`boolean` -• `get` **id**(): `string` +#### Defined in -#### Returns +[types/election/invalid.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/invalid.ts#L24) -`string` +## Constructors -#### Defined in +### constructor -[types/election/invalid.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/invalid.ts#L20) +• **new InvalidElection**(`params`): [`InvalidElection`](InvalidElection) -___ +Constructs an invalid election -### isValid +#### Parameters -• `get` **isValid**(): `boolean` +| Name | Type | Description | +| :------ | :------ | :------ | +| `params` | [`IInvalidElectionParameters`](../interfaces/IInvalidElectionParameters) | Election parameters | #### Returns -`boolean` +[`InvalidElection`](InvalidElection) #### Defined in -[types/election/invalid.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/invalid.ts#L24) +[types/election/invalid.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/invalid.ts#L16) diff --git a/docs/sdk/reference/classes/MultiChoiceElection.md b/docs/sdk/reference/classes/MultiChoiceElection.md index 942ace524..3177d7bb7 100644 --- a/docs/sdk/reference/classes/MultiChoiceElection.md +++ b/docs/sdk/reference/classes/MultiChoiceElection.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / MultiChoiceElection +[@vocdoni/sdk](/sdk) / MultiChoiceElection # Class: MultiChoiceElection @@ -12,28 +12,6 @@ Represents a multi choice election ## Table of contents -### Constructors - -- [constructor](MultiChoiceElection#constructor) - -### Properties - -- [\_addSDKVersion](MultiChoiceElection.md#_addsdkversion) -- [\_canAbstain](MultiChoiceElection.md#_canabstain) -- [\_census](MultiChoiceElection.md#_census) -- [\_description](MultiChoiceElection.md#_description) -- [\_electionType](MultiChoiceElection.md#_electiontype) -- [\_endDate](MultiChoiceElection.md#_enddate) -- [\_header](MultiChoiceElection.md#_header) -- [\_maxCensusSize](MultiChoiceElection.md#_maxcensussize) -- [\_meta](MultiChoiceElection.md#_meta) -- [\_questions](MultiChoiceElection.md#_questions) -- [\_startDate](MultiChoiceElection.md#_startdate) -- [\_streamUri](MultiChoiceElection.md#_streamuri) -- [\_temporarySecretIdentity](MultiChoiceElection.md#_temporarysecretidentity) -- [\_title](MultiChoiceElection.md#_title) -- [\_voteType](MultiChoiceElection.md#_votetype) - ### Accessors - [addSDKVersion](MultiChoiceElection#addsdkversion) @@ -55,6 +33,10 @@ Represents a multi choice election - [title](MultiChoiceElection#title) - [voteType](MultiChoiceElection#votetype) +### Constructors + +- [constructor](MultiChoiceElection#constructor) + ### Methods - [addQuestion](MultiChoiceElection#addquestion) @@ -67,238 +49,6 @@ Represents a multi choice election - [checkVote](MultiChoiceElection#checkvote) - [from](MultiChoiceElection#from) -## Constructors - -### constructor - -• **new MultiChoiceElection**(`params`): [`MultiChoiceElection`](MultiChoiceElection) - -Constructs a multi choice election - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`IMultiChoiceElectionParameters`](../interfaces/IMultiChoiceElectionParameters) | Multi choice election parameters | - -#### Returns - -[`MultiChoiceElection`](MultiChoiceElection) - -#### Overrides - -[UnpublishedElection](UnpublishedElection.md).[constructor](UnpublishedElection#constructor) - -#### Defined in - -[types/election/multichoice.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/multichoice.ts#L24) - -## Properties - -### \_addSDKVersion - -• `Protected` **\_addSDKVersion**: `boolean` - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_addSDKVersion](UnpublishedElection.md#_addsdkversion) - -#### Defined in - -[types/election/election.ts:175](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L175) - -___ - -### \_canAbstain - -• `Private` **\_canAbstain**: `boolean` - -#### Defined in - -[types/election/multichoice.ts:17](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/multichoice.ts#L17) - -___ - -### \_census - -• `Protected` **\_census**: [`Census`](Census) - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_census](UnpublishedElection.md#_census) - -#### Defined in - -[types/election/election.ts:172](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L172) - -___ - -### \_description - -• `Protected` **\_description**: `MultiLanguage`\<`string`\> - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_description](UnpublishedElection.md#_description) - -#### Defined in - -[types/election/election.ts:163](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L163) - -___ - -### \_electionType - -• `Protected` **\_electionType**: [`IElectionType`](../interfaces/IElectionType) - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_electionType](UnpublishedElection.md#_electiontype) - -#### Defined in - -[types/election/election.ts:169](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L169) - -___ - -### \_endDate - -• `Protected` **\_endDate**: `Date` - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_endDate](UnpublishedElection.md#_enddate) - -#### Defined in - -[types/election/election.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L168) - -___ - -### \_header - -• `Protected` **\_header**: `string` - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_header](UnpublishedElection.md#_header) - -#### Defined in - -[types/election/election.ts:164](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L164) - -___ - -### \_maxCensusSize - -• `Protected` **\_maxCensusSize**: `number` - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_maxCensusSize](UnpublishedElection.md#_maxcensussize) - -#### Defined in - -[types/election/election.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L173) - -___ - -### \_meta - -• `Protected` **\_meta**: `any` - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_meta](UnpublishedElection.md#_meta) - -#### Defined in - -[types/election/election.ts:166](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L166) - -___ - -### \_questions - -• `Protected` **\_questions**: [`IQuestion`](../interfaces/IQuestion)[] - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_questions](UnpublishedElection.md#_questions) - -#### Defined in - -[types/election/election.ts:171](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L171) - -___ - -### \_startDate - -• `Protected` **\_startDate**: `Date` - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_startDate](UnpublishedElection.md#_startdate) - -#### Defined in - -[types/election/election.ts:167](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L167) - -___ - -### \_streamUri - -• `Protected` **\_streamUri**: `string` - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_streamUri](UnpublishedElection.md#_streamuri) - -#### Defined in - -[types/election/election.ts:165](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L165) - -___ - -### \_temporarySecretIdentity - -• `Protected` **\_temporarySecretIdentity**: `boolean` - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_temporarySecretIdentity](UnpublishedElection.md#_temporarysecretidentity) - -#### Defined in - -[types/election/election.ts:174](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L174) - -___ - -### \_title - -• `Protected` **\_title**: `MultiLanguage`\<`string`\> - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_title](UnpublishedElection.md#_title) - -#### Defined in - -[types/election/election.ts:162](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L162) - -___ - -### \_voteType - -• `Protected` **\_voteType**: [`IVoteType`](../interfaces/IVoteType) - -#### Inherited from - -[UnpublishedElection](UnpublishedElection).[_voteType](UnpublishedElection.md#_votetype) - -#### Defined in - -[types/election/election.ts:170](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L170) - ## Accessors ### addSDKVersion @@ -315,7 +65,7 @@ UnpublishedElection.addSDKVersion #### Defined in -[types/election/unpublished.ts:275](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L275) +[types/election/unpublished.ts:275](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L275) • `set` **addSDKVersion**(`value`): `void` @@ -335,7 +85,7 @@ UnpublishedElection.addSDKVersion #### Defined in -[types/election/unpublished.ts:279](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L279) +[types/election/unpublished.ts:279](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L279) ___ @@ -349,7 +99,7 @@ ___ #### Defined in -[types/election/multichoice.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/multichoice.ts#L124) +[types/election/multichoice.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/multichoice.ts#L124) • `set` **canAbstain**(`value`): `void` @@ -365,7 +115,7 @@ ___ #### Defined in -[types/election/multichoice.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/multichoice.ts#L128) +[types/election/multichoice.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/multichoice.ts#L128) ___ @@ -379,7 +129,7 @@ ___ #### Defined in -[types/election/multichoice.ts:116](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/multichoice.ts#L116) +[types/election/multichoice.ts:116](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/multichoice.ts#L116) • `set` **canRepeatChoices**(`value`): `void` @@ -395,7 +145,7 @@ ___ #### Defined in -[types/election/multichoice.ts:120](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/multichoice.ts#L120) +[types/election/multichoice.ts:120](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/multichoice.ts#L120) ___ @@ -413,7 +163,7 @@ UnpublishedElection.census #### Defined in -[types/election/unpublished.ts:249](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L249) +[types/election/unpublished.ts:249](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L249) • `set` **census**(`value`): `void` @@ -433,7 +183,7 @@ UnpublishedElection.census #### Defined in -[types/election/unpublished.ts:253](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L253) +[types/election/unpublished.ts:253](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L253) ___ @@ -451,7 +201,7 @@ UnpublishedElection.description #### Defined in -[types/election/unpublished.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L173) +[types/election/unpublished.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L173) • `set` **description**(`value`): `void` @@ -471,7 +221,7 @@ UnpublishedElection.description #### Defined in -[types/election/unpublished.ts:177](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L177) +[types/election/unpublished.ts:177](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L177) ___ @@ -489,7 +239,7 @@ UnpublishedElection.duration #### Defined in -[types/election/unpublished.ts:138](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L138) +[types/election/unpublished.ts:138](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L138) ___ @@ -507,7 +257,7 @@ UnpublishedElection.electionType #### Defined in -[types/election/unpublished.ts:225](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L225) +[types/election/unpublished.ts:225](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L225) • `set` **electionType**(`value`): `void` @@ -527,7 +277,7 @@ UnpublishedElection.electionType #### Defined in -[types/election/unpublished.ts:229](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L229) +[types/election/unpublished.ts:229](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L229) ___ @@ -545,7 +295,7 @@ UnpublishedElection.endDate #### Defined in -[types/election/unpublished.ts:215](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L215) +[types/election/unpublished.ts:215](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L215) • `set` **endDate**(`value`): `void` @@ -565,7 +315,7 @@ UnpublishedElection.endDate #### Defined in -[types/election/unpublished.ts:219](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L219) +[types/election/unpublished.ts:219](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L219) ___ @@ -583,7 +333,7 @@ UnpublishedElection.header #### Defined in -[types/election/unpublished.ts:181](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L181) +[types/election/unpublished.ts:181](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L181) • `set` **header**(`value`): `void` @@ -603,7 +353,7 @@ UnpublishedElection.header #### Defined in -[types/election/unpublished.ts:185](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L185) +[types/election/unpublished.ts:185](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L185) ___ @@ -621,7 +371,7 @@ UnpublishedElection.maxCensusSize #### Defined in -[types/election/unpublished.ts:258](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L258) +[types/election/unpublished.ts:258](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L258) • `set` **maxCensusSize**(`value`): `void` @@ -641,7 +391,7 @@ UnpublishedElection.maxCensusSize #### Defined in -[types/election/unpublished.ts:262](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L262) +[types/election/unpublished.ts:262](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L262) ___ @@ -655,7 +405,7 @@ ___ #### Defined in -[types/election/multichoice.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/multichoice.ts#L108) +[types/election/multichoice.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/multichoice.ts#L108) • `set` **maxNumberOfChoices**(`value`): `void` @@ -671,7 +421,7 @@ ___ #### Defined in -[types/election/multichoice.ts:112](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/multichoice.ts#L112) +[types/election/multichoice.ts:112](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/multichoice.ts#L112) ___ @@ -689,7 +439,7 @@ UnpublishedElection.meta #### Defined in -[types/election/unpublished.ts:197](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L197) +[types/election/unpublished.ts:197](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L197) • `set` **meta**(`value`): `void` @@ -709,7 +459,7 @@ UnpublishedElection.meta #### Defined in -[types/election/unpublished.ts:201](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L201) +[types/election/unpublished.ts:201](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L201) ___ @@ -727,7 +477,7 @@ UnpublishedElection.questions #### Defined in -[types/election/unpublished.ts:241](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L241) +[types/election/unpublished.ts:241](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L241) • `set` **questions**(`value`): `void` @@ -747,7 +497,7 @@ UnpublishedElection.questions #### Defined in -[types/election/unpublished.ts:245](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L245) +[types/election/unpublished.ts:245](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L245) ___ @@ -765,7 +515,7 @@ UnpublishedElection.startDate #### Defined in -[types/election/unpublished.ts:206](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L206) +[types/election/unpublished.ts:206](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L206) • `set` **startDate**(`value`): `void` @@ -785,7 +535,7 @@ UnpublishedElection.startDate #### Defined in -[types/election/unpublished.ts:210](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L210) +[types/election/unpublished.ts:210](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L210) ___ @@ -803,7 +553,7 @@ UnpublishedElection.streamUri #### Defined in -[types/election/unpublished.ts:189](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L189) +[types/election/unpublished.ts:189](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L189) • `set` **streamUri**(`value`): `void` @@ -823,7 +573,7 @@ UnpublishedElection.streamUri #### Defined in -[types/election/unpublished.ts:193](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L193) +[types/election/unpublished.ts:193](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L193) ___ @@ -841,7 +591,7 @@ UnpublishedElection.temporarySecretIdentity #### Defined in -[types/election/unpublished.ts:267](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L267) +[types/election/unpublished.ts:267](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L267) • `set` **temporarySecretIdentity**(`value`): `void` @@ -861,7 +611,7 @@ UnpublishedElection.temporarySecretIdentity #### Defined in -[types/election/unpublished.ts:271](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L271) +[types/election/unpublished.ts:271](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L271) ___ @@ -879,7 +629,7 @@ UnpublishedElection.title #### Defined in -[types/election/unpublished.ts:164](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L164) +[types/election/unpublished.ts:164](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L164) • `set` **title**(`value`): `void` @@ -899,7 +649,7 @@ UnpublishedElection.title #### Defined in -[types/election/unpublished.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L168) +[types/election/unpublished.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L168) ___ @@ -917,7 +667,7 @@ UnpublishedElection.voteType #### Defined in -[types/election/unpublished.ts:233](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L233) +[types/election/unpublished.ts:233](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L233) • `set` **voteType**(`value`): `void` @@ -937,7 +687,33 @@ UnpublishedElection.voteType #### Defined in -[types/election/unpublished.ts:237](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L237) +[types/election/unpublished.ts:237](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L237) + +## Constructors + +### constructor + +• **new MultiChoiceElection**(`params`): [`MultiChoiceElection`](MultiChoiceElection) + +Constructs a multi choice election + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `params` | [`IMultiChoiceElectionParameters`](../interfaces/IMultiChoiceElectionParameters) | Multi choice election parameters | + +#### Returns + +[`MultiChoiceElection`](MultiChoiceElection) + +#### Overrides + +[UnpublishedElection](UnpublishedElection.md).[constructor](UnpublishedElection#constructor) + +#### Defined in + +[types/election/multichoice.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/multichoice.ts#L24) ## Methods @@ -963,7 +739,7 @@ UnpublishedElection.voteType #### Defined in -[types/election/multichoice.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/multichoice.ts#L35) +[types/election/multichoice.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/multichoice.ts#L35) ___ @@ -981,7 +757,7 @@ ___ #### Defined in -[types/election/multichoice.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/multichoice.ts#L65) +[types/election/multichoice.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/multichoice.ts#L65) ___ @@ -999,7 +775,7 @@ ___ #### Defined in -[types/election/multichoice.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/multichoice.ts#L75) +[types/election/multichoice.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/multichoice.ts#L75) ___ @@ -1017,7 +793,7 @@ ___ #### Defined in -[types/election/unpublished.ts:154](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L154) +[types/election/unpublished.ts:154](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L154) ___ @@ -1035,7 +811,7 @@ ___ #### Defined in -[types/election/multichoice.ts:54](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/multichoice.ts#L54) +[types/election/multichoice.ts:54](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/multichoice.ts#L54) ___ @@ -1059,7 +835,7 @@ ___ #### Defined in -[types/election/election.ts:266](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L266) +[types/election/election.ts:266](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L266) ___ @@ -1083,7 +859,7 @@ ___ #### Defined in -[types/election/unpublished.ts:60](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L60) +[types/election/unpublished.ts:60](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L60) ___ @@ -1104,7 +880,7 @@ ___ #### Defined in -[types/election/multichoice.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/multichoice.ts#L92) +[types/election/multichoice.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/multichoice.ts#L92) ___ @@ -1130,4 +906,4 @@ Returns an unpublished election object #### Defined in -[types/election/multichoice.ts:31](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/multichoice.ts#L31) +[types/election/multichoice.ts:31](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/multichoice.ts#L31) diff --git a/docs/sdk/reference/classes/OffchainCensus.md b/docs/sdk/reference/classes/OffchainCensus.md index ddb0c33f9..c60eec19a 100644 --- a/docs/sdk/reference/classes/OffchainCensus.md +++ b/docs/sdk/reference/classes/OffchainCensus.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / OffchainCensus +[@vocdoni/sdk](/sdk) / OffchainCensus # Class: OffchainCensus @@ -16,17 +16,6 @@ Represents an offchain census ## Table of contents -### Constructors - -- [constructor](OffchainCensus#constructor) - -### Properties - -- [\_censusId](OffchainCensus.md#_censusid) -- [\_censusURI](OffchainCensus.md#_censusuri) -- [\_participants](OffchainCensus.md#_participants) -- [\_type](OffchainCensus.md#_type) - ### Accessors - [censusId](OffchainCensus#censusid) @@ -39,83 +28,8 @@ Represents an offchain census ### Methods -- [addParticipants](OffchainCensus#addparticipants) -- [checkParticipant](OffchainCensus#checkparticipant) -- [removeParticipant](OffchainCensus#removeparticipant) - [censusTypeFromCensusOrigin](OffchainCensus#censustypefromcensusorigin) -## Constructors - -### constructor - -• **new OffchainCensus**(): [`OffchainCensus`](OffchainCensus) - -Constructs an offchain census - -#### Returns - -[`OffchainCensus`](OffchainCensus) - -#### Overrides - -[Census](Census.md).[constructor](Census#constructor) - -#### Defined in - -[types/census/offchain.ts:19](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/offchain.ts#L19) - -## Properties - -### \_censusId - -• `Protected` **\_censusId**: `string` - -#### Inherited from - -[Census](Census).[_censusId](Census.md#_censusid) - -#### Defined in - -[types/census/census.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L12) - -___ - -### \_censusURI - -• `Protected` **\_censusURI**: `string` - -#### Inherited from - -[Census](Census).[_censusURI](Census.md#_censusuri) - -#### Defined in - -[types/census/census.ts:13](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L13) - -___ - -### \_participants - -• `Private` **\_participants**: [`ICensusParticipant`](../interfaces/ICensusParticipant)[] - -#### Defined in - -[types/census/offchain.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/offchain.ts#L14) - -___ - -### \_type - -• `Protected` **\_type**: [`CensusType`](../enums/CensusType) - -#### Inherited from - -[Census](Census).[_type](Census.md#_type) - -#### Defined in - -[types/census/census.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L14) - ## Accessors ### censusId @@ -132,7 +46,7 @@ Census.censusId #### Defined in -[types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L35) +[types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L35) • `set` **censusId**(`value`): `void` @@ -152,7 +66,7 @@ Census.censusId #### Defined in -[types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L39) +[types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L39) ___ @@ -170,7 +84,7 @@ Census.censusURI #### Defined in -[types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L43) +[types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L43) • `set` **censusURI**(`value`): `void` @@ -190,7 +104,7 @@ Census.censusURI #### Defined in -[types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L47) +[types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L47) ___ @@ -208,7 +122,7 @@ Census.isPublished #### Defined in -[types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L75) +[types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L75) ___ @@ -222,7 +136,7 @@ ___ #### Defined in -[types/census/offchain.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/offchain.ts#L45) +[types/census/offchain.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/offchain.ts#L45) • `set` **participants**(`value`): `void` @@ -238,7 +152,7 @@ ___ #### Defined in -[types/census/offchain.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/offchain.ts#L49) +[types/census/offchain.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/offchain.ts#L49) ___ @@ -256,7 +170,7 @@ Census.size #### Defined in -[types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L59) +[types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L59) • `set` **size**(`value`): `void` @@ -276,7 +190,7 @@ Census.size #### Defined in -[types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L63) +[types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L63) ___ @@ -294,7 +208,7 @@ Census.type #### Defined in -[types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L51) +[types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L51) • `set` **type**(`value`): `void` @@ -314,7 +228,7 @@ Census.type #### Defined in -[types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L55) +[types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L55) ___ @@ -332,7 +246,7 @@ Census.weight #### Defined in -[types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L67) +[types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L67) • `set` **weight**(`value`): `void` @@ -352,70 +266,10 @@ Census.weight #### Defined in -[types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L71) +[types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L71) ## Methods -### addParticipants - -▸ **addParticipants**(`participants`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `participants` | [`ICensusParticipant`](../interfaces/ICensusParticipant.md) \| [`ICensusParticipant`](../interfaces/ICensusParticipant)[] | - -#### Returns - -`void` - -#### Defined in - -[types/census/offchain.ts:25](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/offchain.ts#L25) - -___ - -### checkParticipant - -▸ **checkParticipant**(`participant`): [`ICensusParticipant`](../interfaces/ICensusParticipant) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `participant` | [`ICensusParticipant`](../interfaces/ICensusParticipant) | - -#### Returns - -[`ICensusParticipant`](../interfaces/ICensusParticipant) - -#### Defined in - -[types/census/offchain.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/offchain.ts#L35) - -___ - -### removeParticipant - -▸ **removeParticipant**(`key`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | - -#### Returns - -`void` - -#### Defined in - -[types/census/offchain.ts:41](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/offchain.ts#L41) - -___ - ### censusTypeFromCensusOrigin ▸ **censusTypeFromCensusOrigin**(`censusOrigin`, `anonymous?`): [`CensusType`](../enums/CensusType) @@ -437,4 +291,4 @@ ___ #### Defined in -[types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L81) +[types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L81) diff --git a/docs/sdk/reference/classes/PlainCensus.md b/docs/sdk/reference/classes/PlainCensus.md index 70524d844..b63c80220 100644 --- a/docs/sdk/reference/classes/PlainCensus.md +++ b/docs/sdk/reference/classes/PlainCensus.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / PlainCensus +[@vocdoni/sdk](/sdk) / PlainCensus # Class: PlainCensus @@ -12,16 +12,6 @@ Represents a plain census ## Table of contents -### Constructors - -- [constructor](PlainCensus#constructor) - -### Properties - -- [\_censusId](PlainCensus.md#_censusid) -- [\_censusURI](PlainCensus.md#_censusuri) -- [\_type](PlainCensus.md#_type) - ### Accessors - [censusId](PlainCensus#censusid) @@ -32,77 +22,16 @@ Represents a plain census - [type](PlainCensus#type) - [weight](PlainCensus#weight) +### Constructors + +- [constructor](PlainCensus#constructor) + ### Methods - [add](PlainCensus#add) -- [addParticipants](PlainCensus#addparticipants) -- [checkParticipant](PlainCensus#checkparticipant) - [remove](PlainCensus#remove) -- [removeParticipant](PlainCensus#removeparticipant) - [censusTypeFromCensusOrigin](PlainCensus#censustypefromcensusorigin) -## Constructors - -### constructor - -• **new PlainCensus**(): [`PlainCensus`](PlainCensus) - -Constructs a plain census - -#### Returns - -[`PlainCensus`](PlainCensus) - -#### Overrides - -[OffchainCensus](OffchainCensus.md).[constructor](OffchainCensus#constructor) - -#### Defined in - -[types/census/plain.ts:10](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/plain.ts#L10) - -## Properties - -### \_censusId - -• `Protected` **\_censusId**: `string` - -#### Inherited from - -[OffchainCensus](OffchainCensus).[_censusId](OffchainCensus.md#_censusid) - -#### Defined in - -[types/census/census.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L12) - -___ - -### \_censusURI - -• `Protected` **\_censusURI**: `string` - -#### Inherited from - -[OffchainCensus](OffchainCensus).[_censusURI](OffchainCensus.md#_censusuri) - -#### Defined in - -[types/census/census.ts:13](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L13) - -___ - -### \_type - -• `Protected` **\_type**: [`CensusType`](../enums/CensusType) - -#### Inherited from - -[OffchainCensus](OffchainCensus).[_type](OffchainCensus.md#_type) - -#### Defined in - -[types/census/census.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L14) - ## Accessors ### censusId @@ -119,7 +48,7 @@ OffchainCensus.censusId #### Defined in -[types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L35) +[types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L35) • `set` **censusId**(`value`): `void` @@ -139,7 +68,7 @@ OffchainCensus.censusId #### Defined in -[types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L39) +[types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L39) ___ @@ -157,7 +86,7 @@ OffchainCensus.censusURI #### Defined in -[types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L43) +[types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L43) • `set` **censusURI**(`value`): `void` @@ -177,7 +106,7 @@ OffchainCensus.censusURI #### Defined in -[types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L47) +[types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L47) ___ @@ -195,7 +124,7 @@ OffchainCensus.isPublished #### Defined in -[types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L75) +[types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L75) ___ @@ -213,7 +142,7 @@ OffchainCensus.participants #### Defined in -[types/census/offchain.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/offchain.ts#L45) +[types/census/offchain.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/offchain.ts#L45) • `set` **participants**(`value`): `void` @@ -233,7 +162,7 @@ OffchainCensus.participants #### Defined in -[types/census/offchain.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/offchain.ts#L49) +[types/census/offchain.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/offchain.ts#L49) ___ @@ -251,7 +180,7 @@ OffchainCensus.size #### Defined in -[types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L59) +[types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L59) • `set` **size**(`value`): `void` @@ -271,7 +200,7 @@ OffchainCensus.size #### Defined in -[types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L63) +[types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L63) ___ @@ -289,7 +218,7 @@ OffchainCensus.type #### Defined in -[types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L51) +[types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L51) • `set` **type**(`value`): `void` @@ -309,7 +238,7 @@ OffchainCensus.type #### Defined in -[types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L55) +[types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L55) ___ @@ -327,7 +256,7 @@ OffchainCensus.weight #### Defined in -[types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L67) +[types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L67) • `set` **weight**(`value`): `void` @@ -347,75 +276,47 @@ OffchainCensus.weight #### Defined in -[types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L71) - -## Methods - -### add - -▸ **add**(`participants`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `participants` | `string` \| `string`[] | - -#### Returns - -`void` - -#### Defined in - -[types/census/plain.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/plain.ts#L14) - -___ +[types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L71) -### addParticipants +## Constructors -▸ **addParticipants**(`participants`): `void` +### constructor -#### Parameters +• **new PlainCensus**(): [`PlainCensus`](PlainCensus) -| Name | Type | -| :------ | :------ | -| `participants` | [`ICensusParticipant`](../interfaces/ICensusParticipant.md) \| [`ICensusParticipant`](../interfaces/ICensusParticipant)[] | +Constructs a plain census #### Returns -`void` +[`PlainCensus`](PlainCensus) -#### Inherited from +#### Overrides -[OffchainCensus](OffchainCensus.md).[addParticipants](OffchainCensus#addparticipants) +OffchainCensus.constructor #### Defined in -[types/census/offchain.ts:25](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/offchain.ts#L25) +[types/census/plain.ts:10](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/plain.ts#L10) -___ +## Methods -### checkParticipant +### add -▸ **checkParticipant**(`participant`): [`ICensusParticipant`](../interfaces/ICensusParticipant) +▸ **add**(`participants`): `void` #### Parameters | Name | Type | | :------ | :------ | -| `participant` | [`ICensusParticipant`](../interfaces/ICensusParticipant) | +| `participants` | `string` \| `string`[] | #### Returns -[`ICensusParticipant`](../interfaces/ICensusParticipant) - -#### Inherited from - -[OffchainCensus](OffchainCensus.md).[checkParticipant](OffchainCensus#checkparticipant) +`void` #### Defined in -[types/census/offchain.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/offchain.ts#L35) +[types/census/plain.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/plain.ts#L14) ___ @@ -435,31 +336,7 @@ ___ #### Defined in -[types/census/plain.ts:30](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/plain.ts#L30) - -___ - -### removeParticipant - -▸ **removeParticipant**(`key`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | - -#### Returns - -`void` - -#### Inherited from - -[OffchainCensus](OffchainCensus.md).[removeParticipant](OffchainCensus#removeparticipant) - -#### Defined in - -[types/census/offchain.ts:41](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/offchain.ts#L41) +[types/census/plain.ts:30](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/plain.ts#L30) ___ @@ -484,4 +361,4 @@ ___ #### Defined in -[types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L81) +[types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L81) diff --git a/docs/sdk/reference/classes/PublishedCensus.md b/docs/sdk/reference/classes/PublishedCensus.md index 7f95c985d..456bbfe72 100644 --- a/docs/sdk/reference/classes/PublishedCensus.md +++ b/docs/sdk/reference/classes/PublishedCensus.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / PublishedCensus +[@vocdoni/sdk](/sdk) / PublishedCensus # Class: PublishedCensus @@ -14,16 +14,6 @@ Represents a published census ## Table of contents -### Constructors - -- [constructor](PublishedCensus#constructor) - -### Properties - -- [\_censusId](PublishedCensus.md#_censusid) -- [\_censusURI](PublishedCensus.md#_censusuri) -- [\_type](PublishedCensus.md#_type) - ### Accessors - [censusId](PublishedCensus#censusid) @@ -33,81 +23,13 @@ Represents a published census - [type](PublishedCensus#type) - [weight](PublishedCensus#weight) -### Methods - -- [censusTypeFromCensusOrigin](PublishedCensus#censustypefromcensusorigin) - -## Constructors - -### constructor - -• **new PublishedCensus**(`censusId`, `censusURI`, `type`, `size?`, `weight?`): [`PublishedCensus`](PublishedCensus) - -Constructs a published census - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `censusId` | `string` | The id of the census | -| `censusURI` | `string` | The URI of the census | -| `type` | [`CensusType`](../enums/CensusType) | The type of the census | -| `size?` | `number` | The size of the census | -| `weight?` | `bigint` | The weight of the census | - -#### Returns - -[`PublishedCensus`](PublishedCensus) - -#### Overrides - -[Census](Census.md).[constructor](Census#constructor) - -#### Defined in - -[types/census/published.ts:17](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/published.ts#L17) - -## Properties - -### \_censusId - -• `Protected` **\_censusId**: `string` - -#### Inherited from - -[Census](Census).[_censusId](Census.md#_censusid) - -#### Defined in - -[types/census/census.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L12) - -___ - -### \_censusURI - -• `Protected` **\_censusURI**: `string` - -#### Inherited from - -[Census](Census).[_censusURI](Census.md#_censusuri) - -#### Defined in - -[types/census/census.ts:13](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L13) - -___ - -### \_type - -• `Protected` **\_type**: [`CensusType`](../enums/CensusType) - -#### Inherited from +### Constructors -[Census](Census).[_type](Census.md#_type) +- [constructor](PublishedCensus#constructor) -#### Defined in +### Methods -[types/census/census.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L14) +- [censusTypeFromCensusOrigin](PublishedCensus#censustypefromcensusorigin) ## Accessors @@ -125,7 +47,7 @@ Census.censusId #### Defined in -[types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L35) +[types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L35) • `set` **censusId**(`value`): `void` @@ -145,7 +67,7 @@ Census.censusId #### Defined in -[types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L39) +[types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L39) ___ @@ -163,7 +85,7 @@ Census.censusURI #### Defined in -[types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L43) +[types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L43) • `set` **censusURI**(`value`): `void` @@ -183,7 +105,7 @@ Census.censusURI #### Defined in -[types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L47) +[types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L47) ___ @@ -201,7 +123,7 @@ Census.isPublished #### Defined in -[types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L75) +[types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L75) ___ @@ -219,7 +141,7 @@ Census.size #### Defined in -[types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L59) +[types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L59) • `set` **size**(`value`): `void` @@ -239,7 +161,7 @@ Census.size #### Defined in -[types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L63) +[types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L63) ___ @@ -257,7 +179,7 @@ Census.type #### Defined in -[types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L51) +[types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L51) • `set` **type**(`value`): `void` @@ -277,7 +199,7 @@ Census.type #### Defined in -[types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L55) +[types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L55) ___ @@ -295,7 +217,7 @@ Census.weight #### Defined in -[types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L67) +[types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L67) • `set` **weight**(`value`): `void` @@ -315,7 +237,37 @@ Census.weight #### Defined in -[types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L71) +[types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L71) + +## Constructors + +### constructor + +• **new PublishedCensus**(`censusId`, `censusURI`, `type`, `size?`, `weight?`): [`PublishedCensus`](PublishedCensus) + +Constructs a published census + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `censusId` | `string` | The id of the census | +| `censusURI` | `string` | The URI of the census | +| `type` | [`CensusType`](../enums/CensusType) | The type of the census | +| `size?` | `number` | The size of the census | +| `weight?` | `bigint` | The weight of the census | + +#### Returns + +[`PublishedCensus`](PublishedCensus) + +#### Overrides + +Census.constructor + +#### Defined in + +[types/census/published.ts:17](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/published.ts#L17) ## Methods @@ -340,4 +292,4 @@ Census.weight #### Defined in -[types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L81) +[types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L81) diff --git a/docs/sdk/reference/classes/PublishedElection.md b/docs/sdk/reference/classes/PublishedElection.md index 9700472b8..4c39a7294 100644 --- a/docs/sdk/reference/classes/PublishedElection.md +++ b/docs/sdk/reference/classes/PublishedElection.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / PublishedElection +[@vocdoni/sdk](/sdk) / PublishedElection # Class: PublishedElection @@ -14,40 +14,6 @@ Represents a published election ## Table of contents -### Constructors - -- [constructor](PublishedElection#constructor) - -### Properties - -- [\_addSDKVersion](PublishedElection.md#_addsdkversion) -- [\_census](PublishedElection.md#_census) -- [\_chainId](PublishedElection.md#_chainid) -- [\_creationTime](PublishedElection.md#_creationtime) -- [\_description](PublishedElection.md#_description) -- [\_electionType](PublishedElection.md#_electiontype) -- [\_endDate](PublishedElection.md#_enddate) -- [\_finalResults](PublishedElection.md#_finalresults) -- [\_fromArchive](PublishedElection.md#_fromarchive) -- [\_header](PublishedElection.md#_header) -- [\_id](PublishedElection.md#_id) -- [\_manuallyEnded](PublishedElection.md#_manuallyended) -- [\_maxCensusSize](PublishedElection.md#_maxcensussize) -- [\_meta](PublishedElection.md#_meta) -- [\_metadataURL](PublishedElection.md#_metadataurl) -- [\_organizationId](PublishedElection.md#_organizationid) -- [\_questions](PublishedElection.md#_questions) -- [\_raw](PublishedElection.md#_raw) -- [\_results](PublishedElection.md#_results) -- [\_resultsType](PublishedElection.md#_resultstype) -- [\_startDate](PublishedElection.md#_startdate) -- [\_status](PublishedElection.md#_status) -- [\_streamUri](PublishedElection.md#_streamuri) -- [\_temporarySecretIdentity](PublishedElection.md#_temporarysecretidentity) -- [\_title](PublishedElection.md#_title) -- [\_voteCount](PublishedElection.md#_votecount) -- [\_voteType](PublishedElection.md#_votetype) - ### Accessors - [addSDKVersion](PublishedElection#addsdkversion) @@ -79,6 +45,10 @@ Represents a published election - [voteCount](PublishedElection#votecount) - [voteType](PublishedElection#votetype) +### Constructors + +- [constructor](PublishedElection#constructor) + ### Methods - [checkVote](PublishedElection#checkvote) @@ -88,358 +58,6 @@ Represents a published election - [from](PublishedElection#from) - [getStatus](PublishedElection#getstatus) -## Constructors - -### constructor - -• **new PublishedElection**(`params`): [`PublishedElection`](PublishedElection) - -Constructs a published election - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`IPublishedElectionParameters`](../interfaces/IPublishedElectionParameters) | Election parameters | - -#### Returns - -[`PublishedElection`](PublishedElection) - -#### Overrides - -[Election](Election.md).[constructor](Election#constructor) - -#### Defined in - -[types/election/published.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L65) - -## Properties - -### \_addSDKVersion - -• `Protected` **\_addSDKVersion**: `boolean` - -#### Inherited from - -[Election](Election).[_addSDKVersion](Election.md#_addsdkversion) - -#### Defined in - -[types/election/election.ts:175](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L175) - -___ - -### \_census - -• `Protected` **\_census**: [`Census`](Census) - -#### Inherited from - -[Election](Election).[_census](Election.md#_census) - -#### Defined in - -[types/election/election.ts:172](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L172) - -___ - -### \_chainId - -• `Private` `Readonly` **\_chainId**: `string` - -#### Defined in - -[types/election/published.ts:53](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L53) - -___ - -### \_creationTime - -• `Private` `Readonly` **\_creationTime**: `Date` - -#### Defined in - -[types/election/published.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L55) - -___ - -### \_description - -• `Protected` **\_description**: `MultiLanguage`\<`string`\> - -#### Inherited from - -[Election](Election).[_description](Election.md#_description) - -#### Defined in - -[types/election/election.ts:163](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L163) - -___ - -### \_electionType - -• `Protected` **\_electionType**: [`IElectionType`](../interfaces/IElectionType) - -#### Inherited from - -[Election](Election).[_electionType](Election.md#_electiontype) - -#### Defined in - -[types/election/election.ts:169](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L169) - -___ - -### \_endDate - -• `Protected` **\_endDate**: `Date` - -#### Inherited from - -[Election](Election).[_endDate](Election.md#_enddate) - -#### Defined in - -[types/election/election.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L168) - -___ - -### \_finalResults - -• `Private` `Readonly` **\_finalResults**: `boolean` - -#### Defined in - -[types/election/published.ts:50](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L50) - -___ - -### \_fromArchive - -• `Private` `Readonly` **\_fromArchive**: `boolean` - -#### Defined in - -[types/election/published.ts:52](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L52) - -___ - -### \_header - -• `Protected` **\_header**: `string` - -#### Inherited from - -[Election](Election).[_header](Election.md#_header) - -#### Defined in - -[types/election/election.ts:164](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L164) - -___ - -### \_id - -• `Private` `Readonly` **\_id**: `string` - -#### Defined in - -[types/election/published.ts:46](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L46) - -___ - -### \_manuallyEnded - -• `Private` `Readonly` **\_manuallyEnded**: `boolean` - -#### Defined in - -[types/election/published.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L51) - -___ - -### \_maxCensusSize - -• `Protected` **\_maxCensusSize**: `number` - -#### Inherited from - -[Election](Election).[_maxCensusSize](Election.md#_maxcensussize) - -#### Defined in - -[types/election/election.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L173) - -___ - -### \_meta - -• `Protected` **\_meta**: `any` - -#### Inherited from - -[Election](Election).[_meta](Election.md#_meta) - -#### Defined in - -[types/election/election.ts:166](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L166) - -___ - -### \_metadataURL - -• `Private` `Readonly` **\_metadataURL**: `string` - -#### Defined in - -[types/election/published.ts:56](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L56) - -___ - -### \_organizationId - -• `Private` `Readonly` **\_organizationId**: `string` - -#### Defined in - -[types/election/published.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L47) - -___ - -### \_questions - -• `Protected` **\_questions**: [`IQuestion`](../interfaces/IQuestion)[] - -#### Inherited from - -[Election](Election).[_questions](Election.md#_questions) - -#### Defined in - -[types/election/election.ts:171](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L171) - -___ - -### \_raw - -• `Private` `Readonly` **\_raw**: `object` - -#### Defined in - -[types/election/published.ts:58](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L58) - -___ - -### \_results - -• `Private` `Readonly` **\_results**: `string`[][] - -#### Defined in - -[types/election/published.ts:54](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L54) - -___ - -### \_resultsType - -• `Private` `Readonly` **\_resultsType**: [`ElectionResultsType`](../modules#electionresultstype) - -#### Defined in - -[types/election/published.ts:57](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L57) - -___ - -### \_startDate - -• `Protected` **\_startDate**: `Date` - -#### Inherited from - -[Election](Election).[_startDate](Election.md#_startdate) - -#### Defined in - -[types/election/election.ts:167](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L167) - -___ - -### \_status - -• `Private` `Readonly` **\_status**: [`ElectionStatus`](../enums/ElectionStatus) - -#### Defined in - -[types/election/published.ts:48](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L48) - -___ - -### \_streamUri - -• `Protected` **\_streamUri**: `string` - -#### Inherited from - -[Election](Election).[_streamUri](Election.md#_streamuri) - -#### Defined in - -[types/election/election.ts:165](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L165) - -___ - -### \_temporarySecretIdentity - -• `Protected` **\_temporarySecretIdentity**: `boolean` - -#### Inherited from - -[Election](Election).[_temporarySecretIdentity](Election.md#_temporarysecretidentity) - -#### Defined in - -[types/election/election.ts:174](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L174) - -___ - -### \_title - -• `Protected` **\_title**: `MultiLanguage`\<`string`\> - -#### Inherited from - -[Election](Election).[_title](Election.md#_title) - -#### Defined in - -[types/election/election.ts:162](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L162) - -___ - -### \_voteCount - -• `Private` `Readonly` **\_voteCount**: `number` - -#### Defined in - -[types/election/published.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L49) - -___ - -### \_voteType - -• `Protected` **\_voteType**: [`IVoteType`](../interfaces/IVoteType) - -#### Inherited from - -[Election](Election).[_voteType](Election.md#_votetype) - -#### Defined in - -[types/election/election.ts:170](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L170) - ## Accessors ### addSDKVersion @@ -456,7 +74,7 @@ Election.addSDKVersion #### Defined in -[types/election/election.ts:262](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L262) +[types/election/election.ts:262](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L262) ___ @@ -474,7 +92,7 @@ Election.census #### Defined in -[types/election/published.ts:179](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L179) +[types/election/published.ts:179](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L179) ___ @@ -488,7 +106,7 @@ ___ #### Defined in -[types/election/published.ts:219](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L219) +[types/election/published.ts:219](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L219) ___ @@ -502,7 +120,7 @@ ___ #### Defined in -[types/election/published.ts:223](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L223) +[types/election/published.ts:223](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L223) ___ @@ -520,7 +138,7 @@ Election.description #### Defined in -[types/election/published.ts:147](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L147) +[types/election/published.ts:147](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L147) ___ @@ -538,7 +156,7 @@ Election.electionType #### Defined in -[types/election/published.ts:167](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L167) +[types/election/published.ts:167](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L167) ___ @@ -556,7 +174,7 @@ Election.endDate #### Defined in -[types/election/published.ts:163](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L163) +[types/election/published.ts:163](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L163) ___ @@ -570,7 +188,7 @@ ___ #### Defined in -[types/election/published.ts:203](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L203) +[types/election/published.ts:203](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L203) ___ @@ -584,7 +202,7 @@ ___ #### Defined in -[types/election/published.ts:215](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L215) +[types/election/published.ts:215](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L215) ___ @@ -602,7 +220,7 @@ Election.header #### Defined in -[types/election/published.ts:151](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L151) +[types/election/published.ts:151](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L151) ___ @@ -616,7 +234,7 @@ ___ #### Defined in -[types/election/published.ts:187](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L187) +[types/election/published.ts:187](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L187) ___ @@ -630,7 +248,7 @@ ___ #### Defined in -[types/election/published.ts:239](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L239) +[types/election/published.ts:239](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L239) ___ @@ -644,7 +262,7 @@ ___ #### Defined in -[types/election/published.ts:211](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L211) +[types/election/published.ts:211](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L211) ___ @@ -662,7 +280,7 @@ Election.maxCensusSize #### Defined in -[types/election/published.ts:183](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L183) +[types/election/published.ts:183](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L183) ___ @@ -680,7 +298,7 @@ Election.meta #### Defined in -[types/election/election.ts:226](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L226) +[types/election/election.ts:226](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L226) ___ @@ -694,7 +312,7 @@ ___ #### Defined in -[types/election/published.ts:227](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L227) +[types/election/published.ts:227](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L227) ___ @@ -708,7 +326,7 @@ ___ #### Defined in -[types/election/published.ts:191](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L191) +[types/election/published.ts:191](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L191) ___ @@ -726,7 +344,7 @@ Election.questions #### Defined in -[types/election/published.ts:175](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L175) +[types/election/published.ts:175](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L175) ___ @@ -740,7 +358,7 @@ ___ #### Defined in -[types/election/published.ts:235](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L235) +[types/election/published.ts:235](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L235) ___ @@ -754,21 +372,21 @@ ___ #### Defined in -[types/election/published.ts:207](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L207) +[types/election/published.ts:207](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L207) ___ ### resultsType -• `get` **resultsType**(): [`ElectionResultsType`](../modules#electionresultstype) +• `get` **resultsType**(): [`ElectionResultsType`](../sdk-reference#electionresultstype) #### Returns -[`ElectionResultsType`](../modules#electionresultstype) +[`ElectionResultsType`](../sdk-reference#electionresultstype) #### Defined in -[types/election/published.ts:231](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L231) +[types/election/published.ts:231](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L231) ___ @@ -786,7 +404,7 @@ Election.startDate #### Defined in -[types/election/published.ts:159](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L159) +[types/election/published.ts:159](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L159) ___ @@ -800,7 +418,7 @@ ___ #### Defined in -[types/election/published.ts:195](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L195) +[types/election/published.ts:195](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L195) ___ @@ -818,7 +436,7 @@ Election.streamUri #### Defined in -[types/election/published.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L155) +[types/election/published.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L155) ___ @@ -836,7 +454,7 @@ Election.temporarySecretIdentity #### Defined in -[types/election/election.ts:258](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L258) +[types/election/election.ts:258](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L258) ___ @@ -854,7 +472,7 @@ Election.title #### Defined in -[types/election/published.ts:143](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L143) +[types/election/published.ts:143](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L143) ___ @@ -868,7 +486,7 @@ ___ #### Defined in -[types/election/published.ts:199](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L199) +[types/election/published.ts:199](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L199) ___ @@ -886,7 +504,33 @@ Election.voteType #### Defined in -[types/election/published.ts:171](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L171) +[types/election/published.ts:171](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L171) + +## Constructors + +### constructor + +• **new PublishedElection**(`params`): [`PublishedElection`](PublishedElection) + +Constructs a published election + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `params` | [`IPublishedElectionParameters`](../interfaces/IPublishedElectionParameters) | Election parameters | + +#### Returns + +[`PublishedElection`](PublishedElection) + +#### Overrides + +Election.constructor + +#### Defined in + +[types/election/published.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L65) ## Methods @@ -906,7 +550,7 @@ Election.voteType #### Defined in -[types/election/published.ts:113](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L113) +[types/election/published.ts:113](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L113) ___ @@ -930,7 +574,7 @@ ___ #### Defined in -[types/election/election.ts:266](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L266) +[types/election/election.ts:266](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L266) ___ @@ -952,7 +596,7 @@ Returns a published election object #### Defined in -[types/election/published.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L100) +[types/election/published.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L100) ___ @@ -973,7 +617,7 @@ ___ #### Defined in -[types/election/published.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L127) +[types/election/published.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L127) ___ @@ -999,7 +643,7 @@ Returns an unpublished election object #### Defined in -[types/election/election.ts:206](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L206) +[types/election/election.ts:206](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L206) ___ @@ -1011,7 +655,7 @@ ___ | Name | Type | | :------ | :------ | -| `status` | [`AllElectionStatus`](../modules#allelectionstatus) | +| `status` | [`AllElectionStatus`](../sdk-reference#allelectionstatus) | | `startDate` | `Date` | #### Returns @@ -1020,4 +664,4 @@ ___ #### Defined in -[types/election/published.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L104) +[types/election/published.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L104) diff --git a/docs/sdk/reference/classes/Service.md b/docs/sdk/reference/classes/Service.md index c692b7afb..2a48de661 100644 --- a/docs/sdk/reference/classes/Service.md +++ b/docs/sdk/reference/classes/Service.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / Service +[@vocdoni/sdk](/sdk) / Service # Class: Service @@ -30,30 +30,10 @@ ## Table of contents -### Constructors - -- [constructor](Service#constructor) - ### Properties - [url](Service#url) -## Constructors - -### constructor - -• **new Service**(): [`Service`](Service) - -Cannot be constructed. - -#### Returns - -[`Service`](Service) - -#### Defined in - -[services/service.ts:10](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/service.ts#L10) - ## Properties ### url @@ -66,4 +46,4 @@ Cannot be constructed. #### Defined in -[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/service.ts#L6) +[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/service.ts#L6) diff --git a/docs/sdk/reference/classes/TokenCensus.md b/docs/sdk/reference/classes/TokenCensus.md index a5e5e9dff..d34fcf54f 100644 --- a/docs/sdk/reference/classes/TokenCensus.md +++ b/docs/sdk/reference/classes/TokenCensus.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / TokenCensus +[@vocdoni/sdk](/sdk) / TokenCensus # Class: TokenCensus @@ -12,17 +12,6 @@ Represents a census3 census ## Table of contents -### Constructors - -- [constructor](TokenCensus#constructor) - -### Properties - -- [\_censusId](TokenCensus.md#_censusid) -- [\_censusURI](TokenCensus.md#_censusuri) -- [\_token](TokenCensus.md#_token) -- [\_type](TokenCensus.md#_type) - ### Accessors - [censusId](TokenCensus#censusid) @@ -33,92 +22,13 @@ Represents a census3 census - [type](TokenCensus#type) - [weight](TokenCensus#weight) -### Methods - -- [censusTypeFromCensusOrigin](TokenCensus#censustypefromcensusorigin) - -## Constructors - -### constructor - -• **new TokenCensus**(`censusId`, `censusURI`, `anonymous`, `token`, `size?`, `weight?`): [`TokenCensus`](TokenCensus) - -Constructs a census3 census - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `censusId` | `string` | The id of the census | -| `censusURI` | `string` | The URI of the census | -| `anonymous` | `boolean` | If the census is anonymous | -| `token` | [`Token`](../modules#token) | The token of the census | -| `size?` | `number` | The size of the census | -| `weight?` | `bigint` | The weight of the census | - -#### Returns - -[`TokenCensus`](TokenCensus) - -#### Overrides - -[PublishedCensus](PublishedCensus.md).[constructor](PublishedCensus#constructor) - -#### Defined in - -[types/census/census3.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census3.ts#L21) - -## Properties - -### \_censusId - -• `Protected` **\_censusId**: `string` - -#### Inherited from - -[PublishedCensus](PublishedCensus).[_censusId](PublishedCensus.md#_censusid) - -#### Defined in - -[types/census/census.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L12) - -___ - -### \_censusURI - -• `Protected` **\_censusURI**: `string` - -#### Inherited from - -[PublishedCensus](PublishedCensus).[_censusURI](PublishedCensus.md#_censusuri) - -#### Defined in - -[types/census/census.ts:13](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L13) - -___ - -### \_token - -• `Private` **\_token**: [`Token`](../modules#token) - -#### Defined in - -[types/census/census3.ts:9](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census3.ts#L9) - -___ - -### \_type - -• `Protected` **\_type**: [`CensusType`](../enums/CensusType) - -#### Inherited from +### Constructors -[PublishedCensus](PublishedCensus).[_type](PublishedCensus.md#_type) +- [constructor](TokenCensus#constructor) -#### Defined in +### Methods -[types/census/census.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L14) +- [censusTypeFromCensusOrigin](TokenCensus#censustypefromcensusorigin) ## Accessors @@ -136,7 +46,7 @@ PublishedCensus.censusId #### Defined in -[types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L35) +[types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L35) • `set` **censusId**(`value`): `void` @@ -156,7 +66,7 @@ PublishedCensus.censusId #### Defined in -[types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L39) +[types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L39) ___ @@ -174,7 +84,7 @@ PublishedCensus.censusURI #### Defined in -[types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L43) +[types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L43) • `set` **censusURI**(`value`): `void` @@ -194,7 +104,7 @@ PublishedCensus.censusURI #### Defined in -[types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L47) +[types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L47) ___ @@ -212,7 +122,7 @@ PublishedCensus.isPublished #### Defined in -[types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L75) +[types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L75) ___ @@ -230,7 +140,7 @@ PublishedCensus.size #### Defined in -[types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L59) +[types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L59) • `set` **size**(`value`): `void` @@ -250,21 +160,21 @@ PublishedCensus.size #### Defined in -[types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L63) +[types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L63) ___ ### token -• `get` **token**(): [`Token`](../modules#token) +• `get` **token**(): [`Token`](../sdk-reference#token) #### Returns -[`Token`](../modules#token) +[`Token`](../sdk-reference#token) #### Defined in -[types/census/census3.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census3.ts#L33) +[types/census/census3.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census3.ts#L33) • `set` **token**(`value`): `void` @@ -272,7 +182,7 @@ ___ | Name | Type | | :------ | :------ | -| `value` | [`Token`](../modules#token) | +| `value` | [`Token`](../sdk-reference#token) | #### Returns @@ -280,7 +190,7 @@ ___ #### Defined in -[types/census/census3.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census3.ts#L37) +[types/census/census3.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census3.ts#L37) ___ @@ -298,7 +208,7 @@ PublishedCensus.type #### Defined in -[types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L51) +[types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L51) • `set` **type**(`value`): `void` @@ -318,7 +228,7 @@ PublishedCensus.type #### Defined in -[types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L55) +[types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L55) ___ @@ -336,7 +246,7 @@ PublishedCensus.weight #### Defined in -[types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L67) +[types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L67) • `set` **weight**(`value`): `void` @@ -356,7 +266,38 @@ PublishedCensus.weight #### Defined in -[types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L71) +[types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L71) + +## Constructors + +### constructor + +• **new TokenCensus**(`censusId`, `censusURI`, `anonymous`, `token`, `size?`, `weight?`): [`TokenCensus`](TokenCensus) + +Constructs a census3 census + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `censusId` | `string` | The id of the census | +| `censusURI` | `string` | The URI of the census | +| `anonymous` | `boolean` | If the census is anonymous | +| `token` | [`Token`](../sdk-reference#token) | The token of the census | +| `size?` | `number` | The size of the census | +| `weight?` | `bigint` | The weight of the census | + +#### Returns + +[`TokenCensus`](TokenCensus) + +#### Overrides + +[PublishedCensus](PublishedCensus.md).[constructor](PublishedCensus#constructor) + +#### Defined in + +[types/census/census3.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census3.ts#L21) ## Methods @@ -381,4 +322,4 @@ PublishedCensus.weight #### Defined in -[types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L81) +[types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L81) diff --git a/docs/sdk/reference/classes/UnpublishedElection.md b/docs/sdk/reference/classes/UnpublishedElection.md index ae9feed82..b9214d84f 100644 --- a/docs/sdk/reference/classes/UnpublishedElection.md +++ b/docs/sdk/reference/classes/UnpublishedElection.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / UnpublishedElection +[@vocdoni/sdk](/sdk) / UnpublishedElection # Class: UnpublishedElection @@ -18,27 +18,6 @@ Represents an unpublished election ## Table of contents -### Constructors - -- [constructor](UnpublishedElection#constructor) - -### Properties - -- [\_addSDKVersion](UnpublishedElection.md#_addsdkversion) -- [\_census](UnpublishedElection.md#_census) -- [\_description](UnpublishedElection.md#_description) -- [\_electionType](UnpublishedElection.md#_electiontype) -- [\_endDate](UnpublishedElection.md#_enddate) -- [\_header](UnpublishedElection.md#_header) -- [\_maxCensusSize](UnpublishedElection.md#_maxcensussize) -- [\_meta](UnpublishedElection.md#_meta) -- [\_questions](UnpublishedElection.md#_questions) -- [\_startDate](UnpublishedElection.md#_startdate) -- [\_streamUri](UnpublishedElection.md#_streamuri) -- [\_temporarySecretIdentity](UnpublishedElection.md#_temporarysecretidentity) -- [\_title](UnpublishedElection.md#_title) -- [\_voteType](UnpublishedElection.md#_votetype) - ### Accessors - [addSDKVersion](UnpublishedElection#addsdkversion) @@ -57,6 +36,10 @@ Represents an unpublished election - [title](UnpublishedElection#title) - [voteType](UnpublishedElection#votetype) +### Constructors + +- [constructor](UnpublishedElection#constructor) + ### Methods - [addQuestion](UnpublishedElection#addquestion) @@ -67,230 +50,6 @@ Represents an unpublished election - [get](UnpublishedElection#get) - [removeQuestion](UnpublishedElection#removequestion) - [from](UnpublishedElection#from) -- [fullElectionType](UnpublishedElection#fullelectiontype) -- [fullVoteType](UnpublishedElection#fullvotetype) - -## Constructors - -### constructor - -• **new UnpublishedElection**(`params`): [`UnpublishedElection`](UnpublishedElection) - -Constructs an unpublished election - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`IElectionParameters`](../interfaces/IElectionParameters) | Election parameters | - -#### Returns - -[`UnpublishedElection`](UnpublishedElection) - -#### Overrides - -[Election](Election.md).[constructor](Election#constructor) - -#### Defined in - -[types/election/unpublished.ts:23](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L23) - -## Properties - -### \_addSDKVersion - -• `Protected` **\_addSDKVersion**: `boolean` - -#### Inherited from - -[Election](Election).[_addSDKVersion](Election.md#_addsdkversion) - -#### Defined in - -[types/election/election.ts:175](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L175) - -___ - -### \_census - -• `Protected` **\_census**: [`Census`](Census) - -#### Inherited from - -[Election](Election).[_census](Election.md#_census) - -#### Defined in - -[types/election/election.ts:172](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L172) - -___ - -### \_description - -• `Protected` **\_description**: `MultiLanguage`\<`string`\> - -#### Inherited from - -[Election](Election).[_description](Election.md#_description) - -#### Defined in - -[types/election/election.ts:163](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L163) - -___ - -### \_electionType - -• `Protected` **\_electionType**: [`IElectionType`](../interfaces/IElectionType) - -#### Inherited from - -[Election](Election).[_electionType](Election.md#_electiontype) - -#### Defined in - -[types/election/election.ts:169](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L169) - -___ - -### \_endDate - -• `Protected` **\_endDate**: `Date` - -#### Inherited from - -[Election](Election).[_endDate](Election.md#_enddate) - -#### Defined in - -[types/election/election.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L168) - -___ - -### \_header - -• `Protected` **\_header**: `string` - -#### Inherited from - -[Election](Election).[_header](Election.md#_header) - -#### Defined in - -[types/election/election.ts:164](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L164) - -___ - -### \_maxCensusSize - -• `Protected` **\_maxCensusSize**: `number` - -#### Inherited from - -[Election](Election).[_maxCensusSize](Election.md#_maxcensussize) - -#### Defined in - -[types/election/election.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L173) - -___ - -### \_meta - -• `Protected` **\_meta**: `any` - -#### Inherited from - -[Election](Election).[_meta](Election.md#_meta) - -#### Defined in - -[types/election/election.ts:166](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L166) - -___ - -### \_questions - -• `Protected` **\_questions**: [`IQuestion`](../interfaces/IQuestion)[] - -#### Inherited from - -[Election](Election).[_questions](Election.md#_questions) - -#### Defined in - -[types/election/election.ts:171](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L171) - -___ - -### \_startDate - -• `Protected` **\_startDate**: `Date` - -#### Inherited from - -[Election](Election).[_startDate](Election.md#_startdate) - -#### Defined in - -[types/election/election.ts:167](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L167) - -___ - -### \_streamUri - -• `Protected` **\_streamUri**: `string` - -#### Inherited from - -[Election](Election).[_streamUri](Election.md#_streamuri) - -#### Defined in - -[types/election/election.ts:165](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L165) - -___ - -### \_temporarySecretIdentity - -• `Protected` **\_temporarySecretIdentity**: `boolean` - -#### Inherited from - -[Election](Election).[_temporarySecretIdentity](Election.md#_temporarysecretidentity) - -#### Defined in - -[types/election/election.ts:174](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L174) - -___ - -### \_title - -• `Protected` **\_title**: `MultiLanguage`\<`string`\> - -#### Inherited from - -[Election](Election).[_title](Election.md#_title) - -#### Defined in - -[types/election/election.ts:162](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L162) - -___ - -### \_voteType - -• `Protected` **\_voteType**: [`IVoteType`](../interfaces/IVoteType) - -#### Inherited from - -[Election](Election).[_voteType](Election.md#_votetype) - -#### Defined in - -[types/election/election.ts:170](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L170) ## Accessors @@ -308,7 +67,7 @@ Election.addSDKVersion #### Defined in -[types/election/unpublished.ts:275](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L275) +[types/election/unpublished.ts:275](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L275) • `set` **addSDKVersion**(`value`): `void` @@ -328,7 +87,7 @@ Election.addSDKVersion #### Defined in -[types/election/unpublished.ts:279](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L279) +[types/election/unpublished.ts:279](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L279) ___ @@ -346,7 +105,7 @@ Election.census #### Defined in -[types/election/unpublished.ts:249](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L249) +[types/election/unpublished.ts:249](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L249) • `set` **census**(`value`): `void` @@ -366,7 +125,7 @@ Election.census #### Defined in -[types/election/unpublished.ts:253](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L253) +[types/election/unpublished.ts:253](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L253) ___ @@ -384,7 +143,7 @@ Election.description #### Defined in -[types/election/unpublished.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L173) +[types/election/unpublished.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L173) • `set` **description**(`value`): `void` @@ -404,7 +163,7 @@ Election.description #### Defined in -[types/election/unpublished.ts:177](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L177) +[types/election/unpublished.ts:177](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L177) ___ @@ -418,7 +177,7 @@ ___ #### Defined in -[types/election/unpublished.ts:138](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L138) +[types/election/unpublished.ts:138](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L138) ___ @@ -436,7 +195,7 @@ Election.electionType #### Defined in -[types/election/unpublished.ts:225](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L225) +[types/election/unpublished.ts:225](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L225) • `set` **electionType**(`value`): `void` @@ -456,7 +215,7 @@ Election.electionType #### Defined in -[types/election/unpublished.ts:229](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L229) +[types/election/unpublished.ts:229](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L229) ___ @@ -474,7 +233,7 @@ Election.endDate #### Defined in -[types/election/unpublished.ts:215](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L215) +[types/election/unpublished.ts:215](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L215) • `set` **endDate**(`value`): `void` @@ -494,7 +253,7 @@ Election.endDate #### Defined in -[types/election/unpublished.ts:219](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L219) +[types/election/unpublished.ts:219](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L219) ___ @@ -512,7 +271,7 @@ Election.header #### Defined in -[types/election/unpublished.ts:181](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L181) +[types/election/unpublished.ts:181](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L181) • `set` **header**(`value`): `void` @@ -532,7 +291,7 @@ Election.header #### Defined in -[types/election/unpublished.ts:185](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L185) +[types/election/unpublished.ts:185](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L185) ___ @@ -550,7 +309,7 @@ Election.maxCensusSize #### Defined in -[types/election/unpublished.ts:258](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L258) +[types/election/unpublished.ts:258](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L258) • `set` **maxCensusSize**(`value`): `void` @@ -570,7 +329,7 @@ Election.maxCensusSize #### Defined in -[types/election/unpublished.ts:262](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L262) +[types/election/unpublished.ts:262](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L262) ___ @@ -588,7 +347,7 @@ Election.meta #### Defined in -[types/election/unpublished.ts:197](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L197) +[types/election/unpublished.ts:197](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L197) • `set` **meta**(`value`): `void` @@ -608,7 +367,7 @@ Election.meta #### Defined in -[types/election/unpublished.ts:201](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L201) +[types/election/unpublished.ts:201](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L201) ___ @@ -626,7 +385,7 @@ Election.questions #### Defined in -[types/election/unpublished.ts:241](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L241) +[types/election/unpublished.ts:241](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L241) • `set` **questions**(`value`): `void` @@ -646,7 +405,7 @@ Election.questions #### Defined in -[types/election/unpublished.ts:245](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L245) +[types/election/unpublished.ts:245](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L245) ___ @@ -664,7 +423,7 @@ Election.startDate #### Defined in -[types/election/unpublished.ts:206](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L206) +[types/election/unpublished.ts:206](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L206) • `set` **startDate**(`value`): `void` @@ -684,7 +443,7 @@ Election.startDate #### Defined in -[types/election/unpublished.ts:210](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L210) +[types/election/unpublished.ts:210](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L210) ___ @@ -702,7 +461,7 @@ Election.streamUri #### Defined in -[types/election/unpublished.ts:189](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L189) +[types/election/unpublished.ts:189](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L189) • `set` **streamUri**(`value`): `void` @@ -722,7 +481,7 @@ Election.streamUri #### Defined in -[types/election/unpublished.ts:193](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L193) +[types/election/unpublished.ts:193](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L193) ___ @@ -740,7 +499,7 @@ Election.temporarySecretIdentity #### Defined in -[types/election/unpublished.ts:267](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L267) +[types/election/unpublished.ts:267](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L267) • `set` **temporarySecretIdentity**(`value`): `void` @@ -760,7 +519,7 @@ Election.temporarySecretIdentity #### Defined in -[types/election/unpublished.ts:271](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L271) +[types/election/unpublished.ts:271](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L271) ___ @@ -778,7 +537,7 @@ Election.title #### Defined in -[types/election/unpublished.ts:164](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L164) +[types/election/unpublished.ts:164](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L164) • `set` **title**(`value`): `void` @@ -798,7 +557,7 @@ Election.title #### Defined in -[types/election/unpublished.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L168) +[types/election/unpublished.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L168) ___ @@ -816,7 +575,7 @@ Election.voteType #### Defined in -[types/election/unpublished.ts:233](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L233) +[types/election/unpublished.ts:233](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L233) • `set` **voteType**(`value`): `void` @@ -836,7 +595,33 @@ Election.voteType #### Defined in -[types/election/unpublished.ts:237](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L237) +[types/election/unpublished.ts:237](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L237) + +## Constructors + +### constructor + +• **new UnpublishedElection**(`params`): [`UnpublishedElection`](UnpublishedElection) + +Constructs an unpublished election + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `params` | [`IElectionParameters`](../interfaces/IElectionParameters) | Election parameters | + +#### Returns + +[`UnpublishedElection`](UnpublishedElection) + +#### Overrides + +Election.constructor + +#### Defined in + +[types/election/unpublished.ts:23](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L23) ## Methods @@ -858,7 +643,7 @@ Election.voteType #### Defined in -[types/election/unpublished.ts:41](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L41) +[types/election/unpublished.ts:41](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L41) ___ @@ -872,7 +657,7 @@ ___ #### Defined in -[types/election/unpublished.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L144) +[types/election/unpublished.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L144) ___ @@ -892,7 +677,7 @@ ___ #### Defined in -[types/election/unpublished.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L88) +[types/election/unpublished.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L88) ___ @@ -906,7 +691,7 @@ ___ #### Defined in -[types/election/unpublished.ts:154](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L154) +[types/election/unpublished.ts:154](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L154) ___ @@ -920,7 +705,7 @@ ___ #### Defined in -[types/election/unpublished.ts:123](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L123) +[types/election/unpublished.ts:123](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L123) ___ @@ -944,7 +729,7 @@ ___ #### Defined in -[types/election/election.ts:266](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L266) +[types/election/election.ts:266](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L266) ___ @@ -964,7 +749,7 @@ ___ #### Defined in -[types/election/unpublished.ts:60](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L60) +[types/election/unpublished.ts:60](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/unpublished.ts#L60) ___ @@ -990,44 +775,4 @@ Returns an unpublished election object #### Defined in -[types/election/election.ts:206](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L206) - -___ - -### fullElectionType - -▸ **fullElectionType**(`value`): [`IElectionType`](../interfaces/IElectionType) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`IElectionType`](../interfaces/IElectionType) | - -#### Returns - -[`IElectionType`](../interfaces/IElectionType) - -#### Defined in - -[types/election/unpublished.ts:66](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L66) - -___ - -### fullVoteType - -▸ **fullVoteType**(`value`): [`IVoteType`](../interfaces/IVoteType) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`IVoteType`](../interfaces/IVoteType) | - -#### Returns - -[`IVoteType`](../interfaces/IVoteType) - -#### Defined in - -[types/election/unpublished.ts:76](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/unpublished.ts#L76) +[types/election/election.ts:206](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L206) diff --git a/docs/sdk/reference/classes/VocdoniCensus3Client.md b/docs/sdk/reference/classes/VocdoniCensus3Client.md index accd4cb8b..fbce7ee3f 100644 --- a/docs/sdk/reference/classes/VocdoniCensus3Client.md +++ b/docs/sdk/reference/classes/VocdoniCensus3Client.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / VocdoniCensus3Client +[@vocdoni/sdk](/sdk) / VocdoniCensus3Client # Class: VocdoniCensus3Client @@ -8,11 +8,6 @@ - [constructor](VocdoniCensus3Client#constructor) -### Properties - -- [queueWait](VocdoniCensus3Client#queuewait) -- [url](VocdoniCensus3Client#url) - ### Methods - [createCensus](VocdoniCensus3Client#createcensus) @@ -36,6 +31,11 @@ - [tokenHolderBalance](VocdoniCensus3Client#tokenholderbalance) - [validatePredicate](VocdoniCensus3Client#validatepredicate) +### Properties + +- [queueWait](VocdoniCensus3Client#queuewait) +- [url](VocdoniCensus3Client#url) + ## Constructors ### constructor @@ -44,7 +44,7 @@ Instantiate new VocdoniCensus3 client. -To instantiate the client just pass the `ClientOptions` you want or empty object to let defaults. +To instantiate the client just pass the `ClientOptions` you want or use an empty object for the defaults. `const client = new VocdoniCensus3Client({EnvOptions.PROD})` @@ -52,7 +52,7 @@ To instantiate the client just pass the `ClientOptions` you want or empty object | Name | Type | Description | | :------ | :------ | :------ | -| `opts` | [`ClientOptions`](../modules#clientoptions) | optional arguments | +| `opts` | [`ClientOptions`](../sdk-reference#clientoptions) | optional arguments | #### Returns @@ -60,34 +60,7 @@ To instantiate the client just pass the `ClientOptions` you want or empty object #### Defined in -[census3.ts:48](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L48) - -## Properties - -### queueWait - -• **queueWait**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `attempts` | `number` | -| `retryTime` | `number` | - -#### Defined in - -[census3.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L37) - -___ - -### url - -• **url**: `string` - -#### Defined in - -[census3.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L36) +[census3.ts:48](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L48) ## Methods @@ -112,7 +85,7 @@ The census information #### Defined in -[census3.ts:358](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L358) +[census3.ts:356](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L356) ___ @@ -138,7 +111,7 @@ The strategy id #### Defined in -[census3.ts:275](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L275) +[census3.ts:273](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L273) ___ @@ -164,7 +137,7 @@ Creates a new token to be tracked in the service #### Defined in -[census3.ts:163](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L163) +[census3.ts:163](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L163) ___ @@ -191,7 +164,7 @@ The token census #### Defined in -[census3.ts:395](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L395) +[census3.ts:393](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L393) ___ @@ -215,7 +188,7 @@ The census3 census #### Defined in -[census3.ts:346](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L346) +[census3.ts:344](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L344) ___ @@ -239,31 +212,31 @@ The list of census3 censuses #### Defined in -[census3.ts:335](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L335) +[census3.ts:333](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L333) ___ ### getStrategies -▸ **getStrategies**(): `Promise`\<[`Census3Strategy`](../modules#census3strategy)[]\> +▸ **getStrategies**(): `Promise`\<[`Census3Strategy`](../sdk-reference#census3strategy)[]\> Returns the strategies #### Returns -`Promise`\<[`Census3Strategy`](../modules#census3strategy)[]\> +`Promise`\<[`Census3Strategy`](../sdk-reference#census3strategy)[]\> The list of strategies #### Defined in -[census3.ts:181](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L181) +[census3.ts:181](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L181) ___ ### getStrategiesByToken -▸ **getStrategiesByToken**(`id`, `chainId`, `externalId?`): `Promise`\<[`Census3Strategy`](../modules#census3strategy)[]\> +▸ **getStrategiesByToken**(`id`, `chainId`, `externalId?`): `Promise`\<[`Census3Strategy`](../sdk-reference#census3strategy)[]\> Returns the strategies from the given token @@ -277,19 +250,19 @@ Returns the strategies from the given token #### Returns -`Promise`\<[`Census3Strategy`](../modules#census3strategy)[]\> +`Promise`\<[`Census3Strategy`](../sdk-reference#census3strategy)[]\> The list of strategies #### Defined in -[census3.ts:207](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L207) +[census3.ts:207](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L207) ___ ### getStrategy -▸ **getStrategy**(`id`): `Promise`\<[`Census3Strategy`](../modules#census3strategy)\> +▸ **getStrategy**(`id`): `Promise`\<[`Census3Strategy`](../sdk-reference#census3strategy)\> Returns the information of the strategy based on the id @@ -301,13 +274,13 @@ Returns the information of the strategy based on the id #### Returns -`Promise`\<[`Census3Strategy`](../modules#census3strategy)\> +`Promise`\<[`Census3Strategy`](../sdk-reference#census3strategy)\> The strategy information #### Defined in -[census3.ts:221](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L221) +[census3.ts:219](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L219) ___ @@ -332,13 +305,13 @@ The strategy estimation #### Defined in -[census3.ts:233](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L233) +[census3.ts:231](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L231) ___ ### getStrategyHolders -▸ **getStrategyHolders**(`id`, `pagination?`): `Promise`\<[`StrategyHolders`](../modules#strategyholders)\> +▸ **getStrategyHolders**(`id`, `pagination?`): `Promise`\<[`StrategyHolders`](../sdk-reference#strategyholders)\> Returns the strategy holders @@ -351,13 +324,13 @@ Returns the strategy holders #### Returns -`Promise`\<[`StrategyHolders`](../modules#strategyholders)\> +`Promise`\<[`StrategyHolders`](../sdk-reference#strategyholders)\> The list strategy holders #### Defined in -[census3.ts:192](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L192) +[census3.ts:192](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L192) ___ @@ -375,7 +348,7 @@ Supported chain list #### Defined in -[census3.ts:76](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L76) +[census3.ts:76](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L76) ___ @@ -393,25 +366,25 @@ Supported strategies operators list #### Defined in -[census3.ts:94](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L94) +[census3.ts:94](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L94) ___ ### getSupportedTokens -▸ **getSupportedTokens**(): `Promise`\<[`TokenSummary`](../modules#tokensummary)[]\> +▸ **getSupportedTokens**(): `Promise`\<[`TokenSummary`](../sdk-reference#tokensummary)[]\> Returns a list of summary tokens supported by the service #### Returns -`Promise`\<[`TokenSummary`](../modules#tokensummary)[]\> +`Promise`\<[`TokenSummary`](../sdk-reference#tokensummary)[]\> Token summary list #### Defined in -[census3.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L61) +[census3.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L61) ___ @@ -429,13 +402,13 @@ Supported tokens type list #### Defined in -[census3.ts:85](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L85) +[census3.ts:85](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L85) ___ ### getToken -▸ **getToken**(`id`, `chainId`, `externalId?`): `Promise`\<[`Token`](../modules#token)\> +▸ **getToken**(`id`, `chainId`, `externalId?`): `Promise`\<[`Token`](../sdk-reference#token)\> Returns the full token information based on the id (address) @@ -449,19 +422,19 @@ Returns the full token information based on the id (address) #### Returns -`Promise`\<[`Token`](../modules#token)\> +`Promise`\<[`Token`](../sdk-reference#token)\> The token information #### Defined in -[census3.ts:106](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L106) +[census3.ts:106](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L106) ___ ### importStrategy -▸ **importStrategy**(`cid`): `Promise`\<[`Census3Strategy`](../modules#census3strategy)\> +▸ **importStrategy**(`cid`): `Promise`\<[`Census3Strategy`](../sdk-reference#census3strategy)\> Imports a strategy from IPFS from the given cid. @@ -473,13 +446,13 @@ Imports a strategy from IPFS from the given cid. #### Returns -`Promise`\<[`Census3Strategy`](../modules#census3strategy)\> +`Promise`\<[`Census3Strategy`](../sdk-reference#census3strategy)\> The strategy information #### Defined in -[census3.ts:290](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L290) +[census3.ts:288](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L288) ___ @@ -506,7 +479,7 @@ If the holder is in the token #### Defined in -[census3.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L124) +[census3.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L124) ___ @@ -533,7 +506,7 @@ The balance of the holder #### Defined in -[census3.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L145) +[census3.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L145) ___ @@ -557,4 +530,31 @@ The parsed predicate #### Defined in -[census3.ts:324](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L324) +[census3.ts:322](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L322) + +## Properties + +### queueWait + +• **queueWait**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `attempts` | `number` | +| `retryTime` | `number` | + +#### Defined in + +[census3.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L37) + +___ + +### url + +• **url**: `string` + +#### Defined in + +[census3.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L36) diff --git a/docs/sdk/reference/classes/VocdoniSDKClient.md b/docs/sdk/reference/classes/VocdoniSDKClient.md index 158858185..0901f7109 100644 --- a/docs/sdk/reference/classes/VocdoniSDKClient.md +++ b/docs/sdk/reference/classes/VocdoniSDKClient.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / VocdoniSDKClient +[@vocdoni/sdk](/sdk) / VocdoniSDKClient # Class: VocdoniSDKClient @@ -12,75 +12,77 @@ point. - [constructor](VocdoniSDKClient#constructor) -### Properties +### Account Methods -- [accountData](VocdoniSDKClient#accountdata) -- [accountService](VocdoniSDKClient#accountservice) -- [anonymousService](VocdoniSDKClient#anonymousservice) -- [censusService](VocdoniSDKClient#censusservice) -- [chainService](VocdoniSDKClient#chainservice) -- [cspService](VocdoniSDKClient#cspservice) -- [election](VocdoniSDKClient#election) -- [electionId](VocdoniSDKClient#electionid) -- [electionService](VocdoniSDKClient#electionservice) -- [explorerUrl](VocdoniSDKClient#explorerurl) -- [faucetService](VocdoniSDKClient#faucetservice) -- [fileService](VocdoniSDKClient#fileservice) -- [url](VocdoniSDKClient#url) -- [voteService](VocdoniSDKClient#voteservice) -- [wallet](VocdoniSDKClient#wallet) +- [createAccount](VocdoniSDKClient#createaccount) +- [createAccountInfo](VocdoniSDKClient#createaccountinfo) +- [fetchAccount](VocdoniSDKClient#fetchaccount) +- [fetchAccountInfo](VocdoniSDKClient#fetchaccountinfo) +- [updateAccountInfo](VocdoniSDKClient#updateaccountinfo) -### Methods +### Election Methods -- [calcZKProofForWallet](VocdoniSDKClient#calczkproofforwallet) -- [calculateCID](VocdoniSDKClient#calculatecid) - [calculateElectionCost](VocdoniSDKClient#calculateelectioncost) - [cancelElection](VocdoniSDKClient#cancelelection) - [changeElectionCensus](VocdoniSDKClient#changeelectioncensus) -- [changeElectionStatus](VocdoniSDKClient#changeelectionstatus) -- [collectFaucetTokens](VocdoniSDKClient#collectfaucettokens) - [continueElection](VocdoniSDKClient#continueelection) -- [createAccount](VocdoniSDKClient#createaccount) -- [createAccountInfo](VocdoniSDKClient#createaccountinfo) -- [createCensus](VocdoniSDKClient#createcensus) - [createElection](VocdoniSDKClient#createelection) - [createElectionSteps](VocdoniSDKClient#createelectionsteps) +- [endElection](VocdoniSDKClient#endelection) +- [estimateElectionCost](VocdoniSDKClient#estimateelectioncost) +- [fetchElection](VocdoniSDKClient#fetchelection) +- [fetchElections](VocdoniSDKClient#fetchelections) +- [pauseElection](VocdoniSDKClient#pauseelection) +- [setElectionId](VocdoniSDKClient#setelectionid) + +### Voting Methods + +- [hasAlreadyVoted](VocdoniSDKClient#hasalreadyvoted) +- [isAbleToVote](VocdoniSDKClient#isabletovote) +- [isInCensus](VocdoniSDKClient#isincensus) +- [submitVote](VocdoniSDKClient#submitvote) +- [submitVoteSteps](VocdoniSDKClient#submitvotesteps) +- [votesLeftCount](VocdoniSDKClient#votesleftcount) + +### Other Methods + +- [calculateCID](VocdoniSDKClient#calculatecid) +- [collectFaucetTokens](VocdoniSDKClient#collectfaucettokens) +- [createCensus](VocdoniSDKClient#createcensus) - [cspInfo](VocdoniSDKClient#cspinfo) - [cspSign](VocdoniSDKClient#cspsign) - [cspStep](VocdoniSDKClient#cspstep) - [cspUrl](VocdoniSDKClient#cspurl) - [cspVote](VocdoniSDKClient#cspvote) -- [endElection](VocdoniSDKClient#endelection) -- [estimateElectionCost](VocdoniSDKClient#estimateelectioncost) -- [fetchAccount](VocdoniSDKClient#fetchaccount) -- [fetchAccountInfo](VocdoniSDKClient#fetchaccountinfo) - [fetchCensusInfo](VocdoniSDKClient#fetchcensusinfo) - [fetchChainCosts](VocdoniSDKClient#fetchchaincosts) - [fetchChainId](VocdoniSDKClient#fetchchainid) - [fetchCircuits](VocdoniSDKClient#fetchcircuits) -- [fetchElection](VocdoniSDKClient#fetchelection) -- [fetchElections](VocdoniSDKClient#fetchelections) - [fetchFaucetPayload](VocdoniSDKClient#fetchfaucetpayload) - [fetchProof](VocdoniSDKClient#fetchproof) -- [fetchProofForWallet](VocdoniSDKClient#fetchproofforwallet) - [generateRandomWallet](VocdoniSDKClient#generaterandomwallet) -- [hasAlreadyVoted](VocdoniSDKClient#hasalreadyvoted) -- [isAbleToVote](VocdoniSDKClient#isabletovote) -- [isInCensus](VocdoniSDKClient#isincensus) - [parseFaucetPackage](VocdoniSDKClient#parsefaucetpackage) -- [pauseElection](VocdoniSDKClient#pauseelection) - [sendTokens](VocdoniSDKClient#sendtokens) -- [setAccountInfo](VocdoniSDKClient#setaccountinfo) -- [setAccountSIK](VocdoniSDKClient#setaccountsik) - [setCircuits](VocdoniSDKClient#setcircuits) -- [setElectionId](VocdoniSDKClient#setelectionid) -- [submitVote](VocdoniSDKClient#submitvote) -- [submitVoteSteps](VocdoniSDKClient#submitvotesteps) -- [updateAccountInfo](VocdoniSDKClient#updateaccountinfo) -- [votesLeftCount](VocdoniSDKClient#votesleftcount) - [waitForTransaction](VocdoniSDKClient#waitfortransaction) - [generateWalletFromData](VocdoniSDKClient#generatewalletfromdata) +### Properties + +- [accountService](VocdoniSDKClient#accountservice) +- [anonymousService](VocdoniSDKClient#anonymousservice) +- [censusService](VocdoniSDKClient#censusservice) +- [chainService](VocdoniSDKClient#chainservice) +- [cspService](VocdoniSDKClient#cspservice) +- [electionId](VocdoniSDKClient#electionid) +- [electionService](VocdoniSDKClient#electionservice) +- [explorerUrl](VocdoniSDKClient#explorerurl) +- [faucetService](VocdoniSDKClient#faucetservice) +- [fileService](VocdoniSDKClient#fileservice) +- [url](VocdoniSDKClient#url) +- [voteService](VocdoniSDKClient#voteservice) +- [wallet](VocdoniSDKClient#wallet) + ## Constructors ### constructor @@ -97,7 +99,7 @@ To instantiate the client just pass the `ClientOptions` you want or empty object | Name | Type | Description | | :------ | :------ | :------ | -| `opts` | [`ClientOptions`](../modules#clientoptions) | optional arguments | +| `opts` | [`ClientOptions`](../sdk-reference#clientoptions) | optional arguments | #### Returns @@ -105,210 +107,130 @@ To instantiate the client just pass the `ClientOptions` you want or empty object #### Defined in -[client.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L127) - -## Properties - -### accountData - -• `Private` **accountData**: [`AccountData`](../modules.md#accountdata) \| [`ArchivedAccountData`](../modules#archivedaccountdata) = `null` - -#### Defined in - -[client.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L100) - -___ - -### accountService - -• **accountService**: [`AccountService`](AccountService) - -#### Defined in - -[client.ts:111](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L111) - -___ - -### anonymousService - -• **anonymousService**: [`AnonymousService`](AnonymousService) - -#### Defined in - -[client.ts:105](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L105) - -___ - -### censusService - -• **censusService**: [`CensusService`](CensusService) - -#### Defined in - -[client.ts:103](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L103) - -___ - -### chainService - -• **chainService**: [`ChainService`](ChainService) - -#### Defined in - -[client.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L104) - -___ - -### cspService - -• **cspService**: [`CspService`](CspService) - -#### Defined in - -[client.ts:106](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L106) - -___ - -### election - -• `Private` **election**: [`PublishedElection`](PublishedElection.md) \| [`UnpublishedElection`](UnpublishedElection) = `null` - -#### Defined in - -[client.ts:101](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L101) +[client.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L127) -___ - -### electionId - -• **electionId**: `string` - -#### Defined in - -[client.ts:115](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L115) +## Account Methods -___ +### createAccount -### electionService +▸ **createAccount**(`options?`): `Promise`\<[`AccountData`](../sdk-reference#accountdata)\> -• **electionService**: [`ElectionService`](ElectionService) - -#### Defined in +Registers an account against vochain, so it can create new elections. -[client.ts:107](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L107) +#### Parameters -___ +| Name | Type | Description | +| :------ | :------ | :------ | +| `options?` | `Object` | Additional options, like extra information of the account, or the faucet package string | +| `options.account?` | [`Account`](Account) | - | +| `options.faucetPackage?` | `string` | - | +| `options.password?` | `string` | - | +| `options.sik?` | `boolean` | - | -### explorerUrl +#### Returns -• **explorerUrl**: `string` +`Promise`\<[`AccountData`](../sdk-reference#accountdata)\> #### Defined in -[client.ts:116](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L116) +[client.ts:414](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L414) ___ -### faucetService +### createAccountInfo -• **faucetService**: [`FaucetService`](FaucetService) +▸ **createAccountInfo**(`options`): `Promise`\<[`AccountData`](../sdk-reference#accountdata)\> -#### Defined in +Creates an account with information. -[client.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L110) +#### Parameters -___ +| Name | Type | Description | +| :------ | :------ | :------ | +| `options` | `Object` | Additional options, like extra information of the account, or the faucet package string. | +| `options.account` | [`Account`](Account) | - | +| `options.faucetPackage?` | `string` | - | +| `options.password?` | `string` | - | +| `options.signedSikPayload?` | `string` | - | -### fileService +#### Returns -• **fileService**: [`FileService`](FileService) +`Promise`\<[`AccountData`](../sdk-reference#accountdata)\> #### Defined in -[client.ts:109](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L109) +[client.ts:325](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L325) ___ -### url +### fetchAccount -• **url**: `string` +▸ **fetchAccount**(`address?`): `Promise`\<[`AccountData`](../sdk-reference#accountdata)\> -#### Defined in +Fetches account. -[client.ts:113](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L113) +#### Parameters -___ +| Name | Type | Description | +| :------ | :------ | :------ | +| `address?` | `string` | The account address to fetch the information | -### voteService +#### Returns -• **voteService**: [`VoteService`](VoteService) +`Promise`\<[`AccountData`](../sdk-reference#accountdata)\> #### Defined in -[client.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L108) +[client.ts:195](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L195) ___ -### wallet - -• **wallet**: `Wallet` \| `Signer` - -#### Defined in - -[client.ts:114](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L114) - -## Methods - -### calcZKProofForWallet +### fetchAccountInfo -▸ **calcZKProofForWallet**(`election`, `wallet`, `signature`, `votePackage`, `password?`): `Promise`\<[`ZkProof`](../modules#zkproof)\> +▸ **fetchAccountInfo**(`address?`): `Promise`\<[`AccountData`](../sdk-reference.md#accountdata) \| [`ArchivedAccountData`](../sdk-reference#archivedaccountdata)\> -Calculates ZK proof from given wallet. +Fetches account information. #### Parameters -| Name | Type | Default value | +| Name | Type | Description | | :------ | :------ | :------ | -| `election` | [`PublishedElection`](PublishedElection) | `undefined` | -| `wallet` | `Wallet` \| `Signer` | `undefined` | -| `signature` | `string` | `undefined` | -| `votePackage` | `Buffer` | `undefined` | -| `password` | `string` | `'0'` | +| `address?` | `string` | The account address to fetch the information | #### Returns -`Promise`\<[`ZkProof`](../modules#zkproof)\> +`Promise`\<[`AccountData`](../sdk-reference.md#accountdata) \| [`ArchivedAccountData`](../sdk-reference#archivedaccountdata)\> #### Defined in -[client.ts:282](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L282) +[client.ts:178](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L178) ___ -### calculateCID +### updateAccountInfo -▸ **calculateCID**(`data`): `Promise`\<`string`\> +▸ **updateAccountInfo**(`account`): `Promise`\<[`AccountData`](../sdk-reference#accountdata)\> -Fetches the CID expected for the specified data content. +Updates an account with information #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `data` | `string` | The data of which we want the CID of | +| `account` | [`Account`](Account) | Account data. | #### Returns -`Promise`\<`string`\> - -Resulting CID +`Promise`\<[`AccountData`](../sdk-reference#accountdata)\> #### Defined in -[client.ts:1041](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L1041) +[client.ts:368](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L368) ___ +## Election Methods + ### calculateElectionCost ▸ **calculateElectionCost**(`election`): `Promise`\<`number`\> @@ -329,7 +251,7 @@ The cost in tokens. #### Defined in -[client.ts:1031](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L1031) +[client.ts:1032](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L1032) ___ @@ -351,7 +273,7 @@ Cancels an election. #### Defined in -[client.ts:620](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L620) +[client.ts:623](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L623) ___ @@ -375,22 +297,21 @@ Changes the census of an election. #### Defined in -[client.ts:666](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L666) +[client.ts:669](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L669) ___ -### changeElectionStatus +### continueElection -▸ **changeElectionStatus**(`electionId`, `newStatus`): `Promise`\<`void`\> +▸ **continueElection**(`electionId?`): `Promise`\<`void`\> -Changes the status of an election. +Continues an election. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `electionId` | `string` | The id of the election | -| `newStatus` | [`AllElectionStatus`](../modules#allelectionstatus) | The new status | +| `electionId?` | `string` | The id of the election | #### Returns @@ -398,485 +319,465 @@ Changes the status of an election. #### Defined in -[client.ts:641](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L641) +[client.ts:633](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L633) ___ -### collectFaucetTokens +### createElection -▸ **collectFaucetTokens**(`faucetPackage?`): `Promise`\<[`AccountData`](../modules#accountdata)\> +▸ **createElection**(`election`): `Promise`\<`string`\> -Calls the faucet to get new tokens. Only under development. +Creates a new voting election. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `faucetPackage?` | `string` | The faucet package | +| `election` | [`UnpublishedElection`](UnpublishedElection) | The election object to be created. | #### Returns -`Promise`\<[`AccountData`](../modules#accountdata)\> +`Promise`\<`string`\> -Account data information updated with new balance +Resulting election id. #### Defined in -[client.ts:480](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L480) +[client.ts:508](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L508) ___ -### continueElection +### createElectionSteps -▸ **continueElection**(`electionId?`): `Promise`\<`void`\> +▸ **createElectionSteps**(`election`): `AsyncGenerator`\<[`ElectionCreationStepValue`](../sdk-reference#electioncreationstepvalue), `any`, `unknown`\> -Continues an election. +Creates a new voting election by steps with async returns. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `electionId?` | `string` | The id of the election | +| `election` | [`UnpublishedElection`](UnpublishedElection) | The election object to be created. | #### Returns -`Promise`\<`void`\> +`AsyncGenerator`\<[`ElectionCreationStepValue`](../sdk-reference#electioncreationstepvalue), `any`, `unknown`\> + +The async step returns. #### Defined in -[client.ts:630](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L630) +[client.ts:525](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L525) ___ -### createAccount +### endElection -▸ **createAccount**(`options?`): `Promise`\<[`AccountData`](../modules#accountdata)\> +▸ **endElection**(`electionId?`): `Promise`\<`void`\> -Registers an account against vochain, so it can create new elections. +Ends an election. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `options?` | `Object` | Additional options, like extra information of the account, or the faucet package string | -| `options.account?` | [`Account`](Account) | - | -| `options.faucetPackage?` | `string` | - | -| `options.password?` | `string` | - | -| `options.sik?` | `boolean` | - | +| `electionId?` | `string` | The id of the election | #### Returns -`Promise`\<[`AccountData`](../modules#accountdata)\> +`Promise`\<`void`\> #### Defined in -[client.ts:412](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L412) +[client.ts:603](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L603) ___ -### createAccountInfo +### estimateElectionCost -▸ **createAccountInfo**(`options`): `Promise`\<[`AccountData`](../modules#accountdata)\> +▸ **estimateElectionCost**(`election`): `Promise`\<`number`\> -Creates an account with information. +Estimates the election cost #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `options` | `Object` | Additional options, like extra information of the account, or the faucet package string. | -| `options.account` | [`Account`](Account) | - | -| `options.faucetPackage?` | `string` | - | -| `options.password?` | `string` | - | -| `options.signedSikPayload?` | `string` | - | +| Name | Type | +| :------ | :------ | +| `election` | [`UnpublishedElection`](UnpublishedElection) | #### Returns -`Promise`\<[`AccountData`](../modules#accountdata)\> +`Promise`\<`number`\> + +The cost in tokens. #### Defined in -[client.ts:323](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L323) +[client.ts:1022](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L1022) ___ -### createCensus +### fetchElection -▸ **createCensus**(`census`): `Promise`\<`void`\> +▸ **fetchElection**(`electionId?`): `Promise`\<[`PublishedElection`](PublishedElection.md) \| [`ArchivedElection`](ArchivedElection)\> -Publishes the given census. +Fetches info about an election. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `census` | [`PlainCensus`](PlainCensus.md) \| [`WeightedCensus`](WeightedCensus) | The census to be published. | +| `electionId?` | `string` | The id of the election | #### Returns -`Promise`\<`void`\> +`Promise`\<[`PublishedElection`](PublishedElection.md) \| [`ArchivedElection`](ArchivedElection)\> #### Defined in -[client.ts:940](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L940) +[client.ts:221](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L221) ___ -### createElection +### fetchElections -▸ **createElection**(`election`): `Promise`\<`string`\> +▸ **fetchElections**(`account?`, `page?`): `Promise`\<([`PublishedElection`](PublishedElection.md) \| [`ArchivedElection`](ArchivedElection.md) \| [`InvalidElection`](InvalidElection))[]\> -Creates a new voting election. +Fetches info about all elections created by the given account #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `election` | [`UnpublishedElection`](UnpublishedElection) | The election object to be created. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `account?` | `string` | `undefined` | specify an account to search for. Otherwise client wallet address is used. | +| `page` | `number` | `0` | - | #### Returns -`Promise`\<`string`\> - -Resulting election id. +`Promise`\<([`PublishedElection`](PublishedElection.md) \| [`ArchivedElection`](ArchivedElection.md) \| [`InvalidElection`](InvalidElection))[]\> #### Defined in -[client.ts:506](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L506) +[client.ts:235](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L235) ___ -### createElectionSteps +### pauseElection -▸ **createElectionSteps**(`election`): `AsyncGenerator`\<[`ElectionCreationStepValue`](../modules#electioncreationstepvalue), `any`, `unknown`\> +▸ **pauseElection**(`electionId?`): `Promise`\<`void`\> -Creates a new voting election by steps with async returns. +Pauses an election. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `election` | [`UnpublishedElection`](UnpublishedElection) | The election object to be created. | +| `electionId?` | `string` | The id of the election | #### Returns -`AsyncGenerator`\<[`ElectionCreationStepValue`](../modules#electioncreationstepvalue), `any`, `unknown`\> - -The async step returns. +`Promise`\<`void`\> #### Defined in -[client.ts:522](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L522) +[client.ts:613](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L613) ___ -### cspInfo - -▸ **cspInfo**(): `Promise`\<`ICspInfoResponse`\> - -#### Returns - -`Promise`\<`ICspInfoResponse`\> - -#### Defined in - -[client.ts:979](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L979) - -___ +### setElectionId -### cspSign +▸ **setElectionId**(`electionId`): `void` -▸ **cspSign**(`address`, `token`): `Promise`\<`string`\> +Sets an election id. Required by other methods like submitVote or createElection. #### Parameters -| Name | Type | -| :------ | :------ | -| `address` | `string` | -| `token` | `string` | +| Name | Type | Description | +| :------ | :------ | :------ | +| `electionId` | `string` | Election id string | #### Returns -`Promise`\<`string`\> +`void` #### Defined in -[client.ts:990](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L990) +[client.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L168) ___ -### cspStep - -▸ **cspStep**(`stepNumber`, `data`, `authToken?`): `Promise`\<`ICspIntermediateStepResponse` \| `ICspFinalStepResponse`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `stepNumber` | `number` | -| `data` | `any`[] | -| `authToken?` | `string` | - -#### Returns - -`Promise`\<`ICspIntermediateStepResponse` \| `ICspFinalStepResponse`\> +## Voting Methods -#### Defined in +### hasAlreadyVoted -[client.ts:983](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L983) +▸ **hasAlreadyVoted**(`options?`): `Promise`\<`string`\> -___ +Checks if the user has already voted -### cspUrl +#### Parameters -▸ **cspUrl**(): `Promise`\<`string`\> +| Name | Type | Description | +| :------ | :------ | :------ | +| `options?` | `Partial`\<[`WalletOption`](../sdk-reference.md#walletoption) & [`ElectionIdOption`](../sdk-reference.md#electionidoption) & [`VoteIdOption`](../sdk-reference#voteidoption)\> | Options for has already voted | #### Returns `Promise`\<`string`\> +The id of the vote + #### Defined in -[client.ts:974](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L974) +[client.ts:715](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L715) ___ -### cspVote +### isAbleToVote -▸ **cspVote**(`vote`, `signature`, `proof_type?`): [`CspVote`](CspVote) +▸ **isAbleToVote**(`options?`): `Promise`\<`boolean`\> + +Checks if the user is able to vote #### Parameters -| Name | Type | -| :------ | :------ | -| `vote` | [`Vote`](Vote) | -| `signature` | `string` | -| `proof_type?` | [`CspProofType`](../enums/CspProofType) | +| Name | Type | Description | +| :------ | :------ | :------ | +| `options?` | `Partial`\<[`WalletOption`](../sdk-reference.md#walletoption) & [`ElectionIdOption`](../sdk-reference.md#electionidoption) & [`VoteIdOption`](../sdk-reference#voteidoption)\> | Options for is able to vote | #### Returns -[`CspVote`](CspVote) +`Promise`\<`boolean`\> #### Defined in -[client.ts:995](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L995) +[client.ts:747](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L747) ___ -### endElection +### isInCensus -▸ **endElection**(`electionId?`): `Promise`\<`void`\> +▸ **isInCensus**(`options?`): `Promise`\<`boolean`\> -Ends an election. +Checks if the user is in census. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `electionId?` | `string` | The id of the election | +| `options?` | `Partial`\<[`WalletOption`](../sdk-reference.md#walletoption) & [`ElectionIdOption`](../sdk-reference#electionidoption)\> | Options for is in census | #### Returns -`Promise`\<`void`\> +`Promise`\<`boolean`\> #### Defined in -[client.ts:600](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L600) +[client.ts:693](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L693) ___ -### estimateElectionCost +### submitVote -▸ **estimateElectionCost**(`election`): `Promise`\<`number`\> +▸ **submitVote**(`vote`): `Promise`\<`string`\> -Estimates the election cost +Submits a vote. #### Parameters -| Name | Type | -| :------ | :------ | -| `election` | [`UnpublishedElection`](UnpublishedElection) | +| Name | Type | Description | +| :------ | :------ | :------ | +| `vote` | [`Vote`](Vote.md) \| [`AnonymousVote`](AnonymousVote.md) \| [`CspVote`](CspVote) | The vote (or votes) to be sent. | #### Returns -`Promise`\<`number`\> +`Promise`\<`string`\> -The cost in tokens. +Vote confirmation id. #### Defined in -[client.ts:1022](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L1022) +[client.ts:795](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L795) ___ -### fetchAccount +### submitVoteSteps -▸ **fetchAccount**(`address?`): `Promise`\<[`AccountData`](../modules#accountdata)\> +▸ **submitVoteSteps**(`vote`): `AsyncGenerator`\<[`VoteStepValue`](../sdk-reference#votestepvalue), `any`, `unknown`\> -Fetches account. +Submits a vote by steps. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `address?` | `string` | The account address to fetch the information | +| `vote` | [`Vote`](Vote.md) \| [`AnonymousVote`](AnonymousVote.md) \| [`CspVote`](CspVote) | The vote (or votes) to be sent. | #### Returns -`Promise`\<[`AccountData`](../modules#accountdata)\> +`AsyncGenerator`\<[`VoteStepValue`](../sdk-reference#votestepvalue), `any`, `unknown`\> + +Vote confirmation id. #### Defined in -[client.ts:196](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L196) +[client.ts:812](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L812) ___ -### fetchAccountInfo +### votesLeftCount -▸ **fetchAccountInfo**(`address?`): `Promise`\<[`AccountData`](../modules.md#accountdata) \| [`ArchivedAccountData`](../modules#archivedaccountdata)\> +▸ **votesLeftCount**(`options?`): `Promise`\<`number`\> -Fetches account information. +Checks how many times a user can submit their vote #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `address?` | `string` | The account address to fetch the information | +| `options?` | `Partial`\<[`WalletOption`](../sdk-reference.md#walletoption) & [`ElectionIdOption`](../sdk-reference.md#electionidoption) & [`VoteIdOption`](../sdk-reference#voteidoption)\> | Options for votes left count | #### Returns -`Promise`\<[`AccountData`](../modules.md#accountdata) \| [`ArchivedAccountData`](../modules#archivedaccountdata)\> +`Promise`\<`number`\> #### Defined in -[client.ts:177](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L177) +[client.ts:757](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L757) ___ -### fetchCensusInfo +## Other Methods -▸ **fetchCensusInfo**(`censusId`): `Promise`\<\{ `size`: `number` ; `type`: [`CensusType`](../enums/CensusType) ; `weight`: `bigint` }\> +### calculateCID -Fetches the information of a given census. +▸ **calculateCID**(`data`): `Promise`\<`string`\> + +Fetches the CID expected for the specified data content. #### Parameters -| Name | Type | -| :------ | :------ | -| `censusId` | `string` | +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | `string` | The data of which we want the CID of | #### Returns -`Promise`\<\{ `size`: `number` ; `type`: [`CensusType`](../enums/CensusType) ; `weight`: `bigint` }\> +`Promise`\<`string`\> + +Resulting CID #### Defined in -[client.ts:950](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L950) +[client.ts:1042](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L1042) ___ -### fetchChainCosts +### collectFaucetTokens -▸ **fetchChainCosts**(): `Promise`\<[`IChainGetCostsResponse`](../interfaces/IChainGetCostsResponse)\> +▸ **collectFaucetTokens**(`faucetPackage?`): `Promise`\<[`AccountData`](../sdk-reference#accountdata)\> -Fetches blockchain costs information if needed. +Calls the faucet to get new tokens. Under development environments, if no faucet package is provided, one is created and tokens are allocated. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `faucetPackage?` | `string` | The faucet package | #### Returns -`Promise`\<[`IChainGetCostsResponse`](../interfaces/IChainGetCostsResponse)\> +`Promise`\<[`AccountData`](../sdk-reference#accountdata)\> + +Account data information updated with new balance #### Defined in -[client.ts:1004](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L1004) +[client.ts:481](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L481) ___ -### fetchChainId +### createCensus -▸ **fetchChainId**(): `Promise`\<`string`\> +▸ **createCensus**(`census`): `Promise`\<`void`\> -Fetches blockchain information if needed and returns the chain id. +Publishes the given census. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `census` | [`PlainCensus`](PlainCensus.md) \| [`WeightedCensus`](WeightedCensus) | The census to be published. | #### Returns -`Promise`\<`string`\> +`Promise`\<`void`\> #### Defined in -[client.ts:1013](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L1013) +[client.ts:944](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L944) ___ -### fetchCircuits - -▸ **fetchCircuits**(`circuits?`): `Promise`\<[`ChainCircuits`](../modules#chaincircuits)\> - -Fetches circuits for anonymous voting - -#### Parameters +### cspInfo -| Name | Type | Description | -| :------ | :------ | :------ | -| `circuits?` | `Omit`\<[`ChainCircuits`](../modules#chaincircuits), ``"zKeyData"`` \| ``"vKeyData"`` \| ``"wasmData"``\> | Additional options for custom circuits | +▸ **cspInfo**(): `Promise`\<`ICspInfoResponse`\> #### Returns -`Promise`\<[`ChainCircuits`](../modules#chaincircuits)\> +`Promise`\<`ICspInfoResponse`\> #### Defined in -[client.ts:960](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L960) +[client.ts:980](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L980) ___ -### fetchElection - -▸ **fetchElection**(`electionId?`): `Promise`\<[`PublishedElection`](PublishedElection.md) \| [`ArchivedElection`](ArchivedElection)\> +### cspSign -Fetches info about an election. +▸ **cspSign**(`address`, `token`): `Promise`\<`string`\> #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `electionId?` | `string` | The id of the election | +| Name | Type | +| :------ | :------ | +| `address` | `string` | +| `token` | `string` | #### Returns -`Promise`\<[`PublishedElection`](PublishedElection.md) \| [`ArchivedElection`](ArchivedElection)\> +`Promise`\<`string`\> #### Defined in -[client.ts:224](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L224) +[client.ts:991](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L991) ___ -### fetchElections +### cspStep -▸ **fetchElections**(`account?`, `page?`): `Promise`\<([`PublishedElection`](PublishedElection.md) \| [`ArchivedElection`](ArchivedElection.md) \| [`InvalidElection`](InvalidElection))[]\> +▸ **cspStep**(`stepNumber`, `data`, `authToken?`): `Promise`\<`ICspIntermediateStepResponse` \| `ICspFinalStepResponse`\> #### Parameters -| Name | Type | Default value | -| :------ | :------ | :------ | -| `account?` | `string` | `undefined` | -| `page` | `number` | `0` | +| Name | Type | +| :------ | :------ | +| `stepNumber` | `number` | +| `data` | `any`[] | +| `authToken?` | `string` | #### Returns -`Promise`\<([`PublishedElection`](PublishedElection.md) \| [`ArchivedElection`](ArchivedElection.md) \| [`InvalidElection`](InvalidElection))[]\> +`Promise`\<`ICspIntermediateStepResponse` \| `ICspFinalStepResponse`\> #### Defined in -[client.ts:231](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L231) +[client.ts:984](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L984) ___ -### fetchFaucetPayload - -▸ **fetchFaucetPayload**(): `Promise`\<`string`\> +### cspUrl -Fetches a faucet payload. Only for development. +▸ **cspUrl**(): `Promise`\<`string`\> #### Returns @@ -884,434 +785,405 @@ Fetches a faucet payload. Only for development. #### Defined in -[client.ts:1050](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L1050) +[client.ts:975](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L975) ___ -### fetchProof - -▸ **fetchProof**(`censusId`, `key`): `Promise`\<[`CensusProof`](../modules#censusproof)\> +### cspVote -Fetches proof that an address is part of the specified census. +▸ **cspVote**(`vote`, `signature`, `proof_type?`): [`CspVote`](CspVote) #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `censusId` | `string` | Census we want to check the address against | -| `key` | `string` | The address to be found | +| Name | Type | +| :------ | :------ | +| `vote` | [`Vote`](Vote) | +| `signature` | `string` | +| `proof_type?` | [`CspProofType`](../enums/CspProofType) | #### Returns -`Promise`\<[`CensusProof`](../modules#censusproof)\> +[`CspVote`](CspVote) #### Defined in -[client.ts:930](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L930) +[client.ts:996](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L996) ___ -### fetchProofForWallet +### fetchCensusInfo -▸ **fetchProofForWallet**(`censusId`, `wallet`): `Promise`\<[`CensusProof`](../modules#censusproof)\> +▸ **fetchCensusInfo**(`censusId`): `Promise`\<\{ `size`: `number` ; `type`: [`CensusType`](../enums/CensusType) ; `weight`: `bigint` }\> -Fetches proof that an address is part of the specified census. +Fetches the information of a given census. #### Parameters | Name | Type | | :------ | :------ | | `censusId` | `string` | -| `wallet` | `Wallet` \| `Signer` | #### Returns -`Promise`\<[`CensusProof`](../modules#censusproof)\> +`Promise`\<\{ `size`: `number` ; `type`: [`CensusType`](../enums/CensusType) ; `weight`: `bigint` }\> #### Defined in -[client.ts:245](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L245) +[client.ts:953](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L953) ___ -### generateRandomWallet +### fetchChainCosts -▸ **generateRandomWallet**(): `string` +▸ **fetchChainCosts**(): `Promise`\<[`IChainGetCostsResponse`](../interfaces/IChainGetCostsResponse)\> -Assigns a random Wallet to the client and returns its private key. +Fetches blockchain costs information if needed. #### Returns -`string` - -The private key. +`Promise`\<[`IChainGetCostsResponse`](../interfaces/IChainGetCostsResponse)\> #### Defined in -[client.ts:901](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L901) +[client.ts:1004](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L1004) ___ -### hasAlreadyVoted - -▸ **hasAlreadyVoted**(`options?`): `Promise`\<`string`\> - -Checks if the user has already voted +### fetchChainId -#### Parameters +▸ **fetchChainId**(): `Promise`\<`string`\> -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | `Partial`\<[`WalletOption`](../modules.md#walletoption) & [`ElectionIdOption`](../modules.md#electionidoption) & [`VoteIdOption`](../modules#voteidoption)\> | Options for has already voted | +Fetches blockchain information if needed and returns the chain id. #### Returns `Promise`\<`string`\> -The id of the vote - #### Defined in -[client.ts:711](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L711) +[client.ts:1012](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L1012) ___ -### isAbleToVote +### fetchCircuits -▸ **isAbleToVote**(`options?`): `Promise`\<`boolean`\> +▸ **fetchCircuits**(`circuits?`): `Promise`\<[`ChainCircuits`](../sdk-reference#chaincircuits)\> -Checks if the user is able to vote +Fetches circuits for anonymous voting #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `options?` | `Partial`\<[`WalletOption`](../modules.md#walletoption) & [`ElectionIdOption`](../modules.md#electionidoption) & [`VoteIdOption`](../modules#voteidoption)\> | Options for is able to vote | +| `circuits?` | `Omit`\<[`ChainCircuits`](../sdk-reference#chaincircuits), ``"zKeyData"`` \| ``"vKeyData"`` \| ``"wasmData"``\> | Additional options for custom circuits | #### Returns -`Promise`\<`boolean`\> +`Promise`\<[`ChainCircuits`](../sdk-reference#chaincircuits)\> #### Defined in -[client.ts:743](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L743) +[client.ts:962](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L962) ___ -### isInCensus - -▸ **isInCensus**(`options?`): `Promise`\<`boolean`\> - -Checks if the user is in census. +### fetchFaucetPayload -#### Parameters +▸ **fetchFaucetPayload**(): `Promise`\<`string`\> -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | `Partial`\<[`WalletOption`](../modules.md#walletoption) & [`ElectionIdOption`](../modules#electionidoption)\> | Options for is in census | +Fetches a faucet payload. Only for development. #### Returns -`Promise`\<`boolean`\> +`Promise`\<`string`\> #### Defined in -[client.ts:690](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L690) +[client.ts:1050](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L1050) ___ -### parseFaucetPackage +### fetchProof -▸ **parseFaucetPackage**(`faucetPackage`): [`FaucetPackage`](../modules#faucetpackage) +▸ **fetchProof**(`censusId`, `key`): `Promise`\<[`CensusProof`](../sdk-reference#censusproof)\> -Parses a faucet package. +Fetches proof that an address is part of the specified census. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `faucetPackage` | `string` | The encoded faucet package | +| `censusId` | `string` | Census we want to check the address against | +| `key` | `string` | The address to be found | #### Returns -[`FaucetPackage`](../modules#faucetpackage) +`Promise`\<[`CensusProof`](../sdk-reference#censusproof)\> #### Defined in -[client.ts:1061](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L1061) +[client.ts:935](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L935) ___ -### pauseElection - -▸ **pauseElection**(`electionId?`): `Promise`\<`void`\> - -Pauses an election. +### generateRandomWallet -#### Parameters +▸ **generateRandomWallet**(): `string` -| Name | Type | Description | -| :------ | :------ | :------ | -| `electionId?` | `string` | The id of the election | +Assigns a random Wallet to the client and returns its private key. #### Returns -`Promise`\<`void`\> +`string` + +The private key. #### Defined in -[client.ts:610](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L610) +[client.ts:907](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L907) ___ -### sendTokens +### parseFaucetPackage -▸ **sendTokens**(`options`): `Promise`\<`void`\> +▸ **parseFaucetPackage**(`faucetPackage`): [`FaucetPackage`](../sdk-reference#faucetpackage) -Send tokens from one account to another. +Parses a faucet package. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `options` | [`SendTokensOptions`](../modules#sendtokensoptions) | Options for send tokens | +| `faucetPackage` | `string` | The encoded faucet package | #### Returns -`Promise`\<`void`\> +[`FaucetPackage`](../sdk-reference#faucetpackage) #### Defined in -[client.ts:451](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L451) +[client.ts:1060](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L1060) ___ -### setAccountInfo +### sendTokens -▸ **setAccountInfo**(`promAccountData`): `Promise`\<[`AccountData`](../modules#accountdata)\> +▸ **sendTokens**(`options`): `Promise`\<`void`\> -Updates an account with information +Send tokens from one account to another. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `promAccountData` | `Promise`\<\{ `message`: `string` ; `metadata`: `string` ; `tx`: `Uint8Array` }\> | Account data promise in Tx form. | +| `options` | [`SendTokensOptions`](../sdk-reference#sendtokensoptions) | Options for send tokens | #### Returns -`Promise`\<[`AccountData`](../modules#accountdata)\> +`Promise`\<`void`\> #### Defined in -[client.ts:392](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L392) +[client.ts:452](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L452) ___ -### setAccountSIK +### setCircuits + +▸ **setCircuits**(`circuits`): [`ChainCircuits`](../sdk-reference#chaincircuits) -▸ **setAccountSIK**(`electionId`, `signature`, `password`, `censusProof`, `wallet`): `Promise`\<`void`\> +Sets circuits for anonymous voting #### Parameters -| Name | Type | -| :------ | :------ | -| `electionId` | `string` | -| `signature` | `string` | -| `password` | `string` | -| `censusProof` | [`CensusProof`](../modules#censusproof) | -| `wallet` | `Wallet` \| `Signer` | +| Name | Type | Description | +| :------ | :------ | :------ | +| `circuits` | [`ChainCircuits`](../sdk-reference#chaincircuits) | Custom circuits | #### Returns -`Promise`\<`void`\> +[`ChainCircuits`](../sdk-reference#chaincircuits) #### Defined in -[client.ts:249](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L249) +[client.ts:971](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L971) ___ -### setCircuits +### waitForTransaction -▸ **setCircuits**(`circuits`): [`ChainCircuits`](../modules#chaincircuits) +▸ **waitForTransaction**(`tx`, `wait?`, `attempts?`): `Promise`\<`void`\> -Sets circuits for anonymous voting +A convenience method to wait for a transaction to be executed. It will +loop trying to get the transaction information, and will retry every time +it fails. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `circuits` | [`ChainCircuits`](../modules#chaincircuits) | Custom circuits | +| `tx` | `string` | Transaction to wait for | +| `wait?` | `number` | The delay in milliseconds between tries | +| `attempts?` | `number` | The attempts to try before failing | #### Returns -[`ChainCircuits`](../modules#chaincircuits) +`Promise`\<`void`\> #### Defined in -[client.ts:970](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L970) +[client.ts:1073](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L1073) ___ -### setElectionId +### generateWalletFromData -▸ **setElectionId**(`electionId`): `void` +▸ **generateWalletFromData**(`data`): `Wallet` -Sets an election id. Required by other methods like submitVote or createElection. +Returns a Wallet based on the inputs. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `electionId` | `string` | Election id string | +| `data` | `string` \| `string`[] | The data inputs which should generate the Wallet | #### Returns -`void` +`Wallet` -#### Defined in +The deterministic wallet. -[client.ts:167](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L167) +#### Defined in -___ +[client.ts:919](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L919) -### submitVote +## Properties -▸ **submitVote**(`vote`): `Promise`\<`string`\> +### accountService -Submits a vote. +• **accountService**: [`AccountService`](AccountService) -#### Parameters +#### Defined in -| Name | Type | Description | -| :------ | :------ | :------ | -| `vote` | [`Vote`](Vote.md) \| [`AnonymousVote`](AnonymousVote.md) \| [`CspVote`](CspVote) | The vote (or votes) to be sent. | +[client.ts:111](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L111) -#### Returns +___ -`Promise`\<`string`\> +### anonymousService -Vote confirmation id. +• **anonymousService**: [`AnonymousService`](AnonymousService) #### Defined in -[client.ts:790](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L790) +[client.ts:105](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L105) ___ -### submitVoteSteps - -▸ **submitVoteSteps**(`vote`): `AsyncGenerator`\<[`VoteStepValue`](../modules#votestepvalue), `any`, `unknown`\> +### censusService -Submits a vote by steps. +• **censusService**: [`CensusService`](CensusService) -#### Parameters +#### Defined in -| Name | Type | Description | -| :------ | :------ | :------ | -| `vote` | [`Vote`](Vote.md) \| [`AnonymousVote`](AnonymousVote.md) \| [`CspVote`](CspVote) | The vote (or votes) to be sent. | +[client.ts:103](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L103) -#### Returns +___ -`AsyncGenerator`\<[`VoteStepValue`](../modules#votestepvalue), `any`, `unknown`\> +### chainService -Vote confirmation id. +• **chainService**: [`ChainService`](ChainService) #### Defined in -[client.ts:806](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L806) +[client.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L104) ___ -### updateAccountInfo +### cspService -▸ **updateAccountInfo**(`account`): `Promise`\<[`AccountData`](../modules#accountdata)\> +• **cspService**: [`CspService`](CspService) -Updates an account with information +#### Defined in -#### Parameters +[client.ts:106](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L106) -| Name | Type | Description | -| :------ | :------ | :------ | -| `account` | [`Account`](Account) | Account data. | +___ -#### Returns +### electionId -`Promise`\<[`AccountData`](../modules#accountdata)\> +• **electionId**: `string` #### Defined in -[client.ts:366](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L366) +[client.ts:115](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L115) ___ -### votesLeftCount +### electionService -▸ **votesLeftCount**(`options?`): `Promise`\<`number`\> +• **electionService**: [`ElectionService`](ElectionService) -Checks how many times a user can submit their vote +#### Defined in -#### Parameters +[client.ts:107](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L107) -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | `Partial`\<[`WalletOption`](../modules.md#walletoption) & [`ElectionIdOption`](../modules.md#electionidoption) & [`VoteIdOption`](../modules#voteidoption)\> | Options for votes left count | +___ -#### Returns +### explorerUrl -`Promise`\<`number`\> +• **explorerUrl**: `string` #### Defined in -[client.ts:753](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L753) +[client.ts:116](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L116) ___ -### waitForTransaction +### faucetService -▸ **waitForTransaction**(`tx`, `wait?`, `attempts?`): `Promise`\<`void`\> +• **faucetService**: [`FaucetService`](FaucetService) -A convenience method to wait for a transaction to be executed. It will -loop trying to get the transaction information, and will retry every time -it fails. +#### Defined in -#### Parameters +[client.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L110) -| Name | Type | Description | -| :------ | :------ | :------ | -| `tx` | `string` | Transaction to wait for | -| `wait?` | `number` | The delay in milliseconds between tries | -| `attempts?` | `number` | The attempts to try before failing | +___ -#### Returns +### fileService -`Promise`\<`void`\> +• **fileService**: [`FileService`](FileService) #### Defined in -[client.ts:1075](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L1075) +[client.ts:109](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L109) ___ -### generateWalletFromData +### url -▸ **generateWalletFromData**(`data`): `Wallet` +• **url**: `string` -Returns a Wallet based on the inputs. +#### Defined in -#### Parameters +[client.ts:113](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L113) -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `string` \| `string`[] | The data inputs which should generate the Wallet | +___ -#### Returns +### voteService -`Wallet` +• **voteService**: [`VoteService`](VoteService) -The deterministic wallet. +#### Defined in + +[client.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L108) + +___ + +### wallet + +• **wallet**: `Wallet` \| `Signer` #### Defined in -[client.ts:913](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L913) +[client.ts:114](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L114) diff --git a/docs/sdk/reference/classes/Vote.md b/docs/sdk/reference/classes/Vote.md index b642b441b..93dbda5fc 100644 --- a/docs/sdk/reference/classes/Vote.md +++ b/docs/sdk/reference/classes/Vote.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / Vote +[@vocdoni/sdk](/sdk) / Vote # Class: Vote @@ -14,76 +14,62 @@ Represents a vote ## Table of contents -### Constructors - -- [constructor](Vote#constructor) - -### Properties - -- [\_votes](Vote.md#_votes) - ### Accessors - [votes](Vote#votes) -## Constructors - -### constructor +### Constructors -• **new Vote**(`votes`): [`Vote`](Vote) +- [constructor](Vote#constructor) -Constructs a vote +## Accessors -#### Parameters +### votes -| Name | Type | Description | -| :------ | :------ | :------ | -| `votes` | (`number` \| `bigint`)[] | The list of votes values | +• `get` **votes**(): (`number` \| `bigint`)[] #### Returns -[`Vote`](Vote) +(`number` \| `bigint`)[] #### Defined in -[types/vote/vote.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/vote/vote.ts#L12) - -## Properties +[types/vote/vote.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/vote/vote.ts#L16) -### \_votes - -• `Private` **\_votes**: (`number` \| `bigint`)[] +• `set` **votes**(`value`): `void` -#### Defined in +#### Parameters -[types/vote/vote.ts:5](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/vote/vote.ts#L5) +| Name | Type | +| :------ | :------ | +| `value` | (`number` \| `bigint`)[] | -## Accessors +#### Returns -### votes +`void` -• `get` **votes**(): (`number` \| `bigint`)[] +#### Defined in -#### Returns +[types/vote/vote.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/vote/vote.ts#L20) -(`number` \| `bigint`)[] +## Constructors -#### Defined in +### constructor -[types/vote/vote.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/vote/vote.ts#L16) +• **new Vote**(`votes`): [`Vote`](Vote) -• `set` **votes**(`value`): `void` +Constructs a vote #### Parameters -| Name | Type | -| :------ | :------ | -| `value` | (`number` \| `bigint`)[] | +| Name | Type | Description | +| :------ | :------ | :------ | +| `votes` | (`number` \| `bigint`)[] | The list of votes values | #### Returns -`void` +[`Vote`](Vote) #### Defined in -[types/vote/vote.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/vote/vote.ts#L20) +[types/vote/vote.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/vote/vote.ts#L12) diff --git a/docs/sdk/reference/classes/VoteAPI.md b/docs/sdk/reference/classes/VoteAPI.md index aba6dfdc0..33eb17e96 100644 --- a/docs/sdk/reference/classes/VoteAPI.md +++ b/docs/sdk/reference/classes/VoteAPI.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / VoteAPI +[@vocdoni/sdk](/sdk) / VoteAPI # Class: VoteAPI @@ -10,38 +10,12 @@ ## Table of contents -### Constructors - -- [constructor](VoteAPI#constructor) - ### Methods - [info](VoteAPI#info) -- [isApiError](VoteAPI#isapierror) -- [isUndefinedError](VoteAPI#isundefinederror) - [submit](VoteAPI#submit) - [verify](VoteAPI#verify) -## Constructors - -### constructor - -• **new VoteAPI**(): [`VoteAPI`](VoteAPI) - -Cannot be constructed. - -#### Returns - -[`VoteAPI`](VoteAPI) - -#### Overrides - -API.constructor - -#### Defined in - -[api/vote.ts:78](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/vote.ts#L78) - ## Methods ### info @@ -63,56 +37,7 @@ Vote info #### Defined in -[api/vote.ts:105](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/vote.ts#L105) - -___ - -### isApiError - -▸ **isApiError**(`error`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `AxiosError`\<`unknown`, `any`\> | - -#### Returns - -`never` - -#### Inherited from - -API.isApiError - -#### Defined in - -[api/api.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/api.ts#L21) - -___ - -### isUndefinedError - -▸ **isUndefinedError**(`error`, `message?`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `AxiosError`\<`unknown`, `any`\> | -| `message?` | `string` | - -#### Returns - -`never` - -#### Inherited from - -API.isUndefinedError - -#### Defined in - -[api/api.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/api.ts#L64) +[api/vote.ts:103](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/vote.ts#L103) ___ @@ -135,7 +60,7 @@ Voting #### Defined in -[api/vote.ts:90](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/vote.ts#L90) +[api/vote.ts:89](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/vote.ts#L89) ___ @@ -161,4 +86,4 @@ Return true if response has status 200 #### Defined in -[api/vote.ts:121](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/vote.ts#L121) +[api/vote.ts:119](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/vote.ts#L119) diff --git a/docs/sdk/reference/classes/VoteService.md b/docs/sdk/reference/classes/VoteService.md index 2847f71d9..7af010d5e 100644 --- a/docs/sdk/reference/classes/VoteService.md +++ b/docs/sdk/reference/classes/VoteService.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / VoteService +[@vocdoni/sdk](/sdk) / VoteService # Class: VoteService @@ -18,11 +18,6 @@ - [constructor](VoteService#constructor) -### Properties - -- [chainService](VoteService#chainservice) -- [url](VoteService#url) - ### Methods - [encodeTransaction](VoteService#encodetransaction) @@ -30,6 +25,11 @@ - [signTransaction](VoteService#signtransaction) - [vote](VoteService#vote) +### Properties + +- [chainService](VoteService#chainservice) +- [url](VoteService#url) + ## Constructors ### constructor @@ -50,39 +50,11 @@ Instantiate the election service. #### Overrides -[Service](Service.md).[constructor](Service#constructor) - -#### Defined in - -[services/vote.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/vote.ts#L45) - -## Properties - -### chainService - -• **chainService**: [`ChainService`](ChainService) - -#### Implementation of - -VoteServiceProperties.chainService - -#### Defined in - -[services/vote.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/vote.ts#L38) - -___ - -### url - -• **url**: `string` - -#### Inherited from - -[Service](Service.md).[url](Service#url) +Service.constructor #### Defined in -[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/service.ts#L6) +[services/vote.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/vote.ts#L45) ## Methods @@ -102,7 +74,7 @@ ___ #### Defined in -[services/vote.ts:58](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/vote.ts#L58) +[services/vote.ts:58](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/vote.ts#L58) ___ @@ -124,7 +96,7 @@ Get the vote information #### Defined in -[services/vote.ts:69](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/vote.ts#L69) +[services/vote.ts:68](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/vote.ts#L68) ___ @@ -146,7 +118,7 @@ ___ #### Defined in -[services/vote.ts:50](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/vote.ts#L50) +[services/vote.ts:50](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/vote.ts#L50) ___ @@ -168,4 +140,32 @@ Submit the vote to the chain #### Defined in -[services/vote.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/vote.ts#L81) +[services/vote.ts:79](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/vote.ts#L79) + +## Properties + +### chainService + +• **chainService**: [`ChainService`](ChainService) + +#### Implementation of + +VoteServiceProperties.chainService + +#### Defined in + +[services/vote.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/vote.ts#L38) + +___ + +### url + +• **url**: `string` + +#### Inherited from + +[Service](Service.md).[url](Service#url) + +#### Defined in + +[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/service.ts#L6) diff --git a/docs/sdk/reference/classes/WalletAPI.md b/docs/sdk/reference/classes/WalletAPI.md index bbae67ae8..5fb608baa 100644 --- a/docs/sdk/reference/classes/WalletAPI.md +++ b/docs/sdk/reference/classes/WalletAPI.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / WalletAPI +[@vocdoni/sdk](/sdk) / WalletAPI # Class: WalletAPI @@ -10,35 +10,9 @@ ## Table of contents -### Constructors - -- [constructor](WalletAPI#constructor) - ### Methods - [add](WalletAPI#add) -- [isApiError](WalletAPI#isapierror) -- [isUndefinedError](WalletAPI#isundefinederror) - -## Constructors - -### constructor - -• **new WalletAPI**(): [`WalletAPI`](WalletAPI) - -Cannot be constructed. - -#### Returns - -[`WalletAPI`](WalletAPI) - -#### Overrides - -API.constructor - -#### Defined in - -[api/wallet.ts:25](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/wallet.ts#L25) ## Methods @@ -59,53 +33,4 @@ API.constructor #### Defined in -[api/wallet.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/wallet.ts#L29) - -___ - -### isApiError - -▸ **isApiError**(`error`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `AxiosError`\<`unknown`, `any`\> | - -#### Returns - -`never` - -#### Inherited from - -API.isApiError - -#### Defined in - -[api/api.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/api.ts#L21) - -___ - -### isUndefinedError - -▸ **isUndefinedError**(`error`, `message?`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `AxiosError`\<`unknown`, `any`\> | -| `message?` | `string` | - -#### Returns - -`never` - -#### Inherited from - -API.isUndefinedError - -#### Defined in - -[api/api.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/api.ts#L64) +[api/wallet.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/wallet.ts#L29) diff --git a/docs/sdk/reference/classes/WeightedCensus.md b/docs/sdk/reference/classes/WeightedCensus.md index d8a137cec..338ddd019 100644 --- a/docs/sdk/reference/classes/WeightedCensus.md +++ b/docs/sdk/reference/classes/WeightedCensus.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / WeightedCensus +[@vocdoni/sdk](/sdk) / WeightedCensus # Class: WeightedCensus @@ -12,16 +12,6 @@ Represents a weighted census ## Table of contents -### Constructors - -- [constructor](WeightedCensus#constructor) - -### Properties - -- [\_censusId](WeightedCensus.md#_censusid) -- [\_censusURI](WeightedCensus.md#_censusuri) -- [\_type](WeightedCensus.md#_type) - ### Accessors - [censusId](WeightedCensus#censusid) @@ -32,77 +22,16 @@ Represents a weighted census - [type](WeightedCensus#type) - [weight](WeightedCensus#weight) +### Constructors + +- [constructor](WeightedCensus#constructor) + ### Methods - [add](WeightedCensus#add) -- [addParticipants](WeightedCensus#addparticipants) -- [checkParticipant](WeightedCensus#checkparticipant) - [remove](WeightedCensus#remove) -- [removeParticipant](WeightedCensus#removeparticipant) - [censusTypeFromCensusOrigin](WeightedCensus#censustypefromcensusorigin) -## Constructors - -### constructor - -• **new WeightedCensus**(): [`WeightedCensus`](WeightedCensus) - -Constructs a weighted census - -#### Returns - -[`WeightedCensus`](WeightedCensus) - -#### Overrides - -[OffchainCensus](OffchainCensus.md).[constructor](OffchainCensus#constructor) - -#### Defined in - -[types/census/weighted.ts:10](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/weighted.ts#L10) - -## Properties - -### \_censusId - -• `Protected` **\_censusId**: `string` - -#### Inherited from - -[OffchainCensus](OffchainCensus).[_censusId](OffchainCensus.md#_censusid) - -#### Defined in - -[types/census/census.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L12) - -___ - -### \_censusURI - -• `Protected` **\_censusURI**: `string` - -#### Inherited from - -[OffchainCensus](OffchainCensus).[_censusURI](OffchainCensus.md#_censusuri) - -#### Defined in - -[types/census/census.ts:13](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L13) - -___ - -### \_type - -• `Protected` **\_type**: [`CensusType`](../enums/CensusType) - -#### Inherited from - -[OffchainCensus](OffchainCensus).[_type](OffchainCensus.md#_type) - -#### Defined in - -[types/census/census.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L14) - ## Accessors ### censusId @@ -119,7 +48,7 @@ OffchainCensus.censusId #### Defined in -[types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L35) +[types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L35) • `set` **censusId**(`value`): `void` @@ -139,7 +68,7 @@ OffchainCensus.censusId #### Defined in -[types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L39) +[types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L39) ___ @@ -157,7 +86,7 @@ OffchainCensus.censusURI #### Defined in -[types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L43) +[types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L43) • `set` **censusURI**(`value`): `void` @@ -177,7 +106,7 @@ OffchainCensus.censusURI #### Defined in -[types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L47) +[types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L47) ___ @@ -195,7 +124,7 @@ OffchainCensus.isPublished #### Defined in -[types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L75) +[types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L75) ___ @@ -213,7 +142,7 @@ OffchainCensus.participants #### Defined in -[types/census/offchain.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/offchain.ts#L45) +[types/census/offchain.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/offchain.ts#L45) • `set` **participants**(`value`): `void` @@ -233,7 +162,7 @@ OffchainCensus.participants #### Defined in -[types/census/offchain.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/offchain.ts#L49) +[types/census/offchain.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/offchain.ts#L49) ___ @@ -251,7 +180,7 @@ OffchainCensus.size #### Defined in -[types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L59) +[types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L59) • `set` **size**(`value`): `void` @@ -271,7 +200,7 @@ OffchainCensus.size #### Defined in -[types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L63) +[types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L63) ___ @@ -289,7 +218,7 @@ OffchainCensus.type #### Defined in -[types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L51) +[types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L51) • `set` **type**(`value`): `void` @@ -309,7 +238,7 @@ OffchainCensus.type #### Defined in -[types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L55) +[types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L55) ___ @@ -327,7 +256,7 @@ OffchainCensus.weight #### Defined in -[types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L67) +[types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L67) • `set` **weight**(`value`): `void` @@ -347,75 +276,47 @@ OffchainCensus.weight #### Defined in -[types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L71) +[types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L71) -## Methods - -### add - -▸ **add**(`participants`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `participants` | [`ICensusParticipant`](../interfaces/ICensusParticipant.md) \| [`ICensusParticipant`](../interfaces/ICensusParticipant)[] | - -#### Returns - -`void` - -#### Defined in - -[types/census/weighted.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/weighted.ts#L14) - -___ - -### addParticipants +## Constructors -▸ **addParticipants**(`participants`): `void` +### constructor -#### Parameters +• **new WeightedCensus**(): [`WeightedCensus`](WeightedCensus) -| Name | Type | -| :------ | :------ | -| `participants` | [`ICensusParticipant`](../interfaces/ICensusParticipant.md) \| [`ICensusParticipant`](../interfaces/ICensusParticipant)[] | +Constructs a weighted census #### Returns -`void` +[`WeightedCensus`](WeightedCensus) -#### Inherited from +#### Overrides -[OffchainCensus](OffchainCensus.md).[addParticipants](OffchainCensus#addparticipants) +OffchainCensus.constructor #### Defined in -[types/census/offchain.ts:25](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/offchain.ts#L25) +[types/census/weighted.ts:10](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/weighted.ts#L10) -___ +## Methods -### checkParticipant +### add -▸ **checkParticipant**(`participant`): [`ICensusParticipant`](../interfaces/ICensusParticipant) +▸ **add**(`participants`): `void` #### Parameters | Name | Type | | :------ | :------ | -| `participant` | [`ICensusParticipant`](../interfaces/ICensusParticipant) | +| `participants` | [`ICensusParticipant`](../interfaces/ICensusParticipant.md) \| [`ICensusParticipant`](../interfaces/ICensusParticipant)[] | #### Returns -[`ICensusParticipant`](../interfaces/ICensusParticipant) - -#### Inherited from - -[OffchainCensus](OffchainCensus.md).[checkParticipant](OffchainCensus#checkparticipant) +`void` #### Defined in -[types/census/offchain.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/offchain.ts#L35) +[types/census/weighted.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/weighted.ts#L14) ___ @@ -435,31 +336,7 @@ ___ #### Defined in -[types/census/weighted.ts:18](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/weighted.ts#L18) - -___ - -### removeParticipant - -▸ **removeParticipant**(`key`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | - -#### Returns - -`void` - -#### Inherited from - -[OffchainCensus](OffchainCensus.md).[removeParticipant](OffchainCensus#removeparticipant) - -#### Defined in - -[types/census/offchain.ts:41](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/offchain.ts#L41) +[types/census/weighted.ts:18](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/weighted.ts#L18) ___ @@ -484,4 +361,4 @@ ___ #### Defined in -[types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L81) +[types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L81) diff --git a/docs/sdk/reference/enums/CensusOrigin.md b/docs/sdk/reference/enums/CensusOrigin.md index b727aa6b8..03867db6f 100644 --- a/docs/sdk/reference/enums/CensusOrigin.md +++ b/docs/sdk/reference/enums/CensusOrigin.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / CensusOrigin +[@vocdoni/sdk](/sdk) / CensusOrigin # Enumeration: CensusOrigin @@ -25,7 +25,7 @@ #### Defined in -[api/chain/transactions.ts:234](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L234) +[api/chain/transactions.ts:234](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L234) ___ @@ -35,7 +35,7 @@ ___ #### Defined in -[api/chain/transactions.ts:240](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L240) +[api/chain/transactions.ts:240](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L240) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -[api/chain/transactions.ts:238](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L238) +[api/chain/transactions.ts:238](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L238) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -[api/chain/transactions.ts:239](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L239) +[api/chain/transactions.ts:239](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L239) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -[api/chain/transactions.ts:241](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L241) +[api/chain/transactions.ts:241](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L241) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[api/chain/transactions.ts:242](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L242) +[api/chain/transactions.ts:242](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L242) ___ @@ -85,7 +85,7 @@ ___ #### Defined in -[api/chain/transactions.ts:237](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L237) +[api/chain/transactions.ts:237](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L237) ___ @@ -95,7 +95,7 @@ ___ #### Defined in -[api/chain/transactions.ts:235](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L235) +[api/chain/transactions.ts:235](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L235) ___ @@ -105,7 +105,7 @@ ___ #### Defined in -[api/chain/transactions.ts:236](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L236) +[api/chain/transactions.ts:236](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L236) ___ @@ -115,4 +115,4 @@ ___ #### Defined in -[api/chain/transactions.ts:243](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L243) +[api/chain/transactions.ts:243](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L243) diff --git a/docs/sdk/reference/enums/CensusType.md b/docs/sdk/reference/enums/CensusType.md index 2c9266b3e..68f69e0a8 100644 --- a/docs/sdk/reference/enums/CensusType.md +++ b/docs/sdk/reference/enums/CensusType.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / CensusType +[@vocdoni/sdk](/sdk) / CensusType # Enumeration: CensusType @@ -19,7 +19,7 @@ #### Defined in -[types/census/census.ts:3](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L3) +[types/census/census.ts:3](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L3) ___ @@ -29,7 +29,7 @@ ___ #### Defined in -[types/census/census.ts:4](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L4) +[types/census/census.ts:4](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L4) ___ @@ -39,7 +39,7 @@ ___ #### Defined in -[types/census/census.ts:5](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L5) +[types/census/census.ts:5](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L5) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[types/census/census.ts:2](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/census.ts#L2) +[types/census/census.ts:2](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/census.ts#L2) diff --git a/docs/sdk/reference/enums/CensusTypeEnum.md b/docs/sdk/reference/enums/CensusTypeEnum.md index 7d5fc43c6..8775ebb5f 100644 --- a/docs/sdk/reference/enums/CensusTypeEnum.md +++ b/docs/sdk/reference/enums/CensusTypeEnum.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / CensusTypeEnum +[@vocdoni/sdk](/sdk) / CensusTypeEnum # Enumeration: CensusTypeEnum @@ -24,7 +24,7 @@ #### Defined in -[api/election.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L150) +[api/election.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L150) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[api/election.ts:156](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L156) +[api/election.ts:156](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L156) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[api/election.ts:154](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L154) +[api/election.ts:154](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L154) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[api/election.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L155) +[api/election.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L155) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[api/election.ts:157](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L157) +[api/election.ts:157](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L157) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[api/election.ts:158](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L158) +[api/election.ts:158](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L158) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[api/election.ts:153](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L153) +[api/election.ts:153](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L153) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[api/election.ts:151](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L151) +[api/election.ts:151](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L151) ___ @@ -104,4 +104,4 @@ ___ #### Defined in -[api/election.ts:152](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L152) +[api/election.ts:152](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L152) diff --git a/docs/sdk/reference/enums/CspProofType.md b/docs/sdk/reference/enums/CspProofType.md index 7ee30ea6f..8e682c2b8 100644 --- a/docs/sdk/reference/enums/CspProofType.md +++ b/docs/sdk/reference/enums/CspProofType.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / CspProofType +[@vocdoni/sdk](/sdk) / CspProofType # Enumeration: CspProofType @@ -19,7 +19,7 @@ #### Defined in -[services/csp.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/csp.ts#L15) +[services/csp.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/csp.ts#L15) ___ @@ -29,7 +29,7 @@ ___ #### Defined in -[services/csp.ts:17](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/csp.ts#L17) +[services/csp.ts:17](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/csp.ts#L17) ___ @@ -39,7 +39,7 @@ ___ #### Defined in -[services/csp.ts:18](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/csp.ts#L18) +[services/csp.ts:18](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/csp.ts#L18) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[services/csp.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/csp.ts#L16) +[services/csp.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/csp.ts#L16) diff --git a/docs/sdk/reference/enums/ElectionCreationSteps.md b/docs/sdk/reference/enums/ElectionCreationSteps.md index f36379fda..66533615b 100644 --- a/docs/sdk/reference/enums/ElectionCreationSteps.md +++ b/docs/sdk/reference/enums/ElectionCreationSteps.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ElectionCreationSteps +[@vocdoni/sdk](/sdk) / ElectionCreationSteps # Enumeration: ElectionCreationSteps @@ -23,7 +23,7 @@ #### Defined in -[services/election.ts:41](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L41) +[services/election.ts:41](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/election.ts#L41) ___ @@ -33,7 +33,7 @@ ___ #### Defined in -[services/election.ts:46](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L46) +[services/election.ts:46](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/election.ts#L46) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -[services/election.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L47) +[services/election.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/election.ts#L47) ___ @@ -53,7 +53,7 @@ ___ #### Defined in -[services/election.ts:44](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L44) +[services/election.ts:44](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/election.ts#L44) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[services/election.ts:42](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L42) +[services/election.ts:42](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/election.ts#L42) ___ @@ -73,7 +73,7 @@ ___ #### Defined in -[services/election.ts:40](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L40) +[services/election.ts:40](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/election.ts#L40) ___ @@ -83,7 +83,7 @@ ___ #### Defined in -[services/election.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L43) +[services/election.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/election.ts#L43) ___ @@ -93,4 +93,4 @@ ___ #### Defined in -[services/election.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L45) +[services/election.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/election.ts#L45) diff --git a/docs/sdk/reference/enums/ElectionResultsTypeNames.md b/docs/sdk/reference/enums/ElectionResultsTypeNames.md index 82982f687..1f462fbc1 100644 --- a/docs/sdk/reference/enums/ElectionResultsTypeNames.md +++ b/docs/sdk/reference/enums/ElectionResultsTypeNames.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ElectionResultsTypeNames +[@vocdoni/sdk](/sdk) / ElectionResultsTypeNames # Enumeration: ElectionResultsTypeNames @@ -19,7 +19,7 @@ #### Defined in -[types/metadata/election.ts:41](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/election.ts#L41) +[types/metadata/election.ts:41](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/election.ts#L41) ___ @@ -29,7 +29,7 @@ ___ #### Defined in -[types/metadata/election.ts:40](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/election.ts#L40) +[types/metadata/election.ts:40](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/election.ts#L40) ___ @@ -39,7 +39,7 @@ ___ #### Defined in -[types/metadata/election.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/election.ts#L39) +[types/metadata/election.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/election.ts#L39) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[types/metadata/election.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/election.ts#L38) +[types/metadata/election.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/election.ts#L38) diff --git a/docs/sdk/reference/enums/ElectionStatus.md b/docs/sdk/reference/enums/ElectionStatus.md index a08ec7326..bec0ce43d 100644 --- a/docs/sdk/reference/enums/ElectionStatus.md +++ b/docs/sdk/reference/enums/ElectionStatus.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ElectionStatus +[@vocdoni/sdk](/sdk) / ElectionStatus # Enumeration: ElectionStatus @@ -22,7 +22,7 @@ #### Defined in -[types/election/published.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L15) +[types/election/published.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L15) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[types/election/published.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L14) +[types/election/published.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L14) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[types/election/published.ts:13](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L13) +[types/election/published.ts:13](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L13) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[types/election/published.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L16) +[types/election/published.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L16) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[types/election/published.ts:11](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L11) +[types/election/published.ts:11](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L11) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[types/election/published.ts:17](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L17) +[types/election/published.ts:17](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L17) ___ @@ -82,4 +82,4 @@ ___ #### Defined in -[types/election/published.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L12) +[types/election/published.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L12) diff --git a/docs/sdk/reference/enums/ElectionStatusReady.md b/docs/sdk/reference/enums/ElectionStatusReady.md index 2acc3b284..0975e9a13 100644 --- a/docs/sdk/reference/enums/ElectionStatusReady.md +++ b/docs/sdk/reference/enums/ElectionStatusReady.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ElectionStatusReady +[@vocdoni/sdk](/sdk) / ElectionStatusReady # Enumeration: ElectionStatusReady @@ -16,4 +16,4 @@ #### Defined in -[types/election/published.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L21) +[types/election/published.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L21) diff --git a/docs/sdk/reference/enums/EnvOptions.md b/docs/sdk/reference/enums/EnvOptions.md index 08f7b3a74..0d1223e8c 100644 --- a/docs/sdk/reference/enums/EnvOptions.md +++ b/docs/sdk/reference/enums/EnvOptions.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / EnvOptions +[@vocdoni/sdk](/sdk) / EnvOptions # Enumeration: EnvOptions @@ -18,7 +18,7 @@ #### Defined in -[client.ts:58](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L58) +[client.ts:58](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L58) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[client.ts:60](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L60) +[client.ts:60](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L60) ___ @@ -38,4 +38,4 @@ ___ #### Defined in -[client.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L59) +[client.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L59) diff --git a/docs/sdk/reference/enums/TransactionType.md b/docs/sdk/reference/enums/TransactionType.md index a3a847060..fbd73cd2c 100644 --- a/docs/sdk/reference/enums/TransactionType.md +++ b/docs/sdk/reference/enums/TransactionType.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / TransactionType +[@vocdoni/sdk](/sdk) / TransactionType # Enumeration: TransactionType @@ -26,7 +26,7 @@ #### Defined in -[api/chain.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L168) +[api/chain.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L168) ___ @@ -36,7 +36,7 @@ ___ #### Defined in -[api/chain.ts:175](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L175) +[api/chain.ts:175](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L175) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[api/chain.ts:171](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L171) +[api/chain.ts:171](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L171) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[api/chain.ts:167](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L167) +[api/chain.ts:167](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L167) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[api/chain.ts:170](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L170) +[api/chain.ts:170](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L170) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[api/chain.ts:172](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L172) +[api/chain.ts:172](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L172) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[api/chain.ts:174](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L174) +[api/chain.ts:174](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L174) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[api/chain.ts:176](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L176) +[api/chain.ts:176](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L176) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[api/chain.ts:169](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L169) +[api/chain.ts:169](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L169) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[api/chain.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L173) +[api/chain.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L173) ___ @@ -126,4 +126,4 @@ ___ #### Defined in -[api/chain.ts:166](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L166) +[api/chain.ts:166](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L166) diff --git a/docs/sdk/reference/enums/TxType.md b/docs/sdk/reference/enums/TxType.md index eb6fef2b2..67a65f1ea 100644 --- a/docs/sdk/reference/enums/TxType.md +++ b/docs/sdk/reference/enums/TxType.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / TxType +[@vocdoni/sdk](/sdk) / TxType # Enumeration: TxType @@ -40,7 +40,7 @@ #### Defined in -[api/chain/transactions.ts:331](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L331) +[api/chain/transactions.ts:331](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L331) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -[api/chain/transactions.ts:334](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L334) +[api/chain/transactions.ts:334](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L334) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[api/chain/transactions.ts:320](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L320) +[api/chain/transactions.ts:320](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L320) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -[api/chain/transactions.ts:318](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L318) +[api/chain/transactions.ts:318](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L318) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[api/chain/transactions.ts:322](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L322) +[api/chain/transactions.ts:322](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L322) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[api/chain/transactions.ts:333](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L333) +[api/chain/transactions.ts:333](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L333) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[api/chain/transactions.ts:336](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L336) +[api/chain/transactions.ts:336](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L336) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[api/chain/transactions.ts:335](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L335) +[api/chain/transactions.ts:335](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L335) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[api/chain/transactions.ts:332](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L332) +[api/chain/transactions.ts:332](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L332) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[api/chain/transactions.ts:327](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L327) +[api/chain/transactions.ts:327](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L327) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[api/chain/transactions.ts:314](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L314) +[api/chain/transactions.ts:314](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L314) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[api/chain/transactions.ts:326](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L326) +[api/chain/transactions.ts:326](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L326) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[api/chain/transactions.ts:321](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L321) +[api/chain/transactions.ts:321](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L321) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[api/chain/transactions.ts:323](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L323) +[api/chain/transactions.ts:323](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L323) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[api/chain/transactions.ts:319](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L319) +[api/chain/transactions.ts:319](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L319) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[api/chain/transactions.ts:328](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L328) +[api/chain/transactions.ts:328](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L328) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -[api/chain/transactions.ts:330](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L330) +[api/chain/transactions.ts:330](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L330) ___ @@ -210,7 +210,7 @@ ___ #### Defined in -[api/chain/transactions.ts:316](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L316) +[api/chain/transactions.ts:316](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L316) ___ @@ -220,7 +220,7 @@ ___ #### Defined in -[api/chain/transactions.ts:317](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L317) +[api/chain/transactions.ts:317](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L317) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -[api/chain/transactions.ts:325](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L325) +[api/chain/transactions.ts:325](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L325) ___ @@ -240,7 +240,7 @@ ___ #### Defined in -[api/chain/transactions.ts:315](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L315) +[api/chain/transactions.ts:315](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L315) ___ @@ -250,7 +250,7 @@ ___ #### Defined in -[api/chain/transactions.ts:329](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L329) +[api/chain/transactions.ts:329](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L329) ___ @@ -260,7 +260,7 @@ ___ #### Defined in -[api/chain/transactions.ts:313](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L313) +[api/chain/transactions.ts:313](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L313) ___ @@ -270,7 +270,7 @@ ___ #### Defined in -[api/chain/transactions.ts:337](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L337) +[api/chain/transactions.ts:337](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L337) ___ @@ -280,4 +280,4 @@ ___ #### Defined in -[api/chain/transactions.ts:324](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L324) +[api/chain/transactions.ts:324](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L324) diff --git a/docs/sdk/reference/enums/VoteSteps.md b/docs/sdk/reference/enums/VoteSteps.md index 918a91a60..924073f52 100644 --- a/docs/sdk/reference/enums/VoteSteps.md +++ b/docs/sdk/reference/enums/VoteSteps.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / VoteSteps +[@vocdoni/sdk](/sdk) / VoteSteps # Enumeration: VoteSteps @@ -22,7 +22,7 @@ #### Defined in -[services/vote.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/vote.ts#L22) +[services/vote.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/vote.ts#L22) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[services/vote.ts:25](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/vote.ts#L25) +[services/vote.ts:25](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/vote.ts#L25) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[services/vote.ts:23](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/vote.ts#L23) +[services/vote.ts:23](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/vote.ts#L23) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[services/vote.ts:19](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/vote.ts#L19) +[services/vote.ts:19](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/vote.ts#L19) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[services/vote.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/vote.ts#L20) +[services/vote.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/vote.ts#L20) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[services/vote.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/vote.ts#L21) +[services/vote.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/vote.ts#L21) ___ @@ -82,4 +82,4 @@ ___ #### Defined in -[services/vote.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/vote.ts#L24) +[services/vote.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/vote.ts#L24) diff --git a/docs/sdk/reference/interfaces/AccountMetadata.md b/docs/sdk/reference/interfaces/AccountMetadata.md index f59d03c82..da4966077 100644 --- a/docs/sdk/reference/interfaces/AccountMetadata.md +++ b/docs/sdk/reference/interfaces/AccountMetadata.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / AccountMetadata +[@vocdoni/sdk](/sdk) / AccountMetadata # Interface: AccountMetadata @@ -25,7 +25,7 @@ More info: https://vocdoni.io/docs/#/architecture/components/entity?id=meta #### Defined in -[types/metadata/account.ts:53](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/account.ts#L53) +[types/metadata/account.ts:53](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/account.ts#L53) ___ @@ -35,7 +35,7 @@ ___ #### Defined in -[types/metadata/account.ts:50](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/account.ts#L50) +[types/metadata/account.ts:50](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/account.ts#L50) ___ @@ -53,7 +53,7 @@ ___ #### Defined in -[types/metadata/account.ts:57](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/account.ts#L57) +[types/metadata/account.ts:57](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/account.ts#L57) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[types/metadata/account.ts:62](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/account.ts#L62) +[types/metadata/account.ts:62](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/account.ts#L62) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -[types/metadata/account.ts:52](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/account.ts#L52) +[types/metadata/account.ts:52](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/account.ts#L52) ___ @@ -87,7 +87,7 @@ ___ #### Defined in -[types/metadata/account.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/account.ts#L55) +[types/metadata/account.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/account.ts#L55) ___ @@ -97,4 +97,4 @@ ___ #### Defined in -[types/metadata/account.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/account.ts#L49) +[types/metadata/account.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/account.ts#L49) diff --git a/docs/sdk/reference/interfaces/AdminTx.md b/docs/sdk/reference/interfaces/AdminTx.md index 7f6a76b69..e056a42bd 100644 --- a/docs/sdk/reference/interfaces/AdminTx.md +++ b/docs/sdk/reference/interfaces/AdminTx.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / AdminTx +[@vocdoni/sdk](/sdk) / AdminTx # Interface: AdminTx @@ -24,7 +24,7 @@ #### Defined in -[api/chain/transactions.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L92) +[api/chain/transactions.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L92) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[api/chain/transactions.ts:93](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L93) +[api/chain/transactions.ts:93](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L93) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[api/chain/transactions.ts:94](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L94) +[api/chain/transactions.ts:94](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L94) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[api/chain/transactions.ts:95](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L95) +[api/chain/transactions.ts:95](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L95) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[api/chain/transactions.ts:98](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L98) +[api/chain/transactions.ts:98](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L98) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[api/chain/transactions.ts:96](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L96) +[api/chain/transactions.ts:96](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L96) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[api/chain/transactions.ts:91](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L91) +[api/chain/transactions.ts:91](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L91) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[api/chain/transactions.ts:97](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L97) +[api/chain/transactions.ts:97](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L97) ___ @@ -104,4 +104,4 @@ ___ #### Defined in -[api/chain/transactions.ts:90](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L90) +[api/chain/transactions.ts:90](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L90) diff --git a/docs/sdk/reference/interfaces/CircuitInputs.md b/docs/sdk/reference/interfaces/CircuitInputs.md index d9e2c83f0..2cca5d034 100644 --- a/docs/sdk/reference/interfaces/CircuitInputs.md +++ b/docs/sdk/reference/interfaces/CircuitInputs.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / CircuitInputs +[@vocdoni/sdk](/sdk) / CircuitInputs # Interface: CircuitInputs @@ -27,7 +27,7 @@ #### Defined in -[services/anonymous.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L43) +[services/anonymous.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L43) ___ @@ -37,7 +37,7 @@ ___ #### Defined in -[services/anonymous.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L38) +[services/anonymous.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L38) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -[services/anonymous.ts:41](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L41) +[services/anonymous.ts:41](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L41) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[services/anonymous.ts:48](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L48) +[services/anonymous.ts:48](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L48) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[services/anonymous.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L36) +[services/anonymous.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L36) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -[services/anonymous.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L37) +[services/anonymous.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L37) ___ @@ -87,7 +87,7 @@ ___ #### Defined in -[services/anonymous.ts:44](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L44) +[services/anonymous.ts:44](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L44) ___ @@ -97,7 +97,7 @@ ___ #### Defined in -[services/anonymous.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L45) +[services/anonymous.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L45) ___ @@ -107,7 +107,7 @@ ___ #### Defined in -[services/anonymous.ts:40](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L40) +[services/anonymous.ts:40](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L40) ___ @@ -117,7 +117,7 @@ ___ #### Defined in -[services/anonymous.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L47) +[services/anonymous.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L47) ___ @@ -127,7 +127,7 @@ ___ #### Defined in -[services/anonymous.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L39) +[services/anonymous.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L39) ___ @@ -137,4 +137,4 @@ ___ #### Defined in -[services/anonymous.ts:46](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L46) +[services/anonymous.ts:46](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L46) diff --git a/docs/sdk/reference/interfaces/CollectFaucetTx.md b/docs/sdk/reference/interfaces/CollectFaucetTx.md index b6d57cb23..eb529208d 100644 --- a/docs/sdk/reference/interfaces/CollectFaucetTx.md +++ b/docs/sdk/reference/interfaces/CollectFaucetTx.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / CollectFaucetTx +[@vocdoni/sdk](/sdk) / CollectFaucetTx # Interface: CollectFaucetTx @@ -18,7 +18,7 @@ #### Defined in -[api/chain/transactions.ts:158](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L158) +[api/chain/transactions.ts:158](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L158) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[api/chain/transactions.ts:159](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L159) +[api/chain/transactions.ts:159](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L159) ___ @@ -38,4 +38,4 @@ ___ #### Defined in -[api/chain/transactions.ts:157](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L157) +[api/chain/transactions.ts:157](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L157) diff --git a/docs/sdk/reference/interfaces/ElectionMetadata.md b/docs/sdk/reference/interfaces/ElectionMetadata.md index b2309f23c..714550bf9 100644 --- a/docs/sdk/reference/interfaces/ElectionMetadata.md +++ b/docs/sdk/reference/interfaces/ElectionMetadata.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ElectionMetadata +[@vocdoni/sdk](/sdk) / ElectionMetadata # Interface: ElectionMetadata @@ -25,7 +25,7 @@ More info: https://vocdoni.io/docs/#/architecture/components/process?id=process- #### Defined in -[types/metadata/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/election.ts#L127) +[types/metadata/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/election.ts#L127) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[types/metadata/election.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/election.ts#L128) +[types/metadata/election.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/election.ts#L128) ___ @@ -58,7 +58,7 @@ Arbitrary key/value data that specific applications can use for their own needs #### Defined in -[types/metadata/election.ts:133](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/election.ts#L133) +[types/metadata/election.ts:133](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/election.ts#L133) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[types/metadata/election.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/election.ts#L136) +[types/metadata/election.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/election.ts#L136) ___ @@ -78,17 +78,17 @@ ___ #### Defined in -[types/metadata/election.ts:126](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/election.ts#L126) +[types/metadata/election.ts:126](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/election.ts#L126) ___ ### type -• **type**: [`ElectionResultsType`](../modules#electionresultstype) +• **type**: [`ElectionResultsType`](../sdk-reference#electionresultstype) #### Defined in -[types/metadata/election.ts:137](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/election.ts#L137) +[types/metadata/election.ts:137](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/election.ts#L137) ___ @@ -98,4 +98,4 @@ ___ #### Defined in -[types/metadata/election.ts:125](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/election.ts#L125) +[types/metadata/election.ts:125](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/election.ts#L125) diff --git a/docs/sdk/reference/interfaces/FetchElectionsParameters.md b/docs/sdk/reference/interfaces/FetchElectionsParameters.md index b5e0cd781..528ce5e13 100644 --- a/docs/sdk/reference/interfaces/FetchElectionsParameters.md +++ b/docs/sdk/reference/interfaces/FetchElectionsParameters.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / FetchElectionsParameters +[@vocdoni/sdk](/sdk) / FetchElectionsParameters # Interface: FetchElectionsParameters @@ -17,7 +17,7 @@ #### Defined in -[services/election.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L32) +[services/election.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/election.ts#L32) ___ @@ -27,4 +27,4 @@ ___ #### Defined in -[services/election.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L33) +[services/election.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/election.ts#L33) diff --git a/docs/sdk/reference/interfaces/IAccount.md b/docs/sdk/reference/interfaces/IAccount.md index ab78f9d2b..a7511933c 100644 --- a/docs/sdk/reference/interfaces/IAccount.md +++ b/docs/sdk/reference/interfaces/IAccount.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IAccount +[@vocdoni/sdk](/sdk) / IAccount # Interface: IAccount @@ -23,7 +23,7 @@ #### Defined in -[types/account.ts:10](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L10) +[types/account.ts:10](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L10) ___ @@ -33,7 +33,7 @@ ___ #### Defined in -[types/account.ts:7](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L7) +[types/account.ts:7](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L7) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -[types/account.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L8) +[types/account.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L8) ___ @@ -53,7 +53,7 @@ ___ #### Defined in -[types/account.ts:9](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L9) +[types/account.ts:9](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L9) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[types/account.ts:5](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L5) +[types/account.ts:5](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L5) ___ @@ -73,7 +73,7 @@ ___ #### Defined in -[types/account.ts:11](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L11) +[types/account.ts:11](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L11) ___ @@ -83,7 +83,7 @@ ___ #### Defined in -[types/account.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L12) +[types/account.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L12) ___ @@ -93,4 +93,4 @@ ___ #### Defined in -[types/account.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L6) +[types/account.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/account.ts#L6) diff --git a/docs/sdk/reference/interfaces/IAccountTransfersCountResponse.md b/docs/sdk/reference/interfaces/IAccountTransfersCountResponse.md index e02d536aa..4ccc32fa6 100644 --- a/docs/sdk/reference/interfaces/IAccountTransfersCountResponse.md +++ b/docs/sdk/reference/interfaces/IAccountTransfersCountResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IAccountTransfersCountResponse +[@vocdoni/sdk](/sdk) / IAccountTransfersCountResponse # Interface: IAccountTransfersCountResponse @@ -18,4 +18,4 @@ Number of account's transfers #### Defined in -[api/account.ts:95](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/account.ts#L95) +[api/account.ts:95](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/account.ts#L95) diff --git a/docs/sdk/reference/interfaces/IAccountsCountResponse.md b/docs/sdk/reference/interfaces/IAccountsCountResponse.md index 124bd9d4d..a18d4c9c4 100644 --- a/docs/sdk/reference/interfaces/IAccountsCountResponse.md +++ b/docs/sdk/reference/interfaces/IAccountsCountResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IAccountsCountResponse +[@vocdoni/sdk](/sdk) / IAccountsCountResponse # Interface: IAccountsCountResponse @@ -18,4 +18,4 @@ Number of accounts #### Defined in -[api/account.ts:102](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/account.ts#L102) +[api/account.ts:102](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/account.ts#L102) diff --git a/docs/sdk/reference/interfaces/IAccountsListResponse.md b/docs/sdk/reference/interfaces/IAccountsListResponse.md index 1d754034c..d5d4871fe 100644 --- a/docs/sdk/reference/interfaces/IAccountsListResponse.md +++ b/docs/sdk/reference/interfaces/IAccountsListResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IAccountsListResponse +[@vocdoni/sdk](/sdk) / IAccountsListResponse # Interface: IAccountsListResponse @@ -12,10 +12,10 @@ ### accounts -• **accounts**: [`IAccountSummary`](../modules#iaccountsummary)[] +• **accounts**: [`IAccountSummary`](../sdk-reference#iaccountsummary)[] List of accounts #### Defined in -[api/account.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/account.ts#L88) +[api/account.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/account.ts#L88) diff --git a/docs/sdk/reference/interfaces/IApprovalElectionParameters.md b/docs/sdk/reference/interfaces/IApprovalElectionParameters.md index 5ebb4ed51..bd1ade525 100644 --- a/docs/sdk/reference/interfaces/IApprovalElectionParameters.md +++ b/docs/sdk/reference/interfaces/IApprovalElectionParameters.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IApprovalElectionParameters +[@vocdoni/sdk](/sdk) / IApprovalElectionParameters # Interface: IApprovalElectionParameters @@ -43,7 +43,7 @@ Used to add the SDK version to the election metadata #### Defined in -[types/election/election.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L155) +[types/election/election.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L155) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[types/election/election.ts:129](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L129) +[types/election/election.ts:129](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L129) ___ @@ -73,7 +73,7 @@ Election description #### Defined in -[types/election/election.ts:114](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L114) +[types/election/election.ts:114](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L114) ___ @@ -87,7 +87,7 @@ ___ #### Defined in -[types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L131) +[types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L131) ___ @@ -101,7 +101,7 @@ ___ #### Defined in -[types/election/election.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L128) +[types/election/election.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L128) ___ @@ -117,7 +117,7 @@ Election header image url. #### Defined in -[types/election/election.ts:118](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L118) +[types/election/election.ts:118](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L118) ___ @@ -141,7 +141,7 @@ size` error. #### Defined in -[types/election/election.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L145) +[types/election/election.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L145) ___ @@ -157,7 +157,7 @@ Metadata (anything added by the election creator) #### Defined in -[types/election/election.ts:126](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L126) +[types/election/election.ts:126](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L126) ___ @@ -171,7 +171,7 @@ ___ #### Defined in -[types/election/election.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L132) +[types/election/election.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L132) ___ @@ -185,7 +185,7 @@ ___ #### Defined in -[types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L127) +[types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L127) ___ @@ -201,7 +201,7 @@ Election stream Uri (ex: a video url) #### Defined in -[types/election/election.ts:122](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L122) +[types/election/election.ts:122](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L122) ___ @@ -217,7 +217,7 @@ Is used to remove the secret identities of the voters once the process is done. #### Defined in -[types/election/election.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L150) +[types/election/election.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L150) ___ @@ -233,7 +233,7 @@ Election title #### Defined in -[types/election/election.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L110) +[types/election/election.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L110) ___ @@ -247,4 +247,4 @@ ___ #### Defined in -[types/election/election.ts:130](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L130) +[types/election/election.ts:130](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L130) diff --git a/docs/sdk/reference/interfaces/IBlockTransactionsResponse.md b/docs/sdk/reference/interfaces/IBlockTransactionsResponse.md index bbd2145c7..dc12d814f 100644 --- a/docs/sdk/reference/interfaces/IBlockTransactionsResponse.md +++ b/docs/sdk/reference/interfaces/IBlockTransactionsResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IBlockTransactionsResponse +[@vocdoni/sdk](/sdk) / IBlockTransactionsResponse # Interface: IBlockTransactionsResponse @@ -18,7 +18,7 @@ #### Defined in -[api/chain.ts:312](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L312) +[api/chain.ts:312](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L312) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[api/chain.ts:313](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L313) +[api/chain.ts:313](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L313) ___ @@ -38,4 +38,4 @@ ___ #### Defined in -[api/chain.ts:314](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L314) +[api/chain.ts:314](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L314) diff --git a/docs/sdk/reference/interfaces/IBudgetElectionParametersInfo.md b/docs/sdk/reference/interfaces/IBudgetElectionParametersInfo.md index eb1aa5624..792ec2503 100644 --- a/docs/sdk/reference/interfaces/IBudgetElectionParametersInfo.md +++ b/docs/sdk/reference/interfaces/IBudgetElectionParametersInfo.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IBudgetElectionParametersInfo +[@vocdoni/sdk](/sdk) / IBudgetElectionParametersInfo # Interface: IBudgetElectionParametersInfo @@ -49,7 +49,7 @@ Used to add the SDK version to the election metadata #### Defined in -[types/election/election.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L155) +[types/election/election.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L155) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[types/election/election.ts:129](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L129) +[types/election/election.ts:129](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L129) ___ @@ -79,7 +79,7 @@ Election description #### Defined in -[types/election/election.ts:114](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L114) +[types/election/election.ts:114](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L114) ___ @@ -93,7 +93,7 @@ ___ #### Defined in -[types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L131) +[types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L131) ___ @@ -107,7 +107,7 @@ ___ #### Defined in -[types/election/election.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L128) +[types/election/election.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L128) ___ @@ -117,7 +117,7 @@ ___ #### Defined in -[types/election/budget.ts:9](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/budget.ts#L9) +[types/election/budget.ts:9](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/budget.ts#L9) ___ @@ -133,7 +133,7 @@ Election header image url. #### Defined in -[types/election/election.ts:118](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L118) +[types/election/election.ts:118](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L118) ___ @@ -157,7 +157,7 @@ size` error. #### Defined in -[types/election/election.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L145) +[types/election/election.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L145) ___ @@ -173,7 +173,7 @@ Metadata (anything added by the election creator) #### Defined in -[types/election/election.ts:126](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L126) +[types/election/election.ts:126](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L126) ___ @@ -183,7 +183,7 @@ ___ #### Defined in -[types/election/budget.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/budget.ts#L8) +[types/election/budget.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/budget.ts#L8) ___ @@ -197,7 +197,7 @@ ___ #### Defined in -[types/election/election.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L132) +[types/election/election.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L132) ___ @@ -211,7 +211,7 @@ ___ #### Defined in -[types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L127) +[types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L127) ___ @@ -227,7 +227,7 @@ Election stream Uri (ex: a video url) #### Defined in -[types/election/election.ts:122](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L122) +[types/election/election.ts:122](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L122) ___ @@ -243,7 +243,7 @@ Is used to remove the secret identities of the voters once the process is done. #### Defined in -[types/election/election.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L150) +[types/election/election.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L150) ___ @@ -259,7 +259,7 @@ Election title #### Defined in -[types/election/election.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L110) +[types/election/election.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L110) ___ @@ -273,4 +273,4 @@ ___ #### Defined in -[types/election/election.ts:130](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L130) +[types/election/election.ts:130](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L130) diff --git a/docs/sdk/reference/interfaces/IBudgetElectionParametersWithBudget.md b/docs/sdk/reference/interfaces/IBudgetElectionParametersWithBudget.md index 41b306f99..53993a078 100644 --- a/docs/sdk/reference/interfaces/IBudgetElectionParametersWithBudget.md +++ b/docs/sdk/reference/interfaces/IBudgetElectionParametersWithBudget.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IBudgetElectionParametersWithBudget +[@vocdoni/sdk](/sdk) / IBudgetElectionParametersWithBudget # Interface: IBudgetElectionParametersWithBudget @@ -47,7 +47,7 @@ Used to add the SDK version to the election metadata #### Defined in -[types/election/election.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L155) +[types/election/election.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L155) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[types/election/election.ts:129](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L129) +[types/election/election.ts:129](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L129) ___ @@ -77,7 +77,7 @@ Election description #### Defined in -[types/election/election.ts:114](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L114) +[types/election/election.ts:114](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L114) ___ @@ -91,7 +91,7 @@ ___ #### Defined in -[types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L131) +[types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L131) ___ @@ -105,7 +105,7 @@ ___ #### Defined in -[types/election/election.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L128) +[types/election/election.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L128) ___ @@ -119,7 +119,7 @@ ___ #### Defined in -[types/election/budget.ts:9](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/budget.ts#L9) +[types/election/budget.ts:9](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/budget.ts#L9) ___ @@ -135,7 +135,7 @@ Election header image url. #### Defined in -[types/election/election.ts:118](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L118) +[types/election/election.ts:118](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L118) ___ @@ -145,7 +145,7 @@ ___ #### Defined in -[types/election/budget.ts:18](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/budget.ts#L18) +[types/election/budget.ts:18](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/budget.ts#L18) ___ @@ -169,7 +169,7 @@ size` error. #### Defined in -[types/election/election.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L145) +[types/election/election.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L145) ___ @@ -185,7 +185,7 @@ Metadata (anything added by the election creator) #### Defined in -[types/election/election.ts:126](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L126) +[types/election/election.ts:126](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L126) ___ @@ -199,7 +199,7 @@ ___ #### Defined in -[types/election/budget.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/budget.ts#L8) +[types/election/budget.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/budget.ts#L8) ___ @@ -213,7 +213,7 @@ ___ #### Defined in -[types/election/election.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L132) +[types/election/election.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L132) ___ @@ -227,7 +227,7 @@ ___ #### Defined in -[types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L127) +[types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L127) ___ @@ -243,7 +243,7 @@ Election stream Uri (ex: a video url) #### Defined in -[types/election/election.ts:122](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L122) +[types/election/election.ts:122](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L122) ___ @@ -259,7 +259,7 @@ Is used to remove the secret identities of the voters once the process is done. #### Defined in -[types/election/election.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L150) +[types/election/election.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L150) ___ @@ -275,7 +275,7 @@ Election title #### Defined in -[types/election/election.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L110) +[types/election/election.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L110) ___ @@ -285,7 +285,7 @@ ___ #### Defined in -[types/election/budget.ts:17](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/budget.ts#L17) +[types/election/budget.ts:17](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/budget.ts#L17) ___ @@ -299,4 +299,4 @@ ___ #### Defined in -[types/election/election.ts:130](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L130) +[types/election/election.ts:130](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L130) diff --git a/docs/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight.md b/docs/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight.md index 6d435831f..5a665bfe3 100644 --- a/docs/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight.md +++ b/docs/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IBudgetElectionParametersWithCensusWeight +[@vocdoni/sdk](/sdk) / IBudgetElectionParametersWithCensusWeight # Interface: IBudgetElectionParametersWithCensusWeight @@ -46,7 +46,7 @@ Used to add the SDK version to the election metadata #### Defined in -[types/election/election.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L155) +[types/election/election.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L155) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[types/election/election.ts:129](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L129) +[types/election/election.ts:129](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L129) ___ @@ -76,7 +76,7 @@ Election description #### Defined in -[types/election/election.ts:114](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L114) +[types/election/election.ts:114](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L114) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L131) +[types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L131) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[types/election/election.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L128) +[types/election/election.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L128) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[types/election/budget.ts:9](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/budget.ts#L9) +[types/election/budget.ts:9](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/budget.ts#L9) ___ @@ -134,7 +134,7 @@ Election header image url. #### Defined in -[types/election/election.ts:118](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L118) +[types/election/election.ts:118](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L118) ___ @@ -158,7 +158,7 @@ size` error. #### Defined in -[types/election/election.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L145) +[types/election/election.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L145) ___ @@ -174,7 +174,7 @@ Metadata (anything added by the election creator) #### Defined in -[types/election/election.ts:126](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L126) +[types/election/election.ts:126](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L126) ___ @@ -188,7 +188,7 @@ ___ #### Defined in -[types/election/budget.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/budget.ts#L8) +[types/election/budget.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/budget.ts#L8) ___ @@ -202,7 +202,7 @@ ___ #### Defined in -[types/election/election.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L132) +[types/election/election.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L132) ___ @@ -216,7 +216,7 @@ ___ #### Defined in -[types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L127) +[types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L127) ___ @@ -232,7 +232,7 @@ Election stream Uri (ex: a video url) #### Defined in -[types/election/election.ts:122](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L122) +[types/election/election.ts:122](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L122) ___ @@ -248,7 +248,7 @@ Is used to remove the secret identities of the voters once the process is done. #### Defined in -[types/election/election.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L150) +[types/election/election.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L150) ___ @@ -264,7 +264,7 @@ Election title #### Defined in -[types/election/election.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L110) +[types/election/election.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L110) ___ @@ -274,7 +274,7 @@ ___ #### Defined in -[types/election/budget.ts:13](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/budget.ts#L13) +[types/election/budget.ts:13](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/budget.ts#L13) ___ @@ -288,4 +288,4 @@ ___ #### Defined in -[types/election/election.ts:130](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L130) +[types/election/election.ts:130](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L130) diff --git a/docs/sdk/reference/interfaces/ICensus.md b/docs/sdk/reference/interfaces/ICensus.md index ad330b131..584ff9699 100644 --- a/docs/sdk/reference/interfaces/ICensus.md +++ b/docs/sdk/reference/interfaces/ICensus.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensus +[@vocdoni/sdk](/sdk) / ICensus # Interface: ICensus @@ -22,7 +22,7 @@ The type of the census #### Defined in -[api/election.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L21) +[api/election.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L21) ___ @@ -34,7 +34,7 @@ The root of the census #### Defined in -[api/election.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L26) +[api/election.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L26) ___ @@ -46,7 +46,7 @@ The URL of the census #### Defined in -[api/election.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L36) +[api/election.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L36) ___ @@ -58,7 +58,7 @@ Max size of the census. How many voters the census can have. #### Defined in -[api/election.ts:41](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L41) +[api/election.ts:41](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L41) ___ @@ -70,4 +70,4 @@ The post register root of the census #### Defined in -[api/election.ts:31](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L31) +[api/election.ts:31](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L31) diff --git a/docs/sdk/reference/interfaces/ICensus3CensusListResponse.md b/docs/sdk/reference/interfaces/ICensus3CensusListResponse.md index 72be360bc..d84a8fd6d 100644 --- a/docs/sdk/reference/interfaces/ICensus3CensusListResponse.md +++ b/docs/sdk/reference/interfaces/ICensus3CensusListResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensus3CensusListResponse +[@vocdoni/sdk](/sdk) / ICensus3CensusListResponse # Interface: ICensus3CensusListResponse @@ -18,4 +18,4 @@ The list of the strategies identifiers #### Defined in -[api/census3/census.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/census.ts#L15) +[api/census3/census.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/census.ts#L15) diff --git a/docs/sdk/reference/interfaces/ICensus3CensusQueueResponse.md b/docs/sdk/reference/interfaces/ICensus3CensusQueueResponse.md index 48089027d..33df1fe39 100644 --- a/docs/sdk/reference/interfaces/ICensus3CensusQueueResponse.md +++ b/docs/sdk/reference/interfaces/ICensus3CensusQueueResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensus3CensusQueueResponse +[@vocdoni/sdk](/sdk) / ICensus3CensusQueueResponse # Interface: ICensus3CensusQueueResponse @@ -21,7 +21,7 @@ The census data #### Defined in -[api/census3/census.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/census.ts#L84) +[api/census3/census.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/census.ts#L84) ___ @@ -33,7 +33,7 @@ If the queue has been done #### Defined in -[api/census3/census.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/census.ts#L64) +[api/census3/census.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/census.ts#L64) ___ @@ -52,7 +52,7 @@ The error of the queue #### Defined in -[api/census3/census.ts:69](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/census.ts#L69) +[api/census3/census.ts:69](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/census.ts#L69) ___ @@ -64,4 +64,4 @@ The creation progress #### Defined in -[api/census3/census.ts:89](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/census.ts#L89) +[api/census3/census.ts:89](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/census.ts#L89) diff --git a/docs/sdk/reference/interfaces/ICensus3CensusResponse.md b/docs/sdk/reference/interfaces/ICensus3CensusResponse.md index 576509853..9cc614800 100644 --- a/docs/sdk/reference/interfaces/ICensus3CensusResponse.md +++ b/docs/sdk/reference/interfaces/ICensus3CensusResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensus3CensusResponse +[@vocdoni/sdk](/sdk) / ICensus3CensusResponse # Interface: ICensus3CensusResponse @@ -25,7 +25,7 @@ The identifier of the census #### Defined in -[api/census3/census.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/census.ts#L22) +[api/census3/census.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/census.ts#L22) ___ @@ -37,7 +37,7 @@ The accuracy for an anonymous census #### Defined in -[api/census3/census.ts:57](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/census.ts#L57) +[api/census3/census.ts:57](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/census.ts#L57) ___ @@ -49,7 +49,7 @@ If the census is anonymous or not #### Defined in -[api/census3/census.ts:52](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/census.ts#L52) +[api/census3/census.ts:52](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/census.ts#L52) ___ @@ -61,7 +61,7 @@ The root of the census #### Defined in -[api/census3/census.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/census.ts#L32) +[api/census3/census.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/census.ts#L32) ___ @@ -73,7 +73,7 @@ The size of the census (number of token holders) #### Defined in -[api/census3/census.ts:42](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/census.ts#L42) +[api/census3/census.ts:42](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/census.ts#L42) ___ @@ -85,7 +85,7 @@ The identifier of the strategy of the built census #### Defined in -[api/census3/census.ts:27](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/census.ts#L27) +[api/census3/census.ts:27](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/census.ts#L27) ___ @@ -97,7 +97,7 @@ The URI of the census #### Defined in -[api/census3/census.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/census.ts#L37) +[api/census3/census.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/census.ts#L37) ___ @@ -109,4 +109,4 @@ The weight of the census (weight of all token holders) #### Defined in -[api/census3/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/census.ts#L47) +[api/census3/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/census.ts#L47) diff --git a/docs/sdk/reference/interfaces/ICensus3ServiceInfoResponse.md b/docs/sdk/reference/interfaces/ICensus3ServiceInfoResponse.md index 0ce04985b..8b124a3fe 100644 --- a/docs/sdk/reference/interfaces/ICensus3ServiceInfoResponse.md +++ b/docs/sdk/reference/interfaces/ICensus3ServiceInfoResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensus3ServiceInfoResponse +[@vocdoni/sdk](/sdk) / ICensus3ServiceInfoResponse # Interface: ICensus3ServiceInfoResponse @@ -18,4 +18,4 @@ The list of supported chains #### Defined in -[api/census3/service.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/service.ts#L29) +[api/census3/service.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/service.ts#L29) diff --git a/docs/sdk/reference/interfaces/ICensus3StrategiesListResponse.md b/docs/sdk/reference/interfaces/ICensus3StrategiesListResponse.md index 6fc767239..7cea0af16 100644 --- a/docs/sdk/reference/interfaces/ICensus3StrategiesListResponse.md +++ b/docs/sdk/reference/interfaces/ICensus3StrategiesListResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensus3StrategiesListResponse +[@vocdoni/sdk](/sdk) / ICensus3StrategiesListResponse # Interface: ICensus3StrategiesListResponse @@ -18,10 +18,10 @@ ### strategies -• **strategies**: [`Census3Strategy`](../modules#census3strategy)[] +• **strategies**: [`Census3Strategy`](../sdk-reference#census3strategy)[] The list of the strategies identifiers #### Defined in -[api/census3/strategy.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L22) +[api/census3/strategy.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L22) diff --git a/docs/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated.md b/docs/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated.md index f4ce481e5..cdcc9ec13 100644 --- a/docs/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated.md +++ b/docs/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensus3StrategiesListResponsePaginated +[@vocdoni/sdk](/sdk) / ICensus3StrategiesListResponsePaginated # Interface: ICensus3StrategiesListResponsePaginated @@ -25,13 +25,13 @@ The pagination information #### Defined in -[api/census3/strategy.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L29) +[api/census3/strategy.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L29) ___ ### strategies -• **strategies**: [`Census3Strategy`](../modules#census3strategy)[] +• **strategies**: [`Census3Strategy`](../sdk-reference#census3strategy)[] The list of the strategies identifiers @@ -41,4 +41,4 @@ The list of the strategies identifiers #### Defined in -[api/census3/strategy.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L22) +[api/census3/strategy.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L22) diff --git a/docs/sdk/reference/interfaces/ICensus3StrategiesOperator.md b/docs/sdk/reference/interfaces/ICensus3StrategiesOperator.md index 16ae83e21..331a6d4fd 100644 --- a/docs/sdk/reference/interfaces/ICensus3StrategiesOperator.md +++ b/docs/sdk/reference/interfaces/ICensus3StrategiesOperator.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensus3StrategiesOperator +[@vocdoni/sdk](/sdk) / ICensus3StrategiesOperator # Interface: ICensus3StrategiesOperator @@ -19,7 +19,7 @@ The description of the operator #### Defined in -[api/census3/strategy.ts:233](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L233) +[api/census3/strategy.ts:233](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L233) ___ @@ -31,4 +31,4 @@ The tag of the operator #### Defined in -[api/census3/strategy.ts:238](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L238) +[api/census3/strategy.ts:238](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L238) diff --git a/docs/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse.md b/docs/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse.md index d23aec647..fc4008034 100644 --- a/docs/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse.md +++ b/docs/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensus3StrategiesOperatorsResponse +[@vocdoni/sdk](/sdk) / ICensus3StrategiesOperatorsResponse # Interface: ICensus3StrategiesOperatorsResponse @@ -18,4 +18,4 @@ The list of supported operators #### Defined in -[api/census3/strategy.ts:245](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L245) +[api/census3/strategy.ts:245](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L245) diff --git a/docs/sdk/reference/interfaces/ICensus3StrategyCreateResponse.md b/docs/sdk/reference/interfaces/ICensus3StrategyCreateResponse.md index ae56d4e35..acf6a3f4d 100644 --- a/docs/sdk/reference/interfaces/ICensus3StrategyCreateResponse.md +++ b/docs/sdk/reference/interfaces/ICensus3StrategyCreateResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensus3StrategyCreateResponse +[@vocdoni/sdk](/sdk) / ICensus3StrategyCreateResponse # Interface: ICensus3StrategyCreateResponse @@ -18,4 +18,4 @@ The identifier of the created strategy #### Defined in -[api/census3/strategy.ts:207](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L207) +[api/census3/strategy.ts:207](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L207) diff --git a/docs/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse.md b/docs/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse.md index d4b5bd9e3..9c4ead111 100644 --- a/docs/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse.md +++ b/docs/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensus3StrategyEstimationQueueResponse +[@vocdoni/sdk](/sdk) / ICensus3StrategyEstimationQueueResponse # Interface: ICensus3StrategyEstimationQueueResponse @@ -29,7 +29,7 @@ The estimation data of the strategy #### Defined in -[api/census3/strategy.ts:126](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L126) +[api/census3/strategy.ts:126](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L126) ___ @@ -41,7 +41,7 @@ If the queue has been done #### Defined in -[api/census3/strategy.ts:106](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L106) +[api/census3/strategy.ts:106](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L106) ___ @@ -60,7 +60,7 @@ The error of the queue #### Defined in -[api/census3/strategy.ts:111](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L111) +[api/census3/strategy.ts:111](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L111) ___ @@ -72,4 +72,4 @@ The estimation progress #### Defined in -[api/census3/strategy.ts:146](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L146) +[api/census3/strategy.ts:146](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L146) diff --git a/docs/sdk/reference/interfaces/ICensus3StrategyHoldersResponse.md b/docs/sdk/reference/interfaces/ICensus3StrategyHoldersResponse.md index e5e9f71b9..7d1a34ddc 100644 --- a/docs/sdk/reference/interfaces/ICensus3StrategyHoldersResponse.md +++ b/docs/sdk/reference/interfaces/ICensus3StrategyHoldersResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensus3StrategyHoldersResponse +[@vocdoni/sdk](/sdk) / ICensus3StrategyHoldersResponse # Interface: ICensus3StrategyHoldersResponse @@ -28,4 +28,4 @@ The list of the strategy holders #### Defined in -[api/census3/strategy.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L36) +[api/census3/strategy.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L36) diff --git a/docs/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated.md b/docs/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated.md index ff8b672fc..ac7c30997 100644 --- a/docs/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated.md +++ b/docs/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensus3StrategyHoldersResponsePaginated +[@vocdoni/sdk](/sdk) / ICensus3StrategyHoldersResponsePaginated # Interface: ICensus3StrategyHoldersResponsePaginated @@ -33,7 +33,7 @@ The list of the strategy holders #### Defined in -[api/census3/strategy.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L36) +[api/census3/strategy.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L36) ___ @@ -45,4 +45,4 @@ The pagination information #### Defined in -[api/census3/strategy.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L43) +[api/census3/strategy.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L43) diff --git a/docs/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse.md b/docs/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse.md index 8e5f123f3..62bccf5c8 100644 --- a/docs/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse.md +++ b/docs/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensus3StrategyImportQueueResponse +[@vocdoni/sdk](/sdk) / ICensus3StrategyImportQueueResponse # Interface: ICensus3StrategyImportQueueResponse @@ -15,13 +15,13 @@ ### data -• **data**: [`Census3Strategy`](../modules#census3strategy) +• **data**: [`Census3Strategy`](../sdk-reference#census3strategy) The imported data strategy #### Defined in -[api/census3/strategy.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L173) +[api/census3/strategy.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L173) ___ @@ -33,7 +33,7 @@ If the queue has been done #### Defined in -[api/census3/strategy.ts:153](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L153) +[api/census3/strategy.ts:153](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L153) ___ @@ -52,7 +52,7 @@ The error of the queue #### Defined in -[api/census3/strategy.ts:158](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L158) +[api/census3/strategy.ts:158](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L158) ___ @@ -64,4 +64,4 @@ The importing progress #### Defined in -[api/census3/strategy.ts:178](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L178) +[api/census3/strategy.ts:178](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L178) diff --git a/docs/sdk/reference/interfaces/ICensus3StrategyToken.md b/docs/sdk/reference/interfaces/ICensus3StrategyToken.md index ecff7d04e..f6cb4a591 100644 --- a/docs/sdk/reference/interfaces/ICensus3StrategyToken.md +++ b/docs/sdk/reference/interfaces/ICensus3StrategyToken.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensus3StrategyToken +[@vocdoni/sdk](/sdk) / ICensus3StrategyToken # Interface: ICensus3StrategyToken @@ -21,7 +21,7 @@ The id (address) of the token. #### Defined in -[api/census3/strategy.ts:185](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L185) +[api/census3/strategy.ts:185](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L185) ___ @@ -33,7 +33,7 @@ The method used for checking balances. #### Defined in -[api/census3/strategy.ts:200](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L200) +[api/census3/strategy.ts:200](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L200) ___ @@ -45,7 +45,7 @@ The minimum balance. #### Defined in -[api/census3/strategy.ts:195](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L195) +[api/census3/strategy.ts:195](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L195) ___ @@ -57,4 +57,4 @@ The name of the token. #### Defined in -[api/census3/strategy.ts:190](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L190) +[api/census3/strategy.ts:190](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L190) diff --git a/docs/sdk/reference/interfaces/ICensus3SupportedChain.md b/docs/sdk/reference/interfaces/ICensus3SupportedChain.md index 9172907c2..c05c4dcec 100644 --- a/docs/sdk/reference/interfaces/ICensus3SupportedChain.md +++ b/docs/sdk/reference/interfaces/ICensus3SupportedChain.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensus3SupportedChain +[@vocdoni/sdk](/sdk) / ICensus3SupportedChain # Interface: ICensus3SupportedChain @@ -20,7 +20,7 @@ The identifier of the chain #### Defined in -[api/census3/service.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/service.ts#L12) +[api/census3/service.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/service.ts#L12) ___ @@ -32,7 +32,7 @@ The name of the chain #### Defined in -[api/census3/service.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/service.ts#L22) +[api/census3/service.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/service.ts#L22) ___ @@ -44,4 +44,4 @@ The short name of the chain #### Defined in -[api/census3/service.ts:17](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/service.ts#L17) +[api/census3/service.ts:17](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/service.ts#L17) diff --git a/docs/sdk/reference/interfaces/ICensus3TokenHolderResponse.md b/docs/sdk/reference/interfaces/ICensus3TokenHolderResponse.md index 3882e5843..6700dea40 100644 --- a/docs/sdk/reference/interfaces/ICensus3TokenHolderResponse.md +++ b/docs/sdk/reference/interfaces/ICensus3TokenHolderResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensus3TokenHolderResponse +[@vocdoni/sdk](/sdk) / ICensus3TokenHolderResponse # Interface: ICensus3TokenHolderResponse @@ -18,4 +18,4 @@ The balance of the holder #### Defined in -[api/census3/token.ts:117](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/token.ts#L117) +[api/census3/token.ts:117](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/token.ts#L117) diff --git a/docs/sdk/reference/interfaces/ICensus3TokenListResponse.md b/docs/sdk/reference/interfaces/ICensus3TokenListResponse.md index fc5f49e3a..795e82ced 100644 --- a/docs/sdk/reference/interfaces/ICensus3TokenListResponse.md +++ b/docs/sdk/reference/interfaces/ICensus3TokenListResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensus3TokenListResponse +[@vocdoni/sdk](/sdk) / ICensus3TokenListResponse # Interface: ICensus3TokenListResponse @@ -18,10 +18,10 @@ ### tokens -• **tokens**: [`Census3SummaryToken`](../modules#census3summarytoken)[] +• **tokens**: [`Census3SummaryToken`](../sdk-reference#census3summarytoken)[] The list of the tokens #### Defined in -[api/census3/token.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/token.ts#L110) +[api/census3/token.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/token.ts#L110) diff --git a/docs/sdk/reference/interfaces/ICensus3TokenListResponsePaginated.md b/docs/sdk/reference/interfaces/ICensus3TokenListResponsePaginated.md index 80c89b39b..238ddb35b 100644 --- a/docs/sdk/reference/interfaces/ICensus3TokenListResponsePaginated.md +++ b/docs/sdk/reference/interfaces/ICensus3TokenListResponsePaginated.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensus3TokenListResponsePaginated +[@vocdoni/sdk](/sdk) / ICensus3TokenListResponsePaginated # Interface: ICensus3TokenListResponsePaginated @@ -25,13 +25,13 @@ The pagination information #### Defined in -[api/census3/token.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/token.ts#L124) +[api/census3/token.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/token.ts#L124) ___ ### tokens -• **tokens**: [`Census3SummaryToken`](../modules#census3summarytoken)[] +• **tokens**: [`Census3SummaryToken`](../sdk-reference#census3summarytoken)[] The list of the tokens @@ -41,4 +41,4 @@ The list of the tokens #### Defined in -[api/census3/token.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/token.ts#L110) +[api/census3/token.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/token.ts#L110) diff --git a/docs/sdk/reference/interfaces/ICensus3TokenTypesResponse.md b/docs/sdk/reference/interfaces/ICensus3TokenTypesResponse.md index 74e0bee19..6a7343108 100644 --- a/docs/sdk/reference/interfaces/ICensus3TokenTypesResponse.md +++ b/docs/sdk/reference/interfaces/ICensus3TokenTypesResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensus3TokenTypesResponse +[@vocdoni/sdk](/sdk) / ICensus3TokenTypesResponse # Interface: ICensus3TokenTypesResponse @@ -18,4 +18,4 @@ The list of the tokens types #### Defined in -[api/census3/token.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/token.ts#L131) +[api/census3/token.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/token.ts#L131) diff --git a/docs/sdk/reference/interfaces/ICensus3ValidatePredicateChild.md b/docs/sdk/reference/interfaces/ICensus3ValidatePredicateChild.md index 6f9fa9b92..b64fa0b2c 100644 --- a/docs/sdk/reference/interfaces/ICensus3ValidatePredicateChild.md +++ b/docs/sdk/reference/interfaces/ICensus3ValidatePredicateChild.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensus3ValidatePredicateChild +[@vocdoni/sdk](/sdk) / ICensus3ValidatePredicateChild # Interface: ICensus3ValidatePredicateChild @@ -19,7 +19,7 @@ The operator used in the predicate #### Defined in -[api/census3/strategy.ts:221](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L221) +[api/census3/strategy.ts:221](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L221) ___ @@ -31,4 +31,4 @@ The list of tokens of the predicate #### Defined in -[api/census3/strategy.ts:226](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L226) +[api/census3/strategy.ts:226](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L226) diff --git a/docs/sdk/reference/interfaces/ICensus3ValidatePredicateResponse.md b/docs/sdk/reference/interfaces/ICensus3ValidatePredicateResponse.md index 035e92897..bd91303cb 100644 --- a/docs/sdk/reference/interfaces/ICensus3ValidatePredicateResponse.md +++ b/docs/sdk/reference/interfaces/ICensus3ValidatePredicateResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensus3ValidatePredicateResponse +[@vocdoni/sdk](/sdk) / ICensus3ValidatePredicateResponse # Interface: ICensus3ValidatePredicateResponse @@ -24,4 +24,4 @@ The parsed version of the predicate #### Defined in -[api/census3/strategy.ts:252](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L252) +[api/census3/strategy.ts:252](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L252) diff --git a/docs/sdk/reference/interfaces/ICensus3ValidatePredicateToken.md b/docs/sdk/reference/interfaces/ICensus3ValidatePredicateToken.md index 4d23f55fe..e06a3c79e 100644 --- a/docs/sdk/reference/interfaces/ICensus3ValidatePredicateToken.md +++ b/docs/sdk/reference/interfaces/ICensus3ValidatePredicateToken.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensus3ValidatePredicateToken +[@vocdoni/sdk](/sdk) / ICensus3ValidatePredicateToken # Interface: ICensus3ValidatePredicateToken @@ -18,4 +18,4 @@ The literal of the predicate #### Defined in -[api/census3/strategy.ts:214](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L214) +[api/census3/strategy.ts:214](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L214) diff --git a/docs/sdk/reference/interfaces/ICensusExportResponse.md b/docs/sdk/reference/interfaces/ICensusExportResponse.md index fe1208147..09bf68d8b 100644 --- a/docs/sdk/reference/interfaces/ICensusExportResponse.md +++ b/docs/sdk/reference/interfaces/ICensusExportResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensusExportResponse +[@vocdoni/sdk](/sdk) / ICensusExportResponse # Interface: ICensusExportResponse @@ -21,7 +21,7 @@ The data of the census #### Defined in -[api/census.ts:54](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census.ts#L54) +[api/census.ts:54](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census.ts#L54) ___ @@ -33,7 +33,7 @@ The max levels of the census #### Defined in -[api/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census.ts#L59) +[api/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census.ts#L59) ___ @@ -45,7 +45,7 @@ The root hash of the census #### Defined in -[api/census.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census.ts#L49) +[api/census.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census.ts#L49) ___ @@ -57,4 +57,4 @@ The type of the census #### Defined in -[api/census.ts:44](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census.ts#L44) +[api/census.ts:44](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census.ts#L44) diff --git a/docs/sdk/reference/interfaces/ICensusImportResponse.md b/docs/sdk/reference/interfaces/ICensusImportResponse.md index f3c3fb8ef..ade31291f 100644 --- a/docs/sdk/reference/interfaces/ICensusImportResponse.md +++ b/docs/sdk/reference/interfaces/ICensusImportResponse.md @@ -1,3 +1,3 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensusImportResponse +[@vocdoni/sdk](/sdk) / ICensusImportResponse # Interface: ICensusImportResponse diff --git a/docs/sdk/reference/interfaces/ICensusParticipant.md b/docs/sdk/reference/interfaces/ICensusParticipant.md index 34a460077..58b270784 100644 --- a/docs/sdk/reference/interfaces/ICensusParticipant.md +++ b/docs/sdk/reference/interfaces/ICensusParticipant.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensusParticipant +[@vocdoni/sdk](/sdk) / ICensusParticipant # Interface: ICensusParticipant @@ -17,7 +17,7 @@ #### Defined in -[types/census/offchain.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/offchain.ts#L6) +[types/census/offchain.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/offchain.ts#L6) ___ @@ -27,4 +27,4 @@ ___ #### Defined in -[types/census/offchain.ts:7](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/census/offchain.ts#L7) +[types/census/offchain.ts:7](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/census/offchain.ts#L7) diff --git a/docs/sdk/reference/interfaces/ICensusProofResponse.md b/docs/sdk/reference/interfaces/ICensusProofResponse.md index 8a05271e0..a8778ea81 100644 --- a/docs/sdk/reference/interfaces/ICensusProofResponse.md +++ b/docs/sdk/reference/interfaces/ICensusProofResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensusProofResponse +[@vocdoni/sdk](/sdk) / ICensusProofResponse # Interface: ICensusProofResponse @@ -23,7 +23,7 @@ The proof for the given key #### Defined in -[api/census.ts:83](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census.ts#L83) +[api/census.ts:83](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census.ts#L83) ___ @@ -35,7 +35,7 @@ The root (id) of the census #### Defined in -[api/census.ts:78](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census.ts#L78) +[api/census.ts:78](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census.ts#L78) ___ @@ -47,7 +47,7 @@ The census siblings #### Defined in -[api/census.ts:93](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census.ts#L93) +[api/census.ts:93](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census.ts#L93) ___ @@ -59,7 +59,7 @@ The type of the census #### Defined in -[api/census.ts:68](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census.ts#L68) +[api/census.ts:68](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census.ts#L68) ___ @@ -71,7 +71,7 @@ The value for the given key #### Defined in -[api/census.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census.ts#L88) +[api/census.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census.ts#L88) ___ @@ -83,4 +83,4 @@ The weight as a string #### Defined in -[api/census.ts:73](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census.ts#L73) +[api/census.ts:73](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census.ts#L73) diff --git a/docs/sdk/reference/interfaces/ICensusPublishResponse.md b/docs/sdk/reference/interfaces/ICensusPublishResponse.md index bff02d28c..72d6e34f7 100644 --- a/docs/sdk/reference/interfaces/ICensusPublishResponse.md +++ b/docs/sdk/reference/interfaces/ICensusPublishResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ICensusPublishResponse +[@vocdoni/sdk](/sdk) / ICensusPublishResponse # Interface: ICensusPublishResponse @@ -19,7 +19,7 @@ The identifier of the published census #### Defined in -[api/census.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census.ts#L32) +[api/census.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census.ts#L32) ___ @@ -31,4 +31,4 @@ The URI of the published census #### Defined in -[api/census.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census.ts#L37) +[api/census.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census.ts#L37) diff --git a/docs/sdk/reference/interfaces/IChainBlockInfoResponse.md b/docs/sdk/reference/interfaces/IChainBlockInfoResponse.md index e349191e0..484ee1dec 100644 --- a/docs/sdk/reference/interfaces/IChainBlockInfoResponse.md +++ b/docs/sdk/reference/interfaces/IChainBlockInfoResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IChainBlockInfoResponse +[@vocdoni/sdk](/sdk) / IChainBlockInfoResponse # Interface: IChainBlockInfoResponse @@ -26,7 +26,7 @@ #### Defined in -[api/chain.ts:272](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L272) +[api/chain.ts:272](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L272) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[api/chain.ts:275](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L275) +[api/chain.ts:275](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L275) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[api/chain.ts:278](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L278) +[api/chain.ts:278](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L278) ___ @@ -83,7 +83,7 @@ ___ #### Defined in -[api/chain.ts:279](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L279) +[api/chain.ts:279](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L279) ___ @@ -102,4 +102,4 @@ ___ #### Defined in -[api/chain.ts:298](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L298) +[api/chain.ts:298](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L298) diff --git a/docs/sdk/reference/interfaces/IChainGetCircuitResponse.md b/docs/sdk/reference/interfaces/IChainGetCircuitResponse.md index 41aa7f87c..c75e7dd12 100644 --- a/docs/sdk/reference/interfaces/IChainGetCircuitResponse.md +++ b/docs/sdk/reference/interfaces/IChainGetCircuitResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IChainGetCircuitResponse +[@vocdoni/sdk](/sdk) / IChainGetCircuitResponse # Interface: IChainGetCircuitResponse @@ -26,7 +26,7 @@ The path of the circuit. #### Defined in -[api/chain.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L127) +[api/chain.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L127) ___ @@ -38,7 +38,7 @@ The circuit levels. #### Defined in -[api/chain.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L132) +[api/chain.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L132) ___ @@ -50,7 +50,7 @@ The base uri of the files. #### Defined in -[api/chain.ts:122](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L122) +[api/chain.ts:122](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L122) ___ @@ -62,7 +62,7 @@ The name of the verification key file. #### Defined in -[api/chain.ts:152](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L152) +[api/chain.ts:152](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L152) ___ @@ -74,7 +74,7 @@ The hash of the verification key file. #### Defined in -[api/chain.ts:147](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L147) +[api/chain.ts:147](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L147) ___ @@ -86,7 +86,7 @@ The name of the WASM file. #### Defined in -[api/chain.ts:162](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L162) +[api/chain.ts:162](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L162) ___ @@ -98,7 +98,7 @@ The hash of the WASM file. #### Defined in -[api/chain.ts:157](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L157) +[api/chain.ts:157](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L157) ___ @@ -110,7 +110,7 @@ The name of the proving key file. #### Defined in -[api/chain.ts:142](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L142) +[api/chain.ts:142](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L142) ___ @@ -122,4 +122,4 @@ The hash of the proving key file. #### Defined in -[api/chain.ts:137](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L137) +[api/chain.ts:137](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L137) diff --git a/docs/sdk/reference/interfaces/IChainGetCostsResponse.md b/docs/sdk/reference/interfaces/IChainGetCostsResponse.md index 93720a966..ecc2d736c 100644 --- a/docs/sdk/reference/interfaces/IChainGetCostsResponse.md +++ b/docs/sdk/reference/interfaces/IChainGetCostsResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IChainGetCostsResponse +[@vocdoni/sdk](/sdk) / IChainGetCostsResponse # Interface: IChainGetCostsResponse @@ -20,7 +20,7 @@ The base price. #### Defined in -[api/chain.ts:97](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L97) +[api/chain.ts:97](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L97) ___ @@ -32,7 +32,7 @@ The capacity of the chain. #### Defined in -[api/chain.ts:102](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L102) +[api/chain.ts:102](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L102) ___ @@ -56,4 +56,4 @@ The factors. #### Defined in -[api/chain.ts:107](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L107) +[api/chain.ts:107](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L107) diff --git a/docs/sdk/reference/interfaces/IChainGetInfoResponse.md b/docs/sdk/reference/interfaces/IChainGetInfoResponse.md index f350960e3..e054b95aa 100644 --- a/docs/sdk/reference/interfaces/IChainGetInfoResponse.md +++ b/docs/sdk/reference/interfaces/IChainGetInfoResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IChainGetInfoResponse +[@vocdoni/sdk](/sdk) / IChainGetInfoResponse # Interface: IChainGetInfoResponse @@ -30,7 +30,7 @@ The different block times from the chain. #### Defined in -[api/chain.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L35) +[api/chain.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L35) ___ @@ -42,7 +42,7 @@ The timestamp of the actual block. #### Defined in -[api/chain.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L65) +[api/chain.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L65) ___ @@ -54,7 +54,7 @@ The id of the current chain #### Defined in -[api/chain.ts:30](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L30) +[api/chain.ts:30](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L30) ___ @@ -66,7 +66,7 @@ The circuit configuration tag. #### Defined in -[api/chain.ts:85](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L85) +[api/chain.ts:85](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L85) ___ @@ -78,7 +78,7 @@ The number of elections existing on the Vochain. #### Defined in -[api/chain.ts:40](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L40) +[api/chain.ts:40](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L40) ___ @@ -90,7 +90,7 @@ The time of the genesis block. #### Defined in -[api/chain.ts:50](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L50) +[api/chain.ts:50](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L50) ___ @@ -102,7 +102,7 @@ The height or actual block of the current chain. #### Defined in -[api/chain.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L55) +[api/chain.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L55) ___ @@ -114,7 +114,7 @@ The maximum size of a census. #### Defined in -[api/chain.ts:90](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L90) +[api/chain.ts:90](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L90) ___ @@ -126,7 +126,7 @@ The number of organizations existing on the Vochain. #### Defined in -[api/chain.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L45) +[api/chain.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L45) ___ @@ -138,7 +138,7 @@ Whether the blockchain is syncing. #### Defined in -[api/chain.ts:60](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L60) +[api/chain.ts:60](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L60) ___ @@ -150,7 +150,7 @@ The number of transactions. #### Defined in -[api/chain.ts:70](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L70) +[api/chain.ts:70](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L70) ___ @@ -162,7 +162,7 @@ The number of validators. #### Defined in -[api/chain.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L75) +[api/chain.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L75) ___ @@ -174,4 +174,4 @@ The number of votes. #### Defined in -[api/chain.ts:80](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L80) +[api/chain.ts:80](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L80) diff --git a/docs/sdk/reference/interfaces/IChainOrganizationCountResponse.md b/docs/sdk/reference/interfaces/IChainOrganizationCountResponse.md index ca91b6fd0..c967f170f 100644 --- a/docs/sdk/reference/interfaces/IChainOrganizationCountResponse.md +++ b/docs/sdk/reference/interfaces/IChainOrganizationCountResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IChainOrganizationCountResponse +[@vocdoni/sdk](/sdk) / IChainOrganizationCountResponse # Interface: IChainOrganizationCountResponse @@ -18,4 +18,4 @@ The number of organizations #### Defined in -[api/chain.ts:241](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L241) +[api/chain.ts:241](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L241) diff --git a/docs/sdk/reference/interfaces/IChainOrganizationListResponse.md b/docs/sdk/reference/interfaces/IChainOrganizationListResponse.md index 15dbb778f..c7c420812 100644 --- a/docs/sdk/reference/interfaces/IChainOrganizationListResponse.md +++ b/docs/sdk/reference/interfaces/IChainOrganizationListResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IChainOrganizationListResponse +[@vocdoni/sdk](/sdk) / IChainOrganizationListResponse # Interface: IChainOrganizationListResponse @@ -18,4 +18,4 @@ The list of organizations #### Defined in -[api/chain.ts:260](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L260) +[api/chain.ts:260](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L260) diff --git a/docs/sdk/reference/interfaces/IChainOrganizationResponse.md b/docs/sdk/reference/interfaces/IChainOrganizationResponse.md index 18a786a38..09caf4a4b 100644 --- a/docs/sdk/reference/interfaces/IChainOrganizationResponse.md +++ b/docs/sdk/reference/interfaces/IChainOrganizationResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IChainOrganizationResponse +[@vocdoni/sdk](/sdk) / IChainOrganizationResponse # Interface: IChainOrganizationResponse @@ -19,7 +19,7 @@ The number of elections #### Defined in -[api/chain.ts:253](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L253) +[api/chain.ts:253](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L253) ___ @@ -31,4 +31,4 @@ The identifier of the organization #### Defined in -[api/chain.ts:248](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L248) +[api/chain.ts:248](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L248) diff --git a/docs/sdk/reference/interfaces/IChainSubmitTxResponse.md b/docs/sdk/reference/interfaces/IChainSubmitTxResponse.md index a1126503e..c8a4b5626 100644 --- a/docs/sdk/reference/interfaces/IChainSubmitTxResponse.md +++ b/docs/sdk/reference/interfaces/IChainSubmitTxResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IChainSubmitTxResponse +[@vocdoni/sdk](/sdk) / IChainSubmitTxResponse # Interface: IChainSubmitTxResponse @@ -20,7 +20,7 @@ The response code #### Defined in -[api/chain.ts:227](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L227) +[api/chain.ts:227](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L227) ___ @@ -32,7 +32,7 @@ The hash of the transaction #### Defined in -[api/chain.ts:217](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L217) +[api/chain.ts:217](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L217) ___ @@ -44,4 +44,4 @@ The response data (can vary depending on the transaction type) #### Defined in -[api/chain.ts:222](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L222) +[api/chain.ts:222](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L222) diff --git a/docs/sdk/reference/interfaces/IChainTxCountResponse.md b/docs/sdk/reference/interfaces/IChainTxCountResponse.md index 5817c37cb..1ec8481ab 100644 --- a/docs/sdk/reference/interfaces/IChainTxCountResponse.md +++ b/docs/sdk/reference/interfaces/IChainTxCountResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IChainTxCountResponse +[@vocdoni/sdk](/sdk) / IChainTxCountResponse # Interface: IChainTxCountResponse @@ -18,4 +18,4 @@ The number of transactions #### Defined in -[api/chain.ts:210](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L210) +[api/chain.ts:210](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L210) diff --git a/docs/sdk/reference/interfaces/IChainTxListResponse.md b/docs/sdk/reference/interfaces/IChainTxListResponse.md index 6633e873a..165d164ae 100644 --- a/docs/sdk/reference/interfaces/IChainTxListResponse.md +++ b/docs/sdk/reference/interfaces/IChainTxListResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IChainTxListResponse +[@vocdoni/sdk](/sdk) / IChainTxListResponse # Interface: IChainTxListResponse @@ -18,4 +18,4 @@ List of transactions reference #### Defined in -[api/chain.ts:234](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L234) +[api/chain.ts:234](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L234) diff --git a/docs/sdk/reference/interfaces/IChainTxReference.md b/docs/sdk/reference/interfaces/IChainTxReference.md index d94aeec36..4ce589779 100644 --- a/docs/sdk/reference/interfaces/IChainTxReference.md +++ b/docs/sdk/reference/interfaces/IChainTxReference.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IChainTxReference +[@vocdoni/sdk](/sdk) / IChainTxReference # Interface: IChainTxReference @@ -22,7 +22,7 @@ The number of the block where the transaction is. #### Defined in -[api/chain.ts:193](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L193) +[api/chain.ts:193](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L193) ___ @@ -34,7 +34,7 @@ The hash of the transaction. #### Defined in -[api/chain.ts:188](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L188) +[api/chain.ts:188](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L188) ___ @@ -46,7 +46,7 @@ The index of the transaction inside the block. #### Defined in -[api/chain.ts:198](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L198) +[api/chain.ts:198](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L198) ___ @@ -58,7 +58,7 @@ The number of the transaction. #### Defined in -[api/chain.ts:183](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L183) +[api/chain.ts:183](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L183) ___ @@ -70,4 +70,4 @@ The type of the transaction. #### Defined in -[api/chain.ts:203](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L203) +[api/chain.ts:203](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L203) diff --git a/docs/sdk/reference/interfaces/IChainValidator.md b/docs/sdk/reference/interfaces/IChainValidator.md index ad8dcd2b7..e28131583 100644 --- a/docs/sdk/reference/interfaces/IChainValidator.md +++ b/docs/sdk/reference/interfaces/IChainValidator.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IChainValidator +[@vocdoni/sdk](/sdk) / IChainValidator # Interface: IChainValidator @@ -21,7 +21,7 @@ Validator address #### Defined in -[api/chain.ts:339](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L339) +[api/chain.ts:339](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L339) ___ @@ -33,7 +33,7 @@ Validator name reference. Could be empty. #### Defined in -[api/chain.ts:344](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L344) +[api/chain.ts:344](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L344) ___ @@ -45,7 +45,7 @@ Current power of the validator #### Defined in -[api/chain.ts:329](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L329) +[api/chain.ts:329](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L329) ___ @@ -57,4 +57,4 @@ Validator public key #### Defined in -[api/chain.ts:334](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L334) +[api/chain.ts:334](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L334) diff --git a/docs/sdk/reference/interfaces/IChainValidatorsListResponse.md b/docs/sdk/reference/interfaces/IChainValidatorsListResponse.md index dec5cec46..644a2ee19 100644 --- a/docs/sdk/reference/interfaces/IChainValidatorsListResponse.md +++ b/docs/sdk/reference/interfaces/IChainValidatorsListResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IChainValidatorsListResponse +[@vocdoni/sdk](/sdk) / IChainValidatorsListResponse # Interface: IChainValidatorsListResponse @@ -18,4 +18,4 @@ The list of validators #### Defined in -[api/chain.ts:351](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain.ts#L351) +[api/chain.ts:351](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain.ts#L351) diff --git a/docs/sdk/reference/interfaces/IChoice.md b/docs/sdk/reference/interfaces/IChoice.md index 0b05d1e20..0da0965ba 100644 --- a/docs/sdk/reference/interfaces/IChoice.md +++ b/docs/sdk/reference/interfaces/IChoice.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IChoice +[@vocdoni/sdk](/sdk) / IChoice # Interface: IChoice @@ -19,7 +19,7 @@ #### Defined in -[types/metadata/election.ts:27](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/election.ts#L27) +[types/metadata/election.ts:27](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/election.ts#L27) ___ @@ -29,7 +29,7 @@ ___ #### Defined in -[types/metadata/election.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/election.ts#L26) +[types/metadata/election.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/election.ts#L26) ___ @@ -39,7 +39,7 @@ ___ #### Defined in -[types/metadata/election.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/election.ts#L24) +[types/metadata/election.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/election.ts#L24) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[types/metadata/election.ts:25](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/election.ts#L25) +[types/metadata/election.ts:25](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/election.ts#L25) diff --git a/docs/sdk/reference/interfaces/IElectionCreateResponse.md b/docs/sdk/reference/interfaces/IElectionCreateResponse.md index 902104e2b..9c0a82a45 100644 --- a/docs/sdk/reference/interfaces/IElectionCreateResponse.md +++ b/docs/sdk/reference/interfaces/IElectionCreateResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IElectionCreateResponse +[@vocdoni/sdk](/sdk) / IElectionCreateResponse # Interface: IElectionCreateResponse @@ -20,7 +20,7 @@ The election identifier #### Defined in -[api/election.ts:134](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L134) +[api/election.ts:134](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L134) ___ @@ -32,7 +32,7 @@ The metadata URL #### Defined in -[api/election.ts:139](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L139) +[api/election.ts:139](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L139) ___ @@ -44,4 +44,4 @@ The hash of the transaction #### Defined in -[api/election.ts:129](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L129) +[api/election.ts:129](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L129) diff --git a/docs/sdk/reference/interfaces/IElectionInfoResponse.md b/docs/sdk/reference/interfaces/IElectionInfoResponse.md index 03d4e3ccf..52a3a66d3 100644 --- a/docs/sdk/reference/interfaces/IElectionInfoResponse.md +++ b/docs/sdk/reference/interfaces/IElectionInfoResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IElectionInfoResponse +[@vocdoni/sdk](/sdk) / IElectionInfoResponse # Interface: IElectionInfoResponse @@ -35,7 +35,7 @@ The census of the election #### Defined in -[api/election.ts:220](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L220) +[api/election.ts:220](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L220) ___ @@ -47,7 +47,7 @@ The chain identifier of the election #### Defined in -[api/election.ts:215](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L215) +[api/election.ts:215](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L215) ___ @@ -59,7 +59,7 @@ The date of creation of the election #### Defined in -[api/election.ts:230](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L230) +[api/election.ts:230](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L230) ___ @@ -71,7 +71,7 @@ The id of the election #### Defined in -[api/election.ts:165](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L165) +[api/election.ts:165](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L165) ___ @@ -83,7 +83,7 @@ The election mode of the election #### Defined in -[api/election.ts:240](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L240) +[api/election.ts:240](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L240) ___ @@ -95,7 +95,7 @@ The end date of the election #### Defined in -[api/election.ts:185](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L185) +[api/election.ts:185](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L185) ___ @@ -107,7 +107,7 @@ If the election has the final results #### Defined in -[api/election.ts:195](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L195) +[api/election.ts:195](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L195) ___ @@ -119,7 +119,7 @@ If the election comes from the archive #### Defined in -[api/election.ts:210](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L210) +[api/election.ts:210](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L210) ___ @@ -131,7 +131,7 @@ If the election has been ended manually #### Defined in -[api/election.ts:205](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L205) +[api/election.ts:205](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L205) ___ @@ -143,7 +143,7 @@ The metadata of the election #### Defined in -[api/election.ts:250](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L250) +[api/election.ts:250](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L250) ___ @@ -155,7 +155,7 @@ The URL of the metadata #### Defined in -[api/election.ts:225](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L225) +[api/election.ts:225](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L225) ___ @@ -167,7 +167,7 @@ The id of the organization that created the election #### Defined in -[api/election.ts:170](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L170) +[api/election.ts:170](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L170) ___ @@ -179,7 +179,7 @@ The result of the election #### Defined in -[api/election.ts:200](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L200) +[api/election.ts:200](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L200) ___ @@ -191,7 +191,7 @@ The start date of the election #### Defined in -[api/election.ts:180](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L180) +[api/election.ts:180](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L180) ___ @@ -203,7 +203,7 @@ The status of the election #### Defined in -[api/election.ts:175](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L175) +[api/election.ts:175](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L175) ___ @@ -215,7 +215,7 @@ The tally mode of the vote #### Defined in -[api/election.ts:245](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L245) +[api/election.ts:245](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L245) ___ @@ -227,7 +227,7 @@ The number of votes of the election #### Defined in -[api/election.ts:190](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L190) +[api/election.ts:190](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L190) ___ @@ -239,4 +239,4 @@ The voting mode of the election #### Defined in -[api/election.ts:235](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L235) +[api/election.ts:235](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L235) diff --git a/docs/sdk/reference/interfaces/IElectionKeysResponse.md b/docs/sdk/reference/interfaces/IElectionKeysResponse.md index f4e5c6be3..b6b91b98f 100644 --- a/docs/sdk/reference/interfaces/IElectionKeysResponse.md +++ b/docs/sdk/reference/interfaces/IElectionKeysResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IElectionKeysResponse +[@vocdoni/sdk](/sdk) / IElectionKeysResponse # Interface: IElectionKeysResponse @@ -17,7 +17,7 @@ #### Defined in -[api/election.ts:267](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L267) +[api/election.ts:267](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L267) ___ @@ -27,4 +27,4 @@ ___ #### Defined in -[api/election.ts:266](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L266) +[api/election.ts:266](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L266) diff --git a/docs/sdk/reference/interfaces/IElectionListFilter.md b/docs/sdk/reference/interfaces/IElectionListFilter.md index e6290512c..a9533dee4 100644 --- a/docs/sdk/reference/interfaces/IElectionListFilter.md +++ b/docs/sdk/reference/interfaces/IElectionListFilter.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IElectionListFilter +[@vocdoni/sdk](/sdk) / IElectionListFilter # Interface: IElectionListFilter @@ -19,7 +19,7 @@ #### Defined in -[api/election.ts:364](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L364) +[api/election.ts:364](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L364) ___ @@ -29,7 +29,7 @@ ___ #### Defined in -[api/election.ts:363](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L363) +[api/election.ts:363](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L363) ___ @@ -39,7 +39,7 @@ ___ #### Defined in -[api/election.ts:366](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L366) +[api/election.ts:366](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L366) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[api/election.ts:365](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L365) +[api/election.ts:365](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L365) diff --git a/docs/sdk/reference/interfaces/IElectionListResponse.md b/docs/sdk/reference/interfaces/IElectionListResponse.md index 94de29d82..34c7eb011 100644 --- a/docs/sdk/reference/interfaces/IElectionListResponse.md +++ b/docs/sdk/reference/interfaces/IElectionListResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IElectionListResponse +[@vocdoni/sdk](/sdk) / IElectionListResponse # Interface: IElectionListResponse @@ -18,4 +18,4 @@ List of election summaries #### Defined in -[api/election.ts:359](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L359) +[api/election.ts:359](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L359) diff --git a/docs/sdk/reference/interfaces/IElectionMode.md b/docs/sdk/reference/interfaces/IElectionMode.md index 8e416de79..d4fad46bf 100644 --- a/docs/sdk/reference/interfaces/IElectionMode.md +++ b/docs/sdk/reference/interfaces/IElectionMode.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IElectionMode +[@vocdoni/sdk](/sdk) / IElectionMode # Interface: IElectionMode @@ -22,7 +22,7 @@ If the election should start automatically #### Defined in -[api/election.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L75) +[api/election.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L75) ___ @@ -34,7 +34,7 @@ If the election has a dynamic census #### Defined in -[api/election.ts:85](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L85) +[api/election.ts:85](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L85) ___ @@ -46,7 +46,7 @@ If the election has encrypted metadata #### Defined in -[api/election.ts:90](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L90) +[api/election.ts:90](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L90) ___ @@ -58,7 +58,7 @@ If the election is interruptible #### Defined in -[api/election.ts:80](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L80) +[api/election.ts:80](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L80) ___ @@ -70,4 +70,4 @@ If the election has preregister phase #### Defined in -[api/election.ts:95](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L95) +[api/election.ts:95](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L95) diff --git a/docs/sdk/reference/interfaces/IElectionNextIdResponse.md b/docs/sdk/reference/interfaces/IElectionNextIdResponse.md index 3b5898f73..ae4d45701 100644 --- a/docs/sdk/reference/interfaces/IElectionNextIdResponse.md +++ b/docs/sdk/reference/interfaces/IElectionNextIdResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IElectionNextIdResponse +[@vocdoni/sdk](/sdk) / IElectionNextIdResponse # Interface: IElectionNextIdResponse @@ -18,4 +18,4 @@ The next election identifier #### Defined in -[api/election.ts:146](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L146) +[api/election.ts:146](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L146) diff --git a/docs/sdk/reference/interfaces/IElectionParameters.md b/docs/sdk/reference/interfaces/IElectionParameters.md index 2cdda1721..25d645fb8 100644 --- a/docs/sdk/reference/interfaces/IElectionParameters.md +++ b/docs/sdk/reference/interfaces/IElectionParameters.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IElectionParameters +[@vocdoni/sdk](/sdk) / IElectionParameters # Interface: IElectionParameters @@ -45,7 +45,7 @@ Used to add the SDK version to the election metadata #### Defined in -[types/election/election.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L155) +[types/election/election.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L155) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -[types/election/election.ts:129](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L129) +[types/election/election.ts:129](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L129) ___ @@ -67,7 +67,7 @@ Election description #### Defined in -[types/election/election.ts:114](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L114) +[types/election/election.ts:114](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L114) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -[types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L131) +[types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L131) ___ @@ -87,7 +87,7 @@ ___ #### Defined in -[types/election/election.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L128) +[types/election/election.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L128) ___ @@ -99,7 +99,7 @@ Election header image url. #### Defined in -[types/election/election.ts:118](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L118) +[types/election/election.ts:118](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L118) ___ @@ -119,7 +119,7 @@ size` error. #### Defined in -[types/election/election.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L145) +[types/election/election.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L145) ___ @@ -131,7 +131,7 @@ Metadata (anything added by the election creator) #### Defined in -[types/election/election.ts:126](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L126) +[types/election/election.ts:126](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L126) ___ @@ -141,7 +141,7 @@ ___ #### Defined in -[types/election/election.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L132) +[types/election/election.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L132) ___ @@ -151,7 +151,7 @@ ___ #### Defined in -[types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L127) +[types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L127) ___ @@ -163,7 +163,7 @@ Election stream Uri (ex: a video url) #### Defined in -[types/election/election.ts:122](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L122) +[types/election/election.ts:122](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L122) ___ @@ -175,7 +175,7 @@ Is used to remove the secret identities of the voters once the process is done. #### Defined in -[types/election/election.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L150) +[types/election/election.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L150) ___ @@ -187,7 +187,7 @@ Election title #### Defined in -[types/election/election.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L110) +[types/election/election.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L110) ___ @@ -197,4 +197,4 @@ ___ #### Defined in -[types/election/election.ts:130](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L130) +[types/election/election.ts:130](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L130) diff --git a/docs/sdk/reference/interfaces/IElectionSummary.md b/docs/sdk/reference/interfaces/IElectionSummary.md index 1264d3bf1..1783a1345 100644 --- a/docs/sdk/reference/interfaces/IElectionSummary.md +++ b/docs/sdk/reference/interfaces/IElectionSummary.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IElectionSummary +[@vocdoni/sdk](/sdk) / IElectionSummary # Interface: IElectionSummary @@ -24,7 +24,7 @@ The id of the election #### Defined in -[api/election.ts:322](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L322) +[api/election.ts:322](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L322) ___ @@ -36,7 +36,7 @@ The end date of the election #### Defined in -[api/election.ts:342](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L342) +[api/election.ts:342](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L342) ___ @@ -48,7 +48,7 @@ If the election has the final results #### Defined in -[api/election.ts:352](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L352) +[api/election.ts:352](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L352) ___ @@ -60,7 +60,7 @@ The id of the organization #### Defined in -[api/election.ts:327](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L327) +[api/election.ts:327](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L327) ___ @@ -72,7 +72,7 @@ The start date of the election #### Defined in -[api/election.ts:337](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L337) +[api/election.ts:337](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L337) ___ @@ -84,7 +84,7 @@ The status of the election #### Defined in -[api/election.ts:332](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L332) +[api/election.ts:332](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L332) ___ @@ -96,4 +96,4 @@ The number of votes of the election #### Defined in -[api/election.ts:347](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L347) +[api/election.ts:347](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L347) diff --git a/docs/sdk/reference/interfaces/IElectionType.md b/docs/sdk/reference/interfaces/IElectionType.md index 69fa85214..e400416fb 100644 --- a/docs/sdk/reference/interfaces/IElectionType.md +++ b/docs/sdk/reference/interfaces/IElectionType.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IElectionType +[@vocdoni/sdk](/sdk) / IElectionType # Interface: IElectionType @@ -22,7 +22,7 @@ Enable anonymous voting. #### Defined in -[types/election/election.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L92) +[types/election/election.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L92) ___ @@ -34,7 +34,7 @@ If false, election will start PAUSED and will have to be resumed manually. #### Defined in -[types/election/election.ts:76](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L76) +[types/election/election.ts:76](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L76) ___ @@ -46,7 +46,7 @@ Can add more voters to the census tree during the election. #### Defined in -[types/election/election.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L84) +[types/election/election.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L84) ___ @@ -58,7 +58,7 @@ The process can be paused and resumed. #### Defined in -[types/election/election.ts:80](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L80) +[types/election/election.ts:80](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L80) ___ @@ -70,4 +70,4 @@ Protect the results until the end of the process if true. It will show live resu #### Defined in -[types/election/election.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L88) +[types/election/election.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L88) diff --git a/docs/sdk/reference/interfaces/IElectionVote.md b/docs/sdk/reference/interfaces/IElectionVote.md index 89b61b3c1..70b1aa5df 100644 --- a/docs/sdk/reference/interfaces/IElectionVote.md +++ b/docs/sdk/reference/interfaces/IElectionVote.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IElectionVote +[@vocdoni/sdk](/sdk) / IElectionVote # Interface: IElectionVote @@ -22,7 +22,7 @@ Block containing the vote transaction #### Defined in -[api/election.ts:303](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L303) +[api/election.ts:303](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L303) ___ @@ -34,7 +34,7 @@ Transaction number on the block #### Defined in -[api/election.ts:308](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L308) +[api/election.ts:308](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L308) ___ @@ -46,7 +46,7 @@ Containing transaction hash #### Defined in -[api/election.ts:288](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L288) +[api/election.ts:288](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L288) ___ @@ -58,7 +58,7 @@ Vote unique identifier also known as vote nullifier #### Defined in -[api/election.ts:293](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L293) +[api/election.ts:293](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L293) ___ @@ -70,4 +70,4 @@ Account that emit the vote #### Defined in -[api/election.ts:298](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L298) +[api/election.ts:298](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L298) diff --git a/docs/sdk/reference/interfaces/IElectionVoteListResponse.md b/docs/sdk/reference/interfaces/IElectionVoteListResponse.md index d0511da7c..5570d51f9 100644 --- a/docs/sdk/reference/interfaces/IElectionVoteListResponse.md +++ b/docs/sdk/reference/interfaces/IElectionVoteListResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IElectionVoteListResponse +[@vocdoni/sdk](/sdk) / IElectionVoteListResponse # Interface: IElectionVoteListResponse @@ -18,4 +18,4 @@ List of votes #### Defined in -[api/election.ts:315](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L315) +[api/election.ts:315](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L315) diff --git a/docs/sdk/reference/interfaces/IEncryptionKey.md b/docs/sdk/reference/interfaces/IEncryptionKey.md index 2a288f3ad..fed7a6c7a 100644 --- a/docs/sdk/reference/interfaces/IEncryptionKey.md +++ b/docs/sdk/reference/interfaces/IEncryptionKey.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IEncryptionKey +[@vocdoni/sdk](/sdk) / IEncryptionKey # Interface: IEncryptionKey @@ -19,7 +19,7 @@ The index of the encryption key #### Defined in -[api/election.ts:257](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L257) +[api/election.ts:257](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L257) ___ @@ -31,4 +31,4 @@ The encryption key #### Defined in -[api/election.ts:262](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L262) +[api/election.ts:262](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L262) diff --git a/docs/sdk/reference/interfaces/IInvalidElectionParameters.md b/docs/sdk/reference/interfaces/IInvalidElectionParameters.md index f2354ddb7..9b5c8958f 100644 --- a/docs/sdk/reference/interfaces/IInvalidElectionParameters.md +++ b/docs/sdk/reference/interfaces/IInvalidElectionParameters.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IInvalidElectionParameters +[@vocdoni/sdk](/sdk) / IInvalidElectionParameters # Interface: IInvalidElectionParameters @@ -16,4 +16,4 @@ #### Defined in -[types/election/invalid.ts:2](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/invalid.ts#L2) +[types/election/invalid.ts:2](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/invalid.ts#L2) diff --git a/docs/sdk/reference/interfaces/IMultiChoiceElectionParameters.md b/docs/sdk/reference/interfaces/IMultiChoiceElectionParameters.md index 38199111f..2fdcda281 100644 --- a/docs/sdk/reference/interfaces/IMultiChoiceElectionParameters.md +++ b/docs/sdk/reference/interfaces/IMultiChoiceElectionParameters.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IMultiChoiceElectionParameters +[@vocdoni/sdk](/sdk) / IMultiChoiceElectionParameters # Interface: IMultiChoiceElectionParameters @@ -46,7 +46,7 @@ Used to add the SDK version to the election metadata #### Defined in -[types/election/election.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L155) +[types/election/election.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L155) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[types/election/multichoice.ts:10](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/multichoice.ts#L10) +[types/election/multichoice.ts:10](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/multichoice.ts#L10) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[types/election/multichoice.ts:9](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/multichoice.ts#L9) +[types/election/multichoice.ts:9](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/multichoice.ts#L9) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[types/election/election.ts:129](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L129) +[types/election/election.ts:129](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L129) ___ @@ -96,7 +96,7 @@ Election description #### Defined in -[types/election/election.ts:114](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L114) +[types/election/election.ts:114](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L114) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L131) +[types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L131) ___ @@ -124,7 +124,7 @@ ___ #### Defined in -[types/election/election.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L128) +[types/election/election.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L128) ___ @@ -140,7 +140,7 @@ Election header image url. #### Defined in -[types/election/election.ts:118](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L118) +[types/election/election.ts:118](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L118) ___ @@ -164,7 +164,7 @@ size` error. #### Defined in -[types/election/election.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L145) +[types/election/election.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L145) ___ @@ -174,7 +174,7 @@ ___ #### Defined in -[types/election/multichoice.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/multichoice.ts#L8) +[types/election/multichoice.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/multichoice.ts#L8) ___ @@ -190,7 +190,7 @@ Metadata (anything added by the election creator) #### Defined in -[types/election/election.ts:126](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L126) +[types/election/election.ts:126](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L126) ___ @@ -204,7 +204,7 @@ ___ #### Defined in -[types/election/election.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L132) +[types/election/election.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L132) ___ @@ -218,7 +218,7 @@ ___ #### Defined in -[types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L127) +[types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L127) ___ @@ -234,7 +234,7 @@ Election stream Uri (ex: a video url) #### Defined in -[types/election/election.ts:122](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L122) +[types/election/election.ts:122](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L122) ___ @@ -250,7 +250,7 @@ Is used to remove the secret identities of the voters once the process is done. #### Defined in -[types/election/election.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L150) +[types/election/election.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L150) ___ @@ -266,7 +266,7 @@ Election title #### Defined in -[types/election/election.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L110) +[types/election/election.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L110) ___ @@ -280,4 +280,4 @@ ___ #### Defined in -[types/election/election.ts:130](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L130) +[types/election/election.ts:130](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L130) diff --git a/docs/sdk/reference/interfaces/IPublishedElectionParameters.md b/docs/sdk/reference/interfaces/IPublishedElectionParameters.md index f942d651e..67aa9d0e5 100644 --- a/docs/sdk/reference/interfaces/IPublishedElectionParameters.md +++ b/docs/sdk/reference/interfaces/IPublishedElectionParameters.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IPublishedElectionParameters +[@vocdoni/sdk](/sdk) / IPublishedElectionParameters # Interface: IPublishedElectionParameters @@ -56,7 +56,7 @@ Used to add the SDK version to the election metadata #### Defined in -[types/election/election.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L155) +[types/election/election.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L155) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -[types/election/election.ts:129](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L129) +[types/election/election.ts:129](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L129) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[types/election/published.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L35) +[types/election/published.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L35) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[types/election/published.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L36) +[types/election/published.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L36) ___ @@ -106,7 +106,7 @@ Election description #### Defined in -[types/election/election.ts:114](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L114) +[types/election/election.ts:114](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L114) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L131) +[types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L131) ___ @@ -134,7 +134,7 @@ ___ #### Defined in -[types/election/election.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L128) +[types/election/election.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L128) ___ @@ -144,7 +144,7 @@ ___ #### Defined in -[types/election/published.ts:31](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L31) +[types/election/published.ts:31](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L31) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[types/election/published.ts:34](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L34) +[types/election/published.ts:34](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L34) ___ @@ -170,7 +170,7 @@ Election header image url. #### Defined in -[types/election/election.ts:118](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L118) +[types/election/election.ts:118](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L118) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[types/election/published.ts:27](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L27) +[types/election/published.ts:27](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L27) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[types/election/published.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L33) +[types/election/published.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L33) ___ @@ -214,7 +214,7 @@ size` error. #### Defined in -[types/election/election.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L145) +[types/election/election.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L145) ___ @@ -230,7 +230,7 @@ Metadata (anything added by the election creator) #### Defined in -[types/election/election.ts:126](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L126) +[types/election/election.ts:126](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L126) ___ @@ -240,7 +240,7 @@ ___ #### Defined in -[types/election/published.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L37) +[types/election/published.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L37) ___ @@ -250,7 +250,7 @@ ___ #### Defined in -[types/election/published.ts:28](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L28) +[types/election/published.ts:28](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L28) ___ @@ -264,7 +264,7 @@ ___ #### Defined in -[types/election/election.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L132) +[types/election/election.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L132) ___ @@ -274,7 +274,7 @@ ___ #### Defined in -[types/election/published.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L39) +[types/election/published.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L39) ___ @@ -284,17 +284,17 @@ ___ #### Defined in -[types/election/published.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L32) +[types/election/published.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L32) ___ ### resultsType -• **resultsType**: [`ElectionResultsType`](../modules#electionresultstype) +• **resultsType**: [`ElectionResultsType`](../sdk-reference#electionresultstype) #### Defined in -[types/election/published.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L38) +[types/election/published.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L38) ___ @@ -308,17 +308,17 @@ ___ #### Defined in -[types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L127) +[types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L127) ___ ### status -• **status**: [`AllElectionStatus`](../modules#allelectionstatus) +• **status**: [`AllElectionStatus`](../sdk-reference#allelectionstatus) #### Defined in -[types/election/published.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L29) +[types/election/published.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L29) ___ @@ -334,7 +334,7 @@ Election stream Uri (ex: a video url) #### Defined in -[types/election/election.ts:122](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L122) +[types/election/election.ts:122](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L122) ___ @@ -350,7 +350,7 @@ Is used to remove the secret identities of the voters once the process is done. #### Defined in -[types/election/election.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L150) +[types/election/election.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L150) ___ @@ -366,7 +366,7 @@ Election title #### Defined in -[types/election/election.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L110) +[types/election/election.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L110) ___ @@ -376,7 +376,7 @@ ___ #### Defined in -[types/election/published.ts:30](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L30) +[types/election/published.ts:30](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L30) ___ @@ -390,4 +390,4 @@ ___ #### Defined in -[types/election/election.ts:130](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L130) +[types/election/election.ts:130](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L130) diff --git a/docs/sdk/reference/interfaces/IQuestion.md b/docs/sdk/reference/interfaces/IQuestion.md index 72d4d211f..a1a7824fd 100644 --- a/docs/sdk/reference/interfaces/IQuestion.md +++ b/docs/sdk/reference/interfaces/IQuestion.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IQuestion +[@vocdoni/sdk](/sdk) / IQuestion # Interface: IQuestion @@ -19,7 +19,7 @@ #### Defined in -[types/metadata/election.ts:34](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/election.ts#L34) +[types/metadata/election.ts:34](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/election.ts#L34) ___ @@ -29,7 +29,7 @@ ___ #### Defined in -[types/metadata/election.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/election.ts#L32) +[types/metadata/election.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/election.ts#L32) ___ @@ -39,7 +39,7 @@ ___ #### Defined in -[types/metadata/election.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/election.ts#L33) +[types/metadata/election.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/election.ts#L33) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[types/metadata/election.ts:31](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/election.ts#L31) +[types/metadata/election.ts:31](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/election.ts#L31) diff --git a/docs/sdk/reference/interfaces/ITallyMode.md b/docs/sdk/reference/interfaces/ITallyMode.md index 56e05cc3b..c616047e7 100644 --- a/docs/sdk/reference/interfaces/ITallyMode.md +++ b/docs/sdk/reference/interfaces/ITallyMode.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ITallyMode +[@vocdoni/sdk](/sdk) / ITallyMode # Interface: ITallyMode @@ -22,7 +22,7 @@ The cost exponent of the vote #### Defined in -[api/election.ts:122](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L122) +[api/election.ts:122](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L122) ___ @@ -34,7 +34,7 @@ The max count of the vote's values sum #### Defined in -[api/election.ts:102](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L102) +[api/election.ts:102](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L102) ___ @@ -46,7 +46,7 @@ The max total cost of the votes #### Defined in -[api/election.ts:117](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L117) +[api/election.ts:117](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L117) ___ @@ -58,7 +58,7 @@ The max value of the vote's values #### Defined in -[api/election.ts:107](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L107) +[api/election.ts:107](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L107) ___ @@ -70,4 +70,4 @@ The max number of votes overwrites #### Defined in -[api/election.ts:112](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L112) +[api/election.ts:112](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L112) diff --git a/docs/sdk/reference/interfaces/IVoteInfoResponse.md b/docs/sdk/reference/interfaces/IVoteInfoResponse.md index 0f184d923..4a911d067 100644 --- a/docs/sdk/reference/interfaces/IVoteInfoResponse.md +++ b/docs/sdk/reference/interfaces/IVoteInfoResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IVoteInfoResponse +[@vocdoni/sdk](/sdk) / IVoteInfoResponse # Interface: IVoteInfoResponse @@ -27,7 +27,7 @@ The block number where the transaction is mined. #### Defined in -[api/vote.ts:56](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/vote.ts#L56) +[api/vote.ts:56](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/vote.ts#L56) ___ @@ -39,7 +39,7 @@ Date when the vote was emitted #### Defined in -[api/vote.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/vote.ts#L71) +[api/vote.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/vote.ts#L71) ___ @@ -51,7 +51,7 @@ The identifier of the election. #### Defined in -[api/vote.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/vote.ts#L51) +[api/vote.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/vote.ts#L51) ___ @@ -63,7 +63,7 @@ Encryption key indexes used #### Defined in -[api/vote.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/vote.ts#L36) +[api/vote.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/vote.ts#L36) ___ @@ -75,7 +75,7 @@ The number of votes overwrites. #### Defined in -[api/vote.ts:66](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/vote.ts#L66) +[api/vote.ts:66](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/vote.ts#L66) ___ @@ -87,7 +87,7 @@ The stringified vote package JSON. #### Defined in -[api/vote.ts:41](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/vote.ts#L41) +[api/vote.ts:41](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/vote.ts#L41) ___ @@ -99,7 +99,7 @@ The index inside the block where the transaction is mined. #### Defined in -[api/vote.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/vote.ts#L61) +[api/vote.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/vote.ts#L61) ___ @@ -111,7 +111,7 @@ The hash of the transaction #### Defined in -[api/vote.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/vote.ts#L26) +[api/vote.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/vote.ts#L26) ___ @@ -123,7 +123,7 @@ The identifier of the vote, also called nullifier. #### Defined in -[api/vote.ts:31](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/vote.ts#L31) +[api/vote.ts:31](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/vote.ts#L31) ___ @@ -135,4 +135,4 @@ The weight of the vote. #### Defined in -[api/vote.ts:46](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/vote.ts#L46) +[api/vote.ts:46](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/vote.ts#L46) diff --git a/docs/sdk/reference/interfaces/IVoteMode.md b/docs/sdk/reference/interfaces/IVoteMode.md index 88dae627b..a5a31c364 100644 --- a/docs/sdk/reference/interfaces/IVoteMode.md +++ b/docs/sdk/reference/interfaces/IVoteMode.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IVoteMode +[@vocdoni/sdk](/sdk) / IVoteMode # Interface: IVoteMode @@ -22,7 +22,7 @@ If the vote is anonymous #### Defined in -[api/election.ts:53](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L53) +[api/election.ts:53](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L53) ___ @@ -34,7 +34,7 @@ Cost from weight of the election #### Defined in -[api/election.ts:68](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L68) +[api/election.ts:68](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L68) ___ @@ -46,7 +46,7 @@ If the vote is encrypted #### Defined in -[api/election.ts:58](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L58) +[api/election.ts:58](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L58) ___ @@ -58,7 +58,7 @@ If the vote is serial #### Defined in -[api/election.ts:48](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L48) +[api/election.ts:48](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L48) ___ @@ -70,4 +70,4 @@ If the vote values are unique #### Defined in -[api/election.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/election.ts#L63) +[api/election.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/election.ts#L63) diff --git a/docs/sdk/reference/interfaces/IVoteSubmitResponse.md b/docs/sdk/reference/interfaces/IVoteSubmitResponse.md index 76cee5056..cdbc657f3 100644 --- a/docs/sdk/reference/interfaces/IVoteSubmitResponse.md +++ b/docs/sdk/reference/interfaces/IVoteSubmitResponse.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IVoteSubmitResponse +[@vocdoni/sdk](/sdk) / IVoteSubmitResponse # Interface: IVoteSubmitResponse @@ -19,7 +19,7 @@ The hash of the transaction #### Defined in -[api/vote.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/vote.ts#L14) +[api/vote.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/vote.ts#L14) ___ @@ -31,4 +31,4 @@ The identifier of the vote, also called nullifier. #### Defined in -[api/vote.ts:19](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/vote.ts#L19) +[api/vote.ts:19](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/vote.ts#L19) diff --git a/docs/sdk/reference/interfaces/IVoteType.md b/docs/sdk/reference/interfaces/IVoteType.md index 6e6111e51..fec39681b 100644 --- a/docs/sdk/reference/interfaces/IVoteType.md +++ b/docs/sdk/reference/interfaces/IVoteType.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / IVoteType +[@vocdoni/sdk](/sdk) / IVoteType # Interface: IVoteType @@ -46,7 +46,7 @@ assigned to each voter determines the credits they have available for voting. #### Defined in -[types/election/election.ts:46](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L46) +[types/election/election.ts:46](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L46) ___ @@ -59,7 +59,7 @@ several choices, even including quadratic voting scenarios. #### Defined in -[types/election/election.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L20) +[types/election/election.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L20) ___ @@ -76,7 +76,7 @@ this value should match the total number of choices available for voting. #### Defined in -[types/election/election.ts:62](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L62) +[types/election/election.ts:62](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L62) ___ @@ -91,7 +91,7 @@ A value of 0 implies no maximum limit or that this parameter is not applicable i #### Defined in -[types/election/election.ts:69](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L69) +[types/election/election.ts:69](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L69) ___ @@ -106,7 +106,7 @@ In the context of a quadratic voting system, this value should typically be set #### Defined in -[types/election/election.ts:53](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L53) +[types/election/election.ts:53](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L53) ___ @@ -118,7 +118,7 @@ The number of times a voter con overwrite its vote (change vote option). #### Defined in -[types/election/election.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L15) +[types/election/election.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L15) ___ @@ -130,4 +130,4 @@ Voter can only select one answer for question #### Defined in -[types/election/election.ts:11](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L11) +[types/election/election.ts:11](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L11) diff --git a/docs/sdk/reference/interfaces/MintTokensTx.md b/docs/sdk/reference/interfaces/MintTokensTx.md index 638c7f922..f920e9c2c 100644 --- a/docs/sdk/reference/interfaces/MintTokensTx.md +++ b/docs/sdk/reference/interfaces/MintTokensTx.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / MintTokensTx +[@vocdoni/sdk](/sdk) / MintTokensTx # Interface: MintTokensTx @@ -19,7 +19,7 @@ #### Defined in -[api/chain/transactions.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L128) +[api/chain/transactions.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L128) ___ @@ -29,7 +29,7 @@ ___ #### Defined in -[api/chain/transactions.ts:129](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L129) +[api/chain/transactions.ts:129](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L129) ___ @@ -39,7 +39,7 @@ ___ #### Defined in -[api/chain/transactions.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L127) +[api/chain/transactions.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L127) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[api/chain/transactions.ts:130](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L130) +[api/chain/transactions.ts:130](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L130) diff --git a/docs/sdk/reference/interfaces/NewProcessTx.md b/docs/sdk/reference/interfaces/NewProcessTx.md index 14a282a8a..964fc5a4a 100644 --- a/docs/sdk/reference/interfaces/NewProcessTx.md +++ b/docs/sdk/reference/interfaces/NewProcessTx.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / NewProcessTx +[@vocdoni/sdk](/sdk) / NewProcessTx # Interface: NewProcessTx @@ -18,7 +18,7 @@ #### Defined in -[api/chain/transactions.ts:85](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L85) +[api/chain/transactions.ts:85](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L85) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[api/chain/transactions.ts:86](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L86) +[api/chain/transactions.ts:86](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L86) ___ @@ -38,4 +38,4 @@ ___ #### Defined in -[api/chain/transactions.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L84) +[api/chain/transactions.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L84) diff --git a/docs/sdk/reference/interfaces/Process.md b/docs/sdk/reference/interfaces/Process.md index 460ccfbd2..4e976da21 100644 --- a/docs/sdk/reference/interfaces/Process.md +++ b/docs/sdk/reference/interfaces/Process.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / Process +[@vocdoni/sdk](/sdk) / Process # Interface: Process @@ -48,7 +48,7 @@ BlockCount represents the amount of tendermint blocks that the process will last #### Defined in -[api/chain/transactions.ts:174](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L174) +[api/chain/transactions.ts:174](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L174) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[api/chain/transactions.ts:192](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L192) +[api/chain/transactions.ts:192](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L192) ___ @@ -70,7 +70,7 @@ CensusRoot merkle root of all the census in the process #### Defined in -[api/chain/transactions.ts:176](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L176) +[api/chain/transactions.ts:176](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L176) ___ @@ -82,7 +82,7 @@ CensusURI where to find the census #### Defined in -[api/chain/transactions.ts:178](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L178) +[api/chain/transactions.ts:178](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L178) ___ @@ -94,7 +94,7 @@ EncryptionPrivateKeys are the keys required to decrypt the votes #### Defined in -[api/chain/transactions.ts:180](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L180) +[api/chain/transactions.ts:180](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L180) ___ @@ -106,7 +106,7 @@ EncryptionPublicKeys are the keys required to encrypt the votes #### Defined in -[api/chain/transactions.ts:182](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L182) +[api/chain/transactions.ts:182](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L182) ___ @@ -118,7 +118,7 @@ EntityId identifies unequivocally an entity #### Defined in -[api/chain/transactions.ts:170](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L170) +[api/chain/transactions.ts:170](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L170) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[api/chain/transactions.ts:187](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L187) +[api/chain/transactions.ts:187](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L187) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -[api/chain/transactions.ts:195](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L195) +[api/chain/transactions.ts:195](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L195) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -[api/chain/transactions.ts:183](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L183) +[api/chain/transactions.ts:183](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L183) ___ @@ -160,7 +160,7 @@ MaxCensusSize is set by the Process creator. #### Defined in -[api/chain/transactions.ts:205](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L205) +[api/chain/transactions.ts:205](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L205) ___ @@ -172,7 +172,7 @@ Metadata is the content hashed URI of the JSON meta data (See Data Origins) #### Defined in -[api/chain/transactions.ts:201](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L201) +[api/chain/transactions.ts:201](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L201) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[api/chain/transactions.ts:188](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L188) +[api/chain/transactions.ts:188](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L188) ___ @@ -192,7 +192,7 @@ ___ #### Defined in -[api/chain/transactions.ts:186](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L186) +[api/chain/transactions.ts:186](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L186) ___ @@ -205,7 +205,7 @@ Used when Mode.PreRegister = true. #### Defined in -[api/chain/transactions.ts:220](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L220) +[api/chain/transactions.ts:220](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L220) ___ @@ -217,7 +217,7 @@ Owner is the creator of a process (if any) otherwise is assumed the creator is t #### Defined in -[api/chain/transactions.ts:199](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L199) +[api/chain/transactions.ts:199](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L199) ___ @@ -227,7 +227,7 @@ ___ #### Defined in -[api/chain/transactions.ts:185](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L185) +[api/chain/transactions.ts:185](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L185) ___ @@ -237,7 +237,7 @@ ___ #### Defined in -[api/chain/transactions.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L168) +[api/chain/transactions.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L168) ___ @@ -247,7 +247,7 @@ ___ #### Defined in -[api/chain/transactions.ts:190](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L190) +[api/chain/transactions.ts:190](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L190) ___ @@ -257,7 +257,7 @@ ___ #### Defined in -[api/chain/transactions.ts:189](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L189) +[api/chain/transactions.ts:189](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L189) ___ @@ -267,7 +267,7 @@ ___ #### Defined in -[api/chain/transactions.ts:193](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L193) +[api/chain/transactions.ts:193](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L193) ___ @@ -277,7 +277,7 @@ ___ #### Defined in -[api/chain/transactions.ts:194](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L194) +[api/chain/transactions.ts:194](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L194) ___ @@ -290,7 +290,7 @@ vocdoni-node when Mode.Process = true #### Defined in -[api/chain/transactions.ts:210](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L210) +[api/chain/transactions.ts:210](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L210) ___ @@ -303,7 +303,7 @@ true and the StartBlock has been reached. #### Defined in -[api/chain/transactions.ts:215](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L215) +[api/chain/transactions.ts:215](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L215) ___ @@ -315,7 +315,7 @@ SourceBlockHeight is the block height of the origin blockchain (if any) #### Defined in -[api/chain/transactions.ts:197](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L197) +[api/chain/transactions.ts:197](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L197) ___ @@ -328,7 +328,7 @@ the contract address of the token that is going to define the census #### Defined in -[api/chain/transactions.ts:225](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L225) +[api/chain/transactions.ts:225](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L225) ___ @@ -340,7 +340,7 @@ SourceNetworkId is the identifier of the network origin (where the process have #### Defined in -[api/chain/transactions.ts:203](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L203) +[api/chain/transactions.ts:203](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L203) ___ @@ -352,7 +352,7 @@ StartBlock represents the tendermint block where the process goes from scheduled #### Defined in -[api/chain/transactions.ts:172](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L172) +[api/chain/transactions.ts:172](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L172) ___ @@ -362,7 +362,7 @@ ___ #### Defined in -[api/chain/transactions.ts:184](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L184) +[api/chain/transactions.ts:184](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L184) ___ @@ -375,7 +375,7 @@ It is normally used for processes with on-chain census #### Defined in -[api/chain/transactions.ts:230](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L230) +[api/chain/transactions.ts:230](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L230) ___ @@ -385,4 +385,4 @@ ___ #### Defined in -[api/chain/transactions.ts:191](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L191) +[api/chain/transactions.ts:191](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L191) diff --git a/docs/sdk/reference/interfaces/Proof.md b/docs/sdk/reference/interfaces/Proof.md index fd9750312..55c03d847 100644 --- a/docs/sdk/reference/interfaces/Proof.md +++ b/docs/sdk/reference/interfaces/Proof.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / Proof +[@vocdoni/sdk](/sdk) / Proof # Interface: Proof @@ -16,4 +16,4 @@ #### Defined in -[api/chain/transactions.ts:341](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L341) +[api/chain/transactions.ts:341](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L341) diff --git a/docs/sdk/reference/interfaces/RegisterKeyTx.md b/docs/sdk/reference/interfaces/RegisterKeyTx.md index 01c848866..a83536b8b 100644 --- a/docs/sdk/reference/interfaces/RegisterKeyTx.md +++ b/docs/sdk/reference/interfaces/RegisterKeyTx.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / RegisterKeyTx +[@vocdoni/sdk](/sdk) / RegisterKeyTx # Interface: RegisterKeyTx @@ -22,7 +22,7 @@ New key to register #### Defined in -[api/chain/transactions.ts:121](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L121) +[api/chain/transactions.ts:121](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L121) ___ @@ -34,7 +34,7 @@ Unique number per vote attempt, so that replay attacks can't reuse this payload #### Defined in -[api/chain/transactions.ts:115](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L115) +[api/chain/transactions.ts:115](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L115) ___ @@ -46,7 +46,7 @@ The process for which the vote is casted #### Defined in -[api/chain/transactions.ts:117](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L117) +[api/chain/transactions.ts:117](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L117) ___ @@ -58,7 +58,7 @@ Franchise proof #### Defined in -[api/chain/transactions.ts:119](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L119) +[api/chain/transactions.ts:119](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L119) ___ @@ -70,4 +70,4 @@ Weight to delegate to newKey #### Defined in -[api/chain/transactions.ts:123](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L123) +[api/chain/transactions.ts:123](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L123) diff --git a/docs/sdk/reference/interfaces/SendTokensTx.md b/docs/sdk/reference/interfaces/SendTokensTx.md index 39efae102..1096910f6 100644 --- a/docs/sdk/reference/interfaces/SendTokensTx.md +++ b/docs/sdk/reference/interfaces/SendTokensTx.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / SendTokensTx +[@vocdoni/sdk](/sdk) / SendTokensTx # Interface: SendTokensTx @@ -20,7 +20,7 @@ #### Defined in -[api/chain/transactions.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L136) +[api/chain/transactions.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L136) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[api/chain/transactions.ts:135](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L135) +[api/chain/transactions.ts:135](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L135) ___ @@ -40,7 +40,7 @@ ___ #### Defined in -[api/chain/transactions.ts:137](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L137) +[api/chain/transactions.ts:137](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L137) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -[api/chain/transactions.ts:134](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L134) +[api/chain/transactions.ts:134](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L134) ___ @@ -60,4 +60,4 @@ ___ #### Defined in -[api/chain/transactions.ts:138](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L138) +[api/chain/transactions.ts:138](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L138) diff --git a/docs/sdk/reference/interfaces/ServiceProperties.md b/docs/sdk/reference/interfaces/ServiceProperties.md index dc0fd9d0e..a891177fe 100644 --- a/docs/sdk/reference/interfaces/ServiceProperties.md +++ b/docs/sdk/reference/interfaces/ServiceProperties.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / ServiceProperties +[@vocdoni/sdk](/sdk) / ServiceProperties # Interface: ServiceProperties @@ -20,4 +20,4 @@ #### Defined in -[services/service.ts:2](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/service.ts#L2) +[services/service.ts:2](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/service.ts#L2) diff --git a/docs/sdk/reference/interfaces/SetAccountTx.md b/docs/sdk/reference/interfaces/SetAccountTx.md index 3c6aff358..79bed1028 100644 --- a/docs/sdk/reference/interfaces/SetAccountTx.md +++ b/docs/sdk/reference/interfaces/SetAccountTx.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / SetAccountTx +[@vocdoni/sdk](/sdk) / SetAccountTx # Interface: SetAccountTx @@ -21,7 +21,7 @@ #### Defined in -[api/chain/transactions.ts:151](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L151) +[api/chain/transactions.ts:151](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L151) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -[api/chain/transactions.ts:153](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L153) +[api/chain/transactions.ts:153](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L153) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[api/chain/transactions.ts:152](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L152) +[api/chain/transactions.ts:152](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L152) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[api/chain/transactions.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L150) +[api/chain/transactions.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L150) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[api/chain/transactions.ts:149](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L149) +[api/chain/transactions.ts:149](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L149) ___ @@ -71,4 +71,4 @@ ___ #### Defined in -[api/chain/transactions.ts:148](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L148) +[api/chain/transactions.ts:148](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L148) diff --git a/docs/sdk/reference/interfaces/SetProcessTx.md b/docs/sdk/reference/interfaces/SetProcessTx.md index eede7131d..ce5ff1408 100644 --- a/docs/sdk/reference/interfaces/SetProcessTx.md +++ b/docs/sdk/reference/interfaces/SetProcessTx.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / SetProcessTx +[@vocdoni/sdk](/sdk) / SetProcessTx # Interface: SetProcessTx @@ -24,7 +24,7 @@ #### Defined in -[api/chain/transactions.ts:107](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L107) +[api/chain/transactions.ts:107](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L107) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[api/chain/transactions.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L108) +[api/chain/transactions.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L108) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[api/chain/transactions.ts:103](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L103) +[api/chain/transactions.ts:103](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L103) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[api/chain/transactions.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L104) +[api/chain/transactions.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L104) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[api/chain/transactions.ts:109](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L109) +[api/chain/transactions.ts:109](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L109) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[api/chain/transactions.ts:106](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L106) +[api/chain/transactions.ts:106](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L106) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[api/chain/transactions.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L110) +[api/chain/transactions.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L110) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[api/chain/transactions.ts:105](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L105) +[api/chain/transactions.ts:105](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L105) ___ @@ -104,4 +104,4 @@ ___ #### Defined in -[api/chain/transactions.ts:102](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L102) +[api/chain/transactions.ts:102](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L102) diff --git a/docs/sdk/reference/interfaces/SetTransactionCostsTx.md b/docs/sdk/reference/interfaces/SetTransactionCostsTx.md index 156dd0cb5..1f8f8152a 100644 --- a/docs/sdk/reference/interfaces/SetTransactionCostsTx.md +++ b/docs/sdk/reference/interfaces/SetTransactionCostsTx.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / SetTransactionCostsTx +[@vocdoni/sdk](/sdk) / SetTransactionCostsTx # Interface: SetTransactionCostsTx @@ -18,7 +18,7 @@ #### Defined in -[api/chain/transactions.ts:143](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L143) +[api/chain/transactions.ts:143](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L143) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[api/chain/transactions.ts:142](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L142) +[api/chain/transactions.ts:142](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L142) ___ @@ -38,4 +38,4 @@ ___ #### Defined in -[api/chain/transactions.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L144) +[api/chain/transactions.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L144) diff --git a/docs/sdk/reference/interfaces/Tx.md b/docs/sdk/reference/interfaces/Tx.md index 292828fda..497c8e4ce 100644 --- a/docs/sdk/reference/interfaces/Tx.md +++ b/docs/sdk/reference/interfaces/Tx.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / Tx +[@vocdoni/sdk](/sdk) / Tx # Interface: Tx @@ -17,7 +17,7 @@ #### Defined in -[api/chain/transactions.ts:4](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L4) +[api/chain/transactions.ts:4](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L4) ___ @@ -27,4 +27,4 @@ ___ #### Defined in -[api/chain/transactions.ts:53](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L53) +[api/chain/transactions.ts:53](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L53) diff --git a/docs/sdk/reference/interfaces/VoteEnvelope.md b/docs/sdk/reference/interfaces/VoteEnvelope.md index fb7e409df..aa01787c8 100644 --- a/docs/sdk/reference/interfaces/VoteEnvelope.md +++ b/docs/sdk/reference/interfaces/VoteEnvelope.md @@ -1,4 +1,4 @@ -[@vocdoni/sdk](/sdk) / [Exports](../modules) / VoteEnvelope +[@vocdoni/sdk](/sdk) / VoteEnvelope # Interface: VoteEnvelope @@ -23,7 +23,7 @@ On encrypted votes, contains the (sorted) indexes of the keys used to encrypt #### Defined in -[api/chain/transactions.ts:80](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L80) +[api/chain/transactions.ts:80](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L80) ___ @@ -35,7 +35,7 @@ Unique number per vote attempt, so that replay attacks can't reuse this payload #### Defined in -[api/chain/transactions.ts:60](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L60) +[api/chain/transactions.ts:60](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L60) ___ @@ -47,7 +47,7 @@ Hash of the private key + processId #### Defined in -[api/chain/transactions.ts:76](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L76) +[api/chain/transactions.ts:76](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L76) ___ @@ -59,7 +59,7 @@ The process for which the vote is casted #### Defined in -[api/chain/transactions.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L64) +[api/chain/transactions.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L64) ___ @@ -71,7 +71,7 @@ Franchise proof #### Defined in -[api/chain/transactions.ts:68](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L68) +[api/chain/transactions.ts:68](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L68) ___ @@ -83,4 +83,4 @@ JSON string of the Vote Package (potentially encrypted), encoded as bytes. #### Defined in -[api/chain/transactions.ts:72](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/chain/transactions.ts#L72) +[api/chain/transactions.ts:72](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/chain/transactions.ts#L72) diff --git a/docs/sdk/reference/modules.md b/docs/sdk/reference/sdk-reference.md similarity index 75% rename from docs/sdk/reference/modules.md rename to docs/sdk/reference/sdk-reference.md index f93c2df11..b1fd6dc1f 100644 --- a/docs/sdk/reference/modules.md +++ b/docs/sdk/reference/sdk-reference.md @@ -1,24 +1,7 @@ -[@vocdoni/sdk](/sdk) / Exports - # @vocdoni/sdk ## Table of contents -### Enumerations - -- [CensusOrigin](enums/CensusOrigin) -- [CensusType](enums/CensusType) -- [CensusTypeEnum](enums/CensusTypeEnum) -- [CspProofType](enums/CspProofType) -- [ElectionCreationSteps](enums/ElectionCreationSteps) -- [ElectionResultsTypeNames](enums/ElectionResultsTypeNames) -- [ElectionStatus](enums/ElectionStatus) -- [ElectionStatusReady](enums/ElectionStatusReady) -- [EnvOptions](enums/EnvOptions) -- [TransactionType](enums/TransactionType) -- [TxType](enums/TxType) -- [VoteSteps](enums/VoteSteps) - ### Classes - [Account](classes/Account) @@ -159,74 +142,306 @@ - [Tx](interfaces/Tx) - [VoteEnvelope](interfaces/VoteEnvelope) +### Enumerations + +- [CensusOrigin](enums/CensusOrigin) +- [CensusType](enums/CensusType) +- [CensusTypeEnum](enums/CensusTypeEnum) +- [CspProofType](enums/CspProofType) +- [ElectionCreationSteps](enums/ElectionCreationSteps) +- [ElectionResultsTypeNames](enums/ElectionResultsTypeNames) +- [ElectionStatus](enums/ElectionStatus) +- [ElectionStatusReady](enums/ElectionStatusReady) +- [EnvOptions](enums/EnvOptions) +- [TransactionType](enums/TransactionType) +- [TxType](enums/TxType) +- [VoteSteps](enums/VoteSteps) + +### Functions + +- [areEqualHexStrings](sdk-reference#areequalhexstrings) +- [checkValidAccountMetadata](sdk-reference#checkvalidaccountmetadata) +- [checkValidElectionMetadata](sdk-reference#checkvalidelectionmetadata) +- [delay](sdk-reference#delay) +- [dotobject](sdk-reference#dotobject) +- [ensure0x](sdk-reference#ensure0x) +- [formatUnits](sdk-reference#formatunits) +- [getBytes](sdk-reference#getbytes) +- [getHex](sdk-reference#gethex) +- [strip0x](sdk-reference#strip0x) + ### Type Aliases -- [AccountData](modules#accountdata) -- [AllElectionStatus](modules#allelectionstatus) -- [ArchivedAccountData](modules#archivedaccountdata) -- [Census3Census](modules#census3census) -- [Census3CreateStrategyToken](modules#census3createstrategytoken) -- [Census3Strategy](modules#census3strategy) -- [Census3StrategyToken](modules#census3strategytoken) -- [Census3SummaryToken](modules#census3summarytoken) -- [Census3Token](modules#census3token) -- [CensusImportExport](modules#censusimportexport) -- [CensusProof](modules#censusproof) -- [ChainCircuits](modules#chaincircuits) -- [ChainCosts](modules#chaincosts) -- [ChainData](modules#chaindata) -- [ChainTx](modules#chaintx) -- [ClientOptions](modules#clientoptions) -- [CspCensusProof](modules#cspcensusproof) -- [ElectionCreatedInformation](modules#electioncreatedinformation) -- [ElectionCreationStepValue](modules#electioncreationstepvalue) -- [ElectionIdOption](modules#electionidoption) -- [ElectionKeys](modules#electionkeys) -- [ElectionMeta](modules#electionmeta) -- [ElectionResultsType](modules#electionresultstype) -- [FaucetOptions](modules#faucetoptions) -- [FaucetPackage](modules#faucetpackage) -- [HasAlreadyVotedOptions](modules#hasalreadyvotedoptions) -- [IAccountSummary](modules#iaccountsummary) -- [IBudgetElectionParameters](modules#ibudgetelectionparameters) -- [IsAbleToVoteOptions](modules#isabletovoteoptions) -- [IsInCensusOptions](modules#isincensusoptions) -- [ParsedPredicate](modules#parsedpredicate) -- [SendTokensOptions](modules#sendtokensoptions) -- [Strategy](modules#strategy) -- [StrategyHolder](modules#strategyholder) -- [StrategyHolders](modules#strategyholders) -- [StrategyToken](modules#strategytoken) -- [SupportedChain](modules#supportedchain) -- [SupportedOperator](modules#supportedoperator) -- [Token](modules#token) -- [TokenSummary](modules#tokensummary) -- [TxWaitOptions](modules#txwaitoptions) -- [VoteIdOption](modules#voteidoption) -- [VoteInfo](modules#voteinfo) -- [VoteStepValue](modules#votestepvalue) -- [VoteSubmit](modules#votesubmit) -- [VotesLeftCountOptions](modules#votesleftcountoptions) -- [WalletOption](modules#walletoption) -- [ZkProof](modules#zkproof) +- [AccountData](sdk-reference#accountdata) +- [AllElectionStatus](sdk-reference#allelectionstatus) +- [ArchivedAccountData](sdk-reference#archivedaccountdata) +- [Census3Census](sdk-reference#census3census) +- [Census3CreateStrategyToken](sdk-reference#census3createstrategytoken) +- [Census3Strategy](sdk-reference#census3strategy) +- [Census3StrategyToken](sdk-reference#census3strategytoken) +- [Census3SummaryToken](sdk-reference#census3summarytoken) +- [Census3Token](sdk-reference#census3token) +- [CensusImportExport](sdk-reference#censusimportexport) +- [CensusProof](sdk-reference#censusproof) +- [ChainCircuits](sdk-reference#chaincircuits) +- [ChainCosts](sdk-reference#chaincosts) +- [ChainData](sdk-reference#chaindata) +- [ChainTx](sdk-reference#chaintx) +- [ClientOptions](sdk-reference#clientoptions) +- [CspCensusProof](sdk-reference#cspcensusproof) +- [ElectionCreatedInformation](sdk-reference#electioncreatedinformation) +- [ElectionCreationStepValue](sdk-reference#electioncreationstepvalue) +- [ElectionIdOption](sdk-reference#electionidoption) +- [ElectionKeys](sdk-reference#electionkeys) +- [ElectionMeta](sdk-reference#electionmeta) +- [ElectionResultsType](sdk-reference#electionresultstype) +- [FaucetOptions](sdk-reference#faucetoptions) +- [FaucetPackage](sdk-reference#faucetpackage) +- [HasAlreadyVotedOptions](sdk-reference#hasalreadyvotedoptions) +- [IAccountSummary](sdk-reference#iaccountsummary) +- [IBudgetElectionParameters](sdk-reference#ibudgetelectionparameters) +- [IsAbleToVoteOptions](sdk-reference#isabletovoteoptions) +- [IsInCensusOptions](sdk-reference#isincensusoptions) +- [ParsedPredicate](sdk-reference#parsedpredicate) +- [SendTokensOptions](sdk-reference#sendtokensoptions) +- [Strategy](sdk-reference#strategy) +- [StrategyHolder](sdk-reference#strategyholder) +- [StrategyHolders](sdk-reference#strategyholders) +- [StrategyToken](sdk-reference#strategytoken) +- [SupportedChain](sdk-reference#supportedchain) +- [SupportedOperator](sdk-reference#supportedoperator) +- [Token](sdk-reference#token) +- [TokenSummary](sdk-reference#tokensummary) +- [TxWaitOptions](sdk-reference#txwaitoptions) +- [VoteIdOption](sdk-reference#voteidoption) +- [VoteInfo](sdk-reference#voteinfo) +- [VoteStepValue](sdk-reference#votestepvalue) +- [VoteSubmit](sdk-reference#votesubmit) +- [VotesLeftCountOptions](sdk-reference#votesleftcountoptions) +- [WalletOption](sdk-reference#walletoption) +- [ZkProof](sdk-reference#zkproof) ### Variables -- [AccountMetadataTemplate](modules#accountmetadatatemplate) -- [ElectionMetadataTemplate](modules#electionmetadatatemplate) +- [AccountMetadataTemplate](sdk-reference#accountmetadatatemplate) +- [ElectionMetadataTemplate](sdk-reference#electionmetadatatemplate) -### Functions +## Functions + +### areEqualHexStrings + +▸ **areEqualHexStrings**(`hex1?`, `hex2?`): `boolean` + +Compares two hex strings checking if they're the same. It ensures both +have hex prefix and are lowercase. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `hex1?` | `string` | +| `hex2?` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +[util/common.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/util/common.ts#L35) + +___ + +### checkValidAccountMetadata + +▸ **checkValidAccountMetadata**(`accountMetadata`): [`AccountMetadata`](interfaces/AccountMetadata) + +Asserts that the given metadata is valid. +Throws an exception if it is not. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `accountMetadata` | [`AccountMetadata`](interfaces/AccountMetadata) | + +#### Returns + +[`AccountMetadata`](interfaces/AccountMetadata) + +#### Defined in + +[types/metadata/account.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/account.ts#L8) + +___ + +### checkValidElectionMetadata + +▸ **checkValidElectionMetadata**(`electionMetadata`): [`ElectionMetadata`](interfaces/ElectionMetadata) + +Asserts that the given metadata is valid. +Throws an exception if it is not. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `electionMetadata` | [`ElectionMetadata`](interfaces/ElectionMetadata) | + +#### Returns + +[`ElectionMetadata`](interfaces/ElectionMetadata) + +#### Defined in + +[types/metadata/election.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/election.ts#L8) + +___ + +### delay + +▸ **delay**(`ms`): `Promise`\<`unknown`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `ms` | `any` | + +#### Returns + +`Promise`\<`unknown`\> + +#### Defined in + +[util/common.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/util/common.ts#L6) + +___ + +### dotobject + +▸ **dotobject**(`obj`, `dot`): `any` + +Dot notation to object conversion. Takes any object as first argument and uses the string dot notation from the +second argument (i.e. 'a.child.node') to access that given object value. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `obj` | `any` | Object to be accessed by dot notation | +| `dot` | `string` | Dot notation string to extract object data | + +#### Returns + +`any` + +Return the object data + +#### Defined in + +[util/common.ts:60](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/util/common.ts#L60) + +___ + +### ensure0x + +▸ **ensure0x**(`value`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `string` | + +#### Returns + +`string` + +#### Defined in + +[util/common.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/util/common.ts#L12) + +___ + +### formatUnits -- [areEqualHexStrings](modules#areequalhexstrings) -- [checkValidAccountMetadata](modules#checkvalidaccountmetadata) -- [checkValidElectionMetadata](modules#checkvalidelectionmetadata) -- [delay](modules#delay) -- [dotobject](modules#dotobject) -- [ensure0x](modules#ensure0x) -- [formatUnits](modules#formatunits) -- [getBytes](modules#getbytes) -- [getHex](modules#gethex) -- [strip0x](modules#strip0x) +▸ **formatUnits**(`value`, `decimals?`): `string` + +Returns a string representation of value formatted with decimals digits + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `value` | `BigNumberish` | `undefined` | The value in native BigInt | +| `decimals` | `number` | `18` | The number of decimals | + +#### Returns + +`string` + +The formatted string + +#### Defined in + +[util/common.ts:48](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/util/common.ts#L48) + +___ + +### getBytes + +▸ **getBytes**(`count`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `count` | `number` | + +#### Returns + +`Uint8Array` + +#### Defined in + +[util/common.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/util/common.ts#L16) + +___ + +### getHex + +▸ **getHex**(): `string` + +Generates a random seed and returns a 32 byte keccak256 hash of it (starting with "0x") + +#### Returns + +`string` + +#### Defined in + +[util/common.ts:23](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/util/common.ts#L23) + +___ + +### strip0x + +▸ **strip0x**(`value`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `string` | + +#### Returns + +`string` + +#### Defined in + +[util/common.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/util/common.ts#L8) ## Type Aliases @@ -248,7 +463,7 @@ #### Defined in -[services/account.ts:25](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/account.ts#L25) +[services/account.ts:25](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/account.ts#L25) ___ @@ -258,17 +473,17 @@ ___ #### Defined in -[types/election/published.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/published.ts#L24) +[types/election/published.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/published.ts#L24) ___ ### ArchivedAccountData -Ƭ **ArchivedAccountData**: `Pick`\<[`AccountData`](modules#accountdata), ``"address"`` \| ``"account"``\> +Ƭ **ArchivedAccountData**: `Pick`\<[`AccountData`](sdk-reference#accountdata), ``"address"`` \| ``"account"``\> #### Defined in -[services/account.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/account.ts#L35) +[services/account.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/account.ts#L35) ___ @@ -278,17 +493,17 @@ ___ #### Defined in -[census3.ts:30](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L30) +[census3.ts:30](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L30) ___ ### Census3CreateStrategyToken -Ƭ **Census3CreateStrategyToken**: `Omit`\<[`Census3StrategyToken`](modules#census3strategytoken), ``"chainAddress"``\> +Ƭ **Census3CreateStrategyToken**: `Omit`\<[`Census3StrategyToken`](sdk-reference#census3strategytoken), ``"chainAddress"``\> #### Defined in -[api/census3/strategy.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L100) +[api/census3/strategy.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L100) ___ @@ -303,12 +518,12 @@ ___ | `ID` | `number` | The strategy identifier | | `alias` | `string` | The strategy alias | | `predicate` | `string` | The strategy predicate | -| `tokens` | \{ `[key: string]`: [`Census3StrategyToken`](modules#census3strategytoken); } | The list of tokens | +| `tokens` | \{ `[key: string]`: [`Census3StrategyToken`](sdk-reference#census3strategytoken); } | The list of tokens | | `uri` | `string` | The URI of the strategy | #### Defined in -[api/census3/strategy.ts:46](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L46) +[api/census3/strategy.ts:46](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L46) ___ @@ -328,17 +543,17 @@ ___ #### Defined in -[api/census3/strategy.ts:73](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/strategy.ts#L73) +[api/census3/strategy.ts:73](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/strategy.ts#L73) ___ ### Census3SummaryToken -Ƭ **Census3SummaryToken**: `Omit`\<[`Census3Token`](modules#census3token), ``"status"`` \| ``"size"``\> & \{ `synced`: `boolean` } +Ƭ **Census3SummaryToken**: `Omit`\<[`Census3Token`](sdk-reference#census3token), ``"status"`` \| ``"size"``\> & \{ `synced`: `boolean` } #### Defined in -[api/census3/token.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/token.ts#L12) +[api/census3/token.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/token.ts#L12) ___ @@ -371,7 +586,7 @@ ___ #### Defined in -[api/census3/token.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/census3/token.ts#L14) +[api/census3/token.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/census3/token.ts#L14) ___ @@ -390,7 +605,7 @@ ___ #### Defined in -[services/census.ts:42](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/census.ts#L42) +[services/census.ts:42](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/census.ts#L42) ___ @@ -411,7 +626,7 @@ ___ #### Defined in -[services/census.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/census.ts#L26) +[services/census.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/census.ts#L26) ___ @@ -435,7 +650,7 @@ ___ #### Defined in -[services/anonymous.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L51) +[services/anonymous.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L51) ___ @@ -445,7 +660,7 @@ ___ #### Defined in -[services/chain.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/chain.ts#L14) +[services/chain.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/chain.ts#L14) ___ @@ -465,7 +680,7 @@ ___ #### Defined in -[services/chain.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/chain.ts#L29) +[services/chain.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/chain.ts#L29) ___ @@ -475,7 +690,7 @@ ___ #### Defined in -[services/chain.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/chain.ts#L15) +[services/chain.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/chain.ts#L15) ___ @@ -492,13 +707,13 @@ Optional VocdoniSDKClient arguments | `api_url?` | `string` | | `electionId?` | `string` | | `env` | [`EnvOptions`](enums/EnvOptions) | -| `faucet?` | `Partial`\<[`FaucetOptions`](modules#faucetoptions)\> | +| `faucet?` | `Partial`\<[`FaucetOptions`](sdk-reference#faucetoptions)\> | | `tx_wait?` | `TxWaitOptions` | | `wallet?` | `Wallet` \| `Signer` | #### Defined in -[client.ts:85](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/client.ts#L85) +[client.ts:85](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/client.ts#L85) ___ @@ -518,7 +733,7 @@ ___ #### Defined in -[services/census.ts:56](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/census.ts#L56) +[services/census.ts:56](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/census.ts#L56) ___ @@ -528,7 +743,7 @@ ___ #### Defined in -[services/election.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L37) +[services/election.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/election.ts#L37) ___ @@ -538,7 +753,7 @@ ___ #### Defined in -[services/election.ts:50](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L50) +[services/election.ts:50](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/election.ts#L50) ___ @@ -554,7 +769,7 @@ ___ #### Defined in -[types/client/account.ts:5](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/client/account.ts#L5) +[types/client/account.ts:5](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/client/account.ts#L5) ___ @@ -564,7 +779,7 @@ ___ #### Defined in -[services/election.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/election.ts#L36) +[services/election.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/election.ts#L36) ___ @@ -574,7 +789,7 @@ ___ #### Defined in -[types/election/election.ts:101](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/election.ts#L101) +[types/election/election.ts:101](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/election.ts#L101) ___ @@ -584,7 +799,7 @@ ___ #### Defined in -[types/metadata/election.ts:44](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/election.ts#L44) +[types/metadata/election.ts:44](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/election.ts#L44) ___ @@ -594,7 +809,7 @@ ___ #### Defined in -[services/faucet.ts:28](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/faucet.ts#L28) +[services/faucet.ts:28](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/faucet.ts#L28) ___ @@ -611,17 +826,17 @@ ___ #### Defined in -[services/faucet.ts:23](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/faucet.ts#L23) +[services/faucet.ts:23](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/faucet.ts#L23) ___ ### HasAlreadyVotedOptions -Ƭ **HasAlreadyVotedOptions**: `Partial`\<[`WalletOption`](modules.md#walletoption) & [`ElectionIdOption`](modules.md#electionidoption) & [`VoteIdOption`](modules#voteidoption)\> +Ƭ **HasAlreadyVotedOptions**: `Partial`\<[`WalletOption`](sdk-reference.md#walletoption) & [`ElectionIdOption`](sdk-reference.md#electionidoption) & [`VoteIdOption`](sdk-reference#voteidoption)\> #### Defined in -[types/client/account.ts:10](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/client/account.ts#L10) +[types/client/account.ts:10](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/client/account.ts#L10) ___ @@ -631,7 +846,7 @@ ___ #### Defined in -[api/account.ts:17](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/account.ts#L17) +[api/account.ts:17](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/api/account.ts#L17) ___ @@ -641,27 +856,27 @@ ___ #### Defined in -[types/election/budget.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/election/budget.ts#L21) +[types/election/budget.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/election/budget.ts#L21) ___ ### IsAbleToVoteOptions -Ƭ **IsAbleToVoteOptions**: `Partial`\<[`WalletOption`](modules.md#walletoption) & [`ElectionIdOption`](modules.md#electionidoption) & [`VoteIdOption`](modules#voteidoption)\> +Ƭ **IsAbleToVoteOptions**: `Partial`\<[`WalletOption`](sdk-reference.md#walletoption) & [`ElectionIdOption`](sdk-reference.md#electionidoption) & [`VoteIdOption`](sdk-reference#voteidoption)\> #### Defined in -[types/client/account.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/client/account.ts#L12) +[types/client/account.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/client/account.ts#L12) ___ ### IsInCensusOptions -Ƭ **IsInCensusOptions**: `Partial`\<[`WalletOption`](modules.md#walletoption) & [`ElectionIdOption`](modules#electionidoption)\> +Ƭ **IsInCensusOptions**: `Partial`\<[`WalletOption`](sdk-reference.md#walletoption) & [`ElectionIdOption`](sdk-reference#electionidoption)\> #### Defined in -[types/client/account.ts:9](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/client/account.ts#L9) +[types/client/account.ts:9](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/client/account.ts#L9) ___ @@ -671,27 +886,27 @@ ___ #### Defined in -[census3.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L33) +[census3.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L33) ___ ### SendTokensOptions -Ƭ **SendTokensOptions**: `Partial`\<[`WalletOption`](modules#walletoption)\> & \{ `amount`: `number` ; `to`: `string` } +Ƭ **SendTokensOptions**: `Partial`\<[`WalletOption`](sdk-reference#walletoption)\> & \{ `amount`: `number` ; `to`: `string` } #### Defined in -[types/client/account.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/client/account.ts#L8) +[types/client/account.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/client/account.ts#L8) ___ ### Strategy -Ƭ **Strategy**: [`Census3Strategy`](modules#census3strategy) +Ƭ **Strategy**: [`Census3Strategy`](sdk-reference#census3strategy) #### Defined in -[census3.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L26) +[census3.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L26) ___ @@ -708,7 +923,7 @@ ___ #### Defined in -[census3.ts:27](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L27) +[census3.ts:27](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L27) ___ @@ -720,22 +935,22 @@ ___ | Name | Type | | :------ | :------ | -| `holders` | [`StrategyHolder`](modules#strategyholder)[] | +| `holders` | [`StrategyHolder`](sdk-reference#strategyholder)[] | | `pagination` | `Census3Pagination` | #### Defined in -[census3.ts:28](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L28) +[census3.ts:28](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L28) ___ ### StrategyToken -Ƭ **StrategyToken**: [`Census3CreateStrategyToken`](modules#census3createstrategytoken) +Ƭ **StrategyToken**: [`Census3CreateStrategyToken`](sdk-reference#census3createstrategytoken) #### Defined in -[census3.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L29) +[census3.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L29) ___ @@ -745,7 +960,7 @@ ___ #### Defined in -[census3.ts:31](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L31) +[census3.ts:31](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L31) ___ @@ -755,27 +970,27 @@ ___ #### Defined in -[census3.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L32) +[census3.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L32) ___ ### Token -Ƭ **Token**: `Omit`\<[`Census3Token`](modules#census3token), ``"tags"``\> & \{ `tags`: `string`[] } +Ƭ **Token**: `Omit`\<[`Census3Token`](sdk-reference#census3token), ``"tags"``\> & \{ `tags`: `string`[] } #### Defined in -[census3.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L24) +[census3.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L24) ___ ### TokenSummary -Ƭ **TokenSummary**: `Omit`\<[`Census3SummaryToken`](modules#census3summarytoken), ``"tags"``\> & \{ `tags`: `string`[] } +Ƭ **TokenSummary**: `Omit`\<[`Census3SummaryToken`](sdk-reference#census3summarytoken), ``"tags"``\> & \{ `tags`: `string`[] } #### Defined in -[census3.ts:25](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/census3.ts#L25) +[census3.ts:25](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/census3.ts#L25) ___ @@ -794,7 +1009,7 @@ Specify custom retry times and attempts when waiting for a transaction. #### Defined in -[services/chain.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/chain.ts#L24) +[services/chain.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/chain.ts#L24) ___ @@ -810,7 +1025,7 @@ ___ #### Defined in -[types/client/account.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/client/account.ts#L6) +[types/client/account.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/client/account.ts#L6) ___ @@ -820,7 +1035,7 @@ ___ #### Defined in -[services/vote.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/vote.ts#L15) +[services/vote.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/vote.ts#L15) ___ @@ -830,7 +1045,7 @@ ___ #### Defined in -[services/vote.ts:28](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/vote.ts#L28) +[services/vote.ts:28](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/vote.ts#L28) ___ @@ -840,17 +1055,17 @@ ___ #### Defined in -[services/vote.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/vote.ts#L16) +[services/vote.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/vote.ts#L16) ___ ### VotesLeftCountOptions -Ƭ **VotesLeftCountOptions**: `Partial`\<[`WalletOption`](modules.md#walletoption) & [`ElectionIdOption`](modules.md#electionidoption) & [`VoteIdOption`](modules#voteidoption)\> +Ƭ **VotesLeftCountOptions**: `Partial`\<[`WalletOption`](sdk-reference.md#walletoption) & [`ElectionIdOption`](sdk-reference.md#electionidoption) & [`VoteIdOption`](sdk-reference#voteidoption)\> #### Defined in -[types/client/account.ts:11](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/client/account.ts#L11) +[types/client/account.ts:11](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/client/account.ts#L11) ___ @@ -866,7 +1081,7 @@ ___ #### Defined in -[types/client/account.ts:4](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/client/account.ts#L4) +[types/client/account.ts:4](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/client/account.ts#L4) ___ @@ -888,7 +1103,7 @@ ___ #### Defined in -[services/anonymous.ts:23](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/anonymous.ts#L23) +[services/anonymous.ts:23](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/services/anonymous.ts#L23) ## Variables @@ -898,7 +1113,7 @@ ___ #### Defined in -[types/metadata/account.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/account.ts#L67) +[types/metadata/account.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/account.ts#L67) ___ @@ -908,221 +1123,4 @@ ___ #### Defined in -[types/metadata/election.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/election.ts#L140) - -## Functions - -### areEqualHexStrings - -▸ **areEqualHexStrings**(`hex1?`, `hex2?`): `boolean` - -Compares two hex strings checking if they're the same. It ensures both -have hex prefix and are lowercase. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `hex1?` | `string` | -| `hex2?` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[util/common.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/util/common.ts#L36) - -___ - -### checkValidAccountMetadata - -▸ **checkValidAccountMetadata**(`accountMetadata`): [`AccountMetadata`](interfaces/AccountMetadata) - -Asserts that the given metadata is valid. -Throws an exception if it is not. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `accountMetadata` | [`AccountMetadata`](interfaces/AccountMetadata) | - -#### Returns - -[`AccountMetadata`](interfaces/AccountMetadata) - -#### Defined in - -[types/metadata/account.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/account.ts#L8) - -___ - -### checkValidElectionMetadata - -▸ **checkValidElectionMetadata**(`electionMetadata`): [`ElectionMetadata`](interfaces/ElectionMetadata) - -Asserts that the given metadata is valid. -Throws an exception if it is not. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `electionMetadata` | [`ElectionMetadata`](interfaces/ElectionMetadata) | - -#### Returns - -[`ElectionMetadata`](interfaces/ElectionMetadata) - -#### Defined in - -[types/metadata/election.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/metadata/election.ts#L8) - -___ - -### delay - -▸ **delay**(`ms`): `Promise`\<`unknown`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ms` | `any` | - -#### Returns - -`Promise`\<`unknown`\> - -#### Defined in - -[util/common.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/util/common.ts#L6) - -___ - -### dotobject - -▸ **dotobject**(`obj`, `dot`): `any` - -Dot notation to object conversion. Takes any object as first argument and uses the string dot notation from the -second argument (i.e. 'a.child.node') to access that given object value. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `obj` | `any` | Object to be accessed by dot notation | -| `dot` | `string` | Dot notation string to extract object data | - -#### Returns - -`any` - -Return the object data - -#### Defined in - -[util/common.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/util/common.ts#L61) - -___ - -### ensure0x - -▸ **ensure0x**(`value`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -`string` - -#### Defined in - -[util/common.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/util/common.ts#L12) - -___ - -### formatUnits - -▸ **formatUnits**(`value`, `decimals?`): `string` - -Returns a string representation of value formatted with decimals digits - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `value` | `BigNumberish` | `undefined` | The value in native BigInt | -| `decimals` | `number` | `18` | The number of decimals | - -#### Returns - -`string` - -The formatted string - -#### Defined in - -[util/common.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/util/common.ts#L49) - -___ - -### getBytes - -▸ **getBytes**(`count`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `count` | `number` | - -#### Returns - -`Uint8Array` - -#### Defined in - -[util/common.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/util/common.ts#L16) - -___ - -### getHex - -▸ **getHex**(): `string` - -Generates a random seed and returns a 32 byte keccak256 hash of it (starting with "0x") - -#### Returns - -`string` - -#### Defined in - -[util/common.ts:23](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/util/common.ts#L23) - -___ - -### strip0x - -▸ **strip0x**(`value`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -`string` - -#### Defined in - -[util/common.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/util/common.ts#L8) +[types/metadata/election.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/1053e59/src/types/metadata/election.ts#L140) diff --git a/package.json b/package.json index 76219d70d..340ba2731 100644 --- a/package.json +++ b/package.json @@ -31,9 +31,9 @@ "gen-post": "if [ \"$(uname)\" = \"Darwin\" ]; then npm run gen-post:Darwin; else npm run gen-post:Linux; fi", "gen-post:Darwin": "grep -L \"mdx-code-block\" docs/vocdoni-api/** | xargs -I {} sed -i '' -e $'/^\\(<\\)/i\\\n````mdx-code-block\n' -e $'/^\\(<\\)/a\\\n````' {}", "gen-post:Linux": "grep -L \"mdx-code-block\" docs/vocdoni-api/** | xargs sed -i -e '/^\\(<\\)/i````mdx-code-block' -e '/^\\(<\\)/a````'", - "copy-sdk-docs": "if [ \"$(uname)\" = \"Darwin\" ]; then npm run copy-sdk-docs:Darwin; else npm run copy-sdk-docs:Linux; fi", - "copy-sdk-docs:Darwin": "rm -rf ./docs/sdk/reference && cp -R $VOCDONI_SDK_PATH/docs/temp_docs/ ./docs/sdk/reference && rm -rf $VOCDONI_SDK_PATH/docs/temp_docs && brew install gsed && find ./docs/sdk/reference -type f | xargs gsed -i -r -e 's\/\\[\\@vocdoni\\\/sdk\\]\\((\\.\\.\\\/)*README\\.md\\)\/\\[\\@vocdoni\\\/sdk\\]\\(\\\/sdk\\)\/g' && find ./docs/sdk/reference -type f | xargs gsed -i -e 's\/(\\(.*\\).md\\(#[a-zA-Z0-9]*\\)*)\/(\\1\\2)\/g'", - "copy-sdk-docs:Linux": "rm -rf ./docs/sdk/reference && cp -R $VOCDONI_SDK_PATH/docs/temp_docs/ ./docs/sdk/reference && rm -rf $VOCDONI_SDK_PATH/docs/temp_docs && find ./docs/sdk/reference -type f | xargs sed -i -r -e 's\/\\[\\@vocdoni\\\/sdk\\]\\((\\.\\.\\\/)*README\\.md\\)\/\\[\\@vocdoni\\\/sdk\\]\\(\\\/sdk\\)\/g' && find ./docs/sdk/reference -type f | xargs sed -i -e 's\/(\\(.*\\).md\\(#[a-zA-Z0-9]*\\)*)\/(\\1\\2)\/g'" + "copy-sdk-docs": "rm -rf ./docs/sdk/reference && cp -R $VOCDONI_SDK_PATH/docs/temp_docs/ ./docs/sdk/reference && rm -rf $VOCDONI_SDK_PATH/docs/temp_docs && mv ./docs/sdk/reference/README.md ./docs/sdk/reference/sdk-reference.md && if [ \"$(uname)\" = \"Darwin\" ]; then npm run sdk-post:Darwin; else npm run sdk-post:Linux; fi", + "sdk-post:Darwin": "brew install gsed && find ./docs/sdk/reference -type f | xargs gsed -i -r -e 's\/\\[\\@vocdoni\\\/sdk\\]\\((\\.\\.\\\/)*README\\.md\\)\/\\[\\@vocdoni\\\/sdk\\]\\(\\\/sdk\\)\/g' && find ./docs/sdk/reference -type f | xargs gsed -i -e 's\/(\\(.*\\).md\\(#[a-zA-Z0-9]*\\)*)\/(\\1\\2)\/g' && gsed -i -z -r -e 's/^@vocdoni\\/sdk\\\n\\\n//g' ./docs/sdk/reference/sdk-reference.md && find ./docs/sdk/reference -type f | xargs gsed -i -e 's/README/sdk-reference/g'", + "sdk-post:Linux": "find ./docs/sdk/reference -type f | xargs sed -i -r -e 's\/\\[\\@vocdoni\\\/sdk\\]\\((\\.\\.\\\/)*README\\.md\\)\/\\[\\@vocdoni\\\/sdk\\]\\(\\\/sdk\\)\/g' && find ./docs/sdk/reference -type f | xargs sed -i -e 's\/(\\(.*\\).md\\(#[a-zA-Z0-9]*\\)*)\/(\\1\\2)\/g' && sed -i -z -r -e 's/^@vocdoni\\/sdk\\\n\\\n//g' ./docs/sdk/reference/sdk-reference.md && find ./docs/sdk/reference -type f | xargs sed -i -e 's/README/sdk-reference/g'" }, "dependencies": { "@aragon/ui-components": "0.1.3", diff --git a/sidebar.js b/sidebar.js index f84da5cb7..5fd7882f9 100644 --- a/sidebar.js +++ b/sidebar.js @@ -49,32 +49,47 @@ function modifySDKReference (items) { // Modify reference category title referenceCategory = { ...SDKCategory.items[index2], - label: 'Reference' - } - // Move Changelog to the last item - if (referenceCategory.items[0].id === 'sdk/reference/changelog') { - changelogItem = referenceCategory.items[0] - referenceCategory.items = referenceCategory.items.slice(1) - referenceCategory.items.push(changelogItem) + label: 'Reference', + link: { + type: 'doc', + id: 'sdk/reference/sdk-reference' + } } + let changelogIdx, + referenceIdx = 0 for (var index3 in referenceCategory?.items) { + // Get index of changelog file + if ( + referenceCategory.items[index3].id === 'sdk/reference/changelog' + ) { + changelogIdx = index3 + } + // Get index of reference file + if ( + referenceCategory.items[index3].id === + 'sdk/reference/sdk-reference' + ) { + referenceIdx = index3 + } // Capitalize category labels if (referenceCategory.items[index3].label != null) { referenceCategory.items[index3].label = toTitleCase( referenceCategory.items[index3].label ) } - // Capitalize modules label - if ( - referenceCategory.items[index3].id === 'sdk/reference/modules' - ) { - referenceCategory.items[index3].label = 'Modules' - } } + // Swap positions of changelog and reference links + ;[ + referenceCategory.items[referenceIdx], + referenceCategory.items[changelogIdx] + ] = [ + referenceCategory.items[changelogIdx], + referenceCategory.items[referenceIdx] + ] SDKCategory.items[index2] = referenceCategory } - items[index1] = SDKCategory } + items[index1] = SDKCategory } } return items