From b788a21a0d723473b14cfe1c19ab9275361d58d4 Mon Sep 17 00:00:00 2001 From: marcvelmer Date: Thu, 31 Oct 2024 14:14:21 +0000 Subject: [PATCH] Update vocdoni-sdk docs by commit f4514c3 --- docs/sdk/reference/changelog.md | 55 ++ docs/sdk/reference/classes/API.md | 29 + docs/sdk/reference/classes/Account.md | 38 +- docs/sdk/reference/classes/AccountAPI.md | 148 +--- docs/sdk/reference/classes/AccountService.md | 14 +- .../sdk/reference/classes/AnonymousService.md | 44 +- docs/sdk/reference/classes/AnonymousVote.md | 14 +- .../sdk/reference/classes/ApprovalElection.md | 85 +- .../sdk/reference/classes/ArchivedElection.md | 737 ------------------ docs/sdk/reference/classes/BudgetElection.md | 101 +-- docs/sdk/reference/classes/Census.md | 24 +- .../sdk/reference/classes/Census3CensusAPI.md | 8 +- .../reference/classes/Census3ServiceAPI.md | 2 +- .../reference/classes/Census3StrategyAPI.md | 54 +- docs/sdk/reference/classes/Census3TokenAPI.md | 10 +- docs/sdk/reference/classes/CensusAPI.md | 82 +- docs/sdk/reference/classes/CensusService.md | 46 +- .../classes/CensusStillNotPublished.md | 184 +++++ docs/sdk/reference/classes/ChainAPI.md | 201 ++--- docs/sdk/reference/classes/ChainService.md | 26 +- .../CouldNotCreateFaucetPackageError.md | 184 +++++ .../classes/CouldNotSignTransactionError.md | 184 +++++ docs/sdk/reference/classes/CspAPI.md | 8 +- docs/sdk/reference/classes/CspCensus.md | 26 +- docs/sdk/reference/classes/CspService.md | 20 +- docs/sdk/reference/classes/CspVote.md | 14 +- .../classes/DuplicateConflictError.md | 184 +++++ docs/sdk/reference/classes/Election.md | 32 +- docs/sdk/reference/classes/ElectionAPI.md | 115 +-- docs/sdk/reference/classes/ElectionService.md | 53 +- .../reference/classes/EmailMalformedError.md | 184 +++++ docs/sdk/reference/classes/ErrAPI.md | 196 +++++ .../classes/ErrAccountAlreadyExists.md | 184 +++++ .../reference/classes/ErrAccountNotFound.md | 184 +++++ .../reference/classes/ErrAddressMalformed.md | 184 +++++ .../sdk/reference/classes/ErrBlockNotFound.md | 184 +++++ .../classes/ErrCantABIEncodeResults.md | 184 +++++ .../classes/ErrCantAddKeyAndValueToTree.md | 184 +++++ .../reference/classes/ErrCantAddKeyToTree.md | 184 +++++ .../reference/classes/ErrCantCheckTxType.md | 184 +++++ .../classes/ErrCantComputeKeyHash.md | 184 +++++ .../reference/classes/ErrCantCountVotes.md | 184 +++++ .../classes/ErrCantEstimateBlockHeight.md | 184 +++++ .../classes/ErrCantExtractMetadataURI.md | 184 +++++ .../reference/classes/ErrCantFetchElection.md | 184 +++++ .../reference/classes/ErrCantFetchEnvelope.md | 184 +++++ .../classes/ErrCantFetchEnvelopeHeight.md | 184 +++++ .../classes/ErrCantFetchTokenFees.md | 184 +++++ .../classes/ErrCantFetchTokenTransfers.md | 184 +++++ .../classes/ErrCantGenerateFaucetPkg.md | 184 +++++ .../classes/ErrCantGetCircomSiblings.md | 184 +++++ .../classes/ErrCantMarshalMetadata.md | 184 +++++ .../classes/ErrCantParseAccountID.md | 184 +++++ .../classes/ErrCantParseBearerToken.md | 184 +++++ .../reference/classes/ErrCantParseBoolean.md | 184 +++++ .../classes/ErrCantParseDataAsJSON.md | 184 +++++ .../classes/ErrCantParseElectionID.md | 184 +++++ .../classes/ErrCantParseHexString.md | 184 +++++ .../classes/ErrCantParseMetadataAsJSON.md | 184 +++++ .../reference/classes/ErrCantParseNumber.md | 184 +++++ .../reference/classes/ErrCantParseOrgID.md | 184 +++++ .../classes/ErrCantParsePayloadAsJSON.md | 184 +++++ .../reference/classes/ErrCantParseVoteID.md | 184 +++++ .../classes/ErrCantPublishMetadata.md | 184 +++++ docs/sdk/reference/classes/ErrCensusBuild.md | 184 +++++ .../classes/ErrCensusIDLengthInvalid.md | 184 +++++ .../classes/ErrCensusIndexedFlagMismatch.md | 184 +++++ .../reference/classes/ErrCensusNotFound.md | 184 +++++ .../ErrCensusProofVerificationFailed.md | 184 +++++ .../classes/ErrCensusRootHashMismatch.md | 184 +++++ .../reference/classes/ErrCensusRootIsNil.md | 184 +++++ .../classes/ErrCensusTypeMismatch.md | 184 +++++ .../reference/classes/ErrCensusTypeUnknown.md | 184 +++++ .../reference/classes/ErrDstAccountUnknown.md | 184 +++++ .../classes/ErrDstAddressMalformed.md | 184 +++++ .../classes/ErrElectionEndDateBeforeStart.md | 184 +++++ .../classes/ErrElectionEndDateInThePast.md | 184 +++++ .../reference/classes/ErrElectionFinished.md | 184 +++++ .../sdk/reference/classes/ErrElectionIsNil.md | 184 +++++ .../reference/classes/ErrElectionNotFound.md | 184 +++++ .../classes/ErrElectionNotStarted.md | 184 +++++ .../classes/ErrElectionResultsIsNil.md | 184 +++++ .../classes/ErrElectionResultsMismatch.md | 184 +++++ .../ErrElectionResultsNotYetAvailable.md | 184 +++++ .../classes/ErrFaucetAlreadyFunded.md | 195 +++++ .../reference/classes/ErrFileSizeTooBig.md | 184 +++++ docs/sdk/reference/classes/ErrGettingSIK.md | 184 +++++ .../classes/ErrIndexedCensusCantUseWeight.md | 184 +++++ .../classes/ErrIndexerQueryFailed.md | 184 +++++ .../classes/ErrInvalidCensusKeyLength.md | 184 +++++ .../sdk/reference/classes/ErrInvalidStatus.md | 184 +++++ .../classes/ErrKeyNotFoundInCensus.md | 184 +++++ .../classes/ErrMarshalingJSONFailed.md | 184 +++++ .../classes/ErrMarshalingServerJSONFailed.md | 184 +++++ .../classes/ErrMarshalingServerProto.md | 184 +++++ .../classes/ErrMetadataProvidedButNoURI.md | 184 +++++ .../classes/ErrMetadataURINotMatchContent.md | 184 +++++ .../reference/classes/ErrMissingParameter.md | 184 +++++ .../reference/classes/ErrNoElectionKeys.md | 184 +++++ docs/sdk/reference/classes/ErrOrgNotFound.md | 184 +++++ docs/sdk/reference/classes/ErrPageNotFound.md | 184 +++++ .../classes/ErrParamDumpOrRootMissing.md | 184 +++++ .../classes/ErrParamKeyOrProofMissing.md | 184 +++++ .../classes/ErrParamNetworkInvalid.md | 184 +++++ .../classes/ErrParamParticipantsMissing.md | 184 +++++ .../classes/ErrParamParticipantsTooBig.md | 184 +++++ .../reference/classes/ErrParamRootInvalid.md | 184 +++++ .../classes/ErrParamStatusInvalid.md | 184 +++++ .../reference/classes/ErrParamToInvalid.md | 184 +++++ .../classes/ErrParticipantKeyMissing.md | 184 +++++ docs/sdk/reference/classes/ErrSIKNotFound.md | 184 +++++ .../classes/ErrTransactionNotFound.md | 184 +++++ .../reference/classes/ErrTxTypeMismatch.md | 184 +++++ .../classes/ErrUnmarshalingServerProto.md | 184 +++++ .../reference/classes/ErrVochainEmptyReply.md | 184 +++++ .../classes/ErrVochainGetTxFailed.md | 184 +++++ .../reference/classes/ErrVochainOverloaded.md | 184 +++++ .../classes/ErrVochainReturnedErrorCode.md | 184 +++++ .../ErrVochainReturnedInvalidElectionID.md | 184 +++++ .../ErrVochainReturnedWrongMetadataCID.md | 184 +++++ .../classes/ErrVochainSendTxFailed.md | 184 +++++ .../reference/classes/ErrVoteIDMalformed.md | 184 +++++ docs/sdk/reference/classes/ErrVoteNotFound.md | 184 +++++ .../reference/classes/ErrWalletNotFound.md | 184 +++++ .../classes/ErrWalletPrivKeyAlreadyExists.md | 184 +++++ docs/sdk/reference/classes/FaucetAPI.md | 4 +- docs/sdk/reference/classes/FaucetService.md | 10 +- docs/sdk/reference/classes/FileAPI.md | 4 +- docs/sdk/reference/classes/FileService.md | 6 +- .../classes/GenericInternalServerError.md | 184 +++++ docs/sdk/reference/classes/InvalidElection.md | 6 +- .../reference/classes/InvalidTxFormatError.md | 184 +++++ .../reference/classes/InvalidUserDataError.md | 184 +++++ .../reference/classes/MalformedBodyError.md | 184 +++++ .../classes/MalformedURLParamError.md | 184 +++++ .../MarshalingServerJSONFailedError.md | 184 +++++ .../reference/classes/MultiChoiceElection.md | 131 ++-- .../classes/NoOrganizationProvidedError.md | 184 +++++ .../reference/classes/NoOrganizationsError.md | 184 +++++ docs/sdk/reference/classes/OffchainCensus.md | 28 +- .../classes/OrganizationNotFoundError.md | 184 +++++ .../classes/PasswordTooShortError.md | 184 +++++ docs/sdk/reference/classes/PlainCensus.md | 34 +- docs/sdk/reference/classes/PublishedCensus.md | 26 +- .../reference/classes/PublishedElection.md | 85 +- docs/sdk/reference/classes/RemoteSigner.md | 632 +++++++++++++++ docs/sdk/reference/classes/RemoteSignerAPI.md | 139 ++++ .../reference/classes/RemoteSignerService.md | 205 +++++ docs/sdk/reference/classes/Service.md | 4 +- docs/sdk/reference/classes/StrategyCensus.md | 30 +- docs/sdk/reference/classes/TokenCensus.md | 30 +- .../classes/TxTypeNotAllowedError.md | 184 +++++ .../reference/classes/UnauthorizedError.md | 184 +++++ .../reference/classes/UnpublishedElection.md | 83 +- .../reference/classes/VocdoniCensus3Client.md | 53 +- .../sdk/reference/classes/VocdoniSDKClient.md | 212 +++-- docs/sdk/reference/classes/Vote.md | 6 +- docs/sdk/reference/classes/VoteAPI.md | 42 +- docs/sdk/reference/classes/VoteService.md | 20 +- docs/sdk/reference/classes/WalletAPI.md | 4 +- docs/sdk/reference/classes/WeightedCensus.md | 34 +- docs/sdk/reference/classes/ZkAPI.md | 6 +- docs/sdk/reference/enums/CensusOrigin.md | 20 +- docs/sdk/reference/enums/CensusType.md | 8 +- docs/sdk/reference/enums/CensusTypeEnum.md | 18 +- docs/sdk/reference/enums/CspProofType.md | 8 +- .../reference/enums/ElectionCreationSteps.md | 16 +- .../enums/ElectionResultsTypeNames.md | 19 +- docs/sdk/reference/enums/ElectionStatus.md | 14 +- .../reference/enums/ElectionStatusReady.md | 2 +- docs/sdk/reference/enums/EnvOptions.md | 6 +- docs/sdk/reference/enums/TransactionType.md | 22 +- docs/sdk/reference/enums/TxType.md | 50 +- docs/sdk/reference/enums/VoteSteps.md | 14 +- .../reference/interfaces/AccountMetadata.md | 14 +- docs/sdk/reference/interfaces/AdminTx.md | 18 +- .../sdk/reference/interfaces/CircuitInputs.md | 24 +- .../reference/interfaces/CollectFaucetTx.md | 6 +- .../reference/interfaces/ElectionMetadata.md | 14 +- .../interfaces/FetchAccountsParameters.md | 3 + .../interfaces/FetchBlocksParameters.md | 41 + .../interfaces/FetchElectionsParameters.md | 60 +- .../interfaces/FetchFeesParameters.md | 41 + .../interfaces/FetchOrganizationParameters.md | 19 + .../interfaces/FetchTransactionsParameters.md | 74 ++ .../interfaces/FetchTransfersParameters.md | 41 + .../interfaces/FetchVotesParameters.md | 19 + docs/sdk/reference/interfaces/IAccount.md | 16 +- .../interfaces/IAccountInfoResponse.md | 125 +++ .../IAccountTransfersCountResponse.md | 21 - .../interfaces/IAccountsCountResponse.md | 21 - .../sdk/reference/interfaces/IAccountsList.md | 27 + .../interfaces/IAccountsListResponse.md | 39 +- .../interfaces/IApprovalElectionParameters.md | 28 +- docs/sdk/reference/interfaces/IBlock.md | 85 ++ .../interfaces/IBlockTransactionsResponse.md | 41 - .../IBudgetElectionParametersInfo.md | 32 +- .../IBudgetElectionParametersWithBudget.md | 36 +- ...udgetElectionParametersWithCensusWeight.md | 34 +- docs/sdk/reference/interfaces/ICensus.md | 10 +- .../interfaces/ICensus3CensusListResponse.md | 2 +- .../interfaces/ICensus3CensusQueueResponse.md | 8 +- .../interfaces/ICensus3CensusResponse.md | 16 +- .../interfaces/ICensus3ServiceInfoResponse.md | 2 +- .../ICensus3StrategiesListResponse.md | 2 +- ...ICensus3StrategiesListResponsePaginated.md | 4 +- .../interfaces/ICensus3StrategiesOperator.md | 4 +- .../ICensus3StrategiesOperatorsResponse.md | 2 +- .../ICensus3StrategyCreateResponse.md | 2 +- ...ICensus3StrategyEstimationQueueResponse.md | 8 +- .../ICensus3StrategyHoldersQueueResponse.md | 71 ++ .../ICensus3StrategyHoldersResponse.md | 31 - ...Census3StrategyHoldersResponsePaginated.md | 48 -- .../ICensus3StrategyImportQueueResponse.md | 8 +- .../interfaces/ICensus3StrategyToken.md | 8 +- .../interfaces/ICensus3SupportedChain.md | 6 +- .../interfaces/ICensus3TokenHolderResponse.md | 2 +- .../interfaces/ICensus3TokenListResponse.md | 2 +- .../ICensus3TokenListResponsePaginated.md | 4 +- .../interfaces/ICensus3TokenTypesResponse.md | 2 +- .../ICensus3ValidatePredicateChild.md | 4 +- .../ICensus3ValidatePredicateResponse.md | 2 +- .../ICensus3ValidatePredicateToken.md | 2 +- .../interfaces/ICensusExportResponse.md | 8 +- .../interfaces/ICensusParticipant.md | 4 +- .../interfaces/ICensusProofResponse.md | 12 +- .../interfaces/ICensusPublishAsyncResponse.md | 21 + .../interfaces/ICensusPublishResponse.md | 4 +- .../interfaces/IChainBlockInfoResponse.md | 55 +- .../reference/interfaces/IChainBlocksList.md | 27 + .../interfaces/IChainBlocksListResponse.md | 58 ++ .../interfaces/IChainFeesListResponse.md | 39 +- .../interfaces/IChainGetCircuitResponse.md | 18 +- .../interfaces/IChainGetCostsResponse.md | 6 +- .../interfaces/IChainGetInfoResponse.md | 26 +- .../IChainOrganizationCountResponse.md | 21 - .../IChainOrganizationListResponse.md | 39 +- .../interfaces/IChainOrganizationResponse.md | 4 +- .../interfaces/IChainSubmitTxResponse.md | 6 +- .../interfaces/IChainTransfersList.md | 27 + .../interfaces/IChainTransfersListResponse.md | 58 ++ .../sdk/reference/interfaces/IChainTxCosts.md | 39 + .../interfaces/IChainTxCountResponse.md | 21 - docs/sdk/reference/interfaces/IChainTxList.md | 27 + .../interfaces/IChainTxListResponse.md | 41 +- .../reference/interfaces/IChainTxReference.md | 59 +- .../reference/interfaces/IChainValidator.md | 73 +- .../IChainValidatorsListResponse.md | 2 +- docs/sdk/reference/interfaces/IChoice.md | 19 +- docs/sdk/reference/interfaces/ICspAuthStep.md | 4 +- .../interfaces/ICspFinalStepResponse.md | 2 +- .../reference/interfaces/ICspInfoResponse.md | 8 +- .../ICspIntermediateStepResponse.md | 4 +- .../reference/interfaces/ICspSignResponse.md | 2 +- .../interfaces/IElectionCreateResponse.md | 6 +- .../interfaces/IElectionInfoResponse.md | 47 +- .../interfaces/IElectionKeysResponse.md | 4 +- .../sdk/reference/interfaces/IElectionList.md | 27 + .../interfaces/IElectionListFilter.md | 52 -- .../interfaces/IElectionListResponse.md | 39 +- .../sdk/reference/interfaces/IElectionMode.md | 21 +- .../interfaces/IElectionNextIdResponse.md | 2 +- .../interfaces/IElectionParameters.md | 28 +- .../reference/interfaces/IElectionSummary.md | 40 +- .../sdk/reference/interfaces/IElectionType.md | 23 +- .../sdk/reference/interfaces/IElectionVote.md | 73 -- .../interfaces/IElectionVoteListResponse.md | 21 - .../reference/interfaces/IEncryptionKey.md | 4 +- docs/sdk/reference/interfaces/IFeesList.md | 27 + .../interfaces/IInvalidElectionParameters.md | 2 +- .../IMultiChoiceElectionParameters.md | 45 +- .../IPublishedElectionParameters.md | 63 +- docs/sdk/reference/interfaces/IQuestion.md | 19 +- .../IRemoteSignerAddressesResponse.md | 21 + .../interfaces/IRemoteSignerLoginResponse.md | 34 + .../IRemoteSignerRefreshResponse.md | 34 + .../interfaces/IRemoteSignerSignResponse.md | 21 + .../interfaces/IRemoteSignerSignTxResponse.md | 21 + docs/sdk/reference/interfaces/ITallyMode.md | 10 +- docs/sdk/reference/interfaces/ITransfer.md | 74 ++ .../interfaces/IVoteEncryptedPackage.md | 2 +- .../reference/interfaces/IVoteInfoResponse.md | 151 ---- .../reference/interfaces/IVoteListResponse.md | 58 ++ docs/sdk/reference/interfaces/IVoteMode.md | 10 +- docs/sdk/reference/interfaces/IVotePackage.md | 4 +- .../interfaces/IVoteSubmitResponse.md | 4 +- docs/sdk/reference/interfaces/IVoteType.md | 14 +- .../reference/interfaces/IZkProofResponse.md | 8 +- .../reference/interfaces/IZkSIKResponse.md | 2 +- docs/sdk/reference/interfaces/MintTokensTx.md | 8 +- docs/sdk/reference/interfaces/NewProcessTx.md | 6 +- .../reference/interfaces/OrganizationList.md | 27 + .../interfaces/PaginationResponse.md | 49 ++ docs/sdk/reference/interfaces/Process.md | 62 +- docs/sdk/reference/interfaces/Proof.md | 2 +- .../sdk/reference/interfaces/RegisterKeyTx.md | 10 +- docs/sdk/reference/interfaces/SendTokensTx.md | 10 +- .../reference/interfaces/ServiceProperties.md | 2 +- docs/sdk/reference/interfaces/SetAccountTx.md | 12 +- docs/sdk/reference/interfaces/SetProcessTx.md | 18 +- .../interfaces/SetTransactionCostsTx.md | 6 +- docs/sdk/reference/interfaces/Tx.md | 15 +- docs/sdk/reference/interfaces/VoteEnvelope.md | 12 +- docs/sdk/reference/interfaces/VotesList.md | 27 + docs/sdk/reference/sdk-reference.md | 629 ++++++++++++--- 305 files changed, 25220 insertions(+), 3013 deletions(-) create mode 100644 docs/sdk/reference/classes/API.md delete mode 100644 docs/sdk/reference/classes/ArchivedElection.md create mode 100644 docs/sdk/reference/classes/CensusStillNotPublished.md create mode 100644 docs/sdk/reference/classes/CouldNotCreateFaucetPackageError.md create mode 100644 docs/sdk/reference/classes/CouldNotSignTransactionError.md create mode 100644 docs/sdk/reference/classes/DuplicateConflictError.md create mode 100644 docs/sdk/reference/classes/EmailMalformedError.md create mode 100644 docs/sdk/reference/classes/ErrAPI.md create mode 100644 docs/sdk/reference/classes/ErrAccountAlreadyExists.md create mode 100644 docs/sdk/reference/classes/ErrAccountNotFound.md create mode 100644 docs/sdk/reference/classes/ErrAddressMalformed.md create mode 100644 docs/sdk/reference/classes/ErrBlockNotFound.md create mode 100644 docs/sdk/reference/classes/ErrCantABIEncodeResults.md create mode 100644 docs/sdk/reference/classes/ErrCantAddKeyAndValueToTree.md create mode 100644 docs/sdk/reference/classes/ErrCantAddKeyToTree.md create mode 100644 docs/sdk/reference/classes/ErrCantCheckTxType.md create mode 100644 docs/sdk/reference/classes/ErrCantComputeKeyHash.md create mode 100644 docs/sdk/reference/classes/ErrCantCountVotes.md create mode 100644 docs/sdk/reference/classes/ErrCantEstimateBlockHeight.md create mode 100644 docs/sdk/reference/classes/ErrCantExtractMetadataURI.md create mode 100644 docs/sdk/reference/classes/ErrCantFetchElection.md create mode 100644 docs/sdk/reference/classes/ErrCantFetchEnvelope.md create mode 100644 docs/sdk/reference/classes/ErrCantFetchEnvelopeHeight.md create mode 100644 docs/sdk/reference/classes/ErrCantFetchTokenFees.md create mode 100644 docs/sdk/reference/classes/ErrCantFetchTokenTransfers.md create mode 100644 docs/sdk/reference/classes/ErrCantGenerateFaucetPkg.md create mode 100644 docs/sdk/reference/classes/ErrCantGetCircomSiblings.md create mode 100644 docs/sdk/reference/classes/ErrCantMarshalMetadata.md create mode 100644 docs/sdk/reference/classes/ErrCantParseAccountID.md create mode 100644 docs/sdk/reference/classes/ErrCantParseBearerToken.md create mode 100644 docs/sdk/reference/classes/ErrCantParseBoolean.md create mode 100644 docs/sdk/reference/classes/ErrCantParseDataAsJSON.md create mode 100644 docs/sdk/reference/classes/ErrCantParseElectionID.md create mode 100644 docs/sdk/reference/classes/ErrCantParseHexString.md create mode 100644 docs/sdk/reference/classes/ErrCantParseMetadataAsJSON.md create mode 100644 docs/sdk/reference/classes/ErrCantParseNumber.md create mode 100644 docs/sdk/reference/classes/ErrCantParseOrgID.md create mode 100644 docs/sdk/reference/classes/ErrCantParsePayloadAsJSON.md create mode 100644 docs/sdk/reference/classes/ErrCantParseVoteID.md create mode 100644 docs/sdk/reference/classes/ErrCantPublishMetadata.md create mode 100644 docs/sdk/reference/classes/ErrCensusBuild.md create mode 100644 docs/sdk/reference/classes/ErrCensusIDLengthInvalid.md create mode 100644 docs/sdk/reference/classes/ErrCensusIndexedFlagMismatch.md create mode 100644 docs/sdk/reference/classes/ErrCensusNotFound.md create mode 100644 docs/sdk/reference/classes/ErrCensusProofVerificationFailed.md create mode 100644 docs/sdk/reference/classes/ErrCensusRootHashMismatch.md create mode 100644 docs/sdk/reference/classes/ErrCensusRootIsNil.md create mode 100644 docs/sdk/reference/classes/ErrCensusTypeMismatch.md create mode 100644 docs/sdk/reference/classes/ErrCensusTypeUnknown.md create mode 100644 docs/sdk/reference/classes/ErrDstAccountUnknown.md create mode 100644 docs/sdk/reference/classes/ErrDstAddressMalformed.md create mode 100644 docs/sdk/reference/classes/ErrElectionEndDateBeforeStart.md create mode 100644 docs/sdk/reference/classes/ErrElectionEndDateInThePast.md create mode 100644 docs/sdk/reference/classes/ErrElectionFinished.md create mode 100644 docs/sdk/reference/classes/ErrElectionIsNil.md create mode 100644 docs/sdk/reference/classes/ErrElectionNotFound.md create mode 100644 docs/sdk/reference/classes/ErrElectionNotStarted.md create mode 100644 docs/sdk/reference/classes/ErrElectionResultsIsNil.md create mode 100644 docs/sdk/reference/classes/ErrElectionResultsMismatch.md create mode 100644 docs/sdk/reference/classes/ErrElectionResultsNotYetAvailable.md create mode 100644 docs/sdk/reference/classes/ErrFaucetAlreadyFunded.md create mode 100644 docs/sdk/reference/classes/ErrFileSizeTooBig.md create mode 100644 docs/sdk/reference/classes/ErrGettingSIK.md create mode 100644 docs/sdk/reference/classes/ErrIndexedCensusCantUseWeight.md create mode 100644 docs/sdk/reference/classes/ErrIndexerQueryFailed.md create mode 100644 docs/sdk/reference/classes/ErrInvalidCensusKeyLength.md create mode 100644 docs/sdk/reference/classes/ErrInvalidStatus.md create mode 100644 docs/sdk/reference/classes/ErrKeyNotFoundInCensus.md create mode 100644 docs/sdk/reference/classes/ErrMarshalingJSONFailed.md create mode 100644 docs/sdk/reference/classes/ErrMarshalingServerJSONFailed.md create mode 100644 docs/sdk/reference/classes/ErrMarshalingServerProto.md create mode 100644 docs/sdk/reference/classes/ErrMetadataProvidedButNoURI.md create mode 100644 docs/sdk/reference/classes/ErrMetadataURINotMatchContent.md create mode 100644 docs/sdk/reference/classes/ErrMissingParameter.md create mode 100644 docs/sdk/reference/classes/ErrNoElectionKeys.md create mode 100644 docs/sdk/reference/classes/ErrOrgNotFound.md create mode 100644 docs/sdk/reference/classes/ErrPageNotFound.md create mode 100644 docs/sdk/reference/classes/ErrParamDumpOrRootMissing.md create mode 100644 docs/sdk/reference/classes/ErrParamKeyOrProofMissing.md create mode 100644 docs/sdk/reference/classes/ErrParamNetworkInvalid.md create mode 100644 docs/sdk/reference/classes/ErrParamParticipantsMissing.md create mode 100644 docs/sdk/reference/classes/ErrParamParticipantsTooBig.md create mode 100644 docs/sdk/reference/classes/ErrParamRootInvalid.md create mode 100644 docs/sdk/reference/classes/ErrParamStatusInvalid.md create mode 100644 docs/sdk/reference/classes/ErrParamToInvalid.md create mode 100644 docs/sdk/reference/classes/ErrParticipantKeyMissing.md create mode 100644 docs/sdk/reference/classes/ErrSIKNotFound.md create mode 100644 docs/sdk/reference/classes/ErrTransactionNotFound.md create mode 100644 docs/sdk/reference/classes/ErrTxTypeMismatch.md create mode 100644 docs/sdk/reference/classes/ErrUnmarshalingServerProto.md create mode 100644 docs/sdk/reference/classes/ErrVochainEmptyReply.md create mode 100644 docs/sdk/reference/classes/ErrVochainGetTxFailed.md create mode 100644 docs/sdk/reference/classes/ErrVochainOverloaded.md create mode 100644 docs/sdk/reference/classes/ErrVochainReturnedErrorCode.md create mode 100644 docs/sdk/reference/classes/ErrVochainReturnedInvalidElectionID.md create mode 100644 docs/sdk/reference/classes/ErrVochainReturnedWrongMetadataCID.md create mode 100644 docs/sdk/reference/classes/ErrVochainSendTxFailed.md create mode 100644 docs/sdk/reference/classes/ErrVoteIDMalformed.md create mode 100644 docs/sdk/reference/classes/ErrVoteNotFound.md create mode 100644 docs/sdk/reference/classes/ErrWalletNotFound.md create mode 100644 docs/sdk/reference/classes/ErrWalletPrivKeyAlreadyExists.md create mode 100644 docs/sdk/reference/classes/GenericInternalServerError.md create mode 100644 docs/sdk/reference/classes/InvalidTxFormatError.md create mode 100644 docs/sdk/reference/classes/InvalidUserDataError.md create mode 100644 docs/sdk/reference/classes/MalformedBodyError.md create mode 100644 docs/sdk/reference/classes/MalformedURLParamError.md create mode 100644 docs/sdk/reference/classes/MarshalingServerJSONFailedError.md create mode 100644 docs/sdk/reference/classes/NoOrganizationProvidedError.md create mode 100644 docs/sdk/reference/classes/NoOrganizationsError.md create mode 100644 docs/sdk/reference/classes/OrganizationNotFoundError.md create mode 100644 docs/sdk/reference/classes/PasswordTooShortError.md create mode 100644 docs/sdk/reference/classes/RemoteSigner.md create mode 100644 docs/sdk/reference/classes/RemoteSignerAPI.md create mode 100644 docs/sdk/reference/classes/RemoteSignerService.md create mode 100644 docs/sdk/reference/classes/TxTypeNotAllowedError.md create mode 100644 docs/sdk/reference/classes/UnauthorizedError.md create mode 100644 docs/sdk/reference/interfaces/FetchAccountsParameters.md create mode 100644 docs/sdk/reference/interfaces/FetchBlocksParameters.md create mode 100644 docs/sdk/reference/interfaces/FetchFeesParameters.md create mode 100644 docs/sdk/reference/interfaces/FetchOrganizationParameters.md create mode 100644 docs/sdk/reference/interfaces/FetchTransactionsParameters.md create mode 100644 docs/sdk/reference/interfaces/FetchTransfersParameters.md create mode 100644 docs/sdk/reference/interfaces/FetchVotesParameters.md create mode 100644 docs/sdk/reference/interfaces/IAccountInfoResponse.md delete mode 100644 docs/sdk/reference/interfaces/IAccountTransfersCountResponse.md delete mode 100644 docs/sdk/reference/interfaces/IAccountsCountResponse.md create mode 100644 docs/sdk/reference/interfaces/IAccountsList.md create mode 100644 docs/sdk/reference/interfaces/IBlock.md delete mode 100644 docs/sdk/reference/interfaces/IBlockTransactionsResponse.md create mode 100644 docs/sdk/reference/interfaces/ICensus3StrategyHoldersQueueResponse.md delete mode 100644 docs/sdk/reference/interfaces/ICensus3StrategyHoldersResponse.md delete mode 100644 docs/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated.md create mode 100644 docs/sdk/reference/interfaces/ICensusPublishAsyncResponse.md create mode 100644 docs/sdk/reference/interfaces/IChainBlocksList.md create mode 100644 docs/sdk/reference/interfaces/IChainBlocksListResponse.md delete mode 100644 docs/sdk/reference/interfaces/IChainOrganizationCountResponse.md create mode 100644 docs/sdk/reference/interfaces/IChainTransfersList.md create mode 100644 docs/sdk/reference/interfaces/IChainTransfersListResponse.md create mode 100644 docs/sdk/reference/interfaces/IChainTxCosts.md delete mode 100644 docs/sdk/reference/interfaces/IChainTxCountResponse.md create mode 100644 docs/sdk/reference/interfaces/IChainTxList.md create mode 100644 docs/sdk/reference/interfaces/IElectionList.md delete mode 100644 docs/sdk/reference/interfaces/IElectionListFilter.md delete mode 100644 docs/sdk/reference/interfaces/IElectionVote.md delete mode 100644 docs/sdk/reference/interfaces/IElectionVoteListResponse.md create mode 100644 docs/sdk/reference/interfaces/IFeesList.md create mode 100644 docs/sdk/reference/interfaces/IRemoteSignerAddressesResponse.md create mode 100644 docs/sdk/reference/interfaces/IRemoteSignerLoginResponse.md create mode 100644 docs/sdk/reference/interfaces/IRemoteSignerRefreshResponse.md create mode 100644 docs/sdk/reference/interfaces/IRemoteSignerSignResponse.md create mode 100644 docs/sdk/reference/interfaces/IRemoteSignerSignTxResponse.md create mode 100644 docs/sdk/reference/interfaces/ITransfer.md delete mode 100644 docs/sdk/reference/interfaces/IVoteInfoResponse.md create mode 100644 docs/sdk/reference/interfaces/IVoteListResponse.md create mode 100644 docs/sdk/reference/interfaces/OrganizationList.md create mode 100644 docs/sdk/reference/interfaces/PaginationResponse.md create mode 100644 docs/sdk/reference/interfaces/VotesList.md diff --git a/docs/sdk/reference/changelog.md b/docs/sdk/reference/changelog.md index 4886e3182..6918564aa 100644 --- a/docs/sdk/reference/changelog.md +++ b/docs/sdk/reference/changelog.md @@ -5,6 +5,57 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [0.9.1] - 2024-09-17 + +### Fixed + +- Added missing `Buffer` dependency in the remote signer service. +- Fixed blocks parameters and added `proposerAddress` in the list. + +## [0.9.0] - 2024-09-04 + +### Added + +- New `RemoteSigner` signer that can be handled by the client. +- New election type `QuadraticElection`. +- Added new count fields information for `AccountData`. +- New errors generated in the API. + +### Changed + +- [**BREAKING**] New pagination system and removed deprecated API functions. +- Better and new improvements to the SDK bundling system. + +### Removed + +- Removed archive functionality for elections and all their components. +- Removed deprecated `autoStart` field from elections. + +## [0.8.3] - 2024-06-12 + +### Added + +- Added new transaction for changing an election duration. +- Added new functions `changeElectionEndDate` and `changeElectionDuration`. +- Added new raw information when election data is not complete. + +### Changed + +- Census3 `getStrategyHolders` changed for using queues instead of direct endpoint call. + +## [0.8.2] - 2024-06-12 + +### Added + +- Added API fees calls functions for checking all fees and account fees. +- Added new function to modify an election maximum census size. +- Added new `delta` parameter when checking for next election identifiers. + +### Changed + +- Census publishing is done async to avoid 502 errors when uploading large censuses. +- Modified change census function to accept a new maximum census size. + ## [0.8.1] - 2024-05-21 ### Added @@ -473,6 +524,10 @@ which extend from the abstract `Election` class. - First unstable version of the SDK for testing purposes +[0.9.1]: https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.9.1 +[0.9.0]: https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.9.0 +[0.8.3]: https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.8.3 +[0.8.2]: https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.8.2 [0.8.1]: https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.8.1 [0.8.0]: https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.8.0 [0.7.5]: https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.7.5 diff --git a/docs/sdk/reference/classes/API.md b/docs/sdk/reference/classes/API.md new file mode 100644 index 000000000..b2a7bec8f --- /dev/null +++ b/docs/sdk/reference/classes/API.md @@ -0,0 +1,29 @@ +[@vocdoni/sdk](/sdk) / API + +# Class: API + +## Hierarchy + +- **`API`** + + ↳ [`AccountAPI`](AccountAPI) + + ↳ [`CensusAPI`](CensusAPI) + + ↳ [`ChainAPI`](ChainAPI) + + ↳ [`ElectionAPI`](ElectionAPI) + + ↳ [`FaucetAPI`](FaucetAPI) + + ↳ [`FileAPI`](FileAPI) + + ↳ [`VoteAPI`](VoteAPI) + + ↳ [`WalletAPI`](WalletAPI) + + ↳ [`CspAPI`](CspAPI) + + ↳ [`ZkAPI`](ZkAPI) + + ↳ [`RemoteSignerAPI`](RemoteSignerAPI) diff --git a/docs/sdk/reference/classes/Account.md b/docs/sdk/reference/classes/Account.md index dc11f6097..e765417c2 100644 --- a/docs/sdk/reference/classes/Account.md +++ b/docs/sdk/reference/classes/Account.md @@ -38,7 +38,7 @@ Represents an account #### Defined in -[types/account.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L108) +[src/types/account.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/account.ts#L108) • `set` **avatar**(`value`): `void` @@ -54,7 +54,7 @@ Represents an account #### Defined in -[types/account.ts:112](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L112) +[src/types/account.ts:112](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/account.ts#L112) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[types/account.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L92) +[src/types/account.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/account.ts#L92) • `set` **description**(`value`): `void` @@ -84,7 +84,7 @@ ___ #### Defined in -[types/account.ts:96](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L96) +[src/types/account.ts:96](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/account.ts#L96) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[types/account.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L124) +[src/types/account.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/account.ts#L124) • `set` **feed**(`value`): `void` @@ -114,7 +114,7 @@ ___ #### Defined in -[types/account.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L128) +[src/types/account.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/account.ts#L128) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[types/account.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L100) +[src/types/account.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/account.ts#L100) • `set` **header**(`value`): `void` @@ -144,7 +144,7 @@ ___ #### Defined in -[types/account.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L104) +[src/types/account.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/account.ts#L104) ___ @@ -158,7 +158,7 @@ ___ #### Defined in -[types/account.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L140) +[src/types/account.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/account.ts#L140) • `set` **languages**(`value`): `void` @@ -174,7 +174,7 @@ ___ #### Defined in -[types/account.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L144) +[src/types/account.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/account.ts#L144) ___ @@ -188,7 +188,7 @@ ___ #### Defined in -[types/account.ts:116](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L116) +[src/types/account.ts:116](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/account.ts#L116) • `set` **logo**(`value`): `void` @@ -204,7 +204,7 @@ ___ #### Defined in -[types/account.ts:120](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L120) +[src/types/account.ts:120](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/account.ts#L120) ___ @@ -218,7 +218,7 @@ ___ #### Defined in -[types/account.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L132) +[src/types/account.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/account.ts#L132) • `set` **meta**(`value`): `void` @@ -234,7 +234,7 @@ ___ #### Defined in -[types/account.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L136) +[src/types/account.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/account.ts#L136) ___ @@ -248,7 +248,7 @@ ___ #### Defined in -[types/account.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L84) +[src/types/account.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/account.ts#L84) • `set` **name**(`value`): `void` @@ -264,7 +264,7 @@ ___ #### Defined in -[types/account.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L88) +[src/types/account.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/account.ts#L88) ## Constructors @@ -286,7 +286,7 @@ Constructs an account #### Defined in -[types/account.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L33) +[src/types/account.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/account.ts#L33) ## Methods @@ -300,7 +300,7 @@ Constructs an account #### Defined in -[types/account.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L65) +[src/types/account.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/account.ts#L65) ___ @@ -322,4 +322,4 @@ Returns an account object #### Defined in -[types/account.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L61) +[src/types/account.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/account.ts#L61) diff --git a/docs/sdk/reference/classes/AccountAPI.md b/docs/sdk/reference/classes/AccountAPI.md index 103ddffff..8dca5f3f2 100644 --- a/docs/sdk/reference/classes/AccountAPI.md +++ b/docs/sdk/reference/classes/AccountAPI.md @@ -4,7 +4,7 @@ ## Hierarchy -- `API` +- [`API`](API) ↳ **`AccountAPI`** @@ -12,91 +12,16 @@ ### Methods -- [count](AccountAPI#count) -- [electionsList](AccountAPI#electionslist) -- [fees](AccountAPI#fees) - [info](AccountAPI#info) - [list](AccountAPI#list) - [metadata](AccountAPI#metadata) - [setInfo](AccountAPI#setinfo) -- [transfersCount](AccountAPI#transferscount) -- [transfersList](AccountAPI#transferslist) ## Methods -### count - -▸ **count**(`url`): `Promise`\<[`IAccountsCountResponse`](../interfaces/IAccountsCountResponse)\> - -Returns the number of accounts - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `url` | `string` | API endpoint URL | - -#### Returns - -`Promise`\<[`IAccountsCountResponse`](../interfaces/IAccountsCountResponse)\> - -#### Defined in - -[api/account.ts:133](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L133) - -___ - -### electionsList - -▸ **electionsList**(`url`, `accountId`, `page?`): `Promise`\<[`IElectionListResponse`](../interfaces/IElectionListResponse)\> - -Returns paginated list of elections for a specific account - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `url` | `string` | `undefined` | API endpoint URL | -| `accountId` | `string` | `undefined` | accountId to get elections | -| `page` | `number` | `0` | The page number | - -#### Returns - -`Promise`\<[`IElectionListResponse`](../interfaces/IElectionListResponse)\> - -#### Defined in - -[api/account.ts:214](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L214) - -___ - -### fees - -▸ **fees**(`url`, `account`, `page?`): `Promise`\<[`IChainFeesListResponse`](../interfaces/IChainFeesListResponse)\> - -Returns the list of fees by account - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `url` | `string` | `undefined` | {string} url API endpoint URL | -| `account` | `string` | `undefined` | {string} account The account | -| `page` | `number` | `0` | {number} page The page number | - -#### Returns - -`Promise`\<[`IChainFeesListResponse`](../interfaces/IChainFeesListResponse)\> - -#### Defined in - -[api/account.ts:228](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L228) - -___ - ### info -▸ **info**(`url`, `accountId`): `Promise`\<`IAccountInfoResponse`\> +▸ **info**(`url`, `accountId`): `Promise`\<[`IAccountInfoResponse`](../interfaces/IAccountInfoResponse)\> Fetches an Account information @@ -109,26 +34,26 @@ Fetches an Account information #### Returns -`Promise`\<`IAccountInfoResponse`\> +`Promise`\<[`IAccountInfoResponse`](../interfaces/IAccountInfoResponse)\> #### Defined in -[api/account.ts:146](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L146) +[src/api/account.ts:114](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/account.ts#L114) ___ ### list -▸ **list**(`url`, `page?`): `Promise`\<[`IAccountsListResponse`](../interfaces/IAccountsListResponse)\> +▸ **list**(`url`, `params?`): `Promise`\<[`IAccountsListResponse`](../interfaces/IAccountsListResponse)\> -Returns paginated list of accounts +Returns list of accounts #### Parameters -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `url` | `string` | `undefined` | API endpoint URL | -| `page` | `number` | `0` | The page number | +| Name | Type | Description | +| :------ | :------ | :------ | +| `url` | `string` | API endpoint URL | +| `params?` | `Partial`\<[`FetchAccountsParametersWithPagination`](../sdk-reference#fetchaccountsparameterswithpagination)\> | The parameters to filter the accounts | #### Returns @@ -136,7 +61,7 @@ Returns paginated list of accounts #### Defined in -[api/account.ts:121](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L121) +[src/api/account.ts:97](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/account.ts#L97) ___ @@ -159,7 +84,7 @@ Fetches the account metadata #### Defined in -[api/account.ts:159](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L159) +[src/api/account.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/account.ts#L127) ___ @@ -183,51 +108,4 @@ Sets Account information #### Defined in -[api/account.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L173) - -___ - -### transfersCount - -▸ **transfersCount**(`url`, `accountId`): `Promise`\<[`IAccountTransfersCountResponse`](../interfaces/IAccountTransfersCountResponse)\> - -Returns the account's transfers count - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `url` | `string` | API endpoint URL | -| `accountId` | `string` | accountId to get the transfers count | - -#### Returns - -`Promise`\<[`IAccountTransfersCountResponse`](../interfaces/IAccountTransfersCountResponse)\> - -#### Defined in - -[api/account.ts:200](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L200) - -___ - -### transfersList - -▸ **transfersList**(`url`, `accountId`, `page?`): `Promise`\<`IAccountTransfersResponse`\> - -Returns paginated list of transfers for a specific account - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `url` | `string` | `undefined` | API endpoint URL | -| `accountId` | `string` | `undefined` | accountId to get transfers | -| `page` | `number` | `0` | The page number | - -#### Returns - -`Promise`\<`IAccountTransfersResponse`\> - -#### Defined in - -[api/account.ts:187](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L187) +[src/api/account.ts:141](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/account.ts#L141) diff --git a/docs/sdk/reference/classes/AccountService.md b/docs/sdk/reference/classes/AccountService.md index 3cf978b65..b81c3d32a 100644 --- a/docs/sdk/reference/classes/AccountService.md +++ b/docs/sdk/reference/classes/AccountService.md @@ -53,7 +53,7 @@ Service.constructor #### Defined in -[services/account.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/account.ts#L45) +[src/services/account.ts:46](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/account.ts#L46) ## Methods @@ -75,7 +75,7 @@ Fetches account information. #### Defined in -[services/account.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/account.ts#L55) +[src/services/account.ts:56](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/account.ts#L56) ___ @@ -100,7 +100,7 @@ The transaction hash #### Defined in -[services/account.ts:95](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/account.ts#L95) +[src/services/account.ts:96](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/account.ts#L96) ___ @@ -114,7 +114,7 @@ ___ | :------ | :------ | | `tx` | `Uint8Array` | | `message` | `string` | -| `walletOrSigner` | `Signer` \| `Wallet` | +| `walletOrSigner` | `Signer` \| `Wallet` \| [`RemoteSigner`](RemoteSigner) | #### Returns @@ -122,7 +122,7 @@ ___ #### Defined in -[services/account.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/account.ts#L100) +[src/services/account.ts:101](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/account.ts#L101) ## Properties @@ -136,7 +136,7 @@ AccountServiceProperties.chainService #### Defined in -[services/account.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/account.ts#L38) +[src/services/account.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/account.ts#L39) ___ @@ -150,4 +150,4 @@ ___ #### Defined in -[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/service.ts#L6) +[src/services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/service.ts#L6) diff --git a/docs/sdk/reference/classes/AnonymousService.md b/docs/sdk/reference/classes/AnonymousService.md index 766d31dff..75711bac3 100644 --- a/docs/sdk/reference/classes/AnonymousService.md +++ b/docs/sdk/reference/classes/AnonymousService.md @@ -68,7 +68,7 @@ Service.constructor #### Defined in -[services/anonymous.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L71) +[src/services/anonymous.ts:72](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L72) ## Methods @@ -86,7 +86,7 @@ The checked circuit parameters #### Defined in -[services/anonymous.ts:107](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L107) +[src/services/anonymous.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L108) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[services/anonymous.ts:82](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L82) +[src/services/anonymous.ts:83](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L83) ___ @@ -128,7 +128,7 @@ Fetches circuits for anonymous voting #### Defined in -[services/anonymous.ts:130](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L130) +[src/services/anonymous.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L131) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -[services/anonymous.ts:93](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L93) +[src/services/anonymous.ts:94](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L94) ___ @@ -168,7 +168,7 @@ ___ #### Defined in -[services/anonymous.ts:76](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L76) +[src/services/anonymous.ts:77](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L77) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[services/anonymous.ts:87](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L87) +[src/services/anonymous.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L88) ___ @@ -212,7 +212,7 @@ Sets circuits for anonymous voting #### Defined in -[services/anonymous.ts:185](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L185) +[src/services/anonymous.ts:186](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L186) ___ @@ -224,7 +224,7 @@ ___ | Name | Type | | :------ | :------ | -| `wallet` | `Signer` \| `Wallet` | +| `wallet` | `Signer` \| `Wallet` \| [`RemoteSigner`](RemoteSigner) | #### Returns @@ -232,7 +232,7 @@ ___ #### Defined in -[services/anonymous.ts:98](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L98) +[src/services/anonymous.ts:99](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L99) ___ @@ -254,7 +254,7 @@ ___ #### Defined in -[services/anonymous.ts:232](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L232) +[src/services/anonymous.ts:233](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L233) ___ @@ -276,7 +276,7 @@ ___ #### Defined in -[services/anonymous.ts:245](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L245) +[src/services/anonymous.ts:246](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L246) ___ @@ -298,7 +298,7 @@ ___ #### Defined in -[services/anonymous.ts:255](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L255) +[src/services/anonymous.ts:256](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L256) ___ @@ -320,7 +320,7 @@ ___ #### Defined in -[services/anonymous.ts:249](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L249) +[src/services/anonymous.ts:250](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L250) ___ @@ -342,7 +342,7 @@ ___ #### Defined in -[services/anonymous.ts:190](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L190) +[src/services/anonymous.ts:191](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L191) ___ @@ -372,7 +372,7 @@ ___ #### Defined in -[services/anonymous.ts:198](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L198) +[src/services/anonymous.ts:199](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L199) ___ @@ -392,7 +392,7 @@ ___ #### Defined in -[services/anonymous.ts:268](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L268) +[src/services/anonymous.ts:269](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L269) ## Properties @@ -406,7 +406,7 @@ AnonymousServiceProperties.chainCircuits #### Defined in -[services/anonymous.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L64) +[src/services/anonymous.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L65) ___ @@ -420,7 +420,7 @@ ___ #### Defined in -[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/service.ts#L6) +[src/services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/service.ts#L6) ___ @@ -438,7 +438,7 @@ ___ #### Defined in -[services/anonymous.ts:275](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L275) +[src/services/anonymous.ts:276](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L276) ___ @@ -456,7 +456,7 @@ ___ #### Defined in -[services/anonymous.ts:327](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L327) +[src/services/anonymous.ts:328](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L328) ___ @@ -474,4 +474,4 @@ ___ #### Defined in -[services/anonymous.ts:302](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L302) +[src/services/anonymous.ts:303](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L303) diff --git a/docs/sdk/reference/classes/AnonymousVote.md b/docs/sdk/reference/classes/AnonymousVote.md index b7bdc56b1..6c5ec1530 100644 --- a/docs/sdk/reference/classes/AnonymousVote.md +++ b/docs/sdk/reference/classes/AnonymousVote.md @@ -34,7 +34,7 @@ Represents a vote #### Defined in -[types/vote/anonymous.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/vote/anonymous.ts#L20) +[src/types/vote/anonymous.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/vote/anonymous.ts#L20) • `set` **password**(`value`): `void` @@ -50,7 +50,7 @@ Represents a vote #### Defined in -[types/vote/anonymous.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/vote/anonymous.ts#L24) +[src/types/vote/anonymous.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/vote/anonymous.ts#L24) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[types/vote/anonymous.ts:28](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/vote/anonymous.ts#L28) +[src/types/vote/anonymous.ts:28](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/vote/anonymous.ts#L28) • `set` **signature**(`value`): `void` @@ -80,7 +80,7 @@ ___ #### Defined in -[types/vote/anonymous.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/vote/anonymous.ts#L32) +[src/types/vote/anonymous.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/vote/anonymous.ts#L32) ___ @@ -98,7 +98,7 @@ Vote.votes #### Defined in -[types/vote/vote.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/vote/vote.ts#L16) +[src/types/vote/vote.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/vote/vote.ts#L16) • `set` **votes**(`value`): `void` @@ -118,7 +118,7 @@ Vote.votes #### Defined in -[types/vote/vote.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/vote/vote.ts#L20) +[src/types/vote/vote.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/vote/vote.ts#L20) ## Constructors @@ -146,4 +146,4 @@ Constructs an anonymous vote #### Defined in -[types/vote/anonymous.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/vote/anonymous.ts#L14) +[src/types/vote/anonymous.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/vote/anonymous.ts#L14) diff --git a/docs/sdk/reference/classes/ApprovalElection.md b/docs/sdk/reference/classes/ApprovalElection.md index 3f2f61e88..8b96491da 100644 --- a/docs/sdk/reference/classes/ApprovalElection.md +++ b/docs/sdk/reference/classes/ApprovalElection.md @@ -63,7 +63,7 @@ UnpublishedElection.addSDKVersion #### Defined in -[types/election/unpublished.ts:287](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L287) +[src/types/election/unpublished.ts:291](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L291) • `set` **addSDKVersion**(`value`): `void` @@ -83,7 +83,7 @@ UnpublishedElection.addSDKVersion #### Defined in -[types/election/unpublished.ts:291](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L291) +[src/types/election/unpublished.ts:295](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L295) ___ @@ -101,7 +101,7 @@ UnpublishedElection.census #### Defined in -[types/election/unpublished.ts:261](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L261) +[src/types/election/unpublished.ts:265](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L265) • `set` **census**(`value`): `void` @@ -121,7 +121,7 @@ UnpublishedElection.census #### Defined in -[types/election/unpublished.ts:265](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L265) +[src/types/election/unpublished.ts:269](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L269) ___ @@ -139,7 +139,7 @@ UnpublishedElection.description #### Defined in -[types/election/unpublished.ts:185](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L185) +[src/types/election/unpublished.ts:189](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L189) • `set` **description**(`value`): `void` @@ -159,7 +159,7 @@ UnpublishedElection.description #### Defined in -[types/election/unpublished.ts:189](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L189) +[src/types/election/unpublished.ts:193](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L193) ___ @@ -177,7 +177,7 @@ UnpublishedElection.duration #### Defined in -[types/election/unpublished.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L150) +[src/types/election/unpublished.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L155) ___ @@ -195,7 +195,7 @@ UnpublishedElection.electionType #### Defined in -[types/election/unpublished.ts:237](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L237) +[src/types/election/unpublished.ts:241](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L241) • `set` **electionType**(`value`): `void` @@ -215,7 +215,7 @@ UnpublishedElection.electionType #### Defined in -[types/election/unpublished.ts:241](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L241) +[src/types/election/unpublished.ts:245](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L245) ___ @@ -233,7 +233,7 @@ UnpublishedElection.endDate #### Defined in -[types/election/unpublished.ts:227](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L227) +[src/types/election/unpublished.ts:231](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L231) • `set` **endDate**(`value`): `void` @@ -253,7 +253,7 @@ UnpublishedElection.endDate #### Defined in -[types/election/unpublished.ts:231](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L231) +[src/types/election/unpublished.ts:235](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L235) ___ @@ -271,7 +271,7 @@ UnpublishedElection.header #### Defined in -[types/election/unpublished.ts:193](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L193) +[src/types/election/unpublished.ts:197](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L197) • `set` **header**(`value`): `void` @@ -291,7 +291,7 @@ UnpublishedElection.header #### Defined in -[types/election/unpublished.ts:197](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L197) +[src/types/election/unpublished.ts:201](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L201) ___ @@ -309,7 +309,7 @@ UnpublishedElection.maxCensusSize #### Defined in -[types/election/unpublished.ts:270](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L270) +[src/types/election/unpublished.ts:274](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L274) • `set` **maxCensusSize**(`value`): `void` @@ -329,7 +329,7 @@ UnpublishedElection.maxCensusSize #### Defined in -[types/election/unpublished.ts:274](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L274) +[src/types/election/unpublished.ts:278](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L278) ___ @@ -347,7 +347,7 @@ UnpublishedElection.meta #### Defined in -[types/election/unpublished.ts:209](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L209) +[src/types/election/unpublished.ts:213](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L213) • `set` **meta**(`value`): `void` @@ -367,7 +367,7 @@ UnpublishedElection.meta #### Defined in -[types/election/unpublished.ts:213](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L213) +[src/types/election/unpublished.ts:217](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L217) ___ @@ -385,7 +385,7 @@ UnpublishedElection.questions #### Defined in -[types/election/unpublished.ts:253](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L253) +[src/types/election/unpublished.ts:257](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L257) • `set` **questions**(`value`): `void` @@ -405,7 +405,7 @@ UnpublishedElection.questions #### Defined in -[types/election/unpublished.ts:257](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L257) +[src/types/election/unpublished.ts:261](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L261) ___ @@ -423,7 +423,7 @@ UnpublishedElection.startDate #### Defined in -[types/election/unpublished.ts:218](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L218) +[src/types/election/unpublished.ts:222](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L222) • `set` **startDate**(`value`): `void` @@ -443,7 +443,7 @@ UnpublishedElection.startDate #### Defined in -[types/election/unpublished.ts:222](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L222) +[src/types/election/unpublished.ts:226](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L226) ___ @@ -461,7 +461,7 @@ UnpublishedElection.streamUri #### Defined in -[types/election/unpublished.ts:201](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L201) +[src/types/election/unpublished.ts:205](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L205) • `set` **streamUri**(`value`): `void` @@ -481,7 +481,7 @@ UnpublishedElection.streamUri #### Defined in -[types/election/unpublished.ts:205](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L205) +[src/types/election/unpublished.ts:209](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L209) ___ @@ -499,7 +499,7 @@ UnpublishedElection.temporarySecretIdentity #### Defined in -[types/election/unpublished.ts:279](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L279) +[src/types/election/unpublished.ts:283](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L283) • `set` **temporarySecretIdentity**(`value`): `void` @@ -519,7 +519,7 @@ UnpublishedElection.temporarySecretIdentity #### Defined in -[types/election/unpublished.ts:283](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L283) +[src/types/election/unpublished.ts:287](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L287) ___ @@ -537,7 +537,7 @@ UnpublishedElection.title #### Defined in -[types/election/unpublished.ts:176](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L176) +[src/types/election/unpublished.ts:180](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L180) • `set` **title**(`value`): `void` @@ -557,7 +557,7 @@ UnpublishedElection.title #### Defined in -[types/election/unpublished.ts:180](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L180) +[src/types/election/unpublished.ts:184](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L184) ___ @@ -575,7 +575,7 @@ UnpublishedElection.voteType #### Defined in -[types/election/unpublished.ts:245](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L245) +[src/types/election/unpublished.ts:249](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L249) • `set` **voteType**(`value`): `void` @@ -595,7 +595,7 @@ UnpublishedElection.voteType #### Defined in -[types/election/unpublished.ts:249](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L249) +[src/types/election/unpublished.ts:253](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L253) ## Constructors @@ -621,13 +621,13 @@ Constructs an approval election #### Defined in -[types/election/approval.ts:18](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/approval.ts#L18) +[src/types/election/approval.ts:18](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/approval.ts#L18) ## Methods ### addQuestion -▸ **addQuestion**(`title`, `description`, `choices`): [`UnpublishedElection`](UnpublishedElection) +▸ **addQuestion**(`title`, `description`, `choices`, `meta?`): [`UnpublishedElection`](UnpublishedElection) #### Parameters @@ -635,7 +635,8 @@ Constructs an approval election | :------ | :------ | | `title` | `string` \| `MultiLanguage`\<`string`\> | | `description` | `string` \| `MultiLanguage`\<`string`\> | -| `choices` | (\{ `title`: `string` } \| \{ `title`: `MultiLanguage`\<`string`\> })[] | +| `choices` | ([`Choice`](../sdk-reference#choice) \| \{ `meta?`: `any` ; `title`: `string` ; `value?`: `number` })[] | +| `meta?` | `any` | #### Returns @@ -647,7 +648,7 @@ Constructs an approval election #### Defined in -[types/election/approval.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/approval.ts#L26) +[src/types/election/approval.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/approval.ts#L26) ___ @@ -665,7 +666,7 @@ ___ #### Defined in -[types/election/approval.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/approval.ts#L55) +[src/types/election/approval.ts:58](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/approval.ts#L58) ___ @@ -683,7 +684,7 @@ ___ #### Defined in -[types/election/approval.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/approval.ts#L65) +[src/types/election/approval.ts:68](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/approval.ts#L68) ___ @@ -701,7 +702,7 @@ ___ #### Defined in -[types/election/unpublished.ts:166](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L166) +[src/types/election/unpublished.ts:171](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L171) ___ @@ -719,7 +720,7 @@ ___ #### Defined in -[types/election/approval.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/approval.ts#L45) +[src/types/election/approval.ts:48](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/approval.ts#L48) ___ @@ -743,7 +744,7 @@ ___ #### Defined in -[types/election/election.ts:279](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L279) +[src/types/election/election.ts:275](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L275) ___ @@ -767,7 +768,7 @@ ___ #### Defined in -[types/election/unpublished.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L61) +[src/types/election/unpublished.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L65) ___ @@ -785,7 +786,7 @@ ___ #### Defined in -[types/election/unpublished.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L128) +[src/types/election/unpublished.ts:133](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L133) ___ @@ -806,7 +807,7 @@ ___ #### Defined in -[types/election/approval.ts:79](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/approval.ts#L79) +[src/types/election/approval.ts:82](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/approval.ts#L82) ___ @@ -832,4 +833,4 @@ Returns an unpublished election object #### Defined in -[types/election/approval.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/approval.ts#L22) +[src/types/election/approval.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/approval.ts#L22) diff --git a/docs/sdk/reference/classes/ArchivedElection.md b/docs/sdk/reference/classes/ArchivedElection.md deleted file mode 100644 index 46adc9a43..000000000 --- a/docs/sdk/reference/classes/ArchivedElection.md +++ /dev/null @@ -1,737 +0,0 @@ -[@vocdoni/sdk](/sdk) / ArchivedElection - -# Class: ArchivedElection - -Represents a published election - -## Hierarchy - -- [`PublishedElection`](PublishedElection) - - ↳ **`ArchivedElection`** - -## Table of contents - -### Accessors - -- [addSDKVersion](ArchivedElection#addsdkversion) -- [census](ArchivedElection#census) -- [chainId](ArchivedElection#chainid) -- [creationTime](ArchivedElection#creationtime) -- [description](ArchivedElection#description) -- [electionType](ArchivedElection#electiontype) -- [endDate](ArchivedElection#enddate) -- [finalResults](ArchivedElection#finalresults) -- [fromArchive](ArchivedElection#fromarchive) -- [header](ArchivedElection#header) -- [id](ArchivedElection#id) -- [isValid](ArchivedElection#isvalid) -- [manuallyEnded](ArchivedElection#manuallyended) -- [maxCensusSize](ArchivedElection#maxcensussize) -- [meta](ArchivedElection#meta) -- [metadataURL](ArchivedElection#metadataurl) -- [organizationId](ArchivedElection#organizationid) -- [questions](ArchivedElection#questions) -- [raw](ArchivedElection#raw) -- [results](ArchivedElection#results) -- [resultsType](ArchivedElection#resultstype) -- [startDate](ArchivedElection#startdate) -- [status](ArchivedElection#status) -- [streamUri](ArchivedElection#streamuri) -- [temporarySecretIdentity](ArchivedElection#temporarysecretidentity) -- [title](ArchivedElection#title) -- [voteCount](ArchivedElection#votecount) -- [voteType](ArchivedElection#votetype) - -### Constructors - -- [constructor](ArchivedElection#constructor) - -### Methods - -- [checkVote](ArchivedElection#checkvote) -- [get](ArchivedElection#get) -- [build](ArchivedElection#build) -- [checkVote](ArchivedElection.md#checkvote-1) -- [from](ArchivedElection#from) -- [getStatus](ArchivedElection#getstatus) - -## Accessors - -### addSDKVersion - -• `get` **addSDKVersion**(): `boolean` - -#### Returns - -`boolean` - -#### Inherited from - -PublishedElection.addSDKVersion - -#### Defined in - -[types/election/election.ts:275](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L275) - -___ - -### census - -• `get` **census**(): `ArchivedCensus` - -#### Returns - -`ArchivedCensus` - -#### Overrides - -PublishedElection.census - -#### Defined in - -[types/election/archived.ts:17](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/archived.ts#L17) - -___ - -### chainId - -• `get` **chainId**(): `string` - -#### Returns - -`string` - -#### Inherited from - -PublishedElection.chainId - -#### Defined in - -[types/election/published.ts:219](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L219) - -___ - -### creationTime - -• `get` **creationTime**(): `Date` - -#### Returns - -`Date` - -#### Inherited from - -PublishedElection.creationTime - -#### Defined in - -[types/election/published.ts:223](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L223) - -___ - -### description - -• `get` **description**(): `MultiLanguage`\<`string`\> - -#### Returns - -`MultiLanguage`\<`string`\> - -#### Inherited from - -PublishedElection.description - -#### Defined in - -[types/election/published.ts:147](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L147) - -___ - -### electionType - -• `get` **electionType**(): [`IElectionType`](../interfaces/IElectionType) - -#### Returns - -[`IElectionType`](../interfaces/IElectionType) - -#### Inherited from - -PublishedElection.electionType - -#### Defined in - -[types/election/published.ts:167](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L167) - -___ - -### endDate - -• `get` **endDate**(): `Date` - -#### Returns - -`Date` - -#### Inherited from - -PublishedElection.endDate - -#### Defined in - -[types/election/published.ts:163](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L163) - -___ - -### finalResults - -• `get` **finalResults**(): `boolean` - -#### Returns - -`boolean` - -#### Inherited from - -PublishedElection.finalResults - -#### Defined in - -[types/election/published.ts:203](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L203) - -___ - -### fromArchive - -• `get` **fromArchive**(): `boolean` - -#### Returns - -`boolean` - -#### Inherited from - -PublishedElection.fromArchive - -#### Defined in - -[types/election/published.ts:215](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L215) - -___ - -### header - -• `get` **header**(): `string` - -#### Returns - -`string` - -#### Inherited from - -PublishedElection.header - -#### Defined in - -[types/election/published.ts:151](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L151) - -___ - -### id - -• `get` **id**(): `string` - -#### Returns - -`string` - -#### Inherited from - -PublishedElection.id - -#### Defined in - -[types/election/published.ts:187](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L187) - -___ - -### isValid - -• `get` **isValid**(): `boolean` - -#### Returns - -`boolean` - -#### Inherited from - -PublishedElection.isValid - -#### Defined in - -[types/election/published.ts:239](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L239) - -___ - -### manuallyEnded - -• `get` **manuallyEnded**(): `boolean` - -#### Returns - -`boolean` - -#### Inherited from - -PublishedElection.manuallyEnded - -#### Defined in - -[types/election/published.ts:211](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L211) - -___ - -### maxCensusSize - -• `get` **maxCensusSize**(): `number` - -#### Returns - -`number` - -#### Inherited from - -PublishedElection.maxCensusSize - -#### Defined in - -[types/election/published.ts:183](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L183) - -___ - -### meta - -• `get` **meta**(): `any` - -#### Returns - -`any` - -#### Inherited from - -PublishedElection.meta - -#### Defined in - -[types/election/election.ts:239](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L239) - -___ - -### metadataURL - -• `get` **metadataURL**(): `string` - -#### Returns - -`string` - -#### Inherited from - -PublishedElection.metadataURL - -#### Defined in - -[types/election/published.ts:227](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L227) - -___ - -### organizationId - -• `get` **organizationId**(): `string` - -#### Returns - -`string` - -#### Inherited from - -PublishedElection.organizationId - -#### Defined in - -[types/election/published.ts:191](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L191) - -___ - -### questions - -• `get` **questions**(): [`IQuestion`](../interfaces/IQuestion)[] - -#### Returns - -[`IQuestion`](../interfaces/IQuestion)[] - -#### Inherited from - -PublishedElection.questions - -#### Defined in - -[types/election/published.ts:175](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L175) - -___ - -### raw - -• `get` **raw**(): `object` - -#### Returns - -`object` - -#### Inherited from - -PublishedElection.raw - -#### Defined in - -[types/election/published.ts:235](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L235) - -___ - -### results - -• `get` **results**(): `string`[][] - -#### Returns - -`string`[][] - -#### Inherited from - -PublishedElection.results - -#### Defined in - -[types/election/published.ts:207](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L207) - -___ - -### resultsType - -• `get` **resultsType**(): [`ElectionResultsType`](../sdk-reference#electionresultstype) - -#### Returns - -[`ElectionResultsType`](../sdk-reference#electionresultstype) - -#### Inherited from - -PublishedElection.resultsType - -#### Defined in - -[types/election/published.ts:231](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L231) - -___ - -### startDate - -• `get` **startDate**(): `Date` - -#### Returns - -`Date` - -#### Inherited from - -PublishedElection.startDate - -#### Defined in - -[types/election/published.ts:159](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L159) - -___ - -### status - -• `get` **status**(): [`ElectionStatus`](../enums/ElectionStatus) - -#### Returns - -[`ElectionStatus`](../enums/ElectionStatus) - -#### Inherited from - -PublishedElection.status - -#### Defined in - -[types/election/published.ts:195](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L195) - -___ - -### streamUri - -• `get` **streamUri**(): `string` - -#### Returns - -`string` - -#### Inherited from - -PublishedElection.streamUri - -#### Defined in - -[types/election/published.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L155) - -___ - -### temporarySecretIdentity - -• `get` **temporarySecretIdentity**(): `boolean` - -#### Returns - -`boolean` - -#### Inherited from - -PublishedElection.temporarySecretIdentity - -#### Defined in - -[types/election/election.ts:271](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L271) - -___ - -### title - -• `get` **title**(): `MultiLanguage`\<`string`\> - -#### Returns - -`MultiLanguage`\<`string`\> - -#### Inherited from - -PublishedElection.title - -#### Defined in - -[types/election/published.ts:143](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L143) - -___ - -### voteCount - -• `get` **voteCount**(): `number` - -#### Returns - -`number` - -#### Inherited from - -PublishedElection.voteCount - -#### Defined in - -[types/election/published.ts:199](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L199) - -___ - -### voteType - -• `get` **voteType**(): [`IVoteType`](../interfaces/IVoteType) - -#### Returns - -[`IVoteType`](../interfaces/IVoteType) - -#### Inherited from - -PublishedElection.voteType - -#### Defined in - -[types/election/published.ts:171](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/archived.ts#L13) - -## Methods - -### checkVote - -▸ **checkVote**(`vote`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `vote` | [`Vote`](Vote) | - -#### Returns - -`void` - -#### Inherited from - -[PublishedElection](PublishedElection.md).[checkVote](PublishedElection#checkvote) - -#### Defined in - -[types/election/published.ts:113](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L113) - -___ - -### get - -▸ **get**(`dot`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `dot` | `string` | - -#### Returns - -`any` - -#### Inherited from - -[PublishedElection](PublishedElection.md).[get](PublishedElection#get) - -#### Defined in - -[types/election/election.ts:279](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L279) - -___ - -### build - -▸ **build**(`params`): [`PublishedElection`](PublishedElection) - -Returns a published election object - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`IPublishedElectionParameters`](../interfaces/IPublishedElectionParameters) | Published election parameters | - -#### Returns - -[`PublishedElection`](PublishedElection) - -#### Inherited from - -[PublishedElection](PublishedElection.md).[build](PublishedElection#build) - -#### Defined in - -[types/election/published.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L100) - -___ - -### checkVote - -▸ **checkVote**(`vote`, `voteType`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `vote` | [`Vote`](Vote) | -| `voteType` | [`IVoteType`](../interfaces/IVoteType) | - -#### Returns - -`void` - -#### Inherited from - -[PublishedElection](PublishedElection).[checkVote](PublishedElection.md#checkvote-1) - -#### Defined in - -[types/election/published.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L127) - -___ - -### from - -▸ **from**(`params`): [`UnpublishedElection`](UnpublishedElection) - -Returns an unpublished election object - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`IElectionParameters`](../interfaces/IElectionParameters) | Unpublished Election parameters | - -#### Returns - -[`UnpublishedElection`](UnpublishedElection) - -#### Inherited from - -[PublishedElection](PublishedElection.md).[from](PublishedElection#from) - -#### Defined in - -[types/election/election.ts:219](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L219) - -___ - -### getStatus - -▸ **getStatus**(`status`, `startDate`): [`ElectionStatus`](../enums/ElectionStatus) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `status` | [`AllElectionStatus`](../sdk-reference#allelectionstatus) | -| `startDate` | `Date` | - -#### Returns - -[`ElectionStatus`](../enums/ElectionStatus) - -#### Inherited from - -[PublishedElection](PublishedElection.md).[getStatus](PublishedElection#getstatus) - -#### Defined in - -[types/election/published.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L104) diff --git a/docs/sdk/reference/classes/BudgetElection.md b/docs/sdk/reference/classes/BudgetElection.md index 9cfe2dc8f..9a8410a9a 100644 --- a/docs/sdk/reference/classes/BudgetElection.md +++ b/docs/sdk/reference/classes/BudgetElection.md @@ -67,7 +67,7 @@ UnpublishedElection.addSDKVersion #### Defined in -[types/election/unpublished.ts:287](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L287) +[src/types/election/unpublished.ts:291](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L291) • `set` **addSDKVersion**(`value`): `void` @@ -87,7 +87,7 @@ UnpublishedElection.addSDKVersion #### Defined in -[types/election/unpublished.ts:291](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L291) +[src/types/election/unpublished.ts:295](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L295) ___ @@ -105,7 +105,7 @@ UnpublishedElection.census #### Defined in -[types/election/unpublished.ts:261](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L261) +[src/types/election/unpublished.ts:265](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L265) • `set` **census**(`value`): `void` @@ -125,7 +125,7 @@ UnpublishedElection.census #### Defined in -[types/election/unpublished.ts:265](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L265) +[src/types/election/unpublished.ts:269](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L269) ___ @@ -143,7 +143,7 @@ UnpublishedElection.description #### Defined in -[types/election/unpublished.ts:185](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L185) +[src/types/election/unpublished.ts:189](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L189) • `set` **description**(`value`): `void` @@ -163,7 +163,7 @@ UnpublishedElection.description #### Defined in -[types/election/unpublished.ts:189](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L189) +[src/types/election/unpublished.ts:193](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L193) ___ @@ -181,7 +181,7 @@ UnpublishedElection.duration #### Defined in -[types/election/unpublished.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L150) +[src/types/election/unpublished.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L155) ___ @@ -199,7 +199,7 @@ UnpublishedElection.electionType #### Defined in -[types/election/unpublished.ts:237](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L237) +[src/types/election/unpublished.ts:241](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L241) • `set` **electionType**(`value`): `void` @@ -219,7 +219,7 @@ UnpublishedElection.electionType #### Defined in -[types/election/unpublished.ts:241](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L241) +[src/types/election/unpublished.ts:245](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L245) ___ @@ -237,7 +237,7 @@ UnpublishedElection.endDate #### Defined in -[types/election/unpublished.ts:227](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L227) +[src/types/election/unpublished.ts:231](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L231) • `set` **endDate**(`value`): `void` @@ -257,7 +257,7 @@ UnpublishedElection.endDate #### Defined in -[types/election/unpublished.ts:231](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L231) +[src/types/election/unpublished.ts:235](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L235) ___ @@ -271,7 +271,7 @@ ___ #### Defined in -[types/election/budget.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/budget.ts#L132) +[src/types/election/budget.ts:141](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/budget.ts#L141) • `set` **forceFullBudget**(`value`): `void` @@ -287,7 +287,7 @@ ___ #### Defined in -[types/election/budget.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/budget.ts#L136) +[src/types/election/budget.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/budget.ts#L145) ___ @@ -305,7 +305,7 @@ UnpublishedElection.header #### Defined in -[types/election/unpublished.ts:193](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L193) +[src/types/election/unpublished.ts:197](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L197) • `set` **header**(`value`): `void` @@ -325,7 +325,7 @@ UnpublishedElection.header #### Defined in -[types/election/unpublished.ts:197](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L197) +[src/types/election/unpublished.ts:201](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L201) ___ @@ -339,7 +339,7 @@ ___ #### Defined in -[types/election/budget.ts:148](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/budget.ts#L148) +[src/types/election/budget.ts:157](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/budget.ts#L157) • `set` **maxBudget**(`value`): `void` @@ -355,7 +355,7 @@ ___ #### Defined in -[types/election/budget.ts:152](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/budget.ts#L152) +[src/types/election/budget.ts:161](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/budget.ts#L161) ___ @@ -373,7 +373,7 @@ UnpublishedElection.maxCensusSize #### Defined in -[types/election/unpublished.ts:270](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L270) +[src/types/election/unpublished.ts:274](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L274) • `set` **maxCensusSize**(`value`): `void` @@ -393,7 +393,7 @@ UnpublishedElection.maxCensusSize #### Defined in -[types/election/unpublished.ts:274](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L274) +[src/types/election/unpublished.ts:278](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L278) ___ @@ -411,7 +411,7 @@ UnpublishedElection.meta #### Defined in -[types/election/unpublished.ts:209](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L209) +[src/types/election/unpublished.ts:213](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L213) • `set` **meta**(`value`): `void` @@ -431,7 +431,7 @@ UnpublishedElection.meta #### Defined in -[types/election/unpublished.ts:213](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L213) +[src/types/election/unpublished.ts:217](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L217) ___ @@ -445,7 +445,7 @@ ___ #### Defined in -[types/election/budget.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/budget.ts#L124) +[src/types/election/budget.ts:133](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/budget.ts#L133) • `set` **minStep**(`value`): `void` @@ -461,7 +461,7 @@ ___ #### Defined in -[types/election/budget.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/budget.ts#L128) +[src/types/election/budget.ts:137](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/budget.ts#L137) ___ @@ -479,7 +479,7 @@ UnpublishedElection.questions #### Defined in -[types/election/unpublished.ts:253](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L253) +[src/types/election/unpublished.ts:257](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L257) • `set` **questions**(`value`): `void` @@ -499,7 +499,7 @@ UnpublishedElection.questions #### Defined in -[types/election/unpublished.ts:257](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L257) +[src/types/election/unpublished.ts:261](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L261) ___ @@ -517,7 +517,7 @@ UnpublishedElection.startDate #### Defined in -[types/election/unpublished.ts:218](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L218) +[src/types/election/unpublished.ts:222](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L222) • `set` **startDate**(`value`): `void` @@ -537,7 +537,7 @@ UnpublishedElection.startDate #### Defined in -[types/election/unpublished.ts:222](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L222) +[src/types/election/unpublished.ts:226](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L226) ___ @@ -555,7 +555,7 @@ UnpublishedElection.streamUri #### Defined in -[types/election/unpublished.ts:201](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L201) +[src/types/election/unpublished.ts:205](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L205) • `set` **streamUri**(`value`): `void` @@ -575,7 +575,7 @@ UnpublishedElection.streamUri #### Defined in -[types/election/unpublished.ts:205](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L205) +[src/types/election/unpublished.ts:209](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L209) ___ @@ -593,7 +593,7 @@ UnpublishedElection.temporarySecretIdentity #### Defined in -[types/election/unpublished.ts:279](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L279) +[src/types/election/unpublished.ts:283](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L283) • `set` **temporarySecretIdentity**(`value`): `void` @@ -613,7 +613,7 @@ UnpublishedElection.temporarySecretIdentity #### Defined in -[types/election/unpublished.ts:283](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L283) +[src/types/election/unpublished.ts:287](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L287) ___ @@ -631,7 +631,7 @@ UnpublishedElection.title #### Defined in -[types/election/unpublished.ts:176](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L176) +[src/types/election/unpublished.ts:180](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L180) • `set` **title**(`value`): `void` @@ -651,7 +651,7 @@ UnpublishedElection.title #### Defined in -[types/election/unpublished.ts:180](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L180) +[src/types/election/unpublished.ts:184](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L184) ___ @@ -665,7 +665,7 @@ ___ #### Defined in -[types/election/budget.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/budget.ts#L140) +[src/types/election/budget.ts:149](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/budget.ts#L149) • `set` **useCensusWeightAsBudget**(`value`): `void` @@ -681,7 +681,7 @@ ___ #### Defined in -[types/election/budget.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/budget.ts#L144) +[src/types/election/budget.ts:153](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/budget.ts#L153) ___ @@ -699,7 +699,7 @@ UnpublishedElection.voteType #### Defined in -[types/election/unpublished.ts:245](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L245) +[src/types/election/unpublished.ts:249](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L249) • `set` **voteType**(`value`): `void` @@ -719,7 +719,7 @@ UnpublishedElection.voteType #### Defined in -[types/election/unpublished.ts:249](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L249) +[src/types/election/unpublished.ts:253](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L253) ## Constructors @@ -745,13 +745,13 @@ Constructs a budget election #### Defined in -[types/election/budget.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/budget.ts#L35) +[src/types/election/budget.ts:41](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/budget.ts#L41) ## Methods ### addQuestion -▸ **addQuestion**(`title`, `description`, `choices`): [`UnpublishedElection`](UnpublishedElection) +▸ **addQuestion**(`title`, `description`, `choices`, `meta?`): [`UnpublishedElection`](UnpublishedElection) #### Parameters @@ -759,7 +759,8 @@ Constructs a budget election | :------ | :------ | | `title` | `string` \| `MultiLanguage`\<`string`\> | | `description` | `string` \| `MultiLanguage`\<`string`\> | -| `choices` | (\{ `title`: `string` } \| \{ `title`: `MultiLanguage`\<`string`\> })[] | +| `choices` | ([`Choice`](../sdk-reference#choice) \| \{ `meta?`: `any` ; `title`: `string` ; `value?`: `number` })[] | +| `meta?` | `any` | #### Returns @@ -771,7 +772,7 @@ Constructs a budget election #### Defined in -[types/election/budget.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/budget.ts#L49) +[src/types/election/budget.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/budget.ts#L55) ___ @@ -789,7 +790,7 @@ ___ #### Defined in -[types/election/budget.ts:78](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/budget.ts#L78) +[src/types/election/budget.ts:87](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/budget.ts#L87) ___ @@ -807,7 +808,7 @@ ___ #### Defined in -[types/election/budget.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/budget.ts#L88) +[src/types/election/budget.ts:97](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/budget.ts#L97) ___ @@ -825,7 +826,7 @@ ___ #### Defined in -[types/election/unpublished.ts:166](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L166) +[src/types/election/unpublished.ts:171](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L171) ___ @@ -843,7 +844,7 @@ ___ #### Defined in -[types/election/budget.ts:68](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/budget.ts#L68) +[src/types/election/budget.ts:77](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/budget.ts#L77) ___ @@ -867,7 +868,7 @@ ___ #### Defined in -[types/election/election.ts:279](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L279) +[src/types/election/election.ts:275](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L275) ___ @@ -891,7 +892,7 @@ ___ #### Defined in -[types/election/unpublished.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L61) +[src/types/election/unpublished.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L65) ___ @@ -909,7 +910,7 @@ ___ #### Defined in -[types/election/unpublished.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L128) +[src/types/election/unpublished.ts:133](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L133) ___ @@ -931,7 +932,7 @@ ___ #### Defined in -[types/election/budget.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/budget.ts#L104) +[src/types/election/budget.ts:113](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/budget.ts#L113) ___ @@ -957,4 +958,4 @@ Returns an unpublished election object #### Defined in -[types/election/budget.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/budget.ts#L45) +[src/types/election/budget.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/budget.ts#L51) diff --git a/docs/sdk/reference/classes/Census.md b/docs/sdk/reference/classes/Census.md index d21cef3ca..ba3fef5b5 100644 --- a/docs/sdk/reference/classes/Census.md +++ b/docs/sdk/reference/classes/Census.md @@ -41,7 +41,7 @@ Represents a generic census #### Defined in -[types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L35) +[src/types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L35) • `set` **censusId**(`value`): `void` @@ -57,7 +57,7 @@ Represents a generic census #### Defined in -[types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L39) +[src/types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L39) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -[types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L43) +[src/types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L43) • `set` **censusURI**(`value`): `void` @@ -87,7 +87,7 @@ ___ #### Defined in -[types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L47) +[src/types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L47) ___ @@ -101,7 +101,7 @@ ___ #### Defined in -[types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L75) +[src/types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L75) ___ @@ -115,7 +115,7 @@ ___ #### Defined in -[types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L59) +[src/types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L59) • `set` **size**(`value`): `void` @@ -131,7 +131,7 @@ ___ #### Defined in -[types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L63) +[src/types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L63) ___ @@ -145,7 +145,7 @@ ___ #### Defined in -[types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L51) +[src/types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L51) • `set` **type**(`value`): `void` @@ -161,7 +161,7 @@ ___ #### Defined in -[types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L55) +[src/types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L55) ___ @@ -175,7 +175,7 @@ ___ #### Defined in -[types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L67) +[src/types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L67) • `set` **weight**(`value`): `void` @@ -191,7 +191,7 @@ ___ #### Defined in -[types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L71) +[src/types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L71) ## Methods @@ -212,4 +212,4 @@ ___ #### Defined in -[types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L81) +[src/types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L81) diff --git a/docs/sdk/reference/classes/Census3CensusAPI.md b/docs/sdk/reference/classes/Census3CensusAPI.md index 601a4c6fe..a951e39e9 100644 --- a/docs/sdk/reference/classes/Census3CensusAPI.md +++ b/docs/sdk/reference/classes/Census3CensusAPI.md @@ -38,7 +38,7 @@ Returns the information of the census #### Defined in -[api/census3/census.ts:119](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/census.ts#L119) +[src/api/census3/census.ts:119](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/census.ts#L119) ___ @@ -64,7 +64,7 @@ The queue identifier #### Defined in -[api/census3/census.ts:147](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/census.ts#L147) +[src/api/census3/census.ts:147](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/census.ts#L147) ___ @@ -87,7 +87,7 @@ Fetches list of census based on given strategy #### Defined in -[api/census3/census.ts:106](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/census.ts#L106) +[src/api/census3/census.ts:106](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/census.ts#L106) ___ @@ -110,4 +110,4 @@ Returns the information of the census queue #### Defined in -[api/census3/census.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/census.ts#L132) +[src/api/census3/census.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/census.ts#L132) diff --git a/docs/sdk/reference/classes/Census3ServiceAPI.md b/docs/sdk/reference/classes/Census3ServiceAPI.md index 2bcadefc2..d4d078166 100644 --- a/docs/sdk/reference/classes/Census3ServiceAPI.md +++ b/docs/sdk/reference/classes/Census3ServiceAPI.md @@ -34,4 +34,4 @@ Fetches supported chains from the service #### Defined in -[api/census3/service.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/service.ts#L45) +[src/api/census3/service.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/service.ts#L45) diff --git a/docs/sdk/reference/classes/Census3StrategyAPI.md b/docs/sdk/reference/classes/Census3StrategyAPI.md index cad908971..f04eba907 100644 --- a/docs/sdk/reference/classes/Census3StrategyAPI.md +++ b/docs/sdk/reference/classes/Census3StrategyAPI.md @@ -16,6 +16,7 @@ - [estimation](Census3StrategyAPI#estimation) - [estimationQueue](Census3StrategyAPI#estimationqueue) - [holders](Census3StrategyAPI#holders) +- [holdersQueue](Census3StrategyAPI#holdersqueue) - [import](Census3StrategyAPI#import) - [importQueue](Census3StrategyAPI#importqueue) - [list](Census3StrategyAPI#list) @@ -49,7 +50,7 @@ The identifier of the created strategy #### Defined in -[api/census3/strategy.ts:422](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L422) +[src/api/census3/strategy.ts:451](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L451) ___ @@ -76,7 +77,7 @@ The queue identifier #### Defined in -[api/census3/strategy.ts:354](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L354) +[src/api/census3/strategy.ts:383](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L383) ___ @@ -99,13 +100,13 @@ Returns the information of the strategy estimation queue #### Defined in -[api/census3/strategy.ts:375](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L375) +[src/api/census3/strategy.ts:404](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L404) ___ ### holders -▸ **holders**(`url`, `id`, `pagination?`): `Promise`\<[`ICensus3StrategyHoldersResponsePaginated`](../interfaces/ICensus3StrategyHoldersResponsePaginated)\> +▸ **holders**(`url`, `id`): `Promise`\<`ICensus3QueueResponse`\> Fetches list of holders by strategy @@ -115,15 +116,40 @@ Fetches list of holders by strategy | :------ | :------ | :------ | | `url` | `string` | API endpoint URL | | `id` | `number` | The identifier of the strategy | -| `pagination?` | `Census3Pagination` | Pagination options | #### Returns -`Promise`\<[`ICensus3StrategyHoldersResponsePaginated`](../interfaces/ICensus3StrategyHoldersResponsePaginated)\> +`Promise`\<`ICensus3QueueResponse`\> + +The queue identifier + +#### Defined in + +[src/api/census3/strategy.ts:314](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L314) + +___ + +### holdersQueue + +▸ **holdersQueue**(`url`, `id`, `queueId`): `Promise`\<[`ICensus3StrategyHoldersQueueResponse`](../interfaces/ICensus3StrategyHoldersQueueResponse)\> + +Returns the information of the strategy holders queue + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `url` | `string` | API endpoint URL | +| `id` | `number` | The identifier of the strategy | +| `queueId` | `string` | The identifier of the strategy holders queue | + +#### Returns + +`Promise`\<[`ICensus3StrategyHoldersQueueResponse`](../interfaces/ICensus3StrategyHoldersQueueResponse)\> #### Defined in -[api/census3/strategy.ts:295](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L295) +[src/api/census3/strategy.ts:328](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L328) ___ @@ -148,7 +174,7 @@ The queue identifier #### Defined in -[api/census3/strategy.ts:406](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L406) +[src/api/census3/strategy.ts:435](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L435) ___ @@ -171,7 +197,7 @@ Returns the information of the strategy import queue #### Defined in -[api/census3/strategy.ts:390](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L390) +[src/api/census3/strategy.ts:419](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L419) ___ @@ -194,7 +220,7 @@ Fetches list of strategies #### Defined in -[api/census3/strategy.ts:279](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L279) +[src/api/census3/strategy.ts:298](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L298) ___ @@ -219,7 +245,7 @@ Fetches list of strategies based on given token #### Defined in -[api/census3/strategy.ts:316](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L316) +[src/api/census3/strategy.ts:345](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L345) ___ @@ -241,7 +267,7 @@ Returns the list of supported operators to build strategy predicates. #### Defined in -[api/census3/strategy.ts:453](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L453) +[src/api/census3/strategy.ts:482](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L482) ___ @@ -264,7 +290,7 @@ Returns the information of the strategy #### Defined in -[api/census3/strategy.ts:338](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L338) +[src/api/census3/strategy.ts:367](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L367) ___ @@ -289,4 +315,4 @@ Parsed version of the predicate #### Defined in -[api/census3/strategy.ts:441](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L441) +[src/api/census3/strategy.ts:470](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L470) diff --git a/docs/sdk/reference/classes/Census3TokenAPI.md b/docs/sdk/reference/classes/Census3TokenAPI.md index 721873ca2..b94c549d1 100644 --- a/docs/sdk/reference/classes/Census3TokenAPI.md +++ b/docs/sdk/reference/classes/Census3TokenAPI.md @@ -45,7 +45,7 @@ promised IFileCIDResponse #### Defined in -[api/census3/token.ts:226](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/token.ts#L226) +[src/api/census3/token.ts:226](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/token.ts#L226) ___ @@ -73,7 +73,7 @@ The balance of holder #### Defined in -[api/census3/token.ts:196](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/token.ts#L196) +[src/api/census3/token.ts:196](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/token.ts#L196) ___ @@ -96,7 +96,7 @@ Fetches list of already added tokens #### Defined in -[api/census3/token.ts:148](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/token.ts#L148) +[src/api/census3/token.ts:148](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/token.ts#L148) ___ @@ -121,7 +121,7 @@ Fetch the full token information #### Defined in -[api/census3/token.ts:175](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/token.ts#L175) +[src/api/census3/token.ts:175](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/token.ts#L175) ___ @@ -143,4 +143,4 @@ Fetches list of tokens types #### Defined in -[api/census3/token.ts:160](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/token.ts#L160) +[src/api/census3/token.ts:160](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/token.ts#L160) diff --git a/docs/sdk/reference/classes/CensusAPI.md b/docs/sdk/reference/classes/CensusAPI.md index 52a84d448..e85f143ca 100644 --- a/docs/sdk/reference/classes/CensusAPI.md +++ b/docs/sdk/reference/classes/CensusAPI.md @@ -4,7 +4,7 @@ ## Hierarchy -- `API` +- [`API`](API) ↳ **`CensusAPI`** @@ -13,12 +13,14 @@ ### Methods - [add](CensusAPI#add) +- [check](CensusAPI#check) - [create](CensusAPI#create) - [delete](CensusAPI#delete) - [export](CensusAPI#export) - [import](CensusAPI#import) - [proof](CensusAPI#proof) -- [publish](CensusAPI#publish) +- [publishAsync](CensusAPI#publishasync) +- [publishSync](CensusAPI#publishsync) - [size](CensusAPI#size) - [type](CensusAPI#type) - [weight](CensusAPI#weight) @@ -46,7 +48,33 @@ Adds participants to a census #### Defined in -[api/census.ts:151](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census.ts#L151) +[src/api/census.ts:161](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census.ts#L161) + +___ + +### check + +▸ **check**(`url`, `authToken`, `censusId`): `Promise`\<[`ICensusPublishResponse`](../interfaces/ICensusPublishResponse)\> + +Checks that the census is published + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `url` | `string` | API endpoint URL | +| `authToken` | `string` | Authentication token | +| `censusId` | `string` | The census ID we're checking | + +#### Returns + +`Promise`\<[`ICensusPublishResponse`](../interfaces/ICensusPublishResponse)\> + +on success + +#### Defined in + +[src/api/census.ts:235](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census.ts#L235) ___ @@ -70,7 +98,7 @@ Create's a new census in the API. #### Defined in -[api/census.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census.ts#L132) +[src/api/census.ts:142](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census.ts#L142) ___ @@ -96,7 +124,7 @@ on success #### Defined in -[api/census.ts:273](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census.ts#L273) +[src/api/census.ts:326](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census.ts#L326) ___ @@ -122,7 +150,7 @@ on success #### Defined in -[api/census.ts:221](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census.ts#L221) +[src/api/census.ts:274](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census.ts#L274) ___ @@ -151,7 +179,7 @@ on success #### Defined in -[api/census.ts:243](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census.ts#L243) +[src/api/census.ts:296](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census.ts#L296) ___ @@ -177,13 +205,39 @@ on success #### Defined in -[api/census.ts:206](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census.ts#L206) +[src/api/census.ts:259](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census.ts#L259) + +___ + +### publishAsync + +▸ **publishAsync**(`url`, `authToken`, `censusId`): `Promise`\<[`ICensusPublishAsyncResponse`](../interfaces/ICensusPublishAsyncResponse)\> + +Publishes the census using an async call + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `url` | `string` | API endpoint URL | +| `authToken` | `string` | Authentication token | +| `censusId` | `string` | The census ID we're publishing | + +#### Returns + +`Promise`\<[`ICensusPublishAsyncResponse`](../interfaces/ICensusPublishAsyncResponse)\> + +on success + +#### Defined in + +[src/api/census.ts:216](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census.ts#L216) ___ -### publish +### publishSync -▸ **publish**(`url`, `authToken`, `censusId`): `Promise`\<[`ICensusPublishResponse`](../interfaces/ICensusPublishResponse)\> +▸ **publishSync**(`url`, `authToken`, `censusId`): `Promise`\<[`ICensusPublishResponse`](../interfaces/ICensusPublishResponse)\> Publishes the census, so it can be used in processes @@ -203,7 +257,7 @@ on success #### Defined in -[api/census.ts:187](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census.ts#L187) +[src/api/census.ts:197](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census.ts#L197) ___ @@ -226,7 +280,7 @@ Returns the size of a given census #### Defined in -[api/census.ts:290](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census.ts#L290) +[src/api/census.ts:343](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census.ts#L343) ___ @@ -249,7 +303,7 @@ Returns the type of given census #### Defined in -[api/census.ts:316](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census.ts#L316) +[src/api/census.ts:369](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census.ts#L369) ___ @@ -272,4 +326,4 @@ Returns the weight of a given census #### Defined in -[api/census.ts:303](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census.ts#L303) +[src/api/census.ts:356](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census.ts#L356) diff --git a/docs/sdk/reference/classes/CensusService.md b/docs/sdk/reference/classes/CensusService.md index 5585b71ca..53a0b929c 100644 --- a/docs/sdk/reference/classes/CensusService.md +++ b/docs/sdk/reference/classes/CensusService.md @@ -33,6 +33,7 @@ ### Properties +- [async](CensusService#async) - [auth](CensusService#auth) - [chunk\_size](CensusService.md#chunk_size) - [url](CensusService#url) @@ -61,7 +62,7 @@ Service.constructor #### Defined in -[services/census.ts:73](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/census.ts#L73) +[src/services/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/census.ts#L81) ## Methods @@ -82,7 +83,7 @@ Service.constructor #### Defined in -[services/census.ts:142](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/census.ts#L142) +[src/services/census.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/census.ts#L150) ___ @@ -102,7 +103,7 @@ ___ #### Defined in -[services/census.ts:134](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/census.ts#L134) +[src/services/census.ts:142](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/census.ts#L142) ___ @@ -124,7 +125,7 @@ Publishes the given census. #### Defined in -[services/census.ts:228](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/census.ts#L228) +[src/services/census.ts:253](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/census.ts#L253) ___ @@ -146,7 +147,7 @@ Deletes the given census. #### Defined in -[services/census.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/census.ts#L108) +[src/services/census.ts:116](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/census.ts#L116) ___ @@ -168,7 +169,7 @@ Exports the given census identifier. #### Defined in -[services/census.ts:203](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/census.ts#L203) +[src/services/census.ts:228](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/census.ts#L228) ___ @@ -184,7 +185,7 @@ Fetches the specific account token auth and sets it to the current instance. #### Defined in -[services/census.ts:269](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/census.ts#L269) +[src/services/census.ts:294](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/census.ts#L294) ___ @@ -207,7 +208,7 @@ Fetches proof that an address is part of the specified census. #### Defined in -[services/census.ts:121](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/census.ts#L121) +[src/services/census.ts:129](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/census.ts#L129) ___ @@ -229,7 +230,7 @@ Fetches the information of a given census. #### Defined in -[services/census.ts:83](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/census.ts#L83) +[src/services/census.ts:91](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/census.ts#L91) ___ @@ -252,13 +253,13 @@ Imports data into the given census identifier. #### Defined in -[services/census.ts:216](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/census.ts#L216) +[src/services/census.ts:241](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/census.ts#L241) ___ ### publish -▸ **publish**(`censusId`): `Promise`\<[`ICensusPublishResponse`](../interfaces/ICensusPublishResponse)\> +▸ **publish**(`censusId`, `async?`): `Promise`\<[`ICensusPublishResponse`](../interfaces/ICensusPublishResponse)\> Publishes the given census identifier. @@ -267,6 +268,7 @@ Publishes the given census identifier. | Name | Type | Description | | :------ | :------ | :------ | | `censusId` | `string` | The census identifier | +| `async?` | `boolean` | If the publication has to be done asynchronously | #### Returns @@ -274,10 +276,24 @@ Publishes the given census identifier. #### Defined in -[services/census.ts:191](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/census.ts#L191) +[src/services/census.ts:200](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/census.ts#L200) ## Properties +### async + +• **async**: `CensusAsync` + +#### Implementation of + +CensusServiceProperties.async + +#### Defined in + +[src/services/census.ts:74](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/census.ts#L74) + +___ + ### auth • **auth**: `CensusAuth` @@ -288,7 +304,7 @@ CensusServiceProperties.auth #### Defined in -[services/census.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/census.ts#L65) +[src/services/census.ts:72](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/census.ts#L72) ___ @@ -302,7 +318,7 @@ CensusServiceProperties.chunk\_size #### Defined in -[services/census.ts:66](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/census.ts#L66) +[src/services/census.ts:73](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/census.ts#L73) ___ @@ -316,4 +332,4 @@ ___ #### Defined in -[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/service.ts#L6) +[src/services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/service.ts#L6) diff --git a/docs/sdk/reference/classes/CensusStillNotPublished.md b/docs/sdk/reference/classes/CensusStillNotPublished.md new file mode 100644 index 000000000..2c9cd87a5 --- /dev/null +++ b/docs/sdk/reference/classes/CensusStillNotPublished.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / CensusStillNotPublished + +# Class: CensusStillNotPublished + +## Hierarchy + +- `Error` + + ↳ **`CensusStillNotPublished`** + +## Table of contents + +### Constructors + +- [constructor](CensusStillNotPublished#constructor) + +### Methods + +- [captureStackTrace](CensusStillNotPublished#capturestacktrace) + +### Properties + +- [cause](CensusStillNotPublished#cause) +- [message](CensusStillNotPublished#message) +- [name](CensusStillNotPublished#name) +- [stack](CensusStillNotPublished#stack) +- [prepareStackTrace](CensusStillNotPublished#preparestacktrace) +- [stackTraceLimit](CensusStillNotPublished#stacktracelimit) + +## Constructors + +### constructor + +• **new CensusStillNotPublished**(`message?`): [`CensusStillNotPublished`](CensusStillNotPublished) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`CensusStillNotPublished`](CensusStillNotPublished) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:568](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L568) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ChainAPI.md b/docs/sdk/reference/classes/ChainAPI.md index 7386e01b0..6f46574aa 100644 --- a/docs/sdk/reference/classes/ChainAPI.md +++ b/docs/sdk/reference/classes/ChainAPI.md @@ -4,7 +4,7 @@ ## Hierarchy -- `API` +- [`API`](API) ↳ **`ChainAPI`** @@ -12,31 +12,29 @@ ### Methods -- [blockByHash](ChainAPI#blockbyhash) -- [blockByHeight](ChainAPI#blockbyheight) +- [blockInfoHash](ChainAPI#blockinfohash) +- [blockInfoHeight](ChainAPI#blockinfoheight) - [blockToDate](ChainAPI#blocktodate) -- [blockTransactions](ChainAPI#blocktransactions) +- [blocksList](ChainAPI#blockslist) - [circuit](ChainAPI#circuit) - [circuits](ChainAPI#circuits) - [costs](ChainAPI#costs) - [dateToBlock](ChainAPI#datetoblock) - [feesList](ChainAPI#feeslist) -- [feesListByReference](ChainAPI#feeslistbyreference) -- [feesListByType](ChainAPI#feeslistbytype) - [info](ChainAPI#info) -- [organizationCount](ChainAPI#organizationcount) - [organizationList](ChainAPI#organizationlist) - [submitTx](ChainAPI#submittx) +- [transfers](ChainAPI#transfers) +- [txCosts](ChainAPI#txcosts) - [txInfo](ChainAPI#txinfo) -- [txInfoByBlock](ChainAPI#txinfobyblock) - [txList](ChainAPI#txlist) - [validatorsList](ChainAPI#validatorslist) ## Methods -### blockByHash +### blockInfoHash -▸ **blockByHash**(`url`, `hash`): `Promise`\<[`IChainBlockInfoResponse`](../interfaces/IChainBlockInfoResponse)\> +▸ **blockInfoHash**(`url`, `hash`): `Promise`\<[`IChainBlockInfoResponse`](../interfaces/IChainBlockInfoResponse)\> Get block information by hash @@ -53,13 +51,13 @@ Get block information by hash #### Defined in -[api/chain.ts:630](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L630) +[src/api/chain.ts:645](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L645) ___ -### blockByHeight +### blockInfoHeight -▸ **blockByHeight**(`url`, `height`): `Promise`\<[`IChainBlockInfoResponse`](../interfaces/IChainBlockInfoResponse)\> +▸ **blockInfoHeight**(`url`, `height`): `Promise`\<[`IChainBlockInfoResponse`](../interfaces/IChainBlockInfoResponse)\> Get block information by height @@ -76,7 +74,7 @@ Get block information by height #### Defined in -[api/chain.ts:605](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L605) +[src/api/chain.ts:658](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L658) ___ @@ -99,31 +97,30 @@ Return approximate date by a given block height. #### Defined in -[api/chain.ts:672](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L672) +[src/api/chain.ts:701](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L701) ___ -### blockTransactions +### blocksList -▸ **blockTransactions**(`url`, `height`, `page?`): `Promise`\<[`IBlockTransactionsResponse`](../interfaces/IBlockTransactionsResponse)\> +▸ **blocksList**(`url`, `params?`): `Promise`\<[`IChainBlocksListResponse`](../interfaces/IChainBlocksListResponse)\> -Get paginated list of transactions registered on specific block +Returns the list of blocks #### Parameters -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `url` | `string` | `undefined` | API endpoint URL | -| `height` | `number` | `undefined` | block height | -| `page` | `number` | `0` | the page number | +| Name | Type | Description | +| :------ | :------ | :------ | +| `url` | `string` | {string} url API endpoint URL | +| `params?` | `Partial`\<[`FetchBlocksParametersWithPagination`](../sdk-reference#fetchblocksparameterswithpagination)\> | The parameters to filter the blocks | #### Returns -`Promise`\<[`IBlockTransactionsResponse`](../interfaces/IBlockTransactionsResponse)\> +`Promise`\<[`IChainBlocksListResponse`](../interfaces/IChainBlocksListResponse)\> #### Defined in -[api/chain.ts:644](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L644) +[src/api/chain.ts:671](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L671) ___ @@ -145,7 +142,7 @@ Fetches a circuit. #### Defined in -[api/chain.ts:445](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L445) +[src/api/chain.ts:506](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L506) ___ @@ -167,7 +164,7 @@ Fetches info about the blockchain anonymous circuits. #### Defined in -[api/chain.ts:433](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L433) +[src/api/chain.ts:494](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L494) ___ @@ -189,7 +186,7 @@ Fetches info about the blockchain costs. #### Defined in -[api/chain.ts:421](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L421) +[src/api/chain.ts:482](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L482) ___ @@ -212,70 +209,22 @@ By a given date give the estimate block for the current Vochain. #### Defined in -[api/chain.ts:658](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L658) +[src/api/chain.ts:687](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L687) ___ ### feesList -▸ **feesList**(`url`, `page?`): `Promise`\<[`IChainFeesListResponse`](../interfaces/IChainFeesListResponse)\> - -Returns the list of fees by page - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `url` | `string` | `undefined` | {string} url API endpoint URL | -| `page` | `number` | `0` | {number} page The page number | - -#### Returns - -`Promise`\<[`IChainFeesListResponse`](../interfaces/IChainFeesListResponse)\> - -#### Defined in - -[api/chain.ts:522](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L522) - -___ - -### feesListByReference - -▸ **feesListByReference**(`url`, `reference`, `page?`): `Promise`\<[`IChainFeesListResponse`](../interfaces/IChainFeesListResponse)\> - -Returns the list of fees by reference - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `url` | `string` | `undefined` | {string} url API endpoint URL | -| `reference` | `string` | `undefined` | {string} reference The reference | -| `page` | `number` | `0` | {number} page The page number | - -#### Returns - -`Promise`\<[`IChainFeesListResponse`](../interfaces/IChainFeesListResponse)\> - -#### Defined in - -[api/chain.ts:536](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L536) - -___ - -### feesListByType - -▸ **feesListByType**(`url`, `type`, `page?`): `Promise`\<[`IChainFeesListResponse`](../interfaces/IChainFeesListResponse)\> +▸ **feesList**(`url`, `params?`): `Promise`\<[`IChainFeesListResponse`](../interfaces/IChainFeesListResponse)\> -Returns the list of fees by type +Returns the list of fees #### Parameters -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `url` | `string` | `undefined` | {string} url API endpoint URL | -| `type` | `string` | `undefined` | {string} type The type of the fee | -| `page` | `number` | `0` | {number} page The page number | +| Name | Type | Description | +| :------ | :------ | :------ | +| `url` | `string` | {string} url API endpoint URL | +| `params?` | `Partial`\<[`FetchFeesParametersWithPagination`](../sdk-reference#fetchfeesparameterswithpagination)\> | The parameters to filter the fees | #### Returns @@ -283,7 +232,7 @@ Returns the list of fees by type #### Defined in -[api/chain.ts:552](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L552) +[src/api/chain.ts:597](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L597) ___ @@ -305,115 +254,113 @@ Fetches info about the blockchain status. #### Defined in -[api/chain.ts:409](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L409) +[src/api/chain.ts:470](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L470) ___ -### organizationCount +### organizationList -▸ **organizationCount**(`url`): `Promise`\<[`IChainOrganizationCountResponse`](../interfaces/IChainOrganizationCountResponse)\> +▸ **organizationList**(`url`, `params?`): `Promise`\<[`IChainOrganizationListResponse`](../interfaces/IChainOrganizationListResponse)\> -Returns the number of organizations +Returns the list of organizations #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `url` | `string` | API endpoint URL | +| `params?` | `Partial`\<[`FetchOrganizationParametersWithPagination`](../sdk-reference#fetchorganizationparameterswithpagination)\> | The parameters to filter the organizations | #### Returns -`Promise`\<[`IChainOrganizationCountResponse`](../interfaces/IChainOrganizationCountResponse)\> +`Promise`\<[`IChainOrganizationListResponse`](../interfaces/IChainOrganizationListResponse)\> #### Defined in -[api/chain.ts:566](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L566) +[src/api/chain.ts:614](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L614) ___ -### organizationList +### submitTx -▸ **organizationList**(`url`, `page?`, `organizationId?`): `Promise`\<[`IChainOrganizationListResponse`](../interfaces/IChainOrganizationListResponse)\> +▸ **submitTx**(`url`, `payload`): `Promise`\<[`IChainSubmitTxResponse`](../interfaces/IChainSubmitTxResponse)\> -Returns the list of organizations by page +Submits a transaction to the blockchain #### Parameters -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `url` | `string` | `undefined` | API endpoint URL | -| `page` | `number` | `0` | The page number | -| `organizationId?` | `string` | `undefined` | Organization id or partial id to search. It has to be a valid hex string. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `url` | `string` | API endpoint URL | +| `payload` | `string` | The transaction data payload | #### Returns -`Promise`\<[`IChainOrganizationListResponse`](../interfaces/IChainOrganizationListResponse)\> +`Promise`\<[`IChainSubmitTxResponse`](../interfaces/IChainSubmitTxResponse)\> #### Defined in -[api/chain.ts:580](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L580) +[src/api/chain.ts:550](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L550) ___ -### submitTx +### transfers -▸ **submitTx**(`url`, `payload`): `Promise`\<[`IChainSubmitTxResponse`](../interfaces/IChainSubmitTxResponse)\> +▸ **transfers**(`url`, `params?`): `Promise`\<[`IChainTransfersListResponse`](../interfaces/IChainTransfersListResponse)\> -Submits a transaction to the blockchain +Returns the list of transfers #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `url` | `string` | API endpoint URL | -| `payload` | `string` | The transaction data payload | +| `url` | `string` | {string} url API endpoint URL | +| `params?` | `Partial`\<[`FetchTransfersParametersWithPagination`](../sdk-reference#fetchtransfersparameterswithpagination)\> | The parameters to filter the transfers | #### Returns -`Promise`\<[`IChainSubmitTxResponse`](../interfaces/IChainSubmitTxResponse)\> +`Promise`\<[`IChainTransfersListResponse`](../interfaces/IChainTransfersListResponse)\> #### Defined in -[api/chain.ts:496](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L496) +[src/api/chain.ts:580](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L580) ___ -### txInfo +### txCosts -▸ **txInfo**(`url`, `txHash`): `Promise`\<[`IChainTxReference`](../interfaces/IChainTxReference)\> +▸ **txCosts**(`url`): `Promise`\<[`IChainTxCosts`](../interfaces/IChainTxCosts)\> -Fetches information about a transaction from the blockchain. +Returns the list of transactions and its cost #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `url` | `string` | API endpoint URL | -| `txHash` | `string` | The transaction hash which we want to retrieve the info from | #### Returns -`Promise`\<[`IChainTxReference`](../interfaces/IChainTxReference)\> +`Promise`\<[`IChainTxCosts`](../interfaces/IChainTxCosts)\> #### Defined in -[api/chain.ts:458](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L458) +[src/api/chain.ts:517](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L517) ___ -### txInfoByBlock +### txInfo -▸ **txInfoByBlock**(`url`, `blockHeight`, `txIndex`): `Promise`\<[`Tx`](../interfaces/Tx)\> +▸ **txInfo**(`url`, `txHash`): `Promise`\<[`Tx`](../interfaces/Tx)\> -Fetches information about a transaction by its containing block an index on the block. +Fetches information about a transaction from the blockchain. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `url` | `string` | API endpoint URL | -| `blockHeight` | `number` | Block with the containing transaction | -| `txIndex` | `number` | Index on the block | +| `txHash` | `string` | The transaction hash which we want to retrieve the info from | #### Returns @@ -421,22 +368,22 @@ Fetches information about a transaction by its containing block an index on the #### Defined in -[api/chain.ts:477](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L477) +[src/api/chain.ts:532](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L532) ___ ### txList -▸ **txList**(`url`, `page?`): `Promise`\<[`IChainTxListResponse`](../interfaces/IChainTxListResponse)\> +▸ **txList**(`url`, `params?`): `Promise`\<[`IChainTxListResponse`](../interfaces/IChainTxListResponse)\> -Returns the list of transactions by page +Returns the list of transactions #### Parameters -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `url` | `string` | `undefined` | {string} url API endpoint URL | -| `page` | `number` | `0` | {number} page The page number | +| Name | Type | Description | +| :------ | :------ | :------ | +| `url` | `string` | {string} url API endpoint URL | +| `params?` | `Partial`\<[`FetchTransactionsParametersWithPagination`](../sdk-reference#fetchtransactionsparameterswithpagination)\> | The parameters to filter the transactions | #### Returns @@ -444,7 +391,7 @@ Returns the list of transactions by page #### Defined in -[api/chain.ts:509](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L509) +[src/api/chain.ts:563](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L563) ___ @@ -466,4 +413,4 @@ Returns the list of validators #### Defined in -[api/chain.ts:617](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L617) +[src/api/chain.ts:632](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L632) diff --git a/docs/sdk/reference/classes/ChainService.md b/docs/sdk/reference/classes/ChainService.md index 19200dae5..d2eebe5a8 100644 --- a/docs/sdk/reference/classes/ChainService.md +++ b/docs/sdk/reference/classes/ChainService.md @@ -58,7 +58,7 @@ Service.constructor #### Defined in -[services/chain.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/chain.ts#L47) +[src/services/chain.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L84) ## Methods @@ -82,7 +82,7 @@ The block number #### Defined in -[services/chain.ts:112](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/chain.ts#L112) +[src/services/chain.ts:149](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L149) ___ @@ -98,7 +98,7 @@ Fetches blockchain costs information if needed. #### Defined in -[services/chain.ts:72](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/chain.ts#L72) +[src/services/chain.ts:109](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L109) ___ @@ -114,7 +114,7 @@ Fetches blockchain information if needed. #### Defined in -[services/chain.ts:56](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/chain.ts#L56) +[src/services/chain.ts:93](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L93) ___ @@ -138,13 +138,13 @@ The transaction hash #### Defined in -[services/chain.ts:90](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/chain.ts#L90) +[src/services/chain.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L127) ___ ### txInfo -▸ **txInfo**(`txHash`): `Promise`\<[`IChainTxReference`](../interfaces/IChainTxReference)\> +▸ **txInfo**(`txHash`): `Promise`\<[`Tx`](../interfaces/Tx)\> Fetches information about a transaction from the blockchain. @@ -156,13 +156,13 @@ Fetches information about a transaction from the blockchain. #### Returns -`Promise`\<[`IChainTxReference`](../interfaces/IChainTxReference)\> +`Promise`\<[`Tx`](../interfaces/Tx)\> The chain transaction #### Defined in -[services/chain.ts:101](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/chain.ts#L101) +[src/services/chain.ts:138](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L138) ___ @@ -188,7 +188,7 @@ it fails. #### Defined in -[services/chain.ts:126](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/chain.ts#L126) +[src/services/chain.ts:163](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L163) ## Properties @@ -202,7 +202,7 @@ ChainServiceProperties.chainCosts #### Defined in -[services/chain.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/chain.ts#L38) +[src/services/chain.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L75) ___ @@ -216,7 +216,7 @@ ChainServiceProperties.chainData #### Defined in -[services/chain.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/chain.ts#L39) +[src/services/chain.ts:76](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L76) ___ @@ -230,7 +230,7 @@ ChainServiceProperties.txWait #### Defined in -[services/chain.ts:40](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/chain.ts#L40) +[src/services/chain.ts:77](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L77) ___ @@ -244,4 +244,4 @@ ___ #### Defined in -[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/service.ts#L6) +[src/services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/service.ts#L6) diff --git a/docs/sdk/reference/classes/CouldNotCreateFaucetPackageError.md b/docs/sdk/reference/classes/CouldNotCreateFaucetPackageError.md new file mode 100644 index 000000000..d037428f5 --- /dev/null +++ b/docs/sdk/reference/classes/CouldNotCreateFaucetPackageError.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / CouldNotCreateFaucetPackageError + +# Class: CouldNotCreateFaucetPackageError + +## Hierarchy + +- `Error` + + ↳ **`CouldNotCreateFaucetPackageError`** + +## Table of contents + +### Constructors + +- [constructor](CouldNotCreateFaucetPackageError#constructor) + +### Methods + +- [captureStackTrace](CouldNotCreateFaucetPackageError#capturestacktrace) + +### Properties + +- [cause](CouldNotCreateFaucetPackageError#cause) +- [message](CouldNotCreateFaucetPackageError#message) +- [name](CouldNotCreateFaucetPackageError#name) +- [stack](CouldNotCreateFaucetPackageError#stack) +- [prepareStackTrace](CouldNotCreateFaucetPackageError#preparestacktrace) +- [stackTraceLimit](CouldNotCreateFaucetPackageError#stacktracelimit) + +## Constructors + +### constructor + +• **new CouldNotCreateFaucetPackageError**(`message?`): [`CouldNotCreateFaucetPackageError`](CouldNotCreateFaucetPackageError) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`CouldNotCreateFaucetPackageError`](CouldNotCreateFaucetPackageError) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/saas/errors.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/saas/errors.ts#L92) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/CouldNotSignTransactionError.md b/docs/sdk/reference/classes/CouldNotSignTransactionError.md new file mode 100644 index 000000000..3c9ff2983 --- /dev/null +++ b/docs/sdk/reference/classes/CouldNotSignTransactionError.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / CouldNotSignTransactionError + +# Class: CouldNotSignTransactionError + +## Hierarchy + +- `Error` + + ↳ **`CouldNotSignTransactionError`** + +## Table of contents + +### Constructors + +- [constructor](CouldNotSignTransactionError#constructor) + +### Methods + +- [captureStackTrace](CouldNotSignTransactionError#capturestacktrace) + +### Properties + +- [cause](CouldNotSignTransactionError#cause) +- [message](CouldNotSignTransactionError#message) +- [name](CouldNotSignTransactionError#name) +- [stack](CouldNotSignTransactionError#stack) +- [prepareStackTrace](CouldNotSignTransactionError#preparestacktrace) +- [stackTraceLimit](CouldNotSignTransactionError#stacktracelimit) + +## Constructors + +### constructor + +• **new CouldNotSignTransactionError**(`message?`): [`CouldNotSignTransactionError`](CouldNotSignTransactionError) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`CouldNotSignTransactionError`](CouldNotSignTransactionError) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/saas/errors.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/saas/errors.ts#L38) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/CspAPI.md b/docs/sdk/reference/classes/CspAPI.md index caf590e29..055034c21 100644 --- a/docs/sdk/reference/classes/CspAPI.md +++ b/docs/sdk/reference/classes/CspAPI.md @@ -4,7 +4,7 @@ ## Hierarchy -- `API` +- [`API`](API) ↳ **`CspAPI`** @@ -36,7 +36,7 @@ CSP info #### Defined in -[api/csp.ts:85](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/csp.ts#L85) +[src/api/csp.ts:85](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/csp.ts#L85) ___ @@ -62,7 +62,7 @@ CSP sign #### Defined in -[api/csp.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/csp.ts#L132) +[src/api/csp.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/csp.ts#L132) ___ @@ -90,4 +90,4 @@ CSP step #### Defined in -[api/csp.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/csp.ts#L104) +[src/api/csp.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/csp.ts#L104) diff --git a/docs/sdk/reference/classes/CspCensus.md b/docs/sdk/reference/classes/CspCensus.md index cbe6bc717..56a9ead09 100644 --- a/docs/sdk/reference/classes/CspCensus.md +++ b/docs/sdk/reference/classes/CspCensus.md @@ -45,7 +45,7 @@ Census.censusId #### Defined in -[types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L35) +[src/types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L35) • `set` **censusId**(`value`): `void` @@ -65,7 +65,7 @@ Census.censusId #### Defined in -[types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L39) +[src/types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L39) ___ @@ -83,7 +83,7 @@ Census.censusURI #### Defined in -[types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L43) +[src/types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L43) • `set` **censusURI**(`value`): `void` @@ -103,7 +103,7 @@ Census.censusURI #### Defined in -[types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L47) +[src/types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L47) ___ @@ -121,7 +121,7 @@ Census.isPublished #### Defined in -[types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L75) +[src/types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L75) ___ @@ -139,7 +139,7 @@ Census.size #### Defined in -[types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L59) +[src/types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L59) • `set` **size**(`value`): `void` @@ -159,7 +159,7 @@ Census.size #### Defined in -[types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L63) +[src/types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L63) ___ @@ -177,7 +177,7 @@ Census.type #### Defined in -[types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L51) +[src/types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L51) • `set` **type**(`value`): `void` @@ -197,7 +197,7 @@ Census.type #### Defined in -[types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L55) +[src/types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L55) ___ @@ -215,7 +215,7 @@ Census.weight #### Defined in -[types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L67) +[src/types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L67) • `set` **weight**(`value`): `void` @@ -235,7 +235,7 @@ Census.weight #### Defined in -[types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L71) +[src/types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L71) ## Constructors @@ -262,7 +262,7 @@ Census.constructor #### Defined in -[types/census/csp.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/csp.ts#L14) +[src/types/census/csp.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/csp.ts#L14) ## Methods @@ -287,4 +287,4 @@ Census.constructor #### Defined in -[types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L81) +[src/types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L81) diff --git a/docs/sdk/reference/classes/CspService.md b/docs/sdk/reference/classes/CspService.md index 01bf02b24..d12f775fb 100644 --- a/docs/sdk/reference/classes/CspService.md +++ b/docs/sdk/reference/classes/CspService.md @@ -57,7 +57,7 @@ Service.constructor #### Defined in -[services/csp.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/csp.ts#L29) +[src/services/csp.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/csp.ts#L29) ## Methods @@ -79,7 +79,7 @@ Service.constructor #### Defined in -[services/csp.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/csp.ts#L64) +[src/services/csp.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/csp.ts#L64) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[services/csp.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/csp.ts#L49) +[src/services/csp.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/csp.ts#L49) ___ @@ -124,7 +124,7 @@ ___ #### Defined in -[services/csp.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/csp.ts#L75) +[src/services/csp.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/csp.ts#L75) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -[services/csp.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/csp.ts#L43) +[src/services/csp.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/csp.ts#L43) ___ @@ -158,7 +158,7 @@ ___ #### Defined in -[services/csp.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/csp.ts#L39) +[src/services/csp.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/csp.ts#L39) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[services/csp.ts:79](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/csp.ts#L79) +[src/services/csp.ts:79](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/csp.ts#L79) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -[services/csp.ts:34](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/csp.ts#L34) +[src/services/csp.ts:34](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/csp.ts#L34) ## Properties @@ -214,7 +214,7 @@ CspServiceProperties.info #### Defined in -[services/csp.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/csp.ts#L22) +[src/services/csp.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/csp.ts#L22) ___ @@ -228,4 +228,4 @@ ___ #### Defined in -[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/service.ts#L6) +[src/services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/service.ts#L6) diff --git a/docs/sdk/reference/classes/CspVote.md b/docs/sdk/reference/classes/CspVote.md index 32a4a776d..5b2c6b1b5 100644 --- a/docs/sdk/reference/classes/CspVote.md +++ b/docs/sdk/reference/classes/CspVote.md @@ -34,7 +34,7 @@ Represents a vote #### Defined in -[types/vote/csp.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/vote/csp.ts#L29) +[src/types/vote/csp.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/vote/csp.ts#L29) • `set` **proof_type**(`value`): `void` @@ -50,7 +50,7 @@ Represents a vote #### Defined in -[types/vote/csp.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/vote/csp.ts#L33) +[src/types/vote/csp.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/vote/csp.ts#L33) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[types/vote/csp.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/vote/csp.ts#L21) +[src/types/vote/csp.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/vote/csp.ts#L21) • `set` **signature**(`value`): `void` @@ -80,7 +80,7 @@ ___ #### Defined in -[types/vote/csp.ts:25](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/vote/csp.ts#L25) +[src/types/vote/csp.ts:25](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/vote/csp.ts#L25) ___ @@ -98,7 +98,7 @@ Vote.votes #### Defined in -[types/vote/vote.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/vote/vote.ts#L16) +[src/types/vote/vote.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/vote/vote.ts#L16) • `set` **votes**(`value`): `void` @@ -118,7 +118,7 @@ Vote.votes #### Defined in -[types/vote/vote.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/vote/vote.ts#L20) +[src/types/vote/vote.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/vote/vote.ts#L20) ## Constructors @@ -146,4 +146,4 @@ Constructs a csp vote #### Defined in -[types/vote/csp.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/vote/csp.ts#L15) +[src/types/vote/csp.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/vote/csp.ts#L15) diff --git a/docs/sdk/reference/classes/DuplicateConflictError.md b/docs/sdk/reference/classes/DuplicateConflictError.md new file mode 100644 index 000000000..d38a19229 --- /dev/null +++ b/docs/sdk/reference/classes/DuplicateConflictError.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / DuplicateConflictError + +# Class: DuplicateConflictError + +## Hierarchy + +- `Error` + + ↳ **`DuplicateConflictError`** + +## Table of contents + +### Constructors + +- [constructor](DuplicateConflictError#constructor) + +### Methods + +- [captureStackTrace](DuplicateConflictError#capturestacktrace) + +### Properties + +- [cause](DuplicateConflictError#cause) +- [message](DuplicateConflictError#message) +- [name](DuplicateConflictError#name) +- [stack](DuplicateConflictError#stack) +- [prepareStackTrace](DuplicateConflictError#preparestacktrace) +- [stackTraceLimit](DuplicateConflictError#stacktracelimit) + +## Constructors + +### constructor + +• **new DuplicateConflictError**(`message?`): [`DuplicateConflictError`](DuplicateConflictError) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`DuplicateConflictError`](DuplicateConflictError) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/saas/errors.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/saas/errors.ts#L26) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/Election.md b/docs/sdk/reference/classes/Election.md index 4aec6f4f9..76f3f692d 100644 --- a/docs/sdk/reference/classes/Election.md +++ b/docs/sdk/reference/classes/Election.md @@ -48,7 +48,7 @@ Represents an election #### Defined in -[types/election/election.ts:275](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L275) +[src/types/election/election.ts:271](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L271) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[types/election/election.ts:263](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L263) +[src/types/election/election.ts:259](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L259) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[types/election/election.ts:227](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L227) +[src/types/election/election.ts:223](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L223) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[types/election/election.ts:251](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L251) +[src/types/election/election.ts:247](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L247) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[types/election/election.ts:247](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L247) +[src/types/election/election.ts:243](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L243) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[types/election/election.ts:231](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L231) +[src/types/election/election.ts:227](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L227) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[types/election/election.ts:267](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L267) +[src/types/election/election.ts:263](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L263) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[types/election/election.ts:239](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L239) +[src/types/election/election.ts:235](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L235) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[types/election/election.ts:259](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L259) +[src/types/election/election.ts:255](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L255) ___ @@ -174,7 +174,7 @@ ___ #### Defined in -[types/election/election.ts:243](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L243) +[src/types/election/election.ts:239](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L239) ___ @@ -188,7 +188,7 @@ ___ #### Defined in -[types/election/election.ts:235](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L235) +[src/types/election/election.ts:231](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L231) ___ @@ -202,7 +202,7 @@ ___ #### Defined in -[types/election/election.ts:271](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L271) +[src/types/election/election.ts:267](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L267) ___ @@ -216,7 +216,7 @@ ___ #### Defined in -[types/election/election.ts:223](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L223) +[src/types/election/election.ts:219](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L219) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -[types/election/election.ts:255](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L255) +[src/types/election/election.ts:251](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L251) ## Methods @@ -250,7 +250,7 @@ ___ #### Defined in -[types/election/election.ts:279](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L279) +[src/types/election/election.ts:275](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L275) ___ @@ -272,4 +272,4 @@ Returns an unpublished election object #### Defined in -[types/election/election.ts:219](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L219) +[src/types/election/election.ts:215](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L215) diff --git a/docs/sdk/reference/classes/ElectionAPI.md b/docs/sdk/reference/classes/ElectionAPI.md index bf0c16fa8..e4c0d296e 100644 --- a/docs/sdk/reference/classes/ElectionAPI.md +++ b/docs/sdk/reference/classes/ElectionAPI.md @@ -4,7 +4,7 @@ ## Hierarchy -- `API` +- [`API`](API) ↳ **`ElectionAPI`** @@ -13,13 +13,11 @@ ### Methods - [create](ElectionAPI#create) -- [electionsList](ElectionAPI#electionslist) - [info](ElectionAPI#info) - [keys](ElectionAPI#keys) +- [list](ElectionAPI#list) - [nextElectionId](ElectionAPI#nextelectionid) - [price](ElectionAPI#price) -- [votesCount](ElectionAPI#votescount) -- [votesList](ElectionAPI#voteslist) ## Methods @@ -43,31 +41,7 @@ Creates a new election. #### Defined in -[api/election.ts:410](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L410) - -___ - -### electionsList - -▸ **electionsList**(`url`, `page?`, `filter?`): `Promise`\<[`IElectionListResponse`](../interfaces/IElectionListResponse)\> - -Return list of all elections in the chain - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `url` | `string` | `undefined` | API endpoint URL | -| `page` | `number` | `0` | The page number | -| `filter` | [`IElectionListFilter`](../interfaces/IElectionListFilter) | `{}` | Search by organizationId, electionId, withResults, and status | - -#### Returns - -`Promise`\<[`IElectionListResponse`](../interfaces/IElectionListResponse)\> - -#### Defined in - -[api/election.ts:477](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L477) +[src/api/election.ts:362](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L362) ___ @@ -90,7 +64,7 @@ Fetches info about the specified process. #### Defined in -[api/election.ts:383](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L383) +[src/api/election.ts:335](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L335) ___ @@ -113,103 +87,80 @@ Fetches the encryption keys from the specified process. #### Defined in -[api/election.ts:396](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L396) +[src/api/election.ts:348](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L348) ___ -### nextElectionId +### list -▸ **nextElectionId**(`url`, `organizationId`, `censusOrigin`, `envelopeType?`): `Promise`\<[`IElectionNextIdResponse`](../interfaces/IElectionNextIdResponse)\> +▸ **list**(`url`, `params?`): `Promise`\<[`IElectionListResponse`](../interfaces/IElectionListResponse)\> -Returns the next election id. +Return list of all elections in the chain #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `url` | `string` | API endpoint URL | -| `organizationId` | `string` | The identifier of the organization | -| `censusOrigin` | `number` | The census origin | -| `envelopeType?` | `Partial`\<[`IVoteMode`](../interfaces/IVoteMode)\> | The envelope type | +| `params?` | `Partial`\<[`FetchElectionsParametersWithPagination`](../sdk-reference#fetchelectionsparameterswithpagination)\> | The parameters to filter the elections | #### Returns -`Promise`\<[`IElectionNextIdResponse`](../interfaces/IElectionNextIdResponse)\> +`Promise`\<[`IElectionListResponse`](../interfaces/IElectionListResponse)\> #### Defined in -[api/election.ts:425](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L425) +[src/api/election.ts:402](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L402) ___ -### price +### nextElectionId -▸ **price**(`url`, `maxCensusSize`, `electionDuration`, `encryptedVotes`, `anonymousVotes`, `maxVoteOverwrite`): `Promise`\<`IElectionCalculatePriceResponse`\> +▸ **nextElectionId**(`url`, `organizationId`, `censusOrigin`, `delta?`, `envelopeType?`): `Promise`\<[`IElectionNextIdResponse`](../interfaces/IElectionNextIdResponse)\> -Calculates the election price. +Returns the next election id. #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `url` | `string` | API endpoint URL | -| `maxCensusSize` | `number` | | -| `electionDuration` | `number` | | -| `encryptedVotes` | `boolean` | | -| `anonymousVotes` | `boolean` | | -| `maxVoteOverwrite` | `number` | | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `url` | `string` | `undefined` | API endpoint URL | +| `organizationId` | `string` | `undefined` | The identifier of the organization | +| `censusOrigin` | `number` | `undefined` | The census origin | +| `delta` | `number` | `0` | The stride to next election id, being 0 the next one | +| `envelopeType?` | `Partial`\<[`IVoteMode`](../interfaces/IVoteMode)\> | `undefined` | The envelope type | #### Returns -`Promise`\<`IElectionCalculatePriceResponse`\> +`Promise`\<[`IElectionNextIdResponse`](../interfaces/IElectionNextIdResponse)\> #### Defined in -[api/election.ts:509](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L509) +[src/api/election.ts:378](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L378) ___ -### votesCount +### price -▸ **votesCount**(`url`, `electionId`): `Promise`\<`IElectionVotesCountResponse`\> +▸ **price**(`url`, `maxCensusSize`, `electionDuration`, `encryptedVotes`, `anonymousVotes`, `maxVoteOverwrite`): `Promise`\<`IElectionCalculatePriceResponse`\> -Returns the number of votes of a given election +Calculates the election price. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `url` | `string` | API endpoint URL | -| `electionId` | `string` | The identifier of the election | - -#### Returns - -`Promise`\<`IElectionVotesCountResponse`\> - -#### Defined in - -[api/election.ts:447](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L447) - -___ - -### votesList - -▸ **votesList**(`url`, `electionId`, `page?`): `Promise`\<[`IElectionVoteListResponse`](../interfaces/IElectionVoteListResponse)\> - -Returns the list of votes for a given election - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `url` | `string` | `undefined` | API endpoint URL | -| `electionId` | `string` | `undefined` | The identifier of the election | -| `page` | `number` | `0` | The page number | +| `maxCensusSize` | `number` | | +| `electionDuration` | `number` | | +| `encryptedVotes` | `boolean` | | +| `anonymousVotes` | `boolean` | | +| `maxVoteOverwrite` | `number` | | #### Returns -`Promise`\<[`IElectionVoteListResponse`](../interfaces/IElectionVoteListResponse)\> +`Promise`\<`IElectionCalculatePriceResponse`\> #### Defined in -[api/election.ts:461](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L461) +[src/api/election.ts:423](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L423) diff --git a/docs/sdk/reference/classes/ElectionService.md b/docs/sdk/reference/classes/ElectionService.md index c3713711d..76233469c 100644 --- a/docs/sdk/reference/classes/ElectionService.md +++ b/docs/sdk/reference/classes/ElectionService.md @@ -62,7 +62,7 @@ Service.constructor #### Defined in -[services/election.ts:70](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/election.ts#L70) +[src/services/election.ts:87](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L87) ## Methods @@ -86,7 +86,7 @@ The cost in tokens. #### Defined in -[services/election.ts:376](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/election.ts#L376) +[src/services/election.ts:397](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L397) ___ @@ -111,7 +111,7 @@ The created election information #### Defined in -[services/election.ts:296](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/election.ts#L296) +[src/services/election.ts:316](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L316) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[services/election.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/election.ts#L110) +[src/services/election.ts:129](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L129) ___ @@ -156,13 +156,13 @@ The cost in tokens. #### Defined in -[services/election.ts:363](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/election.ts#L363) +[src/services/election.ts:384](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L384) ___ ### fetchElection -▸ **fetchElection**(`electionId`, `password?`): `Promise`\<[`PublishedElection`](PublishedElection.md) \| [`ArchivedElection`](ArchivedElection)\> +▸ **fetchElection**(`electionId`, `password?`): `Promise`\<[`PublishedElection`](PublishedElection)\> Fetches info about an election. @@ -175,31 +175,31 @@ Fetches info about an election. #### Returns -`Promise`\<[`PublishedElection`](PublishedElection.md) \| [`ArchivedElection`](ArchivedElection)\> +`Promise`\<[`PublishedElection`](PublishedElection)\> #### Defined in -[services/election.ts:148](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/election.ts#L148) +[src/services/election.ts:167](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L167) ___ ### fetchElections -▸ **fetchElections**(`params`): `Promise`\<([`PublishedElection`](PublishedElection.md) \| [`ArchivedElection`](ArchivedElection.md) \| [`InvalidElection`](InvalidElection))[]\> +▸ **fetchElections**(`params?`): `Promise`\<[`ElectionListWithPagination`](../sdk-reference#electionlistwithpagination)\> #### Parameters | Name | Type | | :------ | :------ | -| `params` | `Partial`\<[`FetchElectionsParameters`](../interfaces/FetchElectionsParameters)\> | +| `params?` | `Partial`\<[`FetchElectionsParametersWithPagination`](../sdk-reference#fetchelectionsparameterswithpagination)\> | #### Returns -`Promise`\<([`PublishedElection`](PublishedElection.md) \| [`ArchivedElection`](ArchivedElection.md) \| [`InvalidElection`](InvalidElection))[]\> +`Promise`\<[`ElectionListWithPagination`](../sdk-reference#electionlistwithpagination)\> #### Defined in -[services/election.ts:261](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/election.ts#L261) +[src/services/election.ts:289](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L289) ___ @@ -224,7 +224,7 @@ The election salt #### Defined in -[services/election.ts:327](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/election.ts#L327) +[src/services/election.ts:348](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L348) ___ @@ -248,7 +248,7 @@ The numeric identifier #### Defined in -[services/election.ts:341](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/election.ts#L341) +[src/services/election.ts:362](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L362) ___ @@ -270,22 +270,23 @@ Fetches the encryption keys from the specified process. #### Defined in -[services/election.ts:353](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/election.ts#L353) +[src/services/election.ts:374](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L374) ___ ### nextElectionId -▸ **nextElectionId**(`address`, `election`): `Promise`\<`string`\> +▸ **nextElectionId**(`address`, `election`, `delta?`): `Promise`\<`string`\> Returns the next election id. #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `address` | `string` | The address of the account | -| `election` | [`UnpublishedElection`](UnpublishedElection) | The unpublished election | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `address` | `string` | `undefined` | The address of the account | +| `election` | [`UnpublishedElection`](UnpublishedElection) | `undefined` | The unpublished election | +| `delta` | `number` | `0` | The stride to next election id, being 0 the next one | #### Returns @@ -295,7 +296,7 @@ The next election identifier #### Defined in -[services/election.ts:308](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/election.ts#L308) +[src/services/election.ts:329](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L329) ___ @@ -309,7 +310,7 @@ ___ | :------ | :------ | | `tx` | `Uint8Array` | | `message` | `string` | -| `walletOrSigner` | `Signer` \| `Wallet` | +| `walletOrSigner` | `Signer` \| `Wallet` \| [`RemoteSigner`](RemoteSigner) | #### Returns @@ -317,7 +318,7 @@ ___ #### Defined in -[services/election.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/election.ts#L75) +[src/services/election.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L92) ## Properties @@ -331,7 +332,7 @@ ElectionServiceProperties.censusService #### Defined in -[services/election.ts:62](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/election.ts#L62) +[src/services/election.ts:79](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L79) ___ @@ -345,7 +346,7 @@ ElectionServiceProperties.chainService #### Defined in -[services/election.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/election.ts#L63) +[src/services/election.ts:80](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L80) ___ @@ -359,4 +360,4 @@ ___ #### Defined in -[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/service.ts#L6) +[src/services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/service.ts#L6) diff --git a/docs/sdk/reference/classes/EmailMalformedError.md b/docs/sdk/reference/classes/EmailMalformedError.md new file mode 100644 index 000000000..2c419fcf0 --- /dev/null +++ b/docs/sdk/reference/classes/EmailMalformedError.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / EmailMalformedError + +# Class: EmailMalformedError + +## Hierarchy + +- `Error` + + ↳ **`EmailMalformedError`** + +## Table of contents + +### Constructors + +- [constructor](EmailMalformedError#constructor) + +### Methods + +- [captureStackTrace](EmailMalformedError#capturestacktrace) + +### Properties + +- [cause](EmailMalformedError#cause) +- [message](EmailMalformedError#message) +- [name](EmailMalformedError#name) +- [stack](EmailMalformedError#stack) +- [prepareStackTrace](EmailMalformedError#preparestacktrace) +- [stackTraceLimit](EmailMalformedError#stacktracelimit) + +## Constructors + +### constructor + +• **new EmailMalformedError**(`message?`): [`EmailMalformedError`](EmailMalformedError) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`EmailMalformedError`](EmailMalformedError) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/saas/errors.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/saas/errors.ts#L8) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrAPI.md b/docs/sdk/reference/classes/ErrAPI.md new file mode 100644 index 000000000..3d22afb93 --- /dev/null +++ b/docs/sdk/reference/classes/ErrAPI.md @@ -0,0 +1,196 @@ +[@vocdoni/sdk](/sdk) / ErrAPI + +# Class: ErrAPI + +## Hierarchy + +- `Error` + + ↳ **`ErrAPI`** + +## Table of contents + +### Constructors + +- [constructor](ErrAPI#constructor) + +### Methods + +- [captureStackTrace](ErrAPI#capturestacktrace) + +### Properties + +- [cause](ErrAPI#cause) +- [message](ErrAPI#message) +- [name](ErrAPI#name) +- [raw](ErrAPI#raw) +- [stack](ErrAPI#stack) +- [prepareStackTrace](ErrAPI#preparestacktrace) +- [stackTraceLimit](ErrAPI#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrAPI**(`message?`, `error?`): [`ErrAPI`](ErrAPI) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | +| `error?` | `AxiosError`\<`unknown`, `any`\> | + +#### Returns + +[`ErrAPI`](ErrAPI) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/api.ts:119](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/api.ts#L119) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### raw + +• **raw**: `AxiosError`\<`unknown`, `any`\> + +#### Defined in + +[src/api/api.ts:117](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/api.ts#L117) + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrAccountAlreadyExists.md b/docs/sdk/reference/classes/ErrAccountAlreadyExists.md new file mode 100644 index 000000000..69fa12a2f --- /dev/null +++ b/docs/sdk/reference/classes/ErrAccountAlreadyExists.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrAccountAlreadyExists + +# Class: ErrAccountAlreadyExists + +## Hierarchy + +- `Error` + + ↳ **`ErrAccountAlreadyExists`** + +## Table of contents + +### Constructors + +- [constructor](ErrAccountAlreadyExists#constructor) + +### Methods + +- [captureStackTrace](ErrAccountAlreadyExists#capturestacktrace) + +### Properties + +- [cause](ErrAccountAlreadyExists#cause) +- [message](ErrAccountAlreadyExists#message) +- [name](ErrAccountAlreadyExists#name) +- [stack](ErrAccountAlreadyExists#stack) +- [prepareStackTrace](ErrAccountAlreadyExists#preparestacktrace) +- [stackTraceLimit](ErrAccountAlreadyExists#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrAccountAlreadyExists**(`message?`): [`ErrAccountAlreadyExists`](ErrAccountAlreadyExists) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrAccountAlreadyExists`](ErrAccountAlreadyExists) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L26) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrAccountNotFound.md b/docs/sdk/reference/classes/ErrAccountNotFound.md new file mode 100644 index 000000000..96c1b09d7 --- /dev/null +++ b/docs/sdk/reference/classes/ErrAccountNotFound.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrAccountNotFound + +# Class: ErrAccountNotFound + +## Hierarchy + +- `Error` + + ↳ **`ErrAccountNotFound`** + +## Table of contents + +### Constructors + +- [constructor](ErrAccountNotFound#constructor) + +### Methods + +- [captureStackTrace](ErrAccountNotFound#capturestacktrace) + +### Properties + +- [cause](ErrAccountNotFound#cause) +- [message](ErrAccountNotFound#message) +- [name](ErrAccountNotFound#name) +- [stack](ErrAccountNotFound#stack) +- [prepareStackTrace](ErrAccountNotFound#preparestacktrace) +- [stackTraceLimit](ErrAccountNotFound#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrAccountNotFound**(`message?`): [`ErrAccountNotFound`](ErrAccountNotFound) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrAccountNotFound`](ErrAccountNotFound) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L20) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrAddressMalformed.md b/docs/sdk/reference/classes/ErrAddressMalformed.md new file mode 100644 index 000000000..29438b348 --- /dev/null +++ b/docs/sdk/reference/classes/ErrAddressMalformed.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrAddressMalformed + +# Class: ErrAddressMalformed + +## Hierarchy + +- `Error` + + ↳ **`ErrAddressMalformed`** + +## Table of contents + +### Constructors + +- [constructor](ErrAddressMalformed#constructor) + +### Methods + +- [captureStackTrace](ErrAddressMalformed#capturestacktrace) + +### Properties + +- [cause](ErrAddressMalformed#cause) +- [message](ErrAddressMalformed#message) +- [name](ErrAddressMalformed#name) +- [stack](ErrAddressMalformed#stack) +- [prepareStackTrace](ErrAddressMalformed#preparestacktrace) +- [stackTraceLimit](ErrAddressMalformed#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrAddressMalformed**(`message?`): [`ErrAddressMalformed`](ErrAddressMalformed) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrAddressMalformed`](ErrAddressMalformed) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:2](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L2) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrBlockNotFound.md b/docs/sdk/reference/classes/ErrBlockNotFound.md new file mode 100644 index 000000000..d73f859cd --- /dev/null +++ b/docs/sdk/reference/classes/ErrBlockNotFound.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrBlockNotFound + +# Class: ErrBlockNotFound + +## Hierarchy + +- `Error` + + ↳ **`ErrBlockNotFound`** + +## Table of contents + +### Constructors + +- [constructor](ErrBlockNotFound#constructor) + +### Methods + +- [captureStackTrace](ErrBlockNotFound#capturestacktrace) + +### Properties + +- [cause](ErrBlockNotFound#cause) +- [message](ErrBlockNotFound#message) +- [name](ErrBlockNotFound#name) +- [stack](ErrBlockNotFound#stack) +- [prepareStackTrace](ErrBlockNotFound#preparestacktrace) +- [stackTraceLimit](ErrBlockNotFound#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrBlockNotFound**(`message?`): [`ErrBlockNotFound`](ErrBlockNotFound) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrBlockNotFound`](ErrBlockNotFound) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:44](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L44) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantABIEncodeResults.md b/docs/sdk/reference/classes/ErrCantABIEncodeResults.md new file mode 100644 index 000000000..c0ad138c4 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantABIEncodeResults.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantABIEncodeResults + +# Class: ErrCantABIEncodeResults + +## Hierarchy + +- `Error` + + ↳ **`ErrCantABIEncodeResults`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantABIEncodeResults#constructor) + +### Methods + +- [captureStackTrace](ErrCantABIEncodeResults#capturestacktrace) + +### Properties + +- [cause](ErrCantABIEncodeResults#cause) +- [message](ErrCantABIEncodeResults#message) +- [name](ErrCantABIEncodeResults#name) +- [stack](ErrCantABIEncodeResults#stack) +- [prepareStackTrace](ErrCantABIEncodeResults#preparestacktrace) +- [stackTraceLimit](ErrCantABIEncodeResults#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantABIEncodeResults**(`message?`): [`ErrCantABIEncodeResults`](ErrCantABIEncodeResults) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantABIEncodeResults`](ErrCantABIEncodeResults) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:416](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L416) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantAddKeyAndValueToTree.md b/docs/sdk/reference/classes/ErrCantAddKeyAndValueToTree.md new file mode 100644 index 000000000..634c373e8 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantAddKeyAndValueToTree.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantAddKeyAndValueToTree + +# Class: ErrCantAddKeyAndValueToTree + +## Hierarchy + +- `Error` + + ↳ **`ErrCantAddKeyAndValueToTree`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantAddKeyAndValueToTree#constructor) + +### Methods + +- [captureStackTrace](ErrCantAddKeyAndValueToTree#capturestacktrace) + +### Properties + +- [cause](ErrCantAddKeyAndValueToTree#cause) +- [message](ErrCantAddKeyAndValueToTree#message) +- [name](ErrCantAddKeyAndValueToTree#name) +- [stack](ErrCantAddKeyAndValueToTree#stack) +- [prepareStackTrace](ErrCantAddKeyAndValueToTree#preparestacktrace) +- [stackTraceLimit](ErrCantAddKeyAndValueToTree#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantAddKeyAndValueToTree**(`message?`): [`ErrCantAddKeyAndValueToTree`](ErrCantAddKeyAndValueToTree) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantAddKeyAndValueToTree`](ErrCantAddKeyAndValueToTree) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:428](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L428) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantAddKeyToTree.md b/docs/sdk/reference/classes/ErrCantAddKeyToTree.md new file mode 100644 index 000000000..54b0479cc --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantAddKeyToTree.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantAddKeyToTree + +# Class: ErrCantAddKeyToTree + +## Hierarchy + +- `Error` + + ↳ **`ErrCantAddKeyToTree`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantAddKeyToTree#constructor) + +### Methods + +- [captureStackTrace](ErrCantAddKeyToTree#capturestacktrace) + +### Properties + +- [cause](ErrCantAddKeyToTree#cause) +- [message](ErrCantAddKeyToTree#message) +- [name](ErrCantAddKeyToTree#name) +- [stack](ErrCantAddKeyToTree#stack) +- [prepareStackTrace](ErrCantAddKeyToTree#preparestacktrace) +- [stackTraceLimit](ErrCantAddKeyToTree#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantAddKeyToTree**(`message?`): [`ErrCantAddKeyToTree`](ErrCantAddKeyToTree) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantAddKeyToTree`](ErrCantAddKeyToTree) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:434](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L434) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantCheckTxType.md b/docs/sdk/reference/classes/ErrCantCheckTxType.md new file mode 100644 index 000000000..f148995bb --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantCheckTxType.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantCheckTxType + +# Class: ErrCantCheckTxType + +## Hierarchy + +- `Error` + + ↳ **`ErrCantCheckTxType`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantCheckTxType#constructor) + +### Methods + +- [captureStackTrace](ErrCantCheckTxType#capturestacktrace) + +### Properties + +- [cause](ErrCantCheckTxType#cause) +- [message](ErrCantCheckTxType#message) +- [name](ErrCantCheckTxType#name) +- [stack](ErrCantCheckTxType#stack) +- [prepareStackTrace](ErrCantCheckTxType#preparestacktrace) +- [stackTraceLimit](ErrCantCheckTxType#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantCheckTxType**(`message?`): [`ErrCantCheckTxType`](ErrCantCheckTxType) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantCheckTxType`](ErrCantCheckTxType) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:410](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L410) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantComputeKeyHash.md b/docs/sdk/reference/classes/ErrCantComputeKeyHash.md new file mode 100644 index 000000000..d04a8fd6d --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantComputeKeyHash.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantComputeKeyHash + +# Class: ErrCantComputeKeyHash + +## Hierarchy + +- `Error` + + ↳ **`ErrCantComputeKeyHash`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantComputeKeyHash#constructor) + +### Methods + +- [captureStackTrace](ErrCantComputeKeyHash#capturestacktrace) + +### Properties + +- [cause](ErrCantComputeKeyHash#cause) +- [message](ErrCantComputeKeyHash#message) +- [name](ErrCantComputeKeyHash#name) +- [stack](ErrCantComputeKeyHash#stack) +- [prepareStackTrace](ErrCantComputeKeyHash#preparestacktrace) +- [stackTraceLimit](ErrCantComputeKeyHash#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantComputeKeyHash**(`message?`): [`ErrCantComputeKeyHash`](ErrCantComputeKeyHash) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantComputeKeyHash`](ErrCantComputeKeyHash) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:422](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L422) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantCountVotes.md b/docs/sdk/reference/classes/ErrCantCountVotes.md new file mode 100644 index 000000000..d3bc45f44 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantCountVotes.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantCountVotes + +# Class: ErrCantCountVotes + +## Hierarchy + +- `Error` + + ↳ **`ErrCantCountVotes`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantCountVotes#constructor) + +### Methods + +- [captureStackTrace](ErrCantCountVotes#capturestacktrace) + +### Properties + +- [cause](ErrCantCountVotes#cause) +- [message](ErrCantCountVotes#message) +- [name](ErrCantCountVotes#name) +- [stack](ErrCantCountVotes#stack) +- [prepareStackTrace](ErrCantCountVotes#preparestacktrace) +- [stackTraceLimit](ErrCantCountVotes#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantCountVotes**(`message?`): [`ErrCantCountVotes`](ErrCantCountVotes) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantCountVotes`](ErrCantCountVotes) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:506](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L506) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantEstimateBlockHeight.md b/docs/sdk/reference/classes/ErrCantEstimateBlockHeight.md new file mode 100644 index 000000000..c5417e559 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantEstimateBlockHeight.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantEstimateBlockHeight + +# Class: ErrCantEstimateBlockHeight + +## Hierarchy + +- `Error` + + ↳ **`ErrCantEstimateBlockHeight`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantEstimateBlockHeight#constructor) + +### Methods + +- [captureStackTrace](ErrCantEstimateBlockHeight#capturestacktrace) + +### Properties + +- [cause](ErrCantEstimateBlockHeight#cause) +- [message](ErrCantEstimateBlockHeight#message) +- [name](ErrCantEstimateBlockHeight#name) +- [stack](ErrCantEstimateBlockHeight#stack) +- [prepareStackTrace](ErrCantEstimateBlockHeight#preparestacktrace) +- [stackTraceLimit](ErrCantEstimateBlockHeight#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantEstimateBlockHeight**(`message?`): [`ErrCantEstimateBlockHeight`](ErrCantEstimateBlockHeight) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantEstimateBlockHeight`](ErrCantEstimateBlockHeight) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:446](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L446) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantExtractMetadataURI.md b/docs/sdk/reference/classes/ErrCantExtractMetadataURI.md new file mode 100644 index 000000000..344b59518 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantExtractMetadataURI.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantExtractMetadataURI + +# Class: ErrCantExtractMetadataURI + +## Hierarchy + +- `Error` + + ↳ **`ErrCantExtractMetadataURI`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantExtractMetadataURI#constructor) + +### Methods + +- [captureStackTrace](ErrCantExtractMetadataURI#capturestacktrace) + +### Properties + +- [cause](ErrCantExtractMetadataURI#cause) +- [message](ErrCantExtractMetadataURI#message) +- [name](ErrCantExtractMetadataURI#name) +- [stack](ErrCantExtractMetadataURI#stack) +- [prepareStackTrace](ErrCantExtractMetadataURI#preparestacktrace) +- [stackTraceLimit](ErrCantExtractMetadataURI#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantExtractMetadataURI**(`message?`): [`ErrCantExtractMetadataURI`](ErrCantExtractMetadataURI) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantExtractMetadataURI`](ErrCantExtractMetadataURI) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L128) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantFetchElection.md b/docs/sdk/reference/classes/ErrCantFetchElection.md new file mode 100644 index 000000000..1c505291c --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantFetchElection.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantFetchElection + +# Class: ErrCantFetchElection + +## Hierarchy + +- `Error` + + ↳ **`ErrCantFetchElection`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantFetchElection#constructor) + +### Methods + +- [captureStackTrace](ErrCantFetchElection#capturestacktrace) + +### Properties + +- [cause](ErrCantFetchElection#cause) +- [message](ErrCantFetchElection#message) +- [name](ErrCantFetchElection#name) +- [stack](ErrCantFetchElection#stack) +- [prepareStackTrace](ErrCantFetchElection#preparestacktrace) +- [stackTraceLimit](ErrCantFetchElection#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantFetchElection**(`message?`): [`ErrCantFetchElection`](ErrCantFetchElection) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantFetchElection`](ErrCantFetchElection) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:386](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L386) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantFetchEnvelope.md b/docs/sdk/reference/classes/ErrCantFetchEnvelope.md new file mode 100644 index 000000000..d79473957 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantFetchEnvelope.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantFetchEnvelope + +# Class: ErrCantFetchEnvelope + +## Hierarchy + +- `Error` + + ↳ **`ErrCantFetchEnvelope`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantFetchEnvelope#constructor) + +### Methods + +- [captureStackTrace](ErrCantFetchEnvelope#capturestacktrace) + +### Properties + +- [cause](ErrCantFetchEnvelope#cause) +- [message](ErrCantFetchEnvelope#message) +- [name](ErrCantFetchEnvelope#name) +- [stack](ErrCantFetchEnvelope#stack) +- [prepareStackTrace](ErrCantFetchEnvelope#preparestacktrace) +- [stackTraceLimit](ErrCantFetchEnvelope#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantFetchEnvelope**(`message?`): [`ErrCantFetchEnvelope`](ErrCantFetchEnvelope) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantFetchEnvelope`](ErrCantFetchEnvelope) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:404](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L404) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantFetchEnvelopeHeight.md b/docs/sdk/reference/classes/ErrCantFetchEnvelopeHeight.md new file mode 100644 index 000000000..dfd29552b --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantFetchEnvelopeHeight.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantFetchEnvelopeHeight + +# Class: ErrCantFetchEnvelopeHeight + +## Hierarchy + +- `Error` + + ↳ **`ErrCantFetchEnvelopeHeight`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantFetchEnvelopeHeight#constructor) + +### Methods + +- [captureStackTrace](ErrCantFetchEnvelopeHeight#capturestacktrace) + +### Properties + +- [cause](ErrCantFetchEnvelopeHeight#cause) +- [message](ErrCantFetchEnvelopeHeight#message) +- [name](ErrCantFetchEnvelopeHeight#name) +- [stack](ErrCantFetchEnvelopeHeight#stack) +- [prepareStackTrace](ErrCantFetchEnvelopeHeight#preparestacktrace) +- [stackTraceLimit](ErrCantFetchEnvelopeHeight#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantFetchEnvelopeHeight**(`message?`): [`ErrCantFetchEnvelopeHeight`](ErrCantFetchEnvelopeHeight) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantFetchEnvelopeHeight`](ErrCantFetchEnvelopeHeight) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:398](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L398) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantFetchTokenFees.md b/docs/sdk/reference/classes/ErrCantFetchTokenFees.md new file mode 100644 index 000000000..961968a58 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantFetchTokenFees.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantFetchTokenFees + +# Class: ErrCantFetchTokenFees + +## Hierarchy + +- `Error` + + ↳ **`ErrCantFetchTokenFees`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantFetchTokenFees#constructor) + +### Methods + +- [captureStackTrace](ErrCantFetchTokenFees#capturestacktrace) + +### Properties + +- [cause](ErrCantFetchTokenFees#cause) +- [message](ErrCantFetchTokenFees#message) +- [name](ErrCantFetchTokenFees#name) +- [stack](ErrCantFetchTokenFees#stack) +- [prepareStackTrace](ErrCantFetchTokenFees#preparestacktrace) +- [stackTraceLimit](ErrCantFetchTokenFees#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantFetchTokenFees**(`message?`): [`ErrCantFetchTokenFees`](ErrCantFetchTokenFees) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantFetchTokenFees`](ErrCantFetchTokenFees) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:536](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L536) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantFetchTokenTransfers.md b/docs/sdk/reference/classes/ErrCantFetchTokenTransfers.md new file mode 100644 index 000000000..1cb2a802d --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantFetchTokenTransfers.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantFetchTokenTransfers + +# Class: ErrCantFetchTokenTransfers + +## Hierarchy + +- `Error` + + ↳ **`ErrCantFetchTokenTransfers`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantFetchTokenTransfers#constructor) + +### Methods + +- [captureStackTrace](ErrCantFetchTokenTransfers#capturestacktrace) + +### Properties + +- [cause](ErrCantFetchTokenTransfers#cause) +- [message](ErrCantFetchTokenTransfers#message) +- [name](ErrCantFetchTokenTransfers#name) +- [stack](ErrCantFetchTokenTransfers#stack) +- [prepareStackTrace](ErrCantFetchTokenTransfers#preparestacktrace) +- [stackTraceLimit](ErrCantFetchTokenTransfers#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantFetchTokenTransfers**(`message?`): [`ErrCantFetchTokenTransfers`](ErrCantFetchTokenTransfers) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantFetchTokenTransfers`](ErrCantFetchTokenTransfers) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:392](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L392) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantGenerateFaucetPkg.md b/docs/sdk/reference/classes/ErrCantGenerateFaucetPkg.md new file mode 100644 index 000000000..de94f52b8 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantGenerateFaucetPkg.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantGenerateFaucetPkg + +# Class: ErrCantGenerateFaucetPkg + +## Hierarchy + +- `Error` + + ↳ **`ErrCantGenerateFaucetPkg`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantGenerateFaucetPkg#constructor) + +### Methods + +- [captureStackTrace](ErrCantGenerateFaucetPkg#capturestacktrace) + +### Properties + +- [cause](ErrCantGenerateFaucetPkg#cause) +- [message](ErrCantGenerateFaucetPkg#message) +- [name](ErrCantGenerateFaucetPkg#name) +- [stack](ErrCantGenerateFaucetPkg#stack) +- [prepareStackTrace](ErrCantGenerateFaucetPkg#preparestacktrace) +- [stackTraceLimit](ErrCantGenerateFaucetPkg#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantGenerateFaucetPkg**(`message?`): [`ErrCantGenerateFaucetPkg`](ErrCantGenerateFaucetPkg) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantGenerateFaucetPkg`](ErrCantGenerateFaucetPkg) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:440](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L440) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantGetCircomSiblings.md b/docs/sdk/reference/classes/ErrCantGetCircomSiblings.md new file mode 100644 index 000000000..a16739022 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantGetCircomSiblings.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantGetCircomSiblings + +# Class: ErrCantGetCircomSiblings + +## Hierarchy + +- `Error` + + ↳ **`ErrCantGetCircomSiblings`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantGetCircomSiblings#constructor) + +### Methods + +- [captureStackTrace](ErrCantGetCircomSiblings#capturestacktrace) + +### Properties + +- [cause](ErrCantGetCircomSiblings#cause) +- [message](ErrCantGetCircomSiblings#message) +- [name](ErrCantGetCircomSiblings#name) +- [stack](ErrCantGetCircomSiblings#stack) +- [prepareStackTrace](ErrCantGetCircomSiblings#preparestacktrace) +- [stackTraceLimit](ErrCantGetCircomSiblings#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantGetCircomSiblings**(`message?`): [`ErrCantGetCircomSiblings`](ErrCantGetCircomSiblings) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantGetCircomSiblings`](ErrCantGetCircomSiblings) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:494](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L494) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantMarshalMetadata.md b/docs/sdk/reference/classes/ErrCantMarshalMetadata.md new file mode 100644 index 000000000..565173253 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantMarshalMetadata.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantMarshalMetadata + +# Class: ErrCantMarshalMetadata + +## Hierarchy + +- `Error` + + ↳ **`ErrCantMarshalMetadata`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantMarshalMetadata#constructor) + +### Methods + +- [captureStackTrace](ErrCantMarshalMetadata#capturestacktrace) + +### Properties + +- [cause](ErrCantMarshalMetadata#cause) +- [message](ErrCantMarshalMetadata#message) +- [name](ErrCantMarshalMetadata#name) +- [stack](ErrCantMarshalMetadata#stack) +- [prepareStackTrace](ErrCantMarshalMetadata#preparestacktrace) +- [stackTraceLimit](ErrCantMarshalMetadata#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantMarshalMetadata**(`message?`): [`ErrCantMarshalMetadata`](ErrCantMarshalMetadata) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantMarshalMetadata`](ErrCantMarshalMetadata) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:452](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L452) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantParseAccountID.md b/docs/sdk/reference/classes/ErrCantParseAccountID.md new file mode 100644 index 000000000..5169c6c22 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantParseAccountID.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantParseAccountID + +# Class: ErrCantParseAccountID + +## Hierarchy + +- `Error` + + ↳ **`ErrCantParseAccountID`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantParseAccountID#constructor) + +### Methods + +- [captureStackTrace](ErrCantParseAccountID#capturestacktrace) + +### Properties + +- [cause](ErrCantParseAccountID#cause) +- [message](ErrCantParseAccountID#message) +- [name](ErrCantParseAccountID#name) +- [stack](ErrCantParseAccountID#stack) +- [prepareStackTrace](ErrCantParseAccountID#preparestacktrace) +- [stackTraceLimit](ErrCantParseAccountID#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantParseAccountID**(`message?`): [`ErrCantParseAccountID`](ErrCantParseAccountID) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantParseAccountID`](ErrCantParseAccountID) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:80](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L80) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantParseBearerToken.md b/docs/sdk/reference/classes/ErrCantParseBearerToken.md new file mode 100644 index 000000000..195a18367 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantParseBearerToken.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantParseBearerToken + +# Class: ErrCantParseBearerToken + +## Hierarchy + +- `Error` + + ↳ **`ErrCantParseBearerToken`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantParseBearerToken#constructor) + +### Methods + +- [captureStackTrace](ErrCantParseBearerToken#capturestacktrace) + +### Properties + +- [cause](ErrCantParseBearerToken#cause) +- [message](ErrCantParseBearerToken#message) +- [name](ErrCantParseBearerToken#name) +- [stack](ErrCantParseBearerToken#stack) +- [prepareStackTrace](ErrCantParseBearerToken#preparestacktrace) +- [stackTraceLimit](ErrCantParseBearerToken#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantParseBearerToken**(`message?`): [`ErrCantParseBearerToken`](ErrCantParseBearerToken) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantParseBearerToken`](ErrCantParseBearerToken) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:86](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L86) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantParseBoolean.md b/docs/sdk/reference/classes/ErrCantParseBoolean.md new file mode 100644 index 000000000..3ea5e6da5 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantParseBoolean.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantParseBoolean + +# Class: ErrCantParseBoolean + +## Hierarchy + +- `Error` + + ↳ **`ErrCantParseBoolean`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantParseBoolean#constructor) + +### Methods + +- [captureStackTrace](ErrCantParseBoolean#capturestacktrace) + +### Properties + +- [cause](ErrCantParseBoolean#cause) +- [message](ErrCantParseBoolean#message) +- [name](ErrCantParseBoolean#name) +- [stack](ErrCantParseBoolean#stack) +- [prepareStackTrace](ErrCantParseBoolean#preparestacktrace) +- [stackTraceLimit](ErrCantParseBoolean#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantParseBoolean**(`message?`): [`ErrCantParseBoolean`](ErrCantParseBoolean) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantParseBoolean`](ErrCantParseBoolean) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:326](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L326) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantParseDataAsJSON.md b/docs/sdk/reference/classes/ErrCantParseDataAsJSON.md new file mode 100644 index 000000000..a0d28ff19 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantParseDataAsJSON.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantParseDataAsJSON + +# Class: ErrCantParseDataAsJSON + +## Hierarchy + +- `Error` + + ↳ **`ErrCantParseDataAsJSON`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantParseDataAsJSON#constructor) + +### Methods + +- [captureStackTrace](ErrCantParseDataAsJSON#capturestacktrace) + +### Properties + +- [cause](ErrCantParseDataAsJSON#cause) +- [message](ErrCantParseDataAsJSON#message) +- [name](ErrCantParseDataAsJSON#name) +- [stack](ErrCantParseDataAsJSON#stack) +- [prepareStackTrace](ErrCantParseDataAsJSON#preparestacktrace) +- [stackTraceLimit](ErrCantParseDataAsJSON#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantParseDataAsJSON**(`message?`): [`ErrCantParseDataAsJSON`](ErrCantParseDataAsJSON) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantParseDataAsJSON`](ErrCantParseDataAsJSON) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L92) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantParseElectionID.md b/docs/sdk/reference/classes/ErrCantParseElectionID.md new file mode 100644 index 000000000..e4262acc3 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantParseElectionID.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantParseElectionID + +# Class: ErrCantParseElectionID + +## Hierarchy + +- `Error` + + ↳ **`ErrCantParseElectionID`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantParseElectionID#constructor) + +### Methods + +- [captureStackTrace](ErrCantParseElectionID#capturestacktrace) + +### Properties + +- [cause](ErrCantParseElectionID#cause) +- [message](ErrCantParseElectionID#message) +- [name](ErrCantParseElectionID#name) +- [stack](ErrCantParseElectionID#stack) +- [prepareStackTrace](ErrCantParseElectionID#preparestacktrace) +- [stackTraceLimit](ErrCantParseElectionID#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantParseElectionID**(`message?`): [`ErrCantParseElectionID`](ErrCantParseElectionID) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantParseElectionID`](ErrCantParseElectionID) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:98](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L98) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantParseHexString.md b/docs/sdk/reference/classes/ErrCantParseHexString.md new file mode 100644 index 000000000..2a09dec52 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantParseHexString.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantParseHexString + +# Class: ErrCantParseHexString + +## Hierarchy + +- `Error` + + ↳ **`ErrCantParseHexString`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantParseHexString#constructor) + +### Methods + +- [captureStackTrace](ErrCantParseHexString#capturestacktrace) + +### Properties + +- [cause](ErrCantParseHexString#cause) +- [message](ErrCantParseHexString#message) +- [name](ErrCantParseHexString#name) +- [stack](ErrCantParseHexString#stack) +- [prepareStackTrace](ErrCantParseHexString#preparestacktrace) +- [stackTraceLimit](ErrCantParseHexString#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantParseHexString**(`message?`): [`ErrCantParseHexString`](ErrCantParseHexString) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantParseHexString`](ErrCantParseHexString) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:332](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L332) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantParseMetadataAsJSON.md b/docs/sdk/reference/classes/ErrCantParseMetadataAsJSON.md new file mode 100644 index 000000000..4dc635429 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantParseMetadataAsJSON.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantParseMetadataAsJSON + +# Class: ErrCantParseMetadataAsJSON + +## Hierarchy + +- `Error` + + ↳ **`ErrCantParseMetadataAsJSON`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantParseMetadataAsJSON#constructor) + +### Methods + +- [captureStackTrace](ErrCantParseMetadataAsJSON#capturestacktrace) + +### Properties + +- [cause](ErrCantParseMetadataAsJSON#cause) +- [message](ErrCantParseMetadataAsJSON#message) +- [name](ErrCantParseMetadataAsJSON#name) +- [stack](ErrCantParseMetadataAsJSON#stack) +- [prepareStackTrace](ErrCantParseMetadataAsJSON#preparestacktrace) +- [stackTraceLimit](ErrCantParseMetadataAsJSON#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantParseMetadataAsJSON**(`message?`): [`ErrCantParseMetadataAsJSON`](ErrCantParseMetadataAsJSON) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantParseMetadataAsJSON`](ErrCantParseMetadataAsJSON) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L104) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantParseNumber.md b/docs/sdk/reference/classes/ErrCantParseNumber.md new file mode 100644 index 000000000..229591fa3 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantParseNumber.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantParseNumber + +# Class: ErrCantParseNumber + +## Hierarchy + +- `Error` + + ↳ **`ErrCantParseNumber`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantParseNumber#constructor) + +### Methods + +- [captureStackTrace](ErrCantParseNumber#capturestacktrace) + +### Properties + +- [cause](ErrCantParseNumber#cause) +- [message](ErrCantParseNumber#message) +- [name](ErrCantParseNumber#name) +- [stack](ErrCantParseNumber#stack) +- [prepareStackTrace](ErrCantParseNumber#preparestacktrace) +- [stackTraceLimit](ErrCantParseNumber#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantParseNumber**(`message?`): [`ErrCantParseNumber`](ErrCantParseNumber) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantParseNumber`](ErrCantParseNumber) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L110) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantParseOrgID.md b/docs/sdk/reference/classes/ErrCantParseOrgID.md new file mode 100644 index 000000000..d94c22984 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantParseOrgID.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantParseOrgID + +# Class: ErrCantParseOrgID + +## Hierarchy + +- `Error` + + ↳ **`ErrCantParseOrgID`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantParseOrgID#constructor) + +### Methods + +- [captureStackTrace](ErrCantParseOrgID#capturestacktrace) + +### Properties + +- [cause](ErrCantParseOrgID#cause) +- [message](ErrCantParseOrgID#message) +- [name](ErrCantParseOrgID#name) +- [stack](ErrCantParseOrgID#stack) +- [prepareStackTrace](ErrCantParseOrgID#preparestacktrace) +- [stackTraceLimit](ErrCantParseOrgID#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantParseOrgID**(`message?`): [`ErrCantParseOrgID`](ErrCantParseOrgID) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantParseOrgID`](ErrCantParseOrgID) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:74](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L74) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantParsePayloadAsJSON.md b/docs/sdk/reference/classes/ErrCantParsePayloadAsJSON.md new file mode 100644 index 000000000..b901315f0 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantParsePayloadAsJSON.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantParsePayloadAsJSON + +# Class: ErrCantParsePayloadAsJSON + +## Hierarchy + +- `Error` + + ↳ **`ErrCantParsePayloadAsJSON`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantParsePayloadAsJSON#constructor) + +### Methods + +- [captureStackTrace](ErrCantParsePayloadAsJSON#capturestacktrace) + +### Properties + +- [cause](ErrCantParsePayloadAsJSON#cause) +- [message](ErrCantParsePayloadAsJSON#message) +- [name](ErrCantParsePayloadAsJSON#name) +- [stack](ErrCantParsePayloadAsJSON#stack) +- [prepareStackTrace](ErrCantParsePayloadAsJSON#preparestacktrace) +- [stackTraceLimit](ErrCantParsePayloadAsJSON#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantParsePayloadAsJSON**(`message?`): [`ErrCantParsePayloadAsJSON`](ErrCantParsePayloadAsJSON) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantParsePayloadAsJSON`](ErrCantParsePayloadAsJSON) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:116](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L116) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantParseVoteID.md b/docs/sdk/reference/classes/ErrCantParseVoteID.md new file mode 100644 index 000000000..a962ecec1 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantParseVoteID.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantParseVoteID + +# Class: ErrCantParseVoteID + +## Hierarchy + +- `Error` + + ↳ **`ErrCantParseVoteID`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantParseVoteID#constructor) + +### Methods + +- [captureStackTrace](ErrCantParseVoteID#capturestacktrace) + +### Properties + +- [cause](ErrCantParseVoteID#cause) +- [message](ErrCantParseVoteID#message) +- [name](ErrCantParseVoteID#name) +- [stack](ErrCantParseVoteID#stack) +- [prepareStackTrace](ErrCantParseVoteID#preparestacktrace) +- [stackTraceLimit](ErrCantParseVoteID#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantParseVoteID**(`message?`): [`ErrCantParseVoteID`](ErrCantParseVoteID) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantParseVoteID`](ErrCantParseVoteID) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:122](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L122) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCantPublishMetadata.md b/docs/sdk/reference/classes/ErrCantPublishMetadata.md new file mode 100644 index 000000000..832d1c0a8 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCantPublishMetadata.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCantPublishMetadata + +# Class: ErrCantPublishMetadata + +## Hierarchy + +- `Error` + + ↳ **`ErrCantPublishMetadata`** + +## Table of contents + +### Constructors + +- [constructor](ErrCantPublishMetadata#constructor) + +### Methods + +- [captureStackTrace](ErrCantPublishMetadata#capturestacktrace) + +### Properties + +- [cause](ErrCantPublishMetadata#cause) +- [message](ErrCantPublishMetadata#message) +- [name](ErrCantPublishMetadata#name) +- [stack](ErrCantPublishMetadata#stack) +- [prepareStackTrace](ErrCantPublishMetadata#preparestacktrace) +- [stackTraceLimit](ErrCantPublishMetadata#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCantPublishMetadata**(`message?`): [`ErrCantPublishMetadata`](ErrCantPublishMetadata) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCantPublishMetadata`](ErrCantPublishMetadata) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:458](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L458) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCensusBuild.md b/docs/sdk/reference/classes/ErrCensusBuild.md new file mode 100644 index 000000000..b5ab98e76 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCensusBuild.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCensusBuild + +# Class: ErrCensusBuild + +## Hierarchy + +- `Error` + + ↳ **`ErrCensusBuild`** + +## Table of contents + +### Constructors + +- [constructor](ErrCensusBuild#constructor) + +### Methods + +- [captureStackTrace](ErrCensusBuild#capturestacktrace) + +### Properties + +- [cause](ErrCensusBuild#cause) +- [message](ErrCensusBuild#message) +- [name](ErrCensusBuild#name) +- [stack](ErrCensusBuild#stack) +- [prepareStackTrace](ErrCensusBuild#preparestacktrace) +- [stackTraceLimit](ErrCensusBuild#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCensusBuild**(`message?`): [`ErrCensusBuild`](ErrCensusBuild) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCensusBuild`](ErrCensusBuild) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:524](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L524) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCensusIDLengthInvalid.md b/docs/sdk/reference/classes/ErrCensusIDLengthInvalid.md new file mode 100644 index 000000000..baa434c12 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCensusIDLengthInvalid.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCensusIDLengthInvalid + +# Class: ErrCensusIDLengthInvalid + +## Hierarchy + +- `Error` + + ↳ **`ErrCensusIDLengthInvalid`** + +## Table of contents + +### Constructors + +- [constructor](ErrCensusIDLengthInvalid#constructor) + +### Methods + +- [captureStackTrace](ErrCensusIDLengthInvalid#capturestacktrace) + +### Properties + +- [cause](ErrCensusIDLengthInvalid#cause) +- [message](ErrCensusIDLengthInvalid#message) +- [name](ErrCensusIDLengthInvalid#name) +- [stack](ErrCensusIDLengthInvalid#stack) +- [prepareStackTrace](ErrCensusIDLengthInvalid#preparestacktrace) +- [stackTraceLimit](ErrCensusIDLengthInvalid#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCensusIDLengthInvalid**(`message?`): [`ErrCensusIDLengthInvalid`](ErrCensusIDLengthInvalid) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCensusIDLengthInvalid`](ErrCensusIDLengthInvalid) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:146](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L146) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCensusIndexedFlagMismatch.md b/docs/sdk/reference/classes/ErrCensusIndexedFlagMismatch.md new file mode 100644 index 000000000..d5fd0c094 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCensusIndexedFlagMismatch.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCensusIndexedFlagMismatch + +# Class: ErrCensusIndexedFlagMismatch + +## Hierarchy + +- `Error` + + ↳ **`ErrCensusIndexedFlagMismatch`** + +## Table of contents + +### Constructors + +- [constructor](ErrCensusIndexedFlagMismatch#constructor) + +### Methods + +- [captureStackTrace](ErrCensusIndexedFlagMismatch#capturestacktrace) + +### Properties + +- [cause](ErrCensusIndexedFlagMismatch#cause) +- [message](ErrCensusIndexedFlagMismatch#message) +- [name](ErrCensusIndexedFlagMismatch#name) +- [stack](ErrCensusIndexedFlagMismatch#stack) +- [prepareStackTrace](ErrCensusIndexedFlagMismatch#preparestacktrace) +- [stackTraceLimit](ErrCensusIndexedFlagMismatch#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCensusIndexedFlagMismatch**(`message?`): [`ErrCensusIndexedFlagMismatch`](ErrCensusIndexedFlagMismatch) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCensusIndexedFlagMismatch`](ErrCensusIndexedFlagMismatch) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:170](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L170) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCensusNotFound.md b/docs/sdk/reference/classes/ErrCensusNotFound.md new file mode 100644 index 000000000..b5f55555f --- /dev/null +++ b/docs/sdk/reference/classes/ErrCensusNotFound.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCensusNotFound + +# Class: ErrCensusNotFound + +## Hierarchy + +- `Error` + + ↳ **`ErrCensusNotFound`** + +## Table of contents + +### Constructors + +- [constructor](ErrCensusNotFound#constructor) + +### Methods + +- [captureStackTrace](ErrCensusNotFound#capturestacktrace) + +### Properties + +- [cause](ErrCensusNotFound#cause) +- [message](ErrCensusNotFound#message) +- [name](ErrCensusNotFound#name) +- [stack](ErrCensusNotFound#stack) +- [prepareStackTrace](ErrCensusNotFound#preparestacktrace) +- [stackTraceLimit](ErrCensusNotFound#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCensusNotFound**(`message?`): [`ErrCensusNotFound`](ErrCensusNotFound) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCensusNotFound`](ErrCensusNotFound) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:272](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L272) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCensusProofVerificationFailed.md b/docs/sdk/reference/classes/ErrCensusProofVerificationFailed.md new file mode 100644 index 000000000..bf144a084 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCensusProofVerificationFailed.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCensusProofVerificationFailed + +# Class: ErrCensusProofVerificationFailed + +## Hierarchy + +- `Error` + + ↳ **`ErrCensusProofVerificationFailed`** + +## Table of contents + +### Constructors + +- [constructor](ErrCensusProofVerificationFailed#constructor) + +### Methods + +- [captureStackTrace](ErrCensusProofVerificationFailed#capturestacktrace) + +### Properties + +- [cause](ErrCensusProofVerificationFailed#cause) +- [message](ErrCensusProofVerificationFailed#message) +- [name](ErrCensusProofVerificationFailed#name) +- [stack](ErrCensusProofVerificationFailed#stack) +- [prepareStackTrace](ErrCensusProofVerificationFailed#preparestacktrace) +- [stackTraceLimit](ErrCensusProofVerificationFailed#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCensusProofVerificationFailed**(`message?`): [`ErrCensusProofVerificationFailed`](ErrCensusProofVerificationFailed) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCensusProofVerificationFailed`](ErrCensusProofVerificationFailed) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:500](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L500) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCensusRootHashMismatch.md b/docs/sdk/reference/classes/ErrCensusRootHashMismatch.md new file mode 100644 index 000000000..687146759 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCensusRootHashMismatch.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCensusRootHashMismatch + +# Class: ErrCensusRootHashMismatch + +## Hierarchy + +- `Error` + + ↳ **`ErrCensusRootHashMismatch`** + +## Table of contents + +### Constructors + +- [constructor](ErrCensusRootHashMismatch#constructor) + +### Methods + +- [captureStackTrace](ErrCensusRootHashMismatch#capturestacktrace) + +### Properties + +- [cause](ErrCensusRootHashMismatch#cause) +- [message](ErrCensusRootHashMismatch#message) +- [name](ErrCensusRootHashMismatch#name) +- [stack](ErrCensusRootHashMismatch#stack) +- [prepareStackTrace](ErrCensusRootHashMismatch#preparestacktrace) +- [stackTraceLimit](ErrCensusRootHashMismatch#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCensusRootHashMismatch**(`message?`): [`ErrCensusRootHashMismatch`](ErrCensusRootHashMismatch) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCensusRootHashMismatch`](ErrCensusRootHashMismatch) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:176](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L176) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCensusRootIsNil.md b/docs/sdk/reference/classes/ErrCensusRootIsNil.md new file mode 100644 index 000000000..04ea65561 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCensusRootIsNil.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCensusRootIsNil + +# Class: ErrCensusRootIsNil + +## Hierarchy + +- `Error` + + ↳ **`ErrCensusRootIsNil`** + +## Table of contents + +### Constructors + +- [constructor](ErrCensusRootIsNil#constructor) + +### Methods + +- [captureStackTrace](ErrCensusRootIsNil#capturestacktrace) + +### Properties + +- [cause](ErrCensusRootIsNil#cause) +- [message](ErrCensusRootIsNil#message) +- [name](ErrCensusRootIsNil#name) +- [stack](ErrCensusRootIsNil#stack) +- [prepareStackTrace](ErrCensusRootIsNil#preparestacktrace) +- [stackTraceLimit](ErrCensusRootIsNil#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCensusRootIsNil**(`message?`): [`ErrCensusRootIsNil`](ErrCensusRootIsNil) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCensusRootIsNil`](ErrCensusRootIsNil) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:152](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L152) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCensusTypeMismatch.md b/docs/sdk/reference/classes/ErrCensusTypeMismatch.md new file mode 100644 index 000000000..db855804f --- /dev/null +++ b/docs/sdk/reference/classes/ErrCensusTypeMismatch.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCensusTypeMismatch + +# Class: ErrCensusTypeMismatch + +## Hierarchy + +- `Error` + + ↳ **`ErrCensusTypeMismatch`** + +## Table of contents + +### Constructors + +- [constructor](ErrCensusTypeMismatch#constructor) + +### Methods + +- [captureStackTrace](ErrCensusTypeMismatch#capturestacktrace) + +### Properties + +- [cause](ErrCensusTypeMismatch#cause) +- [message](ErrCensusTypeMismatch#message) +- [name](ErrCensusTypeMismatch#name) +- [stack](ErrCensusTypeMismatch#stack) +- [prepareStackTrace](ErrCensusTypeMismatch#preparestacktrace) +- [stackTraceLimit](ErrCensusTypeMismatch#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCensusTypeMismatch**(`message?`): [`ErrCensusTypeMismatch`](ErrCensusTypeMismatch) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCensusTypeMismatch`](ErrCensusTypeMismatch) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:164](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L164) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrCensusTypeUnknown.md b/docs/sdk/reference/classes/ErrCensusTypeUnknown.md new file mode 100644 index 000000000..25174d2b6 --- /dev/null +++ b/docs/sdk/reference/classes/ErrCensusTypeUnknown.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrCensusTypeUnknown + +# Class: ErrCensusTypeUnknown + +## Hierarchy + +- `Error` + + ↳ **`ErrCensusTypeUnknown`** + +## Table of contents + +### Constructors + +- [constructor](ErrCensusTypeUnknown#constructor) + +### Methods + +- [captureStackTrace](ErrCensusTypeUnknown#capturestacktrace) + +### Properties + +- [cause](ErrCensusTypeUnknown#cause) +- [message](ErrCensusTypeUnknown#message) +- [name](ErrCensusTypeUnknown#name) +- [stack](ErrCensusTypeUnknown#stack) +- [prepareStackTrace](ErrCensusTypeUnknown#preparestacktrace) +- [stackTraceLimit](ErrCensusTypeUnknown#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrCensusTypeUnknown**(`message?`): [`ErrCensusTypeUnknown`](ErrCensusTypeUnknown) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrCensusTypeUnknown`](ErrCensusTypeUnknown) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:158](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L158) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrDstAccountUnknown.md b/docs/sdk/reference/classes/ErrDstAccountUnknown.md new file mode 100644 index 000000000..8b78aa6de --- /dev/null +++ b/docs/sdk/reference/classes/ErrDstAccountUnknown.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrDstAccountUnknown + +# Class: ErrDstAccountUnknown + +## Hierarchy + +- `Error` + + ↳ **`ErrDstAccountUnknown`** + +## Table of contents + +### Constructors + +- [constructor](ErrDstAccountUnknown#constructor) + +### Methods + +- [captureStackTrace](ErrDstAccountUnknown#capturestacktrace) + +### Properties + +- [cause](ErrDstAccountUnknown#cause) +- [message](ErrDstAccountUnknown#message) +- [name](ErrDstAccountUnknown#name) +- [stack](ErrDstAccountUnknown#stack) +- [prepareStackTrace](ErrDstAccountUnknown#preparestacktrace) +- [stackTraceLimit](ErrDstAccountUnknown#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrDstAccountUnknown**(`message?`): [`ErrDstAccountUnknown`](ErrDstAccountUnknown) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrDstAccountUnknown`](ErrDstAccountUnknown) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L14) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrDstAddressMalformed.md b/docs/sdk/reference/classes/ErrDstAddressMalformed.md new file mode 100644 index 000000000..dc60fa836 --- /dev/null +++ b/docs/sdk/reference/classes/ErrDstAddressMalformed.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrDstAddressMalformed + +# Class: ErrDstAddressMalformed + +## Hierarchy + +- `Error` + + ↳ **`ErrDstAddressMalformed`** + +## Table of contents + +### Constructors + +- [constructor](ErrDstAddressMalformed#constructor) + +### Methods + +- [captureStackTrace](ErrDstAddressMalformed#capturestacktrace) + +### Properties + +- [cause](ErrDstAddressMalformed#cause) +- [message](ErrDstAddressMalformed#message) +- [name](ErrDstAddressMalformed#name) +- [stack](ErrDstAddressMalformed#stack) +- [prepareStackTrace](ErrDstAddressMalformed#preparestacktrace) +- [stackTraceLimit](ErrDstAddressMalformed#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrDstAddressMalformed**(`message?`): [`ErrDstAddressMalformed`](ErrDstAddressMalformed) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrDstAddressMalformed`](ErrDstAddressMalformed) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L8) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrElectionEndDateBeforeStart.md b/docs/sdk/reference/classes/ErrElectionEndDateBeforeStart.md new file mode 100644 index 000000000..a605e4185 --- /dev/null +++ b/docs/sdk/reference/classes/ErrElectionEndDateBeforeStart.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrElectionEndDateBeforeStart + +# Class: ErrElectionEndDateBeforeStart + +## Hierarchy + +- `Error` + + ↳ **`ErrElectionEndDateBeforeStart`** + +## Table of contents + +### Constructors + +- [constructor](ErrElectionEndDateBeforeStart#constructor) + +### Methods + +- [captureStackTrace](ErrElectionEndDateBeforeStart#capturestacktrace) + +### Properties + +- [cause](ErrElectionEndDateBeforeStart#cause) +- [message](ErrElectionEndDateBeforeStart#message) +- [name](ErrElectionEndDateBeforeStart#name) +- [stack](ErrElectionEndDateBeforeStart#stack) +- [prepareStackTrace](ErrElectionEndDateBeforeStart#preparestacktrace) +- [stackTraceLimit](ErrElectionEndDateBeforeStart#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrElectionEndDateBeforeStart**(`message?`): [`ErrElectionEndDateBeforeStart`](ErrElectionEndDateBeforeStart) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrElectionEndDateBeforeStart`](ErrElectionEndDateBeforeStart) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:260](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L260) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrElectionEndDateInThePast.md b/docs/sdk/reference/classes/ErrElectionEndDateInThePast.md new file mode 100644 index 000000000..e9f67d045 --- /dev/null +++ b/docs/sdk/reference/classes/ErrElectionEndDateInThePast.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrElectionEndDateInThePast + +# Class: ErrElectionEndDateInThePast + +## Hierarchy + +- `Error` + + ↳ **`ErrElectionEndDateInThePast`** + +## Table of contents + +### Constructors + +- [constructor](ErrElectionEndDateInThePast#constructor) + +### Methods + +- [captureStackTrace](ErrElectionEndDateInThePast#capturestacktrace) + +### Properties + +- [cause](ErrElectionEndDateInThePast#cause) +- [message](ErrElectionEndDateInThePast#message) +- [name](ErrElectionEndDateInThePast#name) +- [stack](ErrElectionEndDateInThePast#stack) +- [prepareStackTrace](ErrElectionEndDateInThePast#preparestacktrace) +- [stackTraceLimit](ErrElectionEndDateInThePast#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrElectionEndDateInThePast**(`message?`): [`ErrElectionEndDateInThePast`](ErrElectionEndDateInThePast) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrElectionEndDateInThePast`](ErrElectionEndDateInThePast) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:254](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L254) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrElectionFinished.md b/docs/sdk/reference/classes/ErrElectionFinished.md new file mode 100644 index 000000000..61383450c --- /dev/null +++ b/docs/sdk/reference/classes/ErrElectionFinished.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrElectionFinished + +# Class: ErrElectionFinished + +## Hierarchy + +- `Error` + + ↳ **`ErrElectionFinished`** + +## Table of contents + +### Constructors + +- [constructor](ErrElectionFinished#constructor) + +### Methods + +- [captureStackTrace](ErrElectionFinished#capturestacktrace) + +### Properties + +- [cause](ErrElectionFinished#cause) +- [message](ErrElectionFinished#message) +- [name](ErrElectionFinished#name) +- [stack](ErrElectionFinished#stack) +- [prepareStackTrace](ErrElectionFinished#preparestacktrace) +- [stackTraceLimit](ErrElectionFinished#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrElectionFinished**(`message?`): [`ErrElectionFinished`](ErrElectionFinished) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrElectionFinished`](ErrElectionFinished) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:562](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L562) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrElectionIsNil.md b/docs/sdk/reference/classes/ErrElectionIsNil.md new file mode 100644 index 000000000..c8926851f --- /dev/null +++ b/docs/sdk/reference/classes/ErrElectionIsNil.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrElectionIsNil + +# Class: ErrElectionIsNil + +## Hierarchy + +- `Error` + + ↳ **`ErrElectionIsNil`** + +## Table of contents + +### Constructors + +- [constructor](ErrElectionIsNil#constructor) + +### Methods + +- [captureStackTrace](ErrElectionIsNil#capturestacktrace) + +### Properties + +- [cause](ErrElectionIsNil#cause) +- [message](ErrElectionIsNil#message) +- [name](ErrElectionIsNil#name) +- [stack](ErrElectionIsNil#stack) +- [prepareStackTrace](ErrElectionIsNil#preparestacktrace) +- [stackTraceLimit](ErrElectionIsNil#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrElectionIsNil**(`message?`): [`ErrElectionIsNil`](ErrElectionIsNil) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrElectionIsNil`](ErrElectionIsNil) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:470](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L470) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrElectionNotFound.md b/docs/sdk/reference/classes/ErrElectionNotFound.md new file mode 100644 index 000000000..1cceea8dc --- /dev/null +++ b/docs/sdk/reference/classes/ErrElectionNotFound.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrElectionNotFound + +# Class: ErrElectionNotFound + +## Hierarchy + +- `Error` + + ↳ **`ErrElectionNotFound`** + +## Table of contents + +### Constructors + +- [constructor](ErrElectionNotFound#constructor) + +### Methods + +- [captureStackTrace](ErrElectionNotFound#capturestacktrace) + +### Properties + +- [cause](ErrElectionNotFound#cause) +- [message](ErrElectionNotFound#message) +- [name](ErrElectionNotFound#name) +- [stack](ErrElectionNotFound#stack) +- [prepareStackTrace](ErrElectionNotFound#preparestacktrace) +- [stackTraceLimit](ErrElectionNotFound#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrElectionNotFound**(`message?`): [`ErrElectionNotFound`](ErrElectionNotFound) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrElectionNotFound`](ErrElectionNotFound) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:266](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L266) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrElectionNotStarted.md b/docs/sdk/reference/classes/ErrElectionNotStarted.md new file mode 100644 index 000000000..bfcf5bfb5 --- /dev/null +++ b/docs/sdk/reference/classes/ErrElectionNotStarted.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrElectionNotStarted + +# Class: ErrElectionNotStarted + +## Hierarchy + +- `Error` + + ↳ **`ErrElectionNotStarted`** + +## Table of contents + +### Constructors + +- [constructor](ErrElectionNotStarted#constructor) + +### Methods + +- [captureStackTrace](ErrElectionNotStarted#capturestacktrace) + +### Properties + +- [cause](ErrElectionNotStarted#cause) +- [message](ErrElectionNotStarted#message) +- [name](ErrElectionNotStarted#name) +- [stack](ErrElectionNotStarted#stack) +- [prepareStackTrace](ErrElectionNotStarted#preparestacktrace) +- [stackTraceLimit](ErrElectionNotStarted#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrElectionNotStarted**(`message?`): [`ErrElectionNotStarted`](ErrElectionNotStarted) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrElectionNotStarted`](ErrElectionNotStarted) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:556](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L556) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrElectionResultsIsNil.md b/docs/sdk/reference/classes/ErrElectionResultsIsNil.md new file mode 100644 index 000000000..a5f474244 --- /dev/null +++ b/docs/sdk/reference/classes/ErrElectionResultsIsNil.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrElectionResultsIsNil + +# Class: ErrElectionResultsIsNil + +## Hierarchy + +- `Error` + + ↳ **`ErrElectionResultsIsNil`** + +## Table of contents + +### Constructors + +- [constructor](ErrElectionResultsIsNil#constructor) + +### Methods + +- [captureStackTrace](ErrElectionResultsIsNil#capturestacktrace) + +### Properties + +- [cause](ErrElectionResultsIsNil#cause) +- [message](ErrElectionResultsIsNil#message) +- [name](ErrElectionResultsIsNil#name) +- [stack](ErrElectionResultsIsNil#stack) +- [prepareStackTrace](ErrElectionResultsIsNil#preparestacktrace) +- [stackTraceLimit](ErrElectionResultsIsNil#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrElectionResultsIsNil**(`message?`): [`ErrElectionResultsIsNil`](ErrElectionResultsIsNil) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrElectionResultsIsNil`](ErrElectionResultsIsNil) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:482](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L482) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrElectionResultsMismatch.md b/docs/sdk/reference/classes/ErrElectionResultsMismatch.md new file mode 100644 index 000000000..e72d033c7 --- /dev/null +++ b/docs/sdk/reference/classes/ErrElectionResultsMismatch.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrElectionResultsMismatch + +# Class: ErrElectionResultsMismatch + +## Hierarchy + +- `Error` + + ↳ **`ErrElectionResultsMismatch`** + +## Table of contents + +### Constructors + +- [constructor](ErrElectionResultsMismatch#constructor) + +### Methods + +- [captureStackTrace](ErrElectionResultsMismatch#capturestacktrace) + +### Properties + +- [cause](ErrElectionResultsMismatch#cause) +- [message](ErrElectionResultsMismatch#message) +- [name](ErrElectionResultsMismatch#name) +- [stack](ErrElectionResultsMismatch#stack) +- [prepareStackTrace](ErrElectionResultsMismatch#preparestacktrace) +- [stackTraceLimit](ErrElectionResultsMismatch#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrElectionResultsMismatch**(`message?`): [`ErrElectionResultsMismatch`](ErrElectionResultsMismatch) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrElectionResultsMismatch`](ErrElectionResultsMismatch) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:488](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L488) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrElectionResultsNotYetAvailable.md b/docs/sdk/reference/classes/ErrElectionResultsNotYetAvailable.md new file mode 100644 index 000000000..d859e8823 --- /dev/null +++ b/docs/sdk/reference/classes/ErrElectionResultsNotYetAvailable.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrElectionResultsNotYetAvailable + +# Class: ErrElectionResultsNotYetAvailable + +## Hierarchy + +- `Error` + + ↳ **`ErrElectionResultsNotYetAvailable`** + +## Table of contents + +### Constructors + +- [constructor](ErrElectionResultsNotYetAvailable#constructor) + +### Methods + +- [captureStackTrace](ErrElectionResultsNotYetAvailable#capturestacktrace) + +### Properties + +- [cause](ErrElectionResultsNotYetAvailable#cause) +- [message](ErrElectionResultsNotYetAvailable#message) +- [name](ErrElectionResultsNotYetAvailable#name) +- [stack](ErrElectionResultsNotYetAvailable#stack) +- [prepareStackTrace](ErrElectionResultsNotYetAvailable#preparestacktrace) +- [stackTraceLimit](ErrElectionResultsNotYetAvailable#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrElectionResultsNotYetAvailable**(`message?`): [`ErrElectionResultsNotYetAvailable`](ErrElectionResultsNotYetAvailable) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrElectionResultsNotYetAvailable`](ErrElectionResultsNotYetAvailable) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:476](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L476) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrFaucetAlreadyFunded.md b/docs/sdk/reference/classes/ErrFaucetAlreadyFunded.md new file mode 100644 index 000000000..c3d901fb4 --- /dev/null +++ b/docs/sdk/reference/classes/ErrFaucetAlreadyFunded.md @@ -0,0 +1,195 @@ +[@vocdoni/sdk](/sdk) / ErrFaucetAlreadyFunded + +# Class: ErrFaucetAlreadyFunded + +## Hierarchy + +- `Error` + + ↳ **`ErrFaucetAlreadyFunded`** + +## Table of contents + +### Constructors + +- [constructor](ErrFaucetAlreadyFunded#constructor) + +### Methods + +- [captureStackTrace](ErrFaucetAlreadyFunded#capturestacktrace) + +### Properties + +- [cause](ErrFaucetAlreadyFunded#cause) +- [message](ErrFaucetAlreadyFunded#message) +- [name](ErrFaucetAlreadyFunded#name) +- [stack](ErrFaucetAlreadyFunded#stack) +- [untilDate](ErrFaucetAlreadyFunded#untildate) +- [prepareStackTrace](ErrFaucetAlreadyFunded#preparestacktrace) +- [stackTraceLimit](ErrFaucetAlreadyFunded#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrFaucetAlreadyFunded**(`message?`): [`ErrFaucetAlreadyFunded`](ErrFaucetAlreadyFunded) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrFaucetAlreadyFunded`](ErrFaucetAlreadyFunded) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:543](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L543) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### untilDate + +• **untilDate**: `Date` + +#### Defined in + +[src/api/errors.ts:542](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L542) + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrFileSizeTooBig.md b/docs/sdk/reference/classes/ErrFileSizeTooBig.md new file mode 100644 index 000000000..97de4a1f5 --- /dev/null +++ b/docs/sdk/reference/classes/ErrFileSizeTooBig.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrFileSizeTooBig + +# Class: ErrFileSizeTooBig + +## Hierarchy + +- `Error` + + ↳ **`ErrFileSizeTooBig`** + +## Table of contents + +### Constructors + +- [constructor](ErrFileSizeTooBig#constructor) + +### Methods + +- [captureStackTrace](ErrFileSizeTooBig#capturestacktrace) + +### Properties + +- [cause](ErrFileSizeTooBig#cause) +- [message](ErrFileSizeTooBig#message) +- [name](ErrFileSizeTooBig#name) +- [stack](ErrFileSizeTooBig#stack) +- [prepareStackTrace](ErrFileSizeTooBig#preparestacktrace) +- [stackTraceLimit](ErrFileSizeTooBig#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrFileSizeTooBig**(`message?`): [`ErrFileSizeTooBig`](ErrFileSizeTooBig) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrFileSizeTooBig`](ErrFileSizeTooBig) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:68](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L68) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrGettingSIK.md b/docs/sdk/reference/classes/ErrGettingSIK.md new file mode 100644 index 000000000..8da36806a --- /dev/null +++ b/docs/sdk/reference/classes/ErrGettingSIK.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrGettingSIK + +# Class: ErrGettingSIK + +## Hierarchy + +- `Error` + + ↳ **`ErrGettingSIK`** + +## Table of contents + +### Constructors + +- [constructor](ErrGettingSIK#constructor) + +### Methods + +- [captureStackTrace](ErrGettingSIK#capturestacktrace) + +### Properties + +- [cause](ErrGettingSIK#cause) +- [message](ErrGettingSIK#message) +- [name](ErrGettingSIK#name) +- [stack](ErrGettingSIK#stack) +- [prepareStackTrace](ErrGettingSIK#preparestacktrace) +- [stackTraceLimit](ErrGettingSIK#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrGettingSIK**(`message?`): [`ErrGettingSIK`](ErrGettingSIK) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrGettingSIK`](ErrGettingSIK) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:518](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L518) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrIndexedCensusCantUseWeight.md b/docs/sdk/reference/classes/ErrIndexedCensusCantUseWeight.md new file mode 100644 index 000000000..dc91de49a --- /dev/null +++ b/docs/sdk/reference/classes/ErrIndexedCensusCantUseWeight.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrIndexedCensusCantUseWeight + +# Class: ErrIndexedCensusCantUseWeight + +## Hierarchy + +- `Error` + + ↳ **`ErrIndexedCensusCantUseWeight`** + +## Table of contents + +### Constructors + +- [constructor](ErrIndexedCensusCantUseWeight#constructor) + +### Methods + +- [captureStackTrace](ErrIndexedCensusCantUseWeight#capturestacktrace) + +### Properties + +- [cause](ErrIndexedCensusCantUseWeight#cause) +- [message](ErrIndexedCensusCantUseWeight#message) +- [name](ErrIndexedCensusCantUseWeight#name) +- [stack](ErrIndexedCensusCantUseWeight#stack) +- [prepareStackTrace](ErrIndexedCensusCantUseWeight#preparestacktrace) +- [stackTraceLimit](ErrIndexedCensusCantUseWeight#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrIndexedCensusCantUseWeight**(`message?`): [`ErrIndexedCensusCantUseWeight`](ErrIndexedCensusCantUseWeight) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrIndexedCensusCantUseWeight`](ErrIndexedCensusCantUseWeight) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:236](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L236) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrIndexerQueryFailed.md b/docs/sdk/reference/classes/ErrIndexerQueryFailed.md new file mode 100644 index 000000000..d0c74d251 --- /dev/null +++ b/docs/sdk/reference/classes/ErrIndexerQueryFailed.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrIndexerQueryFailed + +# Class: ErrIndexerQueryFailed + +## Hierarchy + +- `Error` + + ↳ **`ErrIndexerQueryFailed`** + +## Table of contents + +### Constructors + +- [constructor](ErrIndexerQueryFailed#constructor) + +### Methods + +- [captureStackTrace](ErrIndexerQueryFailed#capturestacktrace) + +### Properties + +- [cause](ErrIndexerQueryFailed#cause) +- [message](ErrIndexerQueryFailed#message) +- [name](ErrIndexerQueryFailed#name) +- [stack](ErrIndexerQueryFailed#stack) +- [prepareStackTrace](ErrIndexerQueryFailed#preparestacktrace) +- [stackTraceLimit](ErrIndexerQueryFailed#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrIndexerQueryFailed**(`message?`): [`ErrIndexerQueryFailed`](ErrIndexerQueryFailed) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrIndexerQueryFailed`](ErrIndexerQueryFailed) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:530](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L530) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrInvalidCensusKeyLength.md b/docs/sdk/reference/classes/ErrInvalidCensusKeyLength.md new file mode 100644 index 000000000..95dcfa48f --- /dev/null +++ b/docs/sdk/reference/classes/ErrInvalidCensusKeyLength.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrInvalidCensusKeyLength + +# Class: ErrInvalidCensusKeyLength + +## Hierarchy + +- `Error` + + ↳ **`ErrInvalidCensusKeyLength`** + +## Table of contents + +### Constructors + +- [constructor](ErrInvalidCensusKeyLength#constructor) + +### Methods + +- [captureStackTrace](ErrInvalidCensusKeyLength#capturestacktrace) + +### Properties + +- [cause](ErrInvalidCensusKeyLength#cause) +- [message](ErrInvalidCensusKeyLength#message) +- [name](ErrInvalidCensusKeyLength#name) +- [stack](ErrInvalidCensusKeyLength#stack) +- [prepareStackTrace](ErrInvalidCensusKeyLength#preparestacktrace) +- [stackTraceLimit](ErrInvalidCensusKeyLength#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrInvalidCensusKeyLength**(`message?`): [`ErrInvalidCensusKeyLength`](ErrInvalidCensusKeyLength) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrInvalidCensusKeyLength`](ErrInvalidCensusKeyLength) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:302](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L302) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrInvalidStatus.md b/docs/sdk/reference/classes/ErrInvalidStatus.md new file mode 100644 index 000000000..31c36539f --- /dev/null +++ b/docs/sdk/reference/classes/ErrInvalidStatus.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrInvalidStatus + +# Class: ErrInvalidStatus + +## Hierarchy + +- `Error` + + ↳ **`ErrInvalidStatus`** + +## Table of contents + +### Constructors + +- [constructor](ErrInvalidStatus#constructor) + +### Methods + +- [captureStackTrace](ErrInvalidStatus#capturestacktrace) + +### Properties + +- [cause](ErrInvalidStatus#cause) +- [message](ErrInvalidStatus#message) +- [name](ErrInvalidStatus#name) +- [stack](ErrInvalidStatus#stack) +- [prepareStackTrace](ErrInvalidStatus#preparestacktrace) +- [stackTraceLimit](ErrInvalidStatus#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrInvalidStatus**(`message?`): [`ErrInvalidStatus`](ErrInvalidStatus) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrInvalidStatus`](ErrInvalidStatus) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:296](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L296) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrKeyNotFoundInCensus.md b/docs/sdk/reference/classes/ErrKeyNotFoundInCensus.md new file mode 100644 index 000000000..aa6ff05a7 --- /dev/null +++ b/docs/sdk/reference/classes/ErrKeyNotFoundInCensus.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrKeyNotFoundInCensus + +# Class: ErrKeyNotFoundInCensus + +## Hierarchy + +- `Error` + + ↳ **`ErrKeyNotFoundInCensus`** + +## Table of contents + +### Constructors + +- [constructor](ErrKeyNotFoundInCensus#constructor) + +### Methods + +- [captureStackTrace](ErrKeyNotFoundInCensus#capturestacktrace) + +### Properties + +- [cause](ErrKeyNotFoundInCensus#cause) +- [message](ErrKeyNotFoundInCensus#message) +- [name](ErrKeyNotFoundInCensus#name) +- [stack](ErrKeyNotFoundInCensus#stack) +- [prepareStackTrace](ErrKeyNotFoundInCensus#preparestacktrace) +- [stackTraceLimit](ErrKeyNotFoundInCensus#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrKeyNotFoundInCensus**(`message?`): [`ErrKeyNotFoundInCensus`](ErrKeyNotFoundInCensus) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrKeyNotFoundInCensus`](ErrKeyNotFoundInCensus) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:290](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L290) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrMarshalingJSONFailed.md b/docs/sdk/reference/classes/ErrMarshalingJSONFailed.md new file mode 100644 index 000000000..71464c7f9 --- /dev/null +++ b/docs/sdk/reference/classes/ErrMarshalingJSONFailed.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrMarshalingJSONFailed + +# Class: ErrMarshalingJSONFailed + +## Hierarchy + +- `Error` + + ↳ **`ErrMarshalingJSONFailed`** + +## Table of contents + +### Constructors + +- [constructor](ErrMarshalingJSONFailed#constructor) + +### Methods + +- [captureStackTrace](ErrMarshalingJSONFailed#capturestacktrace) + +### Properties + +- [cause](ErrMarshalingJSONFailed#cause) +- [message](ErrMarshalingJSONFailed#message) +- [name](ErrMarshalingJSONFailed#name) +- [stack](ErrMarshalingJSONFailed#stack) +- [prepareStackTrace](ErrMarshalingJSONFailed#preparestacktrace) +- [stackTraceLimit](ErrMarshalingJSONFailed#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrMarshalingJSONFailed**(`message?`): [`ErrMarshalingJSONFailed`](ErrMarshalingJSONFailed) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrMarshalingJSONFailed`](ErrMarshalingJSONFailed) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:62](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L62) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrMarshalingServerJSONFailed.md b/docs/sdk/reference/classes/ErrMarshalingServerJSONFailed.md new file mode 100644 index 000000000..ef79e55e5 --- /dev/null +++ b/docs/sdk/reference/classes/ErrMarshalingServerJSONFailed.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrMarshalingServerJSONFailed + +# Class: ErrMarshalingServerJSONFailed + +## Hierarchy + +- `Error` + + ↳ **`ErrMarshalingServerJSONFailed`** + +## Table of contents + +### Constructors + +- [constructor](ErrMarshalingServerJSONFailed#constructor) + +### Methods + +- [captureStackTrace](ErrMarshalingServerJSONFailed#capturestacktrace) + +### Properties + +- [cause](ErrMarshalingServerJSONFailed#cause) +- [message](ErrMarshalingServerJSONFailed#message) +- [name](ErrMarshalingServerJSONFailed#name) +- [stack](ErrMarshalingServerJSONFailed#stack) +- [prepareStackTrace](ErrMarshalingServerJSONFailed#preparestacktrace) +- [stackTraceLimit](ErrMarshalingServerJSONFailed#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrMarshalingServerJSONFailed**(`message?`): [`ErrMarshalingServerJSONFailed`](ErrMarshalingServerJSONFailed) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrMarshalingServerJSONFailed`](ErrMarshalingServerJSONFailed) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:380](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L380) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrMarshalingServerProto.md b/docs/sdk/reference/classes/ErrMarshalingServerProto.md new file mode 100644 index 000000000..b8fe8d429 --- /dev/null +++ b/docs/sdk/reference/classes/ErrMarshalingServerProto.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrMarshalingServerProto + +# Class: ErrMarshalingServerProto + +## Hierarchy + +- `Error` + + ↳ **`ErrMarshalingServerProto`** + +## Table of contents + +### Constructors + +- [constructor](ErrMarshalingServerProto#constructor) + +### Methods + +- [captureStackTrace](ErrMarshalingServerProto#capturestacktrace) + +### Properties + +- [cause](ErrMarshalingServerProto#cause) +- [message](ErrMarshalingServerProto#message) +- [name](ErrMarshalingServerProto#name) +- [stack](ErrMarshalingServerProto#stack) +- [prepareStackTrace](ErrMarshalingServerProto#preparestacktrace) +- [stackTraceLimit](ErrMarshalingServerProto#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrMarshalingServerProto**(`message?`): [`ErrMarshalingServerProto`](ErrMarshalingServerProto) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrMarshalingServerProto`](ErrMarshalingServerProto) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:314](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L314) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrMetadataProvidedButNoURI.md b/docs/sdk/reference/classes/ErrMetadataProvidedButNoURI.md new file mode 100644 index 000000000..cea7bb56a --- /dev/null +++ b/docs/sdk/reference/classes/ErrMetadataProvidedButNoURI.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrMetadataProvidedButNoURI + +# Class: ErrMetadataProvidedButNoURI + +## Hierarchy + +- `Error` + + ↳ **`ErrMetadataProvidedButNoURI`** + +## Table of contents + +### Constructors + +- [constructor](ErrMetadataProvidedButNoURI#constructor) + +### Methods + +- [captureStackTrace](ErrMetadataProvidedButNoURI#capturestacktrace) + +### Properties + +- [cause](ErrMetadataProvidedButNoURI#cause) +- [message](ErrMetadataProvidedButNoURI#message) +- [name](ErrMetadataProvidedButNoURI#name) +- [stack](ErrMetadataProvidedButNoURI#stack) +- [prepareStackTrace](ErrMetadataProvidedButNoURI#preparestacktrace) +- [stackTraceLimit](ErrMetadataProvidedButNoURI#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrMetadataProvidedButNoURI**(`message?`): [`ErrMetadataProvidedButNoURI`](ErrMetadataProvidedButNoURI) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrMetadataProvidedButNoURI`](ErrMetadataProvidedButNoURI) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:50](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L50) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrMetadataURINotMatchContent.md b/docs/sdk/reference/classes/ErrMetadataURINotMatchContent.md new file mode 100644 index 000000000..2a7c97b9b --- /dev/null +++ b/docs/sdk/reference/classes/ErrMetadataURINotMatchContent.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrMetadataURINotMatchContent + +# Class: ErrMetadataURINotMatchContent + +## Hierarchy + +- `Error` + + ↳ **`ErrMetadataURINotMatchContent`** + +## Table of contents + +### Constructors + +- [constructor](ErrMetadataURINotMatchContent#constructor) + +### Methods + +- [captureStackTrace](ErrMetadataURINotMatchContent#capturestacktrace) + +### Properties + +- [cause](ErrMetadataURINotMatchContent#cause) +- [message](ErrMetadataURINotMatchContent#message) +- [name](ErrMetadataURINotMatchContent#name) +- [stack](ErrMetadataURINotMatchContent#stack) +- [prepareStackTrace](ErrMetadataURINotMatchContent#preparestacktrace) +- [stackTraceLimit](ErrMetadataURINotMatchContent#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrMetadataURINotMatchContent**(`message?`): [`ErrMetadataURINotMatchContent`](ErrMetadataURINotMatchContent) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrMetadataURINotMatchContent`](ErrMetadataURINotMatchContent) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:56](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L56) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrMissingParameter.md b/docs/sdk/reference/classes/ErrMissingParameter.md new file mode 100644 index 000000000..dd888acc5 --- /dev/null +++ b/docs/sdk/reference/classes/ErrMissingParameter.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrMissingParameter + +# Class: ErrMissingParameter + +## Hierarchy + +- `Error` + + ↳ **`ErrMissingParameter`** + +## Table of contents + +### Constructors + +- [constructor](ErrMissingParameter#constructor) + +### Methods + +- [captureStackTrace](ErrMissingParameter#capturestacktrace) + +### Properties + +- [cause](ErrMissingParameter#cause) +- [message](ErrMissingParameter#message) +- [name](ErrMissingParameter#name) +- [stack](ErrMissingParameter#stack) +- [prepareStackTrace](ErrMissingParameter#preparestacktrace) +- [stackTraceLimit](ErrMissingParameter#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrMissingParameter**(`message?`): [`ErrMissingParameter`](ErrMissingParameter) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrMissingParameter`](ErrMissingParameter) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:284](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L284) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrNoElectionKeys.md b/docs/sdk/reference/classes/ErrNoElectionKeys.md new file mode 100644 index 000000000..c960fa1d3 --- /dev/null +++ b/docs/sdk/reference/classes/ErrNoElectionKeys.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrNoElectionKeys + +# Class: ErrNoElectionKeys + +## Hierarchy + +- `Error` + + ↳ **`ErrNoElectionKeys`** + +## Table of contents + +### Constructors + +- [constructor](ErrNoElectionKeys#constructor) + +### Methods + +- [captureStackTrace](ErrNoElectionKeys#capturestacktrace) + +### Properties + +- [cause](ErrNoElectionKeys#cause) +- [message](ErrNoElectionKeys#message) +- [name](ErrNoElectionKeys#name) +- [stack](ErrNoElectionKeys#stack) +- [prepareStackTrace](ErrNoElectionKeys#preparestacktrace) +- [stackTraceLimit](ErrNoElectionKeys#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrNoElectionKeys**(`message?`): [`ErrNoElectionKeys`](ErrNoElectionKeys) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrNoElectionKeys`](ErrNoElectionKeys) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:278](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L278) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrOrgNotFound.md b/docs/sdk/reference/classes/ErrOrgNotFound.md new file mode 100644 index 000000000..df8f7e483 --- /dev/null +++ b/docs/sdk/reference/classes/ErrOrgNotFound.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrOrgNotFound + +# Class: ErrOrgNotFound + +## Hierarchy + +- `Error` + + ↳ **`ErrOrgNotFound`** + +## Table of contents + +### Constructors + +- [constructor](ErrOrgNotFound#constructor) + +### Methods + +- [captureStackTrace](ErrOrgNotFound#capturestacktrace) + +### Properties + +- [cause](ErrOrgNotFound#cause) +- [message](ErrOrgNotFound#message) +- [name](ErrOrgNotFound#name) +- [stack](ErrOrgNotFound#stack) +- [prepareStackTrace](ErrOrgNotFound#preparestacktrace) +- [stackTraceLimit](ErrOrgNotFound#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrOrgNotFound**(`message?`): [`ErrOrgNotFound`](ErrOrgNotFound) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrOrgNotFound`](ErrOrgNotFound) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L32) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrPageNotFound.md b/docs/sdk/reference/classes/ErrPageNotFound.md new file mode 100644 index 000000000..dff2902ee --- /dev/null +++ b/docs/sdk/reference/classes/ErrPageNotFound.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrPageNotFound + +# Class: ErrPageNotFound + +## Hierarchy + +- `Error` + + ↳ **`ErrPageNotFound`** + +## Table of contents + +### Constructors + +- [constructor](ErrPageNotFound#constructor) + +### Methods + +- [captureStackTrace](ErrPageNotFound#capturestacktrace) + +### Properties + +- [cause](ErrPageNotFound#cause) +- [message](ErrPageNotFound#message) +- [name](ErrPageNotFound#name) +- [stack](ErrPageNotFound#stack) +- [prepareStackTrace](ErrPageNotFound#preparestacktrace) +- [stackTraceLimit](ErrPageNotFound#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrPageNotFound**(`message?`): [`ErrPageNotFound`](ErrPageNotFound) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrPageNotFound`](ErrPageNotFound) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:338](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L338) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrParamDumpOrRootMissing.md b/docs/sdk/reference/classes/ErrParamDumpOrRootMissing.md new file mode 100644 index 000000000..0262dd302 --- /dev/null +++ b/docs/sdk/reference/classes/ErrParamDumpOrRootMissing.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrParamDumpOrRootMissing + +# Class: ErrParamDumpOrRootMissing + +## Hierarchy + +- `Error` + + ↳ **`ErrParamDumpOrRootMissing`** + +## Table of contents + +### Constructors + +- [constructor](ErrParamDumpOrRootMissing#constructor) + +### Methods + +- [captureStackTrace](ErrParamDumpOrRootMissing#capturestacktrace) + +### Properties + +- [cause](ErrParamDumpOrRootMissing#cause) +- [message](ErrParamDumpOrRootMissing#message) +- [name](ErrParamDumpOrRootMissing#name) +- [stack](ErrParamDumpOrRootMissing#stack) +- [prepareStackTrace](ErrParamDumpOrRootMissing#preparestacktrace) +- [stackTraceLimit](ErrParamDumpOrRootMissing#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrParamDumpOrRootMissing**(`message?`): [`ErrParamDumpOrRootMissing`](ErrParamDumpOrRootMissing) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrParamDumpOrRootMissing`](ErrParamDumpOrRootMissing) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:200](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L200) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrParamKeyOrProofMissing.md b/docs/sdk/reference/classes/ErrParamKeyOrProofMissing.md new file mode 100644 index 000000000..db875c6a3 --- /dev/null +++ b/docs/sdk/reference/classes/ErrParamKeyOrProofMissing.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrParamKeyOrProofMissing + +# Class: ErrParamKeyOrProofMissing + +## Hierarchy + +- `Error` + + ↳ **`ErrParamKeyOrProofMissing`** + +## Table of contents + +### Constructors + +- [constructor](ErrParamKeyOrProofMissing#constructor) + +### Methods + +- [captureStackTrace](ErrParamKeyOrProofMissing#capturestacktrace) + +### Properties + +- [cause](ErrParamKeyOrProofMissing#cause) +- [message](ErrParamKeyOrProofMissing#message) +- [name](ErrParamKeyOrProofMissing#name) +- [stack](ErrParamKeyOrProofMissing#stack) +- [prepareStackTrace](ErrParamKeyOrProofMissing#preparestacktrace) +- [stackTraceLimit](ErrParamKeyOrProofMissing#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrParamKeyOrProofMissing**(`message?`): [`ErrParamKeyOrProofMissing`](ErrParamKeyOrProofMissing) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrParamKeyOrProofMissing`](ErrParamKeyOrProofMissing) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:206](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L206) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrParamNetworkInvalid.md b/docs/sdk/reference/classes/ErrParamNetworkInvalid.md new file mode 100644 index 000000000..d82728af9 --- /dev/null +++ b/docs/sdk/reference/classes/ErrParamNetworkInvalid.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrParamNetworkInvalid + +# Class: ErrParamNetworkInvalid + +## Hierarchy + +- `Error` + + ↳ **`ErrParamNetworkInvalid`** + +## Table of contents + +### Constructors + +- [constructor](ErrParamNetworkInvalid#constructor) + +### Methods + +- [captureStackTrace](ErrParamNetworkInvalid#capturestacktrace) + +### Properties + +- [cause](ErrParamNetworkInvalid#cause) +- [message](ErrParamNetworkInvalid#message) +- [name](ErrParamNetworkInvalid#name) +- [stack](ErrParamNetworkInvalid#stack) +- [prepareStackTrace](ErrParamNetworkInvalid#preparestacktrace) +- [stackTraceLimit](ErrParamNetworkInvalid#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrParamNetworkInvalid**(`message?`): [`ErrParamNetworkInvalid`](ErrParamNetworkInvalid) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrParamNetworkInvalid`](ErrParamNetworkInvalid) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:218](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L218) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrParamParticipantsMissing.md b/docs/sdk/reference/classes/ErrParamParticipantsMissing.md new file mode 100644 index 000000000..f263e3627 --- /dev/null +++ b/docs/sdk/reference/classes/ErrParamParticipantsMissing.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrParamParticipantsMissing + +# Class: ErrParamParticipantsMissing + +## Hierarchy + +- `Error` + + ↳ **`ErrParamParticipantsMissing`** + +## Table of contents + +### Constructors + +- [constructor](ErrParamParticipantsMissing#constructor) + +### Methods + +- [captureStackTrace](ErrParamParticipantsMissing#capturestacktrace) + +### Properties + +- [cause](ErrParamParticipantsMissing#cause) +- [message](ErrParamParticipantsMissing#message) +- [name](ErrParamParticipantsMissing#name) +- [stack](ErrParamParticipantsMissing#stack) +- [prepareStackTrace](ErrParamParticipantsMissing#preparestacktrace) +- [stackTraceLimit](ErrParamParticipantsMissing#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrParamParticipantsMissing**(`message?`): [`ErrParamParticipantsMissing`](ErrParamParticipantsMissing) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrParamParticipantsMissing`](ErrParamParticipantsMissing) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:188](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L188) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrParamParticipantsTooBig.md b/docs/sdk/reference/classes/ErrParamParticipantsTooBig.md new file mode 100644 index 000000000..5a4a970c0 --- /dev/null +++ b/docs/sdk/reference/classes/ErrParamParticipantsTooBig.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrParamParticipantsTooBig + +# Class: ErrParamParticipantsTooBig + +## Hierarchy + +- `Error` + + ↳ **`ErrParamParticipantsTooBig`** + +## Table of contents + +### Constructors + +- [constructor](ErrParamParticipantsTooBig#constructor) + +### Methods + +- [captureStackTrace](ErrParamParticipantsTooBig#capturestacktrace) + +### Properties + +- [cause](ErrParamParticipantsTooBig#cause) +- [message](ErrParamParticipantsTooBig#message) +- [name](ErrParamParticipantsTooBig#name) +- [stack](ErrParamParticipantsTooBig#stack) +- [prepareStackTrace](ErrParamParticipantsTooBig#preparestacktrace) +- [stackTraceLimit](ErrParamParticipantsTooBig#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrParamParticipantsTooBig**(`message?`): [`ErrParamParticipantsTooBig`](ErrParamParticipantsTooBig) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrParamParticipantsTooBig`](ErrParamParticipantsTooBig) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:194](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L194) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrParamRootInvalid.md b/docs/sdk/reference/classes/ErrParamRootInvalid.md new file mode 100644 index 000000000..2c8fb2b03 --- /dev/null +++ b/docs/sdk/reference/classes/ErrParamRootInvalid.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrParamRootInvalid + +# Class: ErrParamRootInvalid + +## Hierarchy + +- `Error` + + ↳ **`ErrParamRootInvalid`** + +## Table of contents + +### Constructors + +- [constructor](ErrParamRootInvalid#constructor) + +### Methods + +- [captureStackTrace](ErrParamRootInvalid#capturestacktrace) + +### Properties + +- [cause](ErrParamRootInvalid#cause) +- [message](ErrParamRootInvalid#message) +- [name](ErrParamRootInvalid#name) +- [stack](ErrParamRootInvalid#stack) +- [prepareStackTrace](ErrParamRootInvalid#preparestacktrace) +- [stackTraceLimit](ErrParamRootInvalid#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrParamRootInvalid**(`message?`): [`ErrParamRootInvalid`](ErrParamRootInvalid) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrParamRootInvalid`](ErrParamRootInvalid) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:212](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L212) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrParamStatusInvalid.md b/docs/sdk/reference/classes/ErrParamStatusInvalid.md new file mode 100644 index 000000000..b44e6790d --- /dev/null +++ b/docs/sdk/reference/classes/ErrParamStatusInvalid.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrParamStatusInvalid + +# Class: ErrParamStatusInvalid + +## Hierarchy + +- `Error` + + ↳ **`ErrParamStatusInvalid`** + +## Table of contents + +### Constructors + +- [constructor](ErrParamStatusInvalid#constructor) + +### Methods + +- [captureStackTrace](ErrParamStatusInvalid#capturestacktrace) + +### Properties + +- [cause](ErrParamStatusInvalid#cause) +- [message](ErrParamStatusInvalid#message) +- [name](ErrParamStatusInvalid#name) +- [stack](ErrParamStatusInvalid#stack) +- [prepareStackTrace](ErrParamStatusInvalid#preparestacktrace) +- [stackTraceLimit](ErrParamStatusInvalid#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrParamStatusInvalid**(`message?`): [`ErrParamStatusInvalid`](ErrParamStatusInvalid) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrParamStatusInvalid`](ErrParamStatusInvalid) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:182](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L182) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrParamToInvalid.md b/docs/sdk/reference/classes/ErrParamToInvalid.md new file mode 100644 index 000000000..0d8b9c1a1 --- /dev/null +++ b/docs/sdk/reference/classes/ErrParamToInvalid.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrParamToInvalid + +# Class: ErrParamToInvalid + +## Hierarchy + +- `Error` + + ↳ **`ErrParamToInvalid`** + +## Table of contents + +### Constructors + +- [constructor](ErrParamToInvalid#constructor) + +### Methods + +- [captureStackTrace](ErrParamToInvalid#capturestacktrace) + +### Properties + +- [cause](ErrParamToInvalid#cause) +- [message](ErrParamToInvalid#message) +- [name](ErrParamToInvalid#name) +- [stack](ErrParamToInvalid#stack) +- [prepareStackTrace](ErrParamToInvalid#preparestacktrace) +- [stackTraceLimit](ErrParamToInvalid#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrParamToInvalid**(`message?`): [`ErrParamToInvalid`](ErrParamToInvalid) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrParamToInvalid`](ErrParamToInvalid) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:224](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L224) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrParticipantKeyMissing.md b/docs/sdk/reference/classes/ErrParticipantKeyMissing.md new file mode 100644 index 000000000..49ba09764 --- /dev/null +++ b/docs/sdk/reference/classes/ErrParticipantKeyMissing.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrParticipantKeyMissing + +# Class: ErrParticipantKeyMissing + +## Hierarchy + +- `Error` + + ↳ **`ErrParticipantKeyMissing`** + +## Table of contents + +### Constructors + +- [constructor](ErrParticipantKeyMissing#constructor) + +### Methods + +- [captureStackTrace](ErrParticipantKeyMissing#capturestacktrace) + +### Properties + +- [cause](ErrParticipantKeyMissing#cause) +- [message](ErrParticipantKeyMissing#message) +- [name](ErrParticipantKeyMissing#name) +- [stack](ErrParticipantKeyMissing#stack) +- [prepareStackTrace](ErrParticipantKeyMissing#preparestacktrace) +- [stackTraceLimit](ErrParticipantKeyMissing#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrParticipantKeyMissing**(`message?`): [`ErrParticipantKeyMissing`](ErrParticipantKeyMissing) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrParticipantKeyMissing`](ErrParticipantKeyMissing) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:230](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L230) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrSIKNotFound.md b/docs/sdk/reference/classes/ErrSIKNotFound.md new file mode 100644 index 000000000..1160995c8 --- /dev/null +++ b/docs/sdk/reference/classes/ErrSIKNotFound.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrSIKNotFound + +# Class: ErrSIKNotFound + +## Hierarchy + +- `Error` + + ↳ **`ErrSIKNotFound`** + +## Table of contents + +### Constructors + +- [constructor](ErrSIKNotFound#constructor) + +### Methods + +- [captureStackTrace](ErrSIKNotFound#capturestacktrace) + +### Properties + +- [cause](ErrSIKNotFound#cause) +- [message](ErrSIKNotFound#message) +- [name](ErrSIKNotFound#name) +- [stack](ErrSIKNotFound#stack) +- [prepareStackTrace](ErrSIKNotFound#preparestacktrace) +- [stackTraceLimit](ErrSIKNotFound#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrSIKNotFound**(`message?`): [`ErrSIKNotFound`](ErrSIKNotFound) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrSIKNotFound`](ErrSIKNotFound) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:320](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L320) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrTransactionNotFound.md b/docs/sdk/reference/classes/ErrTransactionNotFound.md new file mode 100644 index 000000000..7d4c66611 --- /dev/null +++ b/docs/sdk/reference/classes/ErrTransactionNotFound.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrTransactionNotFound + +# Class: ErrTransactionNotFound + +## Hierarchy + +- `Error` + + ↳ **`ErrTransactionNotFound`** + +## Table of contents + +### Constructors + +- [constructor](ErrTransactionNotFound#constructor) + +### Methods + +- [captureStackTrace](ErrTransactionNotFound#capturestacktrace) + +### Properties + +- [cause](ErrTransactionNotFound#cause) +- [message](ErrTransactionNotFound#message) +- [name](ErrTransactionNotFound#name) +- [stack](ErrTransactionNotFound#stack) +- [prepareStackTrace](ErrTransactionNotFound#preparestacktrace) +- [stackTraceLimit](ErrTransactionNotFound#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrTransactionNotFound**(`message?`): [`ErrTransactionNotFound`](ErrTransactionNotFound) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrTransactionNotFound`](ErrTransactionNotFound) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L38) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrTxTypeMismatch.md b/docs/sdk/reference/classes/ErrTxTypeMismatch.md new file mode 100644 index 000000000..69162d5ba --- /dev/null +++ b/docs/sdk/reference/classes/ErrTxTypeMismatch.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrTxTypeMismatch + +# Class: ErrTxTypeMismatch + +## Hierarchy + +- `Error` + + ↳ **`ErrTxTypeMismatch`** + +## Table of contents + +### Constructors + +- [constructor](ErrTxTypeMismatch#constructor) + +### Methods + +- [captureStackTrace](ErrTxTypeMismatch#capturestacktrace) + +### Properties + +- [cause](ErrTxTypeMismatch#cause) +- [message](ErrTxTypeMismatch#message) +- [name](ErrTxTypeMismatch#name) +- [stack](ErrTxTypeMismatch#stack) +- [prepareStackTrace](ErrTxTypeMismatch#preparestacktrace) +- [stackTraceLimit](ErrTxTypeMismatch#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrTxTypeMismatch**(`message?`): [`ErrTxTypeMismatch`](ErrTxTypeMismatch) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrTxTypeMismatch`](ErrTxTypeMismatch) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:464](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L464) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrUnmarshalingServerProto.md b/docs/sdk/reference/classes/ErrUnmarshalingServerProto.md new file mode 100644 index 000000000..bf90380f9 --- /dev/null +++ b/docs/sdk/reference/classes/ErrUnmarshalingServerProto.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrUnmarshalingServerProto + +# Class: ErrUnmarshalingServerProto + +## Hierarchy + +- `Error` + + ↳ **`ErrUnmarshalingServerProto`** + +## Table of contents + +### Constructors + +- [constructor](ErrUnmarshalingServerProto#constructor) + +### Methods + +- [captureStackTrace](ErrUnmarshalingServerProto#capturestacktrace) + +### Properties + +- [cause](ErrUnmarshalingServerProto#cause) +- [message](ErrUnmarshalingServerProto#message) +- [name](ErrUnmarshalingServerProto#name) +- [stack](ErrUnmarshalingServerProto#stack) +- [prepareStackTrace](ErrUnmarshalingServerProto#preparestacktrace) +- [stackTraceLimit](ErrUnmarshalingServerProto#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrUnmarshalingServerProto**(`message?`): [`ErrUnmarshalingServerProto`](ErrUnmarshalingServerProto) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrUnmarshalingServerProto`](ErrUnmarshalingServerProto) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:308](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L308) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrVochainEmptyReply.md b/docs/sdk/reference/classes/ErrVochainEmptyReply.md new file mode 100644 index 000000000..45b3abf86 --- /dev/null +++ b/docs/sdk/reference/classes/ErrVochainEmptyReply.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrVochainEmptyReply + +# Class: ErrVochainEmptyReply + +## Hierarchy + +- `Error` + + ↳ **`ErrVochainEmptyReply`** + +## Table of contents + +### Constructors + +- [constructor](ErrVochainEmptyReply#constructor) + +### Methods + +- [captureStackTrace](ErrVochainEmptyReply#capturestacktrace) + +### Properties + +- [cause](ErrVochainEmptyReply#cause) +- [message](ErrVochainEmptyReply#message) +- [name](ErrVochainEmptyReply#name) +- [stack](ErrVochainEmptyReply#stack) +- [prepareStackTrace](ErrVochainEmptyReply#preparestacktrace) +- [stackTraceLimit](ErrVochainEmptyReply#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrVochainEmptyReply**(`message?`): [`ErrVochainEmptyReply`](ErrVochainEmptyReply) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrVochainEmptyReply`](ErrVochainEmptyReply) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:344](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L344) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrVochainGetTxFailed.md b/docs/sdk/reference/classes/ErrVochainGetTxFailed.md new file mode 100644 index 000000000..373b9925a --- /dev/null +++ b/docs/sdk/reference/classes/ErrVochainGetTxFailed.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrVochainGetTxFailed + +# Class: ErrVochainGetTxFailed + +## Hierarchy + +- `Error` + + ↳ **`ErrVochainGetTxFailed`** + +## Table of contents + +### Constructors + +- [constructor](ErrVochainGetTxFailed#constructor) + +### Methods + +- [captureStackTrace](ErrVochainGetTxFailed#capturestacktrace) + +### Properties + +- [cause](ErrVochainGetTxFailed#cause) +- [message](ErrVochainGetTxFailed#message) +- [name](ErrVochainGetTxFailed#name) +- [stack](ErrVochainGetTxFailed#stack) +- [prepareStackTrace](ErrVochainGetTxFailed#preparestacktrace) +- [stackTraceLimit](ErrVochainGetTxFailed#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrVochainGetTxFailed**(`message?`): [`ErrVochainGetTxFailed`](ErrVochainGetTxFailed) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrVochainGetTxFailed`](ErrVochainGetTxFailed) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:356](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L356) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrVochainOverloaded.md b/docs/sdk/reference/classes/ErrVochainOverloaded.md new file mode 100644 index 000000000..efd1397bc --- /dev/null +++ b/docs/sdk/reference/classes/ErrVochainOverloaded.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrVochainOverloaded + +# Class: ErrVochainOverloaded + +## Hierarchy + +- `Error` + + ↳ **`ErrVochainOverloaded`** + +## Table of contents + +### Constructors + +- [constructor](ErrVochainOverloaded#constructor) + +### Methods + +- [captureStackTrace](ErrVochainOverloaded#capturestacktrace) + +### Properties + +- [cause](ErrVochainOverloaded#cause) +- [message](ErrVochainOverloaded#message) +- [name](ErrVochainOverloaded#name) +- [stack](ErrVochainOverloaded#stack) +- [prepareStackTrace](ErrVochainOverloaded#preparestacktrace) +- [stackTraceLimit](ErrVochainOverloaded#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrVochainOverloaded**(`message?`): [`ErrVochainOverloaded`](ErrVochainOverloaded) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrVochainOverloaded`](ErrVochainOverloaded) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:512](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L512) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrVochainReturnedErrorCode.md b/docs/sdk/reference/classes/ErrVochainReturnedErrorCode.md new file mode 100644 index 000000000..7231d8437 --- /dev/null +++ b/docs/sdk/reference/classes/ErrVochainReturnedErrorCode.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrVochainReturnedErrorCode + +# Class: ErrVochainReturnedErrorCode + +## Hierarchy + +- `Error` + + ↳ **`ErrVochainReturnedErrorCode`** + +## Table of contents + +### Constructors + +- [constructor](ErrVochainReturnedErrorCode#constructor) + +### Methods + +- [captureStackTrace](ErrVochainReturnedErrorCode#capturestacktrace) + +### Properties + +- [cause](ErrVochainReturnedErrorCode#cause) +- [message](ErrVochainReturnedErrorCode#message) +- [name](ErrVochainReturnedErrorCode#name) +- [stack](ErrVochainReturnedErrorCode#stack) +- [prepareStackTrace](ErrVochainReturnedErrorCode#preparestacktrace) +- [stackTraceLimit](ErrVochainReturnedErrorCode#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrVochainReturnedErrorCode**(`message?`): [`ErrVochainReturnedErrorCode`](ErrVochainReturnedErrorCode) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrVochainReturnedErrorCode`](ErrVochainReturnedErrorCode) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:362](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L362) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrVochainReturnedInvalidElectionID.md b/docs/sdk/reference/classes/ErrVochainReturnedInvalidElectionID.md new file mode 100644 index 000000000..a7ef173e6 --- /dev/null +++ b/docs/sdk/reference/classes/ErrVochainReturnedInvalidElectionID.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrVochainReturnedInvalidElectionID + +# Class: ErrVochainReturnedInvalidElectionID + +## Hierarchy + +- `Error` + + ↳ **`ErrVochainReturnedInvalidElectionID`** + +## Table of contents + +### Constructors + +- [constructor](ErrVochainReturnedInvalidElectionID#constructor) + +### Methods + +- [captureStackTrace](ErrVochainReturnedInvalidElectionID#capturestacktrace) + +### Properties + +- [cause](ErrVochainReturnedInvalidElectionID#cause) +- [message](ErrVochainReturnedInvalidElectionID#message) +- [name](ErrVochainReturnedInvalidElectionID#name) +- [stack](ErrVochainReturnedInvalidElectionID#stack) +- [prepareStackTrace](ErrVochainReturnedInvalidElectionID#preparestacktrace) +- [stackTraceLimit](ErrVochainReturnedInvalidElectionID#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrVochainReturnedInvalidElectionID**(`message?`): [`ErrVochainReturnedInvalidElectionID`](ErrVochainReturnedInvalidElectionID) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrVochainReturnedInvalidElectionID`](ErrVochainReturnedInvalidElectionID) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:368](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L368) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrVochainReturnedWrongMetadataCID.md b/docs/sdk/reference/classes/ErrVochainReturnedWrongMetadataCID.md new file mode 100644 index 000000000..5c5b5dc55 --- /dev/null +++ b/docs/sdk/reference/classes/ErrVochainReturnedWrongMetadataCID.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrVochainReturnedWrongMetadataCID + +# Class: ErrVochainReturnedWrongMetadataCID + +## Hierarchy + +- `Error` + + ↳ **`ErrVochainReturnedWrongMetadataCID`** + +## Table of contents + +### Constructors + +- [constructor](ErrVochainReturnedWrongMetadataCID#constructor) + +### Methods + +- [captureStackTrace](ErrVochainReturnedWrongMetadataCID#capturestacktrace) + +### Properties + +- [cause](ErrVochainReturnedWrongMetadataCID#cause) +- [message](ErrVochainReturnedWrongMetadataCID#message) +- [name](ErrVochainReturnedWrongMetadataCID#name) +- [stack](ErrVochainReturnedWrongMetadataCID#stack) +- [prepareStackTrace](ErrVochainReturnedWrongMetadataCID#preparestacktrace) +- [stackTraceLimit](ErrVochainReturnedWrongMetadataCID#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrVochainReturnedWrongMetadataCID**(`message?`): [`ErrVochainReturnedWrongMetadataCID`](ErrVochainReturnedWrongMetadataCID) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrVochainReturnedWrongMetadataCID`](ErrVochainReturnedWrongMetadataCID) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:374](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L374) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrVochainSendTxFailed.md b/docs/sdk/reference/classes/ErrVochainSendTxFailed.md new file mode 100644 index 000000000..fcf08d797 --- /dev/null +++ b/docs/sdk/reference/classes/ErrVochainSendTxFailed.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrVochainSendTxFailed + +# Class: ErrVochainSendTxFailed + +## Hierarchy + +- `Error` + + ↳ **`ErrVochainSendTxFailed`** + +## Table of contents + +### Constructors + +- [constructor](ErrVochainSendTxFailed#constructor) + +### Methods + +- [captureStackTrace](ErrVochainSendTxFailed#capturestacktrace) + +### Properties + +- [cause](ErrVochainSendTxFailed#cause) +- [message](ErrVochainSendTxFailed#message) +- [name](ErrVochainSendTxFailed#name) +- [stack](ErrVochainSendTxFailed#stack) +- [prepareStackTrace](ErrVochainSendTxFailed#preparestacktrace) +- [stackTraceLimit](ErrVochainSendTxFailed#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrVochainSendTxFailed**(`message?`): [`ErrVochainSendTxFailed`](ErrVochainSendTxFailed) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrVochainSendTxFailed`](ErrVochainSendTxFailed) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:350](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L350) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrVoteIDMalformed.md b/docs/sdk/reference/classes/ErrVoteIDMalformed.md new file mode 100644 index 000000000..e39384247 --- /dev/null +++ b/docs/sdk/reference/classes/ErrVoteIDMalformed.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrVoteIDMalformed + +# Class: ErrVoteIDMalformed + +## Hierarchy + +- `Error` + + ↳ **`ErrVoteIDMalformed`** + +## Table of contents + +### Constructors + +- [constructor](ErrVoteIDMalformed#constructor) + +### Methods + +- [captureStackTrace](ErrVoteIDMalformed#capturestacktrace) + +### Properties + +- [cause](ErrVoteIDMalformed#cause) +- [message](ErrVoteIDMalformed#message) +- [name](ErrVoteIDMalformed#name) +- [stack](ErrVoteIDMalformed#stack) +- [prepareStackTrace](ErrVoteIDMalformed#preparestacktrace) +- [stackTraceLimit](ErrVoteIDMalformed#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrVoteIDMalformed**(`message?`): [`ErrVoteIDMalformed`](ErrVoteIDMalformed) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrVoteIDMalformed`](ErrVoteIDMalformed) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:134](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L134) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrVoteNotFound.md b/docs/sdk/reference/classes/ErrVoteNotFound.md new file mode 100644 index 000000000..6e15e5f5c --- /dev/null +++ b/docs/sdk/reference/classes/ErrVoteNotFound.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrVoteNotFound + +# Class: ErrVoteNotFound + +## Hierarchy + +- `Error` + + ↳ **`ErrVoteNotFound`** + +## Table of contents + +### Constructors + +- [constructor](ErrVoteNotFound#constructor) + +### Methods + +- [captureStackTrace](ErrVoteNotFound#capturestacktrace) + +### Properties + +- [cause](ErrVoteNotFound#cause) +- [message](ErrVoteNotFound#message) +- [name](ErrVoteNotFound#name) +- [stack](ErrVoteNotFound#stack) +- [prepareStackTrace](ErrVoteNotFound#preparestacktrace) +- [stackTraceLimit](ErrVoteNotFound#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrVoteNotFound**(`message?`): [`ErrVoteNotFound`](ErrVoteNotFound) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrVoteNotFound`](ErrVoteNotFound) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L140) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrWalletNotFound.md b/docs/sdk/reference/classes/ErrWalletNotFound.md new file mode 100644 index 000000000..3cc95148f --- /dev/null +++ b/docs/sdk/reference/classes/ErrWalletNotFound.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrWalletNotFound + +# Class: ErrWalletNotFound + +## Hierarchy + +- `Error` + + ↳ **`ErrWalletNotFound`** + +## Table of contents + +### Constructors + +- [constructor](ErrWalletNotFound#constructor) + +### Methods + +- [captureStackTrace](ErrWalletNotFound#capturestacktrace) + +### Properties + +- [cause](ErrWalletNotFound#cause) +- [message](ErrWalletNotFound#message) +- [name](ErrWalletNotFound#name) +- [stack](ErrWalletNotFound#stack) +- [prepareStackTrace](ErrWalletNotFound#preparestacktrace) +- [stackTraceLimit](ErrWalletNotFound#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrWalletNotFound**(`message?`): [`ErrWalletNotFound`](ErrWalletNotFound) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrWalletNotFound`](ErrWalletNotFound) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:242](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L242) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/ErrWalletPrivKeyAlreadyExists.md b/docs/sdk/reference/classes/ErrWalletPrivKeyAlreadyExists.md new file mode 100644 index 000000000..b4d63f933 --- /dev/null +++ b/docs/sdk/reference/classes/ErrWalletPrivKeyAlreadyExists.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / ErrWalletPrivKeyAlreadyExists + +# Class: ErrWalletPrivKeyAlreadyExists + +## Hierarchy + +- `Error` + + ↳ **`ErrWalletPrivKeyAlreadyExists`** + +## Table of contents + +### Constructors + +- [constructor](ErrWalletPrivKeyAlreadyExists#constructor) + +### Methods + +- [captureStackTrace](ErrWalletPrivKeyAlreadyExists#capturestacktrace) + +### Properties + +- [cause](ErrWalletPrivKeyAlreadyExists#cause) +- [message](ErrWalletPrivKeyAlreadyExists#message) +- [name](ErrWalletPrivKeyAlreadyExists#name) +- [stack](ErrWalletPrivKeyAlreadyExists#stack) +- [prepareStackTrace](ErrWalletPrivKeyAlreadyExists#preparestacktrace) +- [stackTraceLimit](ErrWalletPrivKeyAlreadyExists#stacktracelimit) + +## Constructors + +### constructor + +• **new ErrWalletPrivKeyAlreadyExists**(`message?`): [`ErrWalletPrivKeyAlreadyExists`](ErrWalletPrivKeyAlreadyExists) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`ErrWalletPrivKeyAlreadyExists`](ErrWalletPrivKeyAlreadyExists) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/errors.ts:248](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/errors.ts#L248) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/FaucetAPI.md b/docs/sdk/reference/classes/FaucetAPI.md index 931c96f44..871f01815 100644 --- a/docs/sdk/reference/classes/FaucetAPI.md +++ b/docs/sdk/reference/classes/FaucetAPI.md @@ -4,7 +4,7 @@ ## Hierarchy -- `API` +- [`API`](API) ↳ **`FaucetAPI`** @@ -35,4 +35,4 @@ Calls the collect tokens method. #### Defined in -[api/faucet.ts:34](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/faucet.ts#L34) +[src/api/faucet.ts:34](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/faucet.ts#L34) diff --git a/docs/sdk/reference/classes/FaucetService.md b/docs/sdk/reference/classes/FaucetService.md index 2114cac24..d4b6ad00c 100644 --- a/docs/sdk/reference/classes/FaucetService.md +++ b/docs/sdk/reference/classes/FaucetService.md @@ -52,7 +52,7 @@ Service.constructor #### Defined in -[services/faucet.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/faucet.ts#L38) +[src/services/faucet.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/faucet.ts#L38) ## Methods @@ -76,7 +76,7 @@ The encoded faucet package #### Defined in -[services/faucet.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/faucet.ts#L49) +[src/services/faucet.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/faucet.ts#L49) ___ @@ -98,7 +98,7 @@ Parses a faucet package. #### Defined in -[services/faucet.ts:58](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/faucet.ts#L58) +[src/services/faucet.ts:58](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/faucet.ts#L58) ## Properties @@ -112,7 +112,7 @@ FaucetServiceProperties.token\_limit #### Defined in -[services/faucet.ts:31](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/faucet.ts#L31) +[src/services/faucet.ts:31](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/faucet.ts#L31) ___ @@ -126,4 +126,4 @@ ___ #### Defined in -[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/service.ts#L6) +[src/services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/service.ts#L6) diff --git a/docs/sdk/reference/classes/FileAPI.md b/docs/sdk/reference/classes/FileAPI.md index f67c140ef..22d6a70ba 100644 --- a/docs/sdk/reference/classes/FileAPI.md +++ b/docs/sdk/reference/classes/FileAPI.md @@ -4,7 +4,7 @@ ## Hierarchy -- `API` +- [`API`](API) ↳ **`FileAPI`** @@ -37,4 +37,4 @@ promised IFileCIDResponse #### Defined in -[api/file.ts:30](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/file.ts#L30) +[src/api/file.ts:30](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/file.ts#L30) diff --git a/docs/sdk/reference/classes/FileService.md b/docs/sdk/reference/classes/FileService.md index 837efcd9e..bd4d3571c 100644 --- a/docs/sdk/reference/classes/FileService.md +++ b/docs/sdk/reference/classes/FileService.md @@ -50,7 +50,7 @@ Service.constructor #### Defined in -[services/file.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/file.ts#L16) +[src/services/file.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/file.ts#L16) ## Methods @@ -74,7 +74,7 @@ Resulting CID #### Defined in -[services/file.ts:27](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/file.ts#L27) +[src/services/file.ts:27](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/file.ts#L27) ## Properties @@ -88,4 +88,4 @@ Resulting CID #### Defined in -[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/service.ts#L6) +[src/services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/service.ts#L6) diff --git a/docs/sdk/reference/classes/GenericInternalServerError.md b/docs/sdk/reference/classes/GenericInternalServerError.md new file mode 100644 index 000000000..492cac9af --- /dev/null +++ b/docs/sdk/reference/classes/GenericInternalServerError.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / GenericInternalServerError + +# Class: GenericInternalServerError + +## Hierarchy + +- `Error` + + ↳ **`GenericInternalServerError`** + +## Table of contents + +### Constructors + +- [constructor](GenericInternalServerError#constructor) + +### Methods + +- [captureStackTrace](GenericInternalServerError#capturestacktrace) + +### Properties + +- [cause](GenericInternalServerError#cause) +- [message](GenericInternalServerError#message) +- [name](GenericInternalServerError#name) +- [stack](GenericInternalServerError#stack) +- [prepareStackTrace](GenericInternalServerError#preparestacktrace) +- [stackTraceLimit](GenericInternalServerError#stacktracelimit) + +## Constructors + +### constructor + +• **new GenericInternalServerError**(`message?`): [`GenericInternalServerError`](GenericInternalServerError) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`GenericInternalServerError`](GenericInternalServerError) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/saas/errors.ts:86](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/saas/errors.ts#L86) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/InvalidElection.md b/docs/sdk/reference/classes/InvalidElection.md index 80583fe4d..4e66ec106 100644 --- a/docs/sdk/reference/classes/InvalidElection.md +++ b/docs/sdk/reference/classes/InvalidElection.md @@ -27,7 +27,7 @@ Represents an invalid election #### Defined in -[types/election/invalid.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/invalid.ts#L20) +[src/types/election/invalid.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/invalid.ts#L20) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[types/election/invalid.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/invalid.ts#L24) +[src/types/election/invalid.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/invalid.ts#L24) ## Constructors @@ -63,4 +63,4 @@ Constructs an invalid election #### Defined in -[types/election/invalid.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/invalid.ts#L16) +[src/types/election/invalid.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/invalid.ts#L16) diff --git a/docs/sdk/reference/classes/InvalidTxFormatError.md b/docs/sdk/reference/classes/InvalidTxFormatError.md new file mode 100644 index 000000000..d08917576 --- /dev/null +++ b/docs/sdk/reference/classes/InvalidTxFormatError.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / InvalidTxFormatError + +# Class: InvalidTxFormatError + +## Hierarchy + +- `Error` + + ↳ **`InvalidTxFormatError`** + +## Table of contents + +### Constructors + +- [constructor](InvalidTxFormatError#constructor) + +### Methods + +- [captureStackTrace](InvalidTxFormatError#capturestacktrace) + +### Properties + +- [cause](InvalidTxFormatError#cause) +- [message](InvalidTxFormatError#message) +- [name](InvalidTxFormatError#name) +- [stack](InvalidTxFormatError#stack) +- [prepareStackTrace](InvalidTxFormatError#preparestacktrace) +- [stackTraceLimit](InvalidTxFormatError#stacktracelimit) + +## Constructors + +### constructor + +• **new InvalidTxFormatError**(`message?`): [`InvalidTxFormatError`](InvalidTxFormatError) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`InvalidTxFormatError`](InvalidTxFormatError) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/saas/errors.ts:44](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/saas/errors.ts#L44) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/InvalidUserDataError.md b/docs/sdk/reference/classes/InvalidUserDataError.md new file mode 100644 index 000000000..b6fce7c5f --- /dev/null +++ b/docs/sdk/reference/classes/InvalidUserDataError.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / InvalidUserDataError + +# Class: InvalidUserDataError + +## Hierarchy + +- `Error` + + ↳ **`InvalidUserDataError`** + +## Table of contents + +### Constructors + +- [constructor](InvalidUserDataError#constructor) + +### Methods + +- [captureStackTrace](InvalidUserDataError#capturestacktrace) + +### Properties + +- [cause](InvalidUserDataError#cause) +- [message](InvalidUserDataError#message) +- [name](InvalidUserDataError#name) +- [stack](InvalidUserDataError#stack) +- [prepareStackTrace](InvalidUserDataError#preparestacktrace) +- [stackTraceLimit](InvalidUserDataError#stacktracelimit) + +## Constructors + +### constructor + +• **new InvalidUserDataError**(`message?`): [`InvalidUserDataError`](InvalidUserDataError) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`InvalidUserDataError`](InvalidUserDataError) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/saas/errors.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/saas/errors.ts#L32) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/MalformedBodyError.md b/docs/sdk/reference/classes/MalformedBodyError.md new file mode 100644 index 000000000..146c8c384 --- /dev/null +++ b/docs/sdk/reference/classes/MalformedBodyError.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / MalformedBodyError + +# Class: MalformedBodyError + +## Hierarchy + +- `Error` + + ↳ **`MalformedBodyError`** + +## Table of contents + +### Constructors + +- [constructor](MalformedBodyError#constructor) + +### Methods + +- [captureStackTrace](MalformedBodyError#capturestacktrace) + +### Properties + +- [cause](MalformedBodyError#cause) +- [message](MalformedBodyError#message) +- [name](MalformedBodyError#name) +- [stack](MalformedBodyError#stack) +- [prepareStackTrace](MalformedBodyError#preparestacktrace) +- [stackTraceLimit](MalformedBodyError#stacktracelimit) + +## Constructors + +### constructor + +• **new MalformedBodyError**(`message?`): [`MalformedBodyError`](MalformedBodyError) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`MalformedBodyError`](MalformedBodyError) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/saas/errors.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/saas/errors.ts#L20) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/MalformedURLParamError.md b/docs/sdk/reference/classes/MalformedURLParamError.md new file mode 100644 index 000000000..3d350213f --- /dev/null +++ b/docs/sdk/reference/classes/MalformedURLParamError.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / MalformedURLParamError + +# Class: MalformedURLParamError + +## Hierarchy + +- `Error` + + ↳ **`MalformedURLParamError`** + +## Table of contents + +### Constructors + +- [constructor](MalformedURLParamError#constructor) + +### Methods + +- [captureStackTrace](MalformedURLParamError#capturestacktrace) + +### Properties + +- [cause](MalformedURLParamError#cause) +- [message](MalformedURLParamError#message) +- [name](MalformedURLParamError#name) +- [stack](MalformedURLParamError#stack) +- [prepareStackTrace](MalformedURLParamError#preparestacktrace) +- [stackTraceLimit](MalformedURLParamError#stacktracelimit) + +## Constructors + +### constructor + +• **new MalformedURLParamError**(`message?`): [`MalformedURLParamError`](MalformedURLParamError) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`MalformedURLParamError`](MalformedURLParamError) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/saas/errors.ts:62](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/saas/errors.ts#L62) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/MarshalingServerJSONFailedError.md b/docs/sdk/reference/classes/MarshalingServerJSONFailedError.md new file mode 100644 index 000000000..2bc6ed9e5 --- /dev/null +++ b/docs/sdk/reference/classes/MarshalingServerJSONFailedError.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / MarshalingServerJSONFailedError + +# Class: MarshalingServerJSONFailedError + +## Hierarchy + +- `Error` + + ↳ **`MarshalingServerJSONFailedError`** + +## Table of contents + +### Constructors + +- [constructor](MarshalingServerJSONFailedError#constructor) + +### Methods + +- [captureStackTrace](MarshalingServerJSONFailedError#capturestacktrace) + +### Properties + +- [cause](MarshalingServerJSONFailedError#cause) +- [message](MarshalingServerJSONFailedError#message) +- [name](MarshalingServerJSONFailedError#name) +- [stack](MarshalingServerJSONFailedError#stack) +- [prepareStackTrace](MarshalingServerJSONFailedError#preparestacktrace) +- [stackTraceLimit](MarshalingServerJSONFailedError#stacktracelimit) + +## Constructors + +### constructor + +• **new MarshalingServerJSONFailedError**(`message?`): [`MarshalingServerJSONFailedError`](MarshalingServerJSONFailedError) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`MarshalingServerJSONFailedError`](MarshalingServerJSONFailedError) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/saas/errors.ts:80](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/saas/errors.ts#L80) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/MultiChoiceElection.md b/docs/sdk/reference/classes/MultiChoiceElection.md index 9688f5cd3..927030715 100644 --- a/docs/sdk/reference/classes/MultiChoiceElection.md +++ b/docs/sdk/reference/classes/MultiChoiceElection.md @@ -26,6 +26,7 @@ Represents a multi choice election - [maxCensusSize](MultiChoiceElection#maxcensussize) - [maxNumberOfChoices](MultiChoiceElection#maxnumberofchoices) - [meta](MultiChoiceElection#meta) +- [minNumberOfChoices](MultiChoiceElection#minnumberofchoices) - [questions](MultiChoiceElection#questions) - [startDate](MultiChoiceElection#startdate) - [streamUri](MultiChoiceElection#streamuri) @@ -66,7 +67,7 @@ UnpublishedElection.addSDKVersion #### Defined in -[types/election/unpublished.ts:287](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L287) +[src/types/election/unpublished.ts:291](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L291) • `set` **addSDKVersion**(`value`): `void` @@ -86,7 +87,7 @@ UnpublishedElection.addSDKVersion #### Defined in -[types/election/unpublished.ts:291](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L291) +[src/types/election/unpublished.ts:295](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L295) ___ @@ -100,7 +101,7 @@ ___ #### Defined in -[types/election/multichoice.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/multichoice.ts#L124) +[src/types/election/multichoice.ts:152](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/multichoice.ts#L152) • `set` **canAbstain**(`value`): `void` @@ -116,7 +117,7 @@ ___ #### Defined in -[types/election/multichoice.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/multichoice.ts#L128) +[src/types/election/multichoice.ts:156](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/multichoice.ts#L156) ___ @@ -130,7 +131,7 @@ ___ #### Defined in -[types/election/multichoice.ts:116](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/multichoice.ts#L116) +[src/types/election/multichoice.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/multichoice.ts#L144) • `set` **canRepeatChoices**(`value`): `void` @@ -146,7 +147,7 @@ ___ #### Defined in -[types/election/multichoice.ts:120](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/multichoice.ts#L120) +[src/types/election/multichoice.ts:148](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/multichoice.ts#L148) ___ @@ -164,7 +165,7 @@ UnpublishedElection.census #### Defined in -[types/election/unpublished.ts:261](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L261) +[src/types/election/unpublished.ts:265](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L265) • `set` **census**(`value`): `void` @@ -184,7 +185,7 @@ UnpublishedElection.census #### Defined in -[types/election/unpublished.ts:265](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L265) +[src/types/election/unpublished.ts:269](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L269) ___ @@ -202,7 +203,7 @@ UnpublishedElection.description #### Defined in -[types/election/unpublished.ts:185](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L185) +[src/types/election/unpublished.ts:189](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L189) • `set` **description**(`value`): `void` @@ -222,7 +223,7 @@ UnpublishedElection.description #### Defined in -[types/election/unpublished.ts:189](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L189) +[src/types/election/unpublished.ts:193](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L193) ___ @@ -240,7 +241,7 @@ UnpublishedElection.duration #### Defined in -[types/election/unpublished.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L150) +[src/types/election/unpublished.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L155) ___ @@ -258,7 +259,7 @@ UnpublishedElection.electionType #### Defined in -[types/election/unpublished.ts:237](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L237) +[src/types/election/unpublished.ts:241](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L241) • `set` **electionType**(`value`): `void` @@ -278,7 +279,7 @@ UnpublishedElection.electionType #### Defined in -[types/election/unpublished.ts:241](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L241) +[src/types/election/unpublished.ts:245](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L245) ___ @@ -296,7 +297,7 @@ UnpublishedElection.endDate #### Defined in -[types/election/unpublished.ts:227](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L227) +[src/types/election/unpublished.ts:231](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L231) • `set` **endDate**(`value`): `void` @@ -316,7 +317,7 @@ UnpublishedElection.endDate #### Defined in -[types/election/unpublished.ts:231](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L231) +[src/types/election/unpublished.ts:235](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L235) ___ @@ -334,7 +335,7 @@ UnpublishedElection.header #### Defined in -[types/election/unpublished.ts:193](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L193) +[src/types/election/unpublished.ts:197](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L197) • `set` **header**(`value`): `void` @@ -354,7 +355,7 @@ UnpublishedElection.header #### Defined in -[types/election/unpublished.ts:197](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L197) +[src/types/election/unpublished.ts:201](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L201) ___ @@ -372,7 +373,7 @@ UnpublishedElection.maxCensusSize #### Defined in -[types/election/unpublished.ts:270](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L270) +[src/types/election/unpublished.ts:274](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L274) • `set` **maxCensusSize**(`value`): `void` @@ -392,7 +393,7 @@ UnpublishedElection.maxCensusSize #### Defined in -[types/election/unpublished.ts:274](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L274) +[src/types/election/unpublished.ts:278](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L278) ___ @@ -406,7 +407,7 @@ ___ #### Defined in -[types/election/multichoice.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/multichoice.ts#L108) +[src/types/election/multichoice.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/multichoice.ts#L128) • `set` **maxNumberOfChoices**(`value`): `void` @@ -422,7 +423,7 @@ ___ #### Defined in -[types/election/multichoice.ts:112](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/multichoice.ts#L112) +[src/types/election/multichoice.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/multichoice.ts#L132) ___ @@ -440,7 +441,7 @@ UnpublishedElection.meta #### Defined in -[types/election/unpublished.ts:209](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L209) +[src/types/election/unpublished.ts:213](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L213) • `set` **meta**(`value`): `void` @@ -460,7 +461,37 @@ UnpublishedElection.meta #### Defined in -[types/election/unpublished.ts:213](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L213) +[src/types/election/unpublished.ts:217](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L217) + +___ + +### minNumberOfChoices + +• `get` **minNumberOfChoices**(): `number` + +#### Returns + +`number` + +#### Defined in + +[src/types/election/multichoice.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/multichoice.ts#L136) + +• `set` **minNumberOfChoices**(`value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `number` | + +#### Returns + +`void` + +#### Defined in + +[src/types/election/multichoice.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/multichoice.ts#L140) ___ @@ -478,7 +509,7 @@ UnpublishedElection.questions #### Defined in -[types/election/unpublished.ts:253](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L253) +[src/types/election/unpublished.ts:257](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L257) • `set` **questions**(`value`): `void` @@ -498,7 +529,7 @@ UnpublishedElection.questions #### Defined in -[types/election/unpublished.ts:257](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L257) +[src/types/election/unpublished.ts:261](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L261) ___ @@ -516,7 +547,7 @@ UnpublishedElection.startDate #### Defined in -[types/election/unpublished.ts:218](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L218) +[src/types/election/unpublished.ts:222](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L222) • `set` **startDate**(`value`): `void` @@ -536,7 +567,7 @@ UnpublishedElection.startDate #### Defined in -[types/election/unpublished.ts:222](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L222) +[src/types/election/unpublished.ts:226](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L226) ___ @@ -554,7 +585,7 @@ UnpublishedElection.streamUri #### Defined in -[types/election/unpublished.ts:201](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L201) +[src/types/election/unpublished.ts:205](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L205) • `set` **streamUri**(`value`): `void` @@ -574,7 +605,7 @@ UnpublishedElection.streamUri #### Defined in -[types/election/unpublished.ts:205](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L205) +[src/types/election/unpublished.ts:209](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L209) ___ @@ -592,7 +623,7 @@ UnpublishedElection.temporarySecretIdentity #### Defined in -[types/election/unpublished.ts:279](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L279) +[src/types/election/unpublished.ts:283](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L283) • `set` **temporarySecretIdentity**(`value`): `void` @@ -612,7 +643,7 @@ UnpublishedElection.temporarySecretIdentity #### Defined in -[types/election/unpublished.ts:283](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L283) +[src/types/election/unpublished.ts:287](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L287) ___ @@ -630,7 +661,7 @@ UnpublishedElection.title #### Defined in -[types/election/unpublished.ts:176](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L176) +[src/types/election/unpublished.ts:180](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L180) • `set` **title**(`value`): `void` @@ -650,7 +681,7 @@ UnpublishedElection.title #### Defined in -[types/election/unpublished.ts:180](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L180) +[src/types/election/unpublished.ts:184](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L184) ___ @@ -668,7 +699,7 @@ UnpublishedElection.voteType #### Defined in -[types/election/unpublished.ts:245](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L245) +[src/types/election/unpublished.ts:249](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L249) • `set` **voteType**(`value`): `void` @@ -688,7 +719,7 @@ UnpublishedElection.voteType #### Defined in -[types/election/unpublished.ts:249](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L249) +[src/types/election/unpublished.ts:253](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L253) ## Constructors @@ -714,13 +745,13 @@ Constructs a multi choice election #### Defined in -[types/election/multichoice.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/multichoice.ts#L24) +[src/types/election/multichoice.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/multichoice.ts#L32) ## Methods ### addQuestion -▸ **addQuestion**(`title`, `description`, `choices`): [`UnpublishedElection`](UnpublishedElection) +▸ **addQuestion**(`title`, `description`, `choices`, `meta?`): [`UnpublishedElection`](UnpublishedElection) #### Parameters @@ -728,7 +759,8 @@ Constructs a multi choice election | :------ | :------ | | `title` | `string` \| `MultiLanguage`\<`string`\> | | `description` | `string` \| `MultiLanguage`\<`string`\> | -| `choices` | (\{ `title`: `string` } \| \{ `title`: `MultiLanguage`\<`string`\> })[] | +| `choices` | ([`Choice`](../sdk-reference#choice) \| \{ `meta?`: `any` ; `title`: `string` ; `value?`: `number` })[] | +| `meta?` | `any` | #### Returns @@ -740,7 +772,7 @@ Constructs a multi choice election #### Defined in -[types/election/multichoice.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/multichoice.ts#L35) +[src/types/election/multichoice.ts:44](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/multichoice.ts#L44) ___ @@ -758,7 +790,7 @@ ___ #### Defined in -[types/election/multichoice.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/multichoice.ts#L65) +[src/types/election/multichoice.ts:77](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/multichoice.ts#L77) ___ @@ -776,7 +808,7 @@ ___ #### Defined in -[types/election/multichoice.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/multichoice.ts#L75) +[src/types/election/multichoice.ts:87](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/multichoice.ts#L87) ___ @@ -794,7 +826,7 @@ ___ #### Defined in -[types/election/unpublished.ts:166](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L166) +[src/types/election/unpublished.ts:171](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L171) ___ @@ -812,7 +844,7 @@ ___ #### Defined in -[types/election/multichoice.ts:54](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/multichoice.ts#L54) +[src/types/election/multichoice.ts:66](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/multichoice.ts#L66) ___ @@ -836,7 +868,7 @@ ___ #### Defined in -[types/election/election.ts:279](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L279) +[src/types/election/election.ts:275](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L275) ___ @@ -860,7 +892,7 @@ ___ #### Defined in -[types/election/unpublished.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L61) +[src/types/election/unpublished.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L65) ___ @@ -878,13 +910,13 @@ ___ #### Defined in -[types/election/unpublished.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L128) +[src/types/election/unpublished.ts:133](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L133) ___ ### checkVote -▸ **checkVote**(`vote`, `voteType`): `void` +▸ **checkVote**(`vote`, `voteType`, `voteProperties`): `void` #### Parameters @@ -892,6 +924,7 @@ ___ | :------ | :------ | | `vote` | [`Vote`](Vote) | | `voteType` | [`IVoteType`](../interfaces/IVoteType) | +| `voteProperties` | [`ChoiceProperties`](../sdk-reference#choiceproperties) | #### Returns @@ -899,7 +932,7 @@ ___ #### Defined in -[types/election/multichoice.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/multichoice.ts#L92) +[src/types/election/multichoice.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/multichoice.ts#L108) ___ @@ -925,4 +958,4 @@ Returns an unpublished election object #### Defined in -[types/election/multichoice.ts:31](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/multichoice.ts#L31) +[src/types/election/multichoice.ts:40](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/multichoice.ts#L40) diff --git a/docs/sdk/reference/classes/NoOrganizationProvidedError.md b/docs/sdk/reference/classes/NoOrganizationProvidedError.md new file mode 100644 index 000000000..6a59d91a7 --- /dev/null +++ b/docs/sdk/reference/classes/NoOrganizationProvidedError.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / NoOrganizationProvidedError + +# Class: NoOrganizationProvidedError + +## Hierarchy + +- `Error` + + ↳ **`NoOrganizationProvidedError`** + +## Table of contents + +### Constructors + +- [constructor](NoOrganizationProvidedError#constructor) + +### Methods + +- [captureStackTrace](NoOrganizationProvidedError#capturestacktrace) + +### Properties + +- [cause](NoOrganizationProvidedError#cause) +- [message](NoOrganizationProvidedError#message) +- [name](NoOrganizationProvidedError#name) +- [stack](NoOrganizationProvidedError#stack) +- [prepareStackTrace](NoOrganizationProvidedError#preparestacktrace) +- [stackTraceLimit](NoOrganizationProvidedError#stacktracelimit) + +## Constructors + +### constructor + +• **new NoOrganizationProvidedError**(`message?`): [`NoOrganizationProvidedError`](NoOrganizationProvidedError) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`NoOrganizationProvidedError`](NoOrganizationProvidedError) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/saas/errors.ts:68](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/saas/errors.ts#L68) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/NoOrganizationsError.md b/docs/sdk/reference/classes/NoOrganizationsError.md new file mode 100644 index 000000000..221e0b33b --- /dev/null +++ b/docs/sdk/reference/classes/NoOrganizationsError.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / NoOrganizationsError + +# Class: NoOrganizationsError + +## Hierarchy + +- `Error` + + ↳ **`NoOrganizationsError`** + +## Table of contents + +### Constructors + +- [constructor](NoOrganizationsError#constructor) + +### Methods + +- [captureStackTrace](NoOrganizationsError#capturestacktrace) + +### Properties + +- [cause](NoOrganizationsError#cause) +- [message](NoOrganizationsError#message) +- [name](NoOrganizationsError#name) +- [stack](NoOrganizationsError#stack) +- [prepareStackTrace](NoOrganizationsError#preparestacktrace) +- [stackTraceLimit](NoOrganizationsError#stacktracelimit) + +## Constructors + +### constructor + +• **new NoOrganizationsError**(`message?`): [`NoOrganizationsError`](NoOrganizationsError) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`NoOrganizationsError`](NoOrganizationsError) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/saas/errors.ts:74](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/saas/errors.ts#L74) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/OffchainCensus.md b/docs/sdk/reference/classes/OffchainCensus.md index 25ba17be7..3e1e0fbdf 100644 --- a/docs/sdk/reference/classes/OffchainCensus.md +++ b/docs/sdk/reference/classes/OffchainCensus.md @@ -46,7 +46,7 @@ Census.censusId #### Defined in -[types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L35) +[src/types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L35) • `set` **censusId**(`value`): `void` @@ -66,7 +66,7 @@ Census.censusId #### Defined in -[types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L39) +[src/types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L39) ___ @@ -84,7 +84,7 @@ Census.censusURI #### Defined in -[types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L43) +[src/types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L43) • `set` **censusURI**(`value`): `void` @@ -104,7 +104,7 @@ Census.censusURI #### Defined in -[types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L47) +[src/types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L47) ___ @@ -122,7 +122,7 @@ Census.isPublished #### Defined in -[types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L75) +[src/types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L75) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[types/census/offchain.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/offchain.ts#L45) +[src/types/census/offchain.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/offchain.ts#L45) • `set` **participants**(`value`): `void` @@ -152,7 +152,7 @@ ___ #### Defined in -[types/census/offchain.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/offchain.ts#L49) +[src/types/census/offchain.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/offchain.ts#L49) ___ @@ -170,7 +170,7 @@ Census.size #### Defined in -[types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L59) +[src/types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L59) • `set` **size**(`value`): `void` @@ -190,7 +190,7 @@ Census.size #### Defined in -[types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L63) +[src/types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L63) ___ @@ -208,7 +208,7 @@ Census.type #### Defined in -[types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L51) +[src/types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L51) • `set` **type**(`value`): `void` @@ -228,7 +228,7 @@ Census.type #### Defined in -[types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L55) +[src/types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L55) ___ @@ -246,7 +246,7 @@ Census.weight #### Defined in -[types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L67) +[src/types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L67) • `set` **weight**(`value`): `void` @@ -266,7 +266,7 @@ Census.weight #### Defined in -[types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L71) +[src/types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L71) ## Methods @@ -291,4 +291,4 @@ Census.weight #### Defined in -[types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L81) +[src/types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L81) diff --git a/docs/sdk/reference/classes/OrganizationNotFoundError.md b/docs/sdk/reference/classes/OrganizationNotFoundError.md new file mode 100644 index 000000000..088a02685 --- /dev/null +++ b/docs/sdk/reference/classes/OrganizationNotFoundError.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / OrganizationNotFoundError + +# Class: OrganizationNotFoundError + +## Hierarchy + +- `Error` + + ↳ **`OrganizationNotFoundError`** + +## Table of contents + +### Constructors + +- [constructor](OrganizationNotFoundError#constructor) + +### Methods + +- [captureStackTrace](OrganizationNotFoundError#capturestacktrace) + +### Properties + +- [cause](OrganizationNotFoundError#cause) +- [message](OrganizationNotFoundError#message) +- [name](OrganizationNotFoundError#name) +- [stack](OrganizationNotFoundError#stack) +- [prepareStackTrace](OrganizationNotFoundError#preparestacktrace) +- [stackTraceLimit](OrganizationNotFoundError#stacktracelimit) + +## Constructors + +### constructor + +• **new OrganizationNotFoundError**(`message?`): [`OrganizationNotFoundError`](OrganizationNotFoundError) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`OrganizationNotFoundError`](OrganizationNotFoundError) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/saas/errors.ts:56](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/saas/errors.ts#L56) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/PasswordTooShortError.md b/docs/sdk/reference/classes/PasswordTooShortError.md new file mode 100644 index 000000000..f74b4c931 --- /dev/null +++ b/docs/sdk/reference/classes/PasswordTooShortError.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / PasswordTooShortError + +# Class: PasswordTooShortError + +## Hierarchy + +- `Error` + + ↳ **`PasswordTooShortError`** + +## Table of contents + +### Constructors + +- [constructor](PasswordTooShortError#constructor) + +### Methods + +- [captureStackTrace](PasswordTooShortError#capturestacktrace) + +### Properties + +- [cause](PasswordTooShortError#cause) +- [message](PasswordTooShortError#message) +- [name](PasswordTooShortError#name) +- [stack](PasswordTooShortError#stack) +- [prepareStackTrace](PasswordTooShortError#preparestacktrace) +- [stackTraceLimit](PasswordTooShortError#stacktracelimit) + +## Constructors + +### constructor + +• **new PasswordTooShortError**(`message?`): [`PasswordTooShortError`](PasswordTooShortError) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`PasswordTooShortError`](PasswordTooShortError) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/saas/errors.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/saas/errors.ts#L14) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/PlainCensus.md b/docs/sdk/reference/classes/PlainCensus.md index 377d7b5f3..e05d41715 100644 --- a/docs/sdk/reference/classes/PlainCensus.md +++ b/docs/sdk/reference/classes/PlainCensus.md @@ -48,7 +48,7 @@ OffchainCensus.censusId #### Defined in -[types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L35) +[src/types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L35) • `set` **censusId**(`value`): `void` @@ -68,7 +68,7 @@ OffchainCensus.censusId #### Defined in -[types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L39) +[src/types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L39) ___ @@ -86,7 +86,7 @@ OffchainCensus.censusURI #### Defined in -[types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L43) +[src/types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L43) • `set` **censusURI**(`value`): `void` @@ -106,7 +106,7 @@ OffchainCensus.censusURI #### Defined in -[types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L47) +[src/types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L47) ___ @@ -124,7 +124,7 @@ OffchainCensus.isPublished #### Defined in -[types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L75) +[src/types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L75) ___ @@ -142,7 +142,7 @@ OffchainCensus.participants #### Defined in -[types/census/offchain.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/offchain.ts#L45) +[src/types/census/offchain.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/offchain.ts#L45) • `set` **participants**(`value`): `void` @@ -162,7 +162,7 @@ OffchainCensus.participants #### Defined in -[types/census/offchain.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/offchain.ts#L49) +[src/types/census/offchain.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/offchain.ts#L49) ___ @@ -180,7 +180,7 @@ OffchainCensus.size #### Defined in -[types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L59) +[src/types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L59) • `set` **size**(`value`): `void` @@ -200,7 +200,7 @@ OffchainCensus.size #### Defined in -[types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L63) +[src/types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L63) ___ @@ -218,7 +218,7 @@ OffchainCensus.type #### Defined in -[types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L51) +[src/types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L51) • `set` **type**(`value`): `void` @@ -238,7 +238,7 @@ OffchainCensus.type #### Defined in -[types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L55) +[src/types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L55) ___ @@ -256,7 +256,7 @@ OffchainCensus.weight #### Defined in -[types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L67) +[src/types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L67) • `set` **weight**(`value`): `void` @@ -276,7 +276,7 @@ OffchainCensus.weight #### Defined in -[types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L71) +[src/types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L71) ## Constructors @@ -296,7 +296,7 @@ OffchainCensus.constructor #### Defined in -[types/census/plain.ts:10](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/plain.ts#L10) +[src/types/census/plain.ts:10](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/plain.ts#L10) ## Methods @@ -316,7 +316,7 @@ OffchainCensus.constructor #### Defined in -[types/census/plain.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/plain.ts#L14) +[src/types/census/plain.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/plain.ts#L14) ___ @@ -336,7 +336,7 @@ ___ #### Defined in -[types/census/plain.ts:30](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/plain.ts#L30) +[src/types/census/plain.ts:30](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/plain.ts#L30) ___ @@ -361,4 +361,4 @@ ___ #### Defined in -[types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L81) +[src/types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L81) diff --git a/docs/sdk/reference/classes/PublishedCensus.md b/docs/sdk/reference/classes/PublishedCensus.md index c3da9a0e7..3467e830c 100644 --- a/docs/sdk/reference/classes/PublishedCensus.md +++ b/docs/sdk/reference/classes/PublishedCensus.md @@ -49,7 +49,7 @@ Census.censusId #### Defined in -[types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L35) +[src/types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L35) • `set` **censusId**(`value`): `void` @@ -69,7 +69,7 @@ Census.censusId #### Defined in -[types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L39) +[src/types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L39) ___ @@ -87,7 +87,7 @@ Census.censusURI #### Defined in -[types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L43) +[src/types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L43) • `set` **censusURI**(`value`): `void` @@ -107,7 +107,7 @@ Census.censusURI #### Defined in -[types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L47) +[src/types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L47) ___ @@ -125,7 +125,7 @@ Census.isPublished #### Defined in -[types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L75) +[src/types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L75) ___ @@ -143,7 +143,7 @@ Census.size #### Defined in -[types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L59) +[src/types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L59) • `set` **size**(`value`): `void` @@ -163,7 +163,7 @@ Census.size #### Defined in -[types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L63) +[src/types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L63) ___ @@ -181,7 +181,7 @@ Census.type #### Defined in -[types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L51) +[src/types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L51) • `set` **type**(`value`): `void` @@ -201,7 +201,7 @@ Census.type #### Defined in -[types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L55) +[src/types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L55) ___ @@ -219,7 +219,7 @@ Census.weight #### Defined in -[types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L67) +[src/types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L67) • `set` **weight**(`value`): `void` @@ -239,7 +239,7 @@ Census.weight #### Defined in -[types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L71) +[src/types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L71) ## Constructors @@ -269,7 +269,7 @@ Census.constructor #### Defined in -[types/census/published.ts:17](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/published.ts#L17) +[src/types/census/published.ts:17](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/published.ts#L17) ## Methods @@ -294,4 +294,4 @@ Census.constructor #### Defined in -[types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L81) +[src/types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L81) diff --git a/docs/sdk/reference/classes/PublishedElection.md b/docs/sdk/reference/classes/PublishedElection.md index 4c76a6ef6..c1573300d 100644 --- a/docs/sdk/reference/classes/PublishedElection.md +++ b/docs/sdk/reference/classes/PublishedElection.md @@ -10,8 +10,6 @@ Represents a published election ↳ **`PublishedElection`** - ↳↳ [`ArchivedElection`](ArchivedElection) - ## Table of contents ### Accessors @@ -24,7 +22,6 @@ Represents a published election - [electionType](PublishedElection#electiontype) - [endDate](PublishedElection#enddate) - [finalResults](PublishedElection#finalresults) -- [fromArchive](PublishedElection#fromarchive) - [header](PublishedElection#header) - [id](PublishedElection#id) - [isValid](PublishedElection#isvalid) @@ -74,7 +71,7 @@ Election.addSDKVersion #### Defined in -[types/election/election.ts:275](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L275) +[src/types/election/election.ts:271](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L271) ___ @@ -92,7 +89,7 @@ Election.census #### Defined in -[types/election/published.ts:179](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L179) +[src/types/election/published.ts:179](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L179) ___ @@ -106,7 +103,7 @@ ___ #### Defined in -[types/election/published.ts:219](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L219) +[src/types/election/published.ts:215](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L215) ___ @@ -120,7 +117,7 @@ ___ #### Defined in -[types/election/published.ts:223](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L223) +[src/types/election/published.ts:219](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L219) ___ @@ -138,7 +135,7 @@ Election.description #### Defined in -[types/election/published.ts:147](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L147) +[src/types/election/published.ts:147](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L147) ___ @@ -156,7 +153,7 @@ Election.electionType #### Defined in -[types/election/published.ts:167](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L167) +[src/types/election/published.ts:167](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L167) ___ @@ -174,7 +171,7 @@ Election.endDate #### Defined in -[types/election/published.ts:163](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L163) +[src/types/election/published.ts:163](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L163) ___ @@ -188,21 +185,7 @@ ___ #### Defined in -[types/election/published.ts:203](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L203) - -___ - -### fromArchive - -• `get` **fromArchive**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[types/election/published.ts:215](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L215) +[src/types/election/published.ts:203](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L203) ___ @@ -220,7 +203,7 @@ Election.header #### Defined in -[types/election/published.ts:151](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L151) +[src/types/election/published.ts:151](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L151) ___ @@ -234,7 +217,7 @@ ___ #### Defined in -[types/election/published.ts:187](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L187) +[src/types/election/published.ts:187](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L187) ___ @@ -248,7 +231,7 @@ ___ #### Defined in -[types/election/published.ts:239](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L239) +[src/types/election/published.ts:235](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L235) ___ @@ -262,7 +245,7 @@ ___ #### Defined in -[types/election/published.ts:211](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L211) +[src/types/election/published.ts:211](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L211) ___ @@ -280,7 +263,7 @@ Election.maxCensusSize #### Defined in -[types/election/published.ts:183](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L183) +[src/types/election/published.ts:183](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L183) ___ @@ -298,7 +281,7 @@ Election.meta #### Defined in -[types/election/election.ts:239](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L239) +[src/types/election/election.ts:235](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L235) ___ @@ -312,7 +295,7 @@ ___ #### Defined in -[types/election/published.ts:227](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L227) +[src/types/election/published.ts:223](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L223) ___ @@ -326,7 +309,7 @@ ___ #### Defined in -[types/election/published.ts:191](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L191) +[src/types/election/published.ts:191](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L191) ___ @@ -344,7 +327,7 @@ Election.questions #### Defined in -[types/election/published.ts:175](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L175) +[src/types/election/published.ts:175](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L175) ___ @@ -358,7 +341,7 @@ ___ #### Defined in -[types/election/published.ts:235](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L235) +[src/types/election/published.ts:231](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L231) ___ @@ -372,7 +355,7 @@ ___ #### Defined in -[types/election/published.ts:207](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L207) +[src/types/election/published.ts:207](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L207) ___ @@ -386,7 +369,7 @@ ___ #### Defined in -[types/election/published.ts:231](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L231) +[src/types/election/published.ts:227](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L227) ___ @@ -404,7 +387,7 @@ Election.startDate #### Defined in -[types/election/published.ts:159](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L159) +[src/types/election/published.ts:159](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L159) ___ @@ -418,7 +401,7 @@ ___ #### Defined in -[types/election/published.ts:195](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L195) +[src/types/election/published.ts:195](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L195) ___ @@ -436,7 +419,7 @@ Election.streamUri #### Defined in -[types/election/published.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L155) +[src/types/election/published.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L155) ___ @@ -454,7 +437,7 @@ Election.temporarySecretIdentity #### Defined in -[types/election/election.ts:271](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L271) +[src/types/election/election.ts:267](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L267) ___ @@ -472,7 +455,7 @@ Election.title #### Defined in -[types/election/published.ts:143](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L143) +[src/types/election/published.ts:143](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L143) ___ @@ -486,7 +469,7 @@ ___ #### Defined in -[types/election/published.ts:199](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L199) +[src/types/election/published.ts:199](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L199) ___ @@ -504,7 +487,7 @@ Election.voteType #### Defined in -[types/election/published.ts:171](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L171) +[src/types/election/published.ts:171](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L171) ## Constructors @@ -530,7 +513,7 @@ Election.constructor #### Defined in -[types/election/published.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L65) +[src/types/election/published.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L64) ## Methods @@ -550,7 +533,7 @@ Election.constructor #### Defined in -[types/election/published.ts:113](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L113) +[src/types/election/published.ts:111](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L111) ___ @@ -574,7 +557,7 @@ ___ #### Defined in -[types/election/election.ts:279](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L279) +[src/types/election/election.ts:275](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L275) ___ @@ -596,7 +579,7 @@ Returns a published election object #### Defined in -[types/election/published.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L100) +[src/types/election/published.ts:98](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L98) ___ @@ -617,7 +600,7 @@ ___ #### Defined in -[types/election/published.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L127) +[src/types/election/published.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L127) ___ @@ -643,7 +626,7 @@ Returns an unpublished election object #### Defined in -[types/election/election.ts:219](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L219) +[src/types/election/election.ts:215](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L215) ___ @@ -664,4 +647,4 @@ ___ #### Defined in -[types/election/published.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L104) +[src/types/election/published.ts:102](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L102) diff --git a/docs/sdk/reference/classes/RemoteSigner.md b/docs/sdk/reference/classes/RemoteSigner.md new file mode 100644 index 000000000..2ee360d17 --- /dev/null +++ b/docs/sdk/reference/classes/RemoteSigner.md @@ -0,0 +1,632 @@ +[@vocdoni/sdk](/sdk) / RemoteSigner + +# Class: RemoteSigner + +## Hierarchy + +- `Signer` + + ↳ **`RemoteSigner`** + +## Table of contents + +### Accessors + +- [address](RemoteSigner#address) +- [remoteSignerService](RemoteSigner#remotesignerservice) + +### Constructors + +- [constructor](RemoteSigner#constructor) + +### Methods + +- [\_checkProvider](RemoteSigner.md#_checkprovider) +- [call](RemoteSigner#call) +- [checkTransaction](RemoteSigner#checktransaction) +- [connect](RemoteSigner#connect) +- [estimateGas](RemoteSigner#estimategas) +- [getAddress](RemoteSigner#getaddress) +- [getBalance](RemoteSigner#getbalance) +- [getChainId](RemoteSigner#getchainid) +- [getFeeData](RemoteSigner#getfeedata) +- [getGasPrice](RemoteSigner#getgasprice) +- [getTransactionCount](RemoteSigner#gettransactioncount) +- [login](RemoteSigner#login) +- [populateTransaction](RemoteSigner#populatetransaction) +- [refresh](RemoteSigner#refresh) +- [resolveName](RemoteSigner#resolvename) +- [sendTransaction](RemoteSigner#sendtransaction) +- [signMessage](RemoteSigner#signmessage) +- [signTransaction](RemoteSigner#signtransaction) +- [signTransactionRemotely](RemoteSigner#signtransactionremotely) +- [isSigner](RemoteSigner#issigner) + +### Properties + +- [\_isSigner](RemoteSigner.md#_issigner) +- [credentials](RemoteSigner#credentials) +- [provider](RemoteSigner#provider) +- [token](RemoteSigner#token) +- [url](RemoteSigner#url) + +## Accessors + +### address + +• `get` **address**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/types/remote-signer.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/remote-signer.ts#L81) + +• `set` **address**(`value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `string` | + +#### Returns + +`void` + +#### Defined in + +[src/types/remote-signer.ts:85](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/remote-signer.ts#L85) + +___ + +### remoteSignerService + +• `get` **remoteSignerService**(): [`RemoteSignerService`](RemoteSignerService) + +#### Returns + +[`RemoteSignerService`](RemoteSignerService) + +#### Defined in + +[src/types/remote-signer.ts:73](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/remote-signer.ts#L73) + +• `set` **remoteSignerService**(`value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`RemoteSignerService`](RemoteSignerService) | + +#### Returns + +`void` + +#### Defined in + +[src/types/remote-signer.ts:77](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/remote-signer.ts#L77) + +## Constructors + +### constructor + +• **new RemoteSigner**(`params`): [`RemoteSigner`](RemoteSigner) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | `Partial`\<[`RemoteSignerProperties`](../sdk-reference#remotesignerproperties)\> | + +#### Returns + +[`RemoteSigner`](RemoteSigner) + +#### Overrides + +Signer.constructor + +#### Defined in + +[src/types/remote-signer.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/remote-signer.ts#L26) + +## Methods + +### \_checkProvider + +▸ **_checkProvider**(`operation?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `operation?` | `string` | + +#### Returns + +`void` + +#### Inherited from + +Signer.\_checkProvider + +#### Defined in + +node_modules/@ethersproject/abstract-signer/lib/index.d.ts:42 + +___ + +### call + +▸ **call**(`transaction`, `blockTag?`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transaction` | `Deferrable`\<`TransactionRequest`\> | +| `blockTag?` | `BlockTag` | + +#### Returns + +`Promise`\<`string`\> + +#### Inherited from + +Signer.call + +#### Defined in + +node_modules/@ethersproject/abstract-signer/lib/index.d.ts:34 + +___ + +### checkTransaction + +▸ **checkTransaction**(`transaction`): `Deferrable`\<`TransactionRequest`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transaction` | `Deferrable`\<`TransactionRequest`\> | + +#### Returns + +`Deferrable`\<`TransactionRequest`\> + +#### Inherited from + +Signer.checkTransaction + +#### Defined in + +node_modules/@ethersproject/abstract-signer/lib/index.d.ts:40 + +___ + +### connect + +▸ **connect**(`_provider`): `Signer` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_provider` | `Provider` | + +#### Returns + +`Signer` + +#### Overrides + +Signer.connect + +#### Defined in + +[src/types/remote-signer.ts:69](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/remote-signer.ts#L69) + +___ + +### estimateGas + +▸ **estimateGas**(`transaction`): `Promise`\<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transaction` | `Deferrable`\<`TransactionRequest`\> | + +#### Returns + +`Promise`\<`BigNumber`\> + +#### Inherited from + +Signer.estimateGas + +#### Defined in + +node_modules/@ethersproject/abstract-signer/lib/index.d.ts:33 + +___ + +### getAddress + +▸ **getAddress**(): `Promise`\<`string`\> + +#### Returns + +`Promise`\<`string`\> + +#### Overrides + +Signer.getAddress + +#### Defined in + +[src/types/remote-signer.ts:58](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/remote-signer.ts#L58) + +___ + +### getBalance + +▸ **getBalance**(`blockTag?`): `Promise`\<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `blockTag?` | `BlockTag` | + +#### Returns + +`Promise`\<`BigNumber`\> + +#### Inherited from + +Signer.getBalance + +#### Defined in + +node_modules/@ethersproject/abstract-signer/lib/index.d.ts:31 + +___ + +### getChainId + +▸ **getChainId**(): `Promise`\<`number`\> + +#### Returns + +`Promise`\<`number`\> + +#### Inherited from + +Signer.getChainId + +#### Defined in + +node_modules/@ethersproject/abstract-signer/lib/index.d.ts:36 + +___ + +### getFeeData + +▸ **getFeeData**(): `Promise`\<`FeeData`\> + +#### Returns + +`Promise`\<`FeeData`\> + +#### Inherited from + +Signer.getFeeData + +#### Defined in + +node_modules/@ethersproject/abstract-signer/lib/index.d.ts:38 + +___ + +### getGasPrice + +▸ **getGasPrice**(): `Promise`\<`BigNumber`\> + +#### Returns + +`Promise`\<`BigNumber`\> + +#### Inherited from + +Signer.getGasPrice + +#### Defined in + +node_modules/@ethersproject/abstract-signer/lib/index.d.ts:37 + +___ + +### getTransactionCount + +▸ **getTransactionCount**(`blockTag?`): `Promise`\<`number`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `blockTag?` | `BlockTag` | + +#### Returns + +`Promise`\<`number`\> + +#### Inherited from + +Signer.getTransactionCount + +#### Defined in + +node_modules/@ethersproject/abstract-signer/lib/index.d.ts:32 + +___ + +### login + +▸ **login**(`credentials?`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `credentials?` | [`RemoteSignerCredentials`](../sdk-reference#remotesignercredentials) | + +#### Returns + +`Promise`\<`string`\> + +#### Defined in + +[src/types/remote-signer.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/remote-signer.ts#L32) + +___ + +### populateTransaction + +▸ **populateTransaction**(`transaction`): `Promise`\<`TransactionRequest`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transaction` | `Deferrable`\<`TransactionRequest`\> | + +#### Returns + +`Promise`\<`TransactionRequest`\> + +#### Inherited from + +Signer.populateTransaction + +#### Defined in + +node_modules/@ethersproject/abstract-signer/lib/index.d.ts:41 + +___ + +### refresh + +▸ **refresh**(): `Promise`\<`string`\> + +#### Returns + +`Promise`\<`string`\> + +#### Defined in + +[src/types/remote-signer.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/remote-signer.ts#L43) + +___ + +### resolveName + +▸ **resolveName**(`name`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +`Promise`\<`string`\> + +#### Inherited from + +Signer.resolveName + +#### Defined in + +node_modules/@ethersproject/abstract-signer/lib/index.d.ts:39 + +___ + +### sendTransaction + +▸ **sendTransaction**(`transaction`): `Promise`\<`TransactionResponse`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transaction` | `Deferrable`\<`TransactionRequest`\> | + +#### Returns + +`Promise`\<`TransactionResponse`\> + +#### Inherited from + +Signer.sendTransaction + +#### Defined in + +node_modules/@ethersproject/abstract-signer/lib/index.d.ts:35 + +___ + +### signMessage + +▸ **signMessage**(`message`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` \| `Bytes` | + +#### Returns + +`Promise`\<`string`\> + +#### Overrides + +Signer.signMessage + +#### Defined in + +[src/types/remote-signer.ts:50](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/remote-signer.ts#L50) + +___ + +### signTransaction + +▸ **signTransaction**(`_transaction`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_transaction` | `TransactionRequest` | + +#### Returns + +`Promise`\<`string`\> + +#### Overrides + +Signer.signTransaction + +#### Defined in + +[src/types/remote-signer.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/remote-signer.ts#L65) + +___ + +### signTransactionRemotely + +▸ **signTransactionRemotely**(`message`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` \| `Bytes` | + +#### Returns + +`Promise`\<`string`\> + +#### Defined in + +[src/types/remote-signer.ts:54](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/remote-signer.ts#L54) + +___ + +### isSigner + +▸ **isSigner**(`value`): value is Signer + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `any` | + +#### Returns + +value is Signer + +#### Inherited from + +Signer.isSigner + +#### Defined in + +node_modules/@ethersproject/abstract-signer/lib/index.d.ts:43 + +## Properties + +### \_isSigner + +• `Readonly` **\_isSigner**: `boolean` + +#### Inherited from + +Signer.\_isSigner + +#### Defined in + +node_modules/@ethersproject/abstract-signer/lib/index.d.ts:29 + +___ + +### credentials + +• **credentials**: [`RemoteSignerCredentials`](../sdk-reference#remotesignercredentials) + +#### Defined in + +[src/types/remote-signer.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/remote-signer.ts#L21) + +___ + +### provider + +• `Optional` `Readonly` **provider**: `Provider` + +#### Inherited from + +Signer.provider + +#### Defined in + +node_modules/@ethersproject/abstract-signer/lib/index.d.ts:24 + +___ + +### token + +• **token**: `string` + +#### Defined in + +[src/types/remote-signer.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/remote-signer.ts#L22) + +___ + +### url + +• **url**: `string` + +#### Defined in + +[src/types/remote-signer.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/remote-signer.ts#L20) diff --git a/docs/sdk/reference/classes/RemoteSignerAPI.md b/docs/sdk/reference/classes/RemoteSignerAPI.md new file mode 100644 index 000000000..8234d9dd7 --- /dev/null +++ b/docs/sdk/reference/classes/RemoteSignerAPI.md @@ -0,0 +1,139 @@ +[@vocdoni/sdk](/sdk) / RemoteSignerAPI + +# Class: RemoteSignerAPI + +## Hierarchy + +- [`API`](API) + + ↳ **`RemoteSignerAPI`** + +## Table of contents + +### Methods + +- [addresses](RemoteSignerAPI#addresses) +- [login](RemoteSignerAPI#login) +- [refresh](RemoteSignerAPI#refresh) +- [sign](RemoteSignerAPI#sign) +- [signTransaction](RemoteSignerAPI#signtransaction) + +## Methods + +### addresses + +▸ **addresses**(`url`, `authToken`): `Promise`\<[`IRemoteSignerAddressesResponse`](../interfaces/IRemoteSignerAddressesResponse)\> + +Gets the writable addresses of the logged-in user. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `url` | `string` | API endpoint URL | +| `authToken` | `string` | Authentication token | + +#### Returns + +`Promise`\<[`IRemoteSignerAddressesResponse`](../interfaces/IRemoteSignerAddressesResponse)\> + +#### Defined in + +[src/api/remote-signer.ts:102](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/remote-signer.ts#L102) + +___ + +### login + +▸ **login**(`url`, `email`, `password`): `Promise`\<[`IRemoteSignerLoginResponse`](../interfaces/IRemoteSignerLoginResponse)\> + +Logs in a user using email and password. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `url` | `string` | API endpoint URL | +| `email` | `string` | The email address | +| `password` | `string` | The password | + +#### Returns + +`Promise`\<[`IRemoteSignerLoginResponse`](../interfaces/IRemoteSignerLoginResponse)\> + +#### Defined in + +[src/api/remote-signer.ts:72](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/remote-signer.ts#L72) + +___ + +### refresh + +▸ **refresh**(`url`, `authToken`): `Promise`\<[`IRemoteSignerRefreshResponse`](../interfaces/IRemoteSignerRefreshResponse)\> + +Refreshes the JWT token. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `url` | `string` | API endpoint URL | +| `authToken` | `string` | Authentication token | + +#### Returns + +`Promise`\<[`IRemoteSignerRefreshResponse`](../interfaces/IRemoteSignerRefreshResponse)\> + +#### Defined in + +[src/api/remote-signer.ts:85](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/remote-signer.ts#L85) + +___ + +### sign + +▸ **sign**(`url`, `authToken`, `address`, `payload`): `Promise`\<[`IRemoteSignerSignResponse`](../interfaces/IRemoteSignerSignResponse)\> + +Signs the payload using the remote signer. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `url` | `string` | API endpoint URL | +| `authToken` | `string` | Authentication token | +| `address` | `string` | The address | +| `payload` | `string` | The payload | + +#### Returns + +`Promise`\<[`IRemoteSignerSignResponse`](../interfaces/IRemoteSignerSignResponse)\> + +#### Defined in + +[src/api/remote-signer.ts:149](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/remote-signer.ts#L149) + +___ + +### signTransaction + +▸ **signTransaction**(`url`, `authToken`, `address`, `payload`): `Promise`\<[`IRemoteSignerSignTxResponse`](../interfaces/IRemoteSignerSignTxResponse)\> + +Signs the transaction using the remote signer. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `url` | `string` | API endpoint URL | +| `authToken` | `string` | Authentication token | +| `address` | `string` | The address | +| `payload` | `string` | The transaction payload | + +#### Returns + +`Promise`\<[`IRemoteSignerSignTxResponse`](../interfaces/IRemoteSignerSignTxResponse)\> + +#### Defined in + +[src/api/remote-signer.ts:121](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/remote-signer.ts#L121) diff --git a/docs/sdk/reference/classes/RemoteSignerService.md b/docs/sdk/reference/classes/RemoteSignerService.md new file mode 100644 index 000000000..6c5d32bdb --- /dev/null +++ b/docs/sdk/reference/classes/RemoteSignerService.md @@ -0,0 +1,205 @@ +[@vocdoni/sdk](/sdk) / RemoteSignerService + +# Class: RemoteSignerService + +## Hierarchy + +- [`Service`](Service) + + ↳ **`RemoteSignerService`** + +## Implements + +- `RemoteSignerServiceProperties` + +## Table of contents + +### Constructors + +- [constructor](RemoteSignerService#constructor) + +### Methods + +- [addresses](RemoteSignerService#addresses) +- [getAddress](RemoteSignerService#getaddress) +- [login](RemoteSignerService#login) +- [refresh](RemoteSignerService#refresh) +- [signPayload](RemoteSignerService#signpayload) +- [signTxPayload](RemoteSignerService#signtxpayload) + +### Properties + +- [remoteSigner](RemoteSignerService#remotesigner) +- [url](RemoteSignerService#url) + +## Constructors + +### constructor + +• **new RemoteSignerService**(`params`): [`RemoteSignerService`](RemoteSignerService) + +Instantiate the remote signer service. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `params` | `Partial`\<`RemoteSignerServiceParameters`\> | The service parameters | + +#### Returns + +[`RemoteSignerService`](RemoteSignerService) + +#### Overrides + +Service.constructor + +#### Defined in + +[src/services/remote-signer.ts:23](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/remote-signer.ts#L23) + +## Methods + +### addresses + +▸ **addresses**(): `Promise`\<`string`[]\> + +Returns the writable addresses. + +#### Returns + +`Promise`\<`string`[]\> + +The writable addresses + +#### Defined in + +[src/services/remote-signer.ts:58](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/remote-signer.ts#L58) + +___ + +### getAddress + +▸ **getAddress**(): `Promise`\<`string`\> + +Returns the address of the remote signer. + +#### Returns + +`Promise`\<`string`\> + +The remote signer address + +#### Defined in + +[src/services/remote-signer.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/remote-signer.ts#L71) + +___ + +### login + +▸ **login**(`credentials?`): `Promise`\<`string`\> + +Logs in to the remote signer. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `credentials?` | [`RemoteSignerCredentials`](../sdk-reference#remotesignercredentials) | + +#### Returns + +`Promise`\<`string`\> + +The JWT token + +#### Defined in + +[src/services/remote-signer.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/remote-signer.ts#L33) + +___ + +### refresh + +▸ **refresh**(): `Promise`\<`string`\> + +Refreshes the JWT token. + +#### Returns + +`Promise`\<`string`\> + +The JWT token + +#### Defined in + +[src/services/remote-signer.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/remote-signer.ts#L47) + +___ + +### signPayload + +▸ **signPayload**(`payload`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | `string` \| `Bytes` | + +#### Returns + +`Promise`\<`string`\> + +#### Defined in + +[src/services/remote-signer.ts:97](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/remote-signer.ts#L97) + +___ + +### signTxPayload + +▸ **signTxPayload**(`payload`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | `string` \| `Bytes` | + +#### Returns + +`Promise`\<`string`\> + +#### Defined in + +[src/services/remote-signer.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/remote-signer.ts#L81) + +## Properties + +### remoteSigner + +• **remoteSigner**: [`RemoteSigner`](RemoteSigner) + +#### Implementation of + +RemoteSignerServiceProperties.remoteSigner + +#### Defined in + +[src/services/remote-signer.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/remote-signer.ts#L16) + +___ + +### url + +• **url**: `string` + +#### Inherited from + +[Service](Service.md).[url](Service#url) + +#### Defined in + +[src/services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/service.ts#L6) diff --git a/docs/sdk/reference/classes/Service.md b/docs/sdk/reference/classes/Service.md index c13e6c16d..e31c9264c 100644 --- a/docs/sdk/reference/classes/Service.md +++ b/docs/sdk/reference/classes/Service.md @@ -24,6 +24,8 @@ ↳ [`VoteService`](VoteService) + ↳ [`RemoteSignerService`](RemoteSignerService) + ## Implements - [`ServiceProperties`](../interfaces/ServiceProperties) @@ -46,4 +48,4 @@ #### Defined in -[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/service.ts#L6) +[src/services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/service.ts#L6) diff --git a/docs/sdk/reference/classes/StrategyCensus.md b/docs/sdk/reference/classes/StrategyCensus.md index 9047fb021..6c2e999d8 100644 --- a/docs/sdk/reference/classes/StrategyCensus.md +++ b/docs/sdk/reference/classes/StrategyCensus.md @@ -46,7 +46,7 @@ PublishedCensus.censusId #### Defined in -[types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L35) +[src/types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L35) • `set` **censusId**(`value`): `void` @@ -66,7 +66,7 @@ PublishedCensus.censusId #### Defined in -[types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L39) +[src/types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L39) ___ @@ -84,7 +84,7 @@ PublishedCensus.censusURI #### Defined in -[types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L43) +[src/types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L43) • `set` **censusURI**(`value`): `void` @@ -104,7 +104,7 @@ PublishedCensus.censusURI #### Defined in -[types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L47) +[src/types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L47) ___ @@ -122,7 +122,7 @@ PublishedCensus.isPublished #### Defined in -[types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L75) +[src/types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L75) ___ @@ -140,7 +140,7 @@ PublishedCensus.size #### Defined in -[types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L59) +[src/types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L59) • `set` **size**(`value`): `void` @@ -160,7 +160,7 @@ PublishedCensus.size #### Defined in -[types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L63) +[src/types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L63) ___ @@ -174,7 +174,7 @@ ___ #### Defined in -[types/census/census3/strategy.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census3/strategy.ts#L33) +[src/types/census/census3/strategy.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census3/strategy.ts#L33) • `set` **strategy**(`value`): `void` @@ -190,7 +190,7 @@ ___ #### Defined in -[types/census/census3/strategy.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census3/strategy.ts#L37) +[src/types/census/census3/strategy.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census3/strategy.ts#L37) ___ @@ -208,7 +208,7 @@ PublishedCensus.type #### Defined in -[types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L51) +[src/types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L51) • `set` **type**(`value`): `void` @@ -228,7 +228,7 @@ PublishedCensus.type #### Defined in -[types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L55) +[src/types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L55) ___ @@ -246,7 +246,7 @@ PublishedCensus.weight #### Defined in -[types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L67) +[src/types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L67) • `set` **weight**(`value`): `void` @@ -266,7 +266,7 @@ PublishedCensus.weight #### Defined in -[types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L71) +[src/types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L71) ## Constructors @@ -297,7 +297,7 @@ Constructs a census3 census #### Defined in -[types/census/census3/strategy.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census3/strategy.ts#L21) +[src/types/census/census3/strategy.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census3/strategy.ts#L21) ## Methods @@ -322,4 +322,4 @@ Constructs a census3 census #### Defined in -[types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L81) +[src/types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L81) diff --git a/docs/sdk/reference/classes/TokenCensus.md b/docs/sdk/reference/classes/TokenCensus.md index 8c3295999..e87b1eb5d 100644 --- a/docs/sdk/reference/classes/TokenCensus.md +++ b/docs/sdk/reference/classes/TokenCensus.md @@ -46,7 +46,7 @@ PublishedCensus.censusId #### Defined in -[types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L35) +[src/types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L35) • `set` **censusId**(`value`): `void` @@ -66,7 +66,7 @@ PublishedCensus.censusId #### Defined in -[types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L39) +[src/types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L39) ___ @@ -84,7 +84,7 @@ PublishedCensus.censusURI #### Defined in -[types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L43) +[src/types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L43) • `set` **censusURI**(`value`): `void` @@ -104,7 +104,7 @@ PublishedCensus.censusURI #### Defined in -[types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L47) +[src/types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L47) ___ @@ -122,7 +122,7 @@ PublishedCensus.isPublished #### Defined in -[types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L75) +[src/types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L75) ___ @@ -140,7 +140,7 @@ PublishedCensus.size #### Defined in -[types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L59) +[src/types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L59) • `set` **size**(`value`): `void` @@ -160,7 +160,7 @@ PublishedCensus.size #### Defined in -[types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L63) +[src/types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L63) ___ @@ -174,7 +174,7 @@ ___ #### Defined in -[types/census/census3/token.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census3/token.ts#L33) +[src/types/census/census3/token.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census3/token.ts#L33) • `set` **token**(`value`): `void` @@ -190,7 +190,7 @@ ___ #### Defined in -[types/census/census3/token.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census3/token.ts#L37) +[src/types/census/census3/token.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census3/token.ts#L37) ___ @@ -208,7 +208,7 @@ PublishedCensus.type #### Defined in -[types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L51) +[src/types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L51) • `set` **type**(`value`): `void` @@ -228,7 +228,7 @@ PublishedCensus.type #### Defined in -[types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L55) +[src/types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L55) ___ @@ -246,7 +246,7 @@ PublishedCensus.weight #### Defined in -[types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L67) +[src/types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L67) • `set` **weight**(`value`): `void` @@ -266,7 +266,7 @@ PublishedCensus.weight #### Defined in -[types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L71) +[src/types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L71) ## Constructors @@ -297,7 +297,7 @@ Constructs a census3 census #### Defined in -[types/census/census3/token.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census3/token.ts#L21) +[src/types/census/census3/token.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census3/token.ts#L21) ## Methods @@ -322,4 +322,4 @@ Constructs a census3 census #### Defined in -[types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L81) +[src/types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L81) diff --git a/docs/sdk/reference/classes/TxTypeNotAllowedError.md b/docs/sdk/reference/classes/TxTypeNotAllowedError.md new file mode 100644 index 000000000..10e1cab97 --- /dev/null +++ b/docs/sdk/reference/classes/TxTypeNotAllowedError.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / TxTypeNotAllowedError + +# Class: TxTypeNotAllowedError + +## Hierarchy + +- `Error` + + ↳ **`TxTypeNotAllowedError`** + +## Table of contents + +### Constructors + +- [constructor](TxTypeNotAllowedError#constructor) + +### Methods + +- [captureStackTrace](TxTypeNotAllowedError#capturestacktrace) + +### Properties + +- [cause](TxTypeNotAllowedError#cause) +- [message](TxTypeNotAllowedError#message) +- [name](TxTypeNotAllowedError#name) +- [stack](TxTypeNotAllowedError#stack) +- [prepareStackTrace](TxTypeNotAllowedError#preparestacktrace) +- [stackTraceLimit](TxTypeNotAllowedError#stacktracelimit) + +## Constructors + +### constructor + +• **new TxTypeNotAllowedError**(`message?`): [`TxTypeNotAllowedError`](TxTypeNotAllowedError) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`TxTypeNotAllowedError`](TxTypeNotAllowedError) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/saas/errors.ts:50](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/saas/errors.ts#L50) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/UnauthorizedError.md b/docs/sdk/reference/classes/UnauthorizedError.md new file mode 100644 index 000000000..09b552939 --- /dev/null +++ b/docs/sdk/reference/classes/UnauthorizedError.md @@ -0,0 +1,184 @@ +[@vocdoni/sdk](/sdk) / UnauthorizedError + +# Class: UnauthorizedError + +## Hierarchy + +- `Error` + + ↳ **`UnauthorizedError`** + +## Table of contents + +### Constructors + +- [constructor](UnauthorizedError#constructor) + +### Methods + +- [captureStackTrace](UnauthorizedError#capturestacktrace) + +### Properties + +- [cause](UnauthorizedError#cause) +- [message](UnauthorizedError#message) +- [name](UnauthorizedError#name) +- [stack](UnauthorizedError#stack) +- [prepareStackTrace](UnauthorizedError#preparestacktrace) +- [stackTraceLimit](UnauthorizedError#stacktracelimit) + +## Constructors + +### constructor + +• **new UnauthorizedError**(`message?`): [`UnauthorizedError`](UnauthorizedError) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`UnauthorizedError`](UnauthorizedError) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/api/saas/errors.ts:2](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/saas/errors.ts#L2) + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:136 + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs/node_modules/typescript/lib/lib.es5.d.ts:1055 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:143 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:145 diff --git a/docs/sdk/reference/classes/UnpublishedElection.md b/docs/sdk/reference/classes/UnpublishedElection.md index 084059a62..69b8b5c0c 100644 --- a/docs/sdk/reference/classes/UnpublishedElection.md +++ b/docs/sdk/reference/classes/UnpublishedElection.md @@ -68,7 +68,7 @@ Election.addSDKVersion #### Defined in -[types/election/unpublished.ts:287](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L287) +[src/types/election/unpublished.ts:291](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L291) • `set` **addSDKVersion**(`value`): `void` @@ -88,7 +88,7 @@ Election.addSDKVersion #### Defined in -[types/election/unpublished.ts:291](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L291) +[src/types/election/unpublished.ts:295](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L295) ___ @@ -106,7 +106,7 @@ Election.census #### Defined in -[types/election/unpublished.ts:261](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L261) +[src/types/election/unpublished.ts:265](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L265) • `set` **census**(`value`): `void` @@ -126,7 +126,7 @@ Election.census #### Defined in -[types/election/unpublished.ts:265](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L265) +[src/types/election/unpublished.ts:269](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L269) ___ @@ -144,7 +144,7 @@ Election.description #### Defined in -[types/election/unpublished.ts:185](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L185) +[src/types/election/unpublished.ts:189](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L189) • `set` **description**(`value`): `void` @@ -164,7 +164,7 @@ Election.description #### Defined in -[types/election/unpublished.ts:189](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L189) +[src/types/election/unpublished.ts:193](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L193) ___ @@ -178,7 +178,7 @@ ___ #### Defined in -[types/election/unpublished.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L150) +[src/types/election/unpublished.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L155) ___ @@ -196,7 +196,7 @@ Election.electionType #### Defined in -[types/election/unpublished.ts:237](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L237) +[src/types/election/unpublished.ts:241](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L241) • `set` **electionType**(`value`): `void` @@ -216,7 +216,7 @@ Election.electionType #### Defined in -[types/election/unpublished.ts:241](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L241) +[src/types/election/unpublished.ts:245](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L245) ___ @@ -234,7 +234,7 @@ Election.endDate #### Defined in -[types/election/unpublished.ts:227](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L227) +[src/types/election/unpublished.ts:231](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L231) • `set` **endDate**(`value`): `void` @@ -254,7 +254,7 @@ Election.endDate #### Defined in -[types/election/unpublished.ts:231](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L231) +[src/types/election/unpublished.ts:235](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L235) ___ @@ -272,7 +272,7 @@ Election.header #### Defined in -[types/election/unpublished.ts:193](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L193) +[src/types/election/unpublished.ts:197](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L197) • `set` **header**(`value`): `void` @@ -292,7 +292,7 @@ Election.header #### Defined in -[types/election/unpublished.ts:197](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L197) +[src/types/election/unpublished.ts:201](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L201) ___ @@ -310,7 +310,7 @@ Election.maxCensusSize #### Defined in -[types/election/unpublished.ts:270](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L270) +[src/types/election/unpublished.ts:274](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L274) • `set` **maxCensusSize**(`value`): `void` @@ -330,7 +330,7 @@ Election.maxCensusSize #### Defined in -[types/election/unpublished.ts:274](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L274) +[src/types/election/unpublished.ts:278](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L278) ___ @@ -348,7 +348,7 @@ Election.meta #### Defined in -[types/election/unpublished.ts:209](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L209) +[src/types/election/unpublished.ts:213](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L213) • `set` **meta**(`value`): `void` @@ -368,7 +368,7 @@ Election.meta #### Defined in -[types/election/unpublished.ts:213](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L213) +[src/types/election/unpublished.ts:217](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L217) ___ @@ -386,7 +386,7 @@ Election.questions #### Defined in -[types/election/unpublished.ts:253](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L253) +[src/types/election/unpublished.ts:257](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L257) • `set` **questions**(`value`): `void` @@ -406,7 +406,7 @@ Election.questions #### Defined in -[types/election/unpublished.ts:257](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L257) +[src/types/election/unpublished.ts:261](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L261) ___ @@ -424,7 +424,7 @@ Election.startDate #### Defined in -[types/election/unpublished.ts:218](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L218) +[src/types/election/unpublished.ts:222](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L222) • `set` **startDate**(`value`): `void` @@ -444,7 +444,7 @@ Election.startDate #### Defined in -[types/election/unpublished.ts:222](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L222) +[src/types/election/unpublished.ts:226](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L226) ___ @@ -462,7 +462,7 @@ Election.streamUri #### Defined in -[types/election/unpublished.ts:201](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L201) +[src/types/election/unpublished.ts:205](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L205) • `set` **streamUri**(`value`): `void` @@ -482,7 +482,7 @@ Election.streamUri #### Defined in -[types/election/unpublished.ts:205](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L205) +[src/types/election/unpublished.ts:209](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L209) ___ @@ -500,7 +500,7 @@ Election.temporarySecretIdentity #### Defined in -[types/election/unpublished.ts:279](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L279) +[src/types/election/unpublished.ts:283](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L283) • `set` **temporarySecretIdentity**(`value`): `void` @@ -520,7 +520,7 @@ Election.temporarySecretIdentity #### Defined in -[types/election/unpublished.ts:283](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L283) +[src/types/election/unpublished.ts:287](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L287) ___ @@ -538,7 +538,7 @@ Election.title #### Defined in -[types/election/unpublished.ts:176](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L176) +[src/types/election/unpublished.ts:180](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L180) • `set` **title**(`value`): `void` @@ -558,7 +558,7 @@ Election.title #### Defined in -[types/election/unpublished.ts:180](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L180) +[src/types/election/unpublished.ts:184](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L184) ___ @@ -576,7 +576,7 @@ Election.voteType #### Defined in -[types/election/unpublished.ts:245](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L245) +[src/types/election/unpublished.ts:249](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L249) • `set` **voteType**(`value`): `void` @@ -596,7 +596,7 @@ Election.voteType #### Defined in -[types/election/unpublished.ts:249](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L249) +[src/types/election/unpublished.ts:253](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L253) ## Constructors @@ -622,13 +622,13 @@ Election.constructor #### Defined in -[types/election/unpublished.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L24) +[src/types/election/unpublished.ts:25](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L25) ## Methods ### addQuestion -▸ **addQuestion**(`title`, `description`, `choices`): [`UnpublishedElection`](UnpublishedElection) +▸ **addQuestion**(`title`, `description`, `choices`, `meta?`): [`UnpublishedElection`](UnpublishedElection) #### Parameters @@ -636,7 +636,8 @@ Election.constructor | :------ | :------ | | `title` | `string` \| `MultiLanguage`\<`string`\> | | `description` | `string` \| `MultiLanguage`\<`string`\> | -| `choices` | (\{ `title`: `string` ; `value`: `number` } \| \{ `title`: `MultiLanguage`\<`string`\> ; `value`: `number` })[] | +| `choices` | (\{ `meta?`: `any` ; `title`: `string` ; `value?`: `number` } \| [`Choice`](../sdk-reference#choice))[] | +| `meta?` | `any` | #### Returns @@ -644,7 +645,7 @@ Election.constructor #### Defined in -[types/election/unpublished.ts:42](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L42) +[src/types/election/unpublished.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L43) ___ @@ -658,7 +659,7 @@ ___ #### Defined in -[types/election/unpublished.ts:156](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L156) +[src/types/election/unpublished.ts:161](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L161) ___ @@ -678,7 +679,7 @@ ___ #### Defined in -[types/election/unpublished.ts:93](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L93) +[src/types/election/unpublished.ts:96](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L96) ___ @@ -692,7 +693,7 @@ ___ #### Defined in -[types/election/unpublished.ts:166](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L166) +[src/types/election/unpublished.ts:171](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L171) ___ @@ -706,7 +707,7 @@ ___ #### Defined in -[types/election/unpublished.ts:135](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L135) +[src/types/election/unpublished.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L140) ___ @@ -730,7 +731,7 @@ ___ #### Defined in -[types/election/election.ts:279](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L279) +[src/types/election/election.ts:275](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L275) ___ @@ -750,7 +751,7 @@ ___ #### Defined in -[types/election/unpublished.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L61) +[src/types/election/unpublished.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L65) ___ @@ -764,7 +765,7 @@ ___ #### Defined in -[types/election/unpublished.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/unpublished.ts#L128) +[src/types/election/unpublished.ts:133](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/unpublished.ts#L133) ___ @@ -790,4 +791,4 @@ Returns an unpublished election object #### Defined in -[types/election/election.ts:219](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L219) +[src/types/election/election.ts:215](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L215) diff --git a/docs/sdk/reference/classes/VocdoniCensus3Client.md b/docs/sdk/reference/classes/VocdoniCensus3Client.md index c63a6e71c..ea7da7bf5 100644 --- a/docs/sdk/reference/classes/VocdoniCensus3Client.md +++ b/docs/sdk/reference/classes/VocdoniCensus3Client.md @@ -62,7 +62,7 @@ To instantiate the client just pass the `ClientOptions` you want or use an empty #### Defined in -[census3.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L49) +[src/census3.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L47) ## Methods @@ -87,7 +87,7 @@ The census information #### Defined in -[census3.ts:379](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L379) +[src/census3.ts:398](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L398) ___ @@ -113,7 +113,7 @@ The strategy id #### Defined in -[census3.ts:296](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L296) +[src/census3.ts:315](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L315) ___ @@ -138,7 +138,7 @@ The strategy census #### Defined in -[census3.ts:439](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L439) +[src/census3.ts:458](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L458) ___ @@ -164,7 +164,7 @@ Creates a new token to be tracked in the service #### Defined in -[census3.ts:164](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L164) +[src/census3.ts:162](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L162) ___ @@ -191,7 +191,7 @@ The token census #### Defined in -[census3.ts:416](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L416) +[src/census3.ts:435](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L435) ___ @@ -215,7 +215,7 @@ The census3 census #### Defined in -[census3.ts:367](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L367) +[src/census3.ts:386](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L386) ___ @@ -239,7 +239,7 @@ The list of census3 censuses #### Defined in -[census3.ts:356](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L356) +[src/census3.ts:375](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L375) ___ @@ -265,7 +265,7 @@ The predicate estimation #### Defined in -[census3.ts:252](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L252) +[src/census3.ts:271](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L271) ___ @@ -283,7 +283,7 @@ The list of strategies #### Defined in -[census3.ts:182](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L182) +[src/census3.ts:180](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L180) ___ @@ -309,7 +309,7 @@ The list of strategies #### Defined in -[census3.ts:208](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L208) +[src/census3.ts:227](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L227) ___ @@ -333,7 +333,7 @@ The strategy information #### Defined in -[census3.ts:222](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L222) +[src/census3.ts:241](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L241) ___ @@ -358,13 +358,13 @@ The strategy estimation #### Defined in -[census3.ts:234](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L234) +[src/census3.ts:253](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L253) ___ ### getStrategyHolders -▸ **getStrategyHolders**(`id`, `pagination?`): `Promise`\<[`StrategyHolders`](../sdk-reference#strategyholders)\> +▸ **getStrategyHolders**(`id`): `Promise`\<[`StrategyHolders`](../sdk-reference#strategyholders)\> Returns the strategy holders @@ -373,7 +373,6 @@ Returns the strategy holders | Name | Type | Description | | :------ | :------ | :------ | | `id` | `number` | The id of the strategy | -| `pagination` | `Census3Pagination` | Pagination options | #### Returns @@ -383,7 +382,7 @@ The list strategy holders #### Defined in -[census3.ts:193](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L193) +[src/census3.ts:190](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L190) ___ @@ -401,7 +400,7 @@ Supported chain list #### Defined in -[census3.ts:77](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L77) +[src/census3.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L75) ___ @@ -419,7 +418,7 @@ Supported strategies operators list #### Defined in -[census3.ts:95](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L95) +[src/census3.ts:93](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L93) ___ @@ -437,7 +436,7 @@ Token summary list #### Defined in -[census3.ts:62](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L62) +[src/census3.ts:60](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L60) ___ @@ -455,7 +454,7 @@ Supported tokens type list #### Defined in -[census3.ts:86](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L86) +[src/census3.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L84) ___ @@ -481,7 +480,7 @@ The token information #### Defined in -[census3.ts:107](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L107) +[src/census3.ts:105](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L105) ___ @@ -505,7 +504,7 @@ The strategy information #### Defined in -[census3.ts:311](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L311) +[src/census3.ts:330](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L330) ___ @@ -532,7 +531,7 @@ If the holder is in the token #### Defined in -[census3.ts:125](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L125) +[src/census3.ts:123](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L123) ___ @@ -559,7 +558,7 @@ The balance of the holder #### Defined in -[census3.ts:146](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L146) +[src/census3.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L144) ___ @@ -583,7 +582,7 @@ The parsed predicate #### Defined in -[census3.ts:345](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L345) +[src/census3.ts:364](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L364) ## Properties @@ -600,7 +599,7 @@ The parsed predicate #### Defined in -[census3.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L38) +[src/census3.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L36) ___ @@ -610,4 +609,4 @@ ___ #### Defined in -[census3.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L37) +[src/census3.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L35) diff --git a/docs/sdk/reference/classes/VocdoniSDKClient.md b/docs/sdk/reference/classes/VocdoniSDKClient.md index 3eb14e8ed..8e427a98b 100644 --- a/docs/sdk/reference/classes/VocdoniSDKClient.md +++ b/docs/sdk/reference/classes/VocdoniSDKClient.md @@ -25,6 +25,9 @@ point. - [calculateElectionCost](VocdoniSDKClient#calculateelectioncost) - [cancelElection](VocdoniSDKClient#cancelelection) - [changeElectionCensus](VocdoniSDKClient#changeelectioncensus) +- [changeElectionDuration](VocdoniSDKClient#changeelectionduration) +- [changeElectionEndDate](VocdoniSDKClient#changeelectionenddate) +- [changeElectionMaxCensusSize](VocdoniSDKClient#changeelectionmaxcensussize) - [continueElection](VocdoniSDKClient#continueelection) - [createElection](VocdoniSDKClient#createelection) - [createElectionSteps](VocdoniSDKClient#createelectionsteps) @@ -107,7 +110,7 @@ To instantiate the client just pass the `ClientOptions` you want or empty object #### Defined in -[client.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L128) +[src/client.ts:152](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L152) ## Account Methods @@ -133,7 +136,7 @@ Registers an account against vochain, so it can create new elections. #### Defined in -[client.ts:421](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L421) +[src/client.ts:445](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L445) ___ @@ -159,7 +162,7 @@ Creates an account with information. #### Defined in -[client.ts:331](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L331) +[src/client.ts:355](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L355) ___ @@ -181,7 +184,7 @@ Fetches account. #### Defined in -[client.ts:198](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L198) +[src/client.ts:226](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L226) ___ @@ -203,7 +206,7 @@ Fetches account information. #### Defined in -[client.ts:179](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L179) +[src/client.ts:207](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L207) ___ @@ -225,7 +228,7 @@ Updates an account with information #### Defined in -[client.ts:375](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L375) +[src/client.ts:399](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L399) ___ @@ -251,7 +254,7 @@ The cost in tokens. #### Defined in -[client.ts:1043](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L1043) +[src/client.ts:1136](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L1136) ___ @@ -273,13 +276,13 @@ Cancels an election. #### Defined in -[client.ts:634](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L634) +[src/client.ts:658](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L658) ___ ### changeElectionCensus -▸ **changeElectionCensus**(`electionId`, `censusId`, `censusURI`): `Promise`\<`void`\> +▸ **changeElectionCensus**(`electionId`, `censusId`, `censusURI`, `maxCensusSize?`): `Promise`\<`void`\> Changes the census of an election. @@ -290,6 +293,7 @@ Changes the census of an election. | `electionId` | `string` | The id of the election | | `censusId` | `string` | The new census id (root) | | `censusURI` | `string` | The new census URI | +| `maxCensusSize?` | `number` | The new max census size | #### Returns @@ -297,7 +301,76 @@ Changes the census of an election. #### Defined in -[client.ts:680](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L680) +[src/client.ts:705](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L705) + +___ + +### changeElectionDuration + +▸ **changeElectionDuration**(`electionId`, `duration`): `Promise`\<`void`\> + +Changes the duration of an election. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `electionId` | `string` | The id of the election | +| `duration` | `number` | The new duration of the election | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/client.ts:758](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L758) + +___ + +### changeElectionEndDate + +▸ **changeElectionEndDate**(`electionId`, `endDate`): `Promise`\<`void`\> + +Changes the end date of an election. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `electionId` | `string` | The id of the election | +| `endDate` | `string` \| `number` \| `Date` | The new end date | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/client.ts:779](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L779) + +___ + +### changeElectionMaxCensusSize + +▸ **changeElectionMaxCensusSize**(`electionId`, `maxCensusSize`): `Promise`\<`void`\> + +Changes the max census size of an election. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `electionId` | `string` | The id of the election | +| `maxCensusSize` | `number` | The new max census size | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/client.ts:736](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L736) ___ @@ -319,7 +392,7 @@ Continues an election. #### Defined in -[client.ts:644](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L644) +[src/client.ts:668](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L668) ___ @@ -343,7 +416,7 @@ Resulting election id. #### Defined in -[client.ts:515](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L515) +[src/client.ts:539](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L539) ___ @@ -367,7 +440,7 @@ The async step returns. #### Defined in -[client.ts:532](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L532) +[src/client.ts:556](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L556) ___ @@ -389,7 +462,7 @@ Ends an election. #### Defined in -[client.ts:614](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L614) +[src/client.ts:638](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L638) ___ @@ -413,13 +486,13 @@ The cost in tokens. #### Defined in -[client.ts:1033](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L1033) +[src/client.ts:1126](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L1126) ___ ### fetchElection -▸ **fetchElection**(`electionId?`, `password?`): `Promise`\<[`PublishedElection`](PublishedElection.md) \| [`ArchivedElection`](ArchivedElection)\> +▸ **fetchElection**(`electionId?`, `password?`): `Promise`\<[`PublishedElection`](PublishedElection)\> Fetches info about an election. @@ -432,34 +505,33 @@ Fetches info about an election. #### Returns -`Promise`\<[`PublishedElection`](PublishedElection.md) \| [`ArchivedElection`](ArchivedElection)\> +`Promise`\<[`PublishedElection`](PublishedElection)\> #### Defined in -[client.ts:227](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L227) +[src/client.ts:255](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L255) ___ ### fetchElections -▸ **fetchElections**(`account?`, `page?`): `Promise`\<([`PublishedElection`](PublishedElection.md) \| [`ArchivedElection`](ArchivedElection.md) \| [`InvalidElection`](InvalidElection))[]\> +▸ **fetchElections**(`params?`): `Promise`\<[`ElectionListWithPagination`](../sdk-reference#electionlistwithpagination)\> -Fetches info about all elections created by the given account +Fetches info about all elections #### Parameters -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `account?` | `string` | `undefined` | specify an account to search for. Otherwise client wallet address is used. | -| `page` | `number` | `0` | - | +| Name | Type | Description | +| :------ | :------ | :------ | +| `params?` | `Partial`\<[`FetchElectionsParametersWithPagination`](../sdk-reference#fetchelectionsparameterswithpagination)\> | The parameters to filter the elections | #### Returns -`Promise`\<([`PublishedElection`](PublishedElection.md) \| [`ArchivedElection`](ArchivedElection.md) \| [`InvalidElection`](InvalidElection))[]\> +`Promise`\<[`ElectionListWithPagination`](../sdk-reference#electionlistwithpagination)\> #### Defined in -[client.ts:241](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L241) +[src/client.ts:268](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L268) ___ @@ -481,7 +553,7 @@ Pauses an election. #### Defined in -[client.ts:624](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L624) +[src/client.ts:648](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L648) ___ @@ -503,7 +575,7 @@ Sets an election id. Required by other methods like submitVote or createElection #### Defined in -[client.ts:169](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L169) +[src/client.ts:197](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L197) ___ @@ -529,7 +601,7 @@ The id of the vote #### Defined in -[client.ts:726](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L726) +[src/client.ts:819](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L819) ___ @@ -551,7 +623,7 @@ Checks if the user is able to vote #### Defined in -[client.ts:758](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L758) +[src/client.ts:851](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L851) ___ @@ -573,7 +645,7 @@ Checks if the user is in census. #### Defined in -[client.ts:704](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L704) +[src/client.ts:797](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L797) ___ @@ -587,7 +659,7 @@ Submits a vote. | Name | Type | Description | | :------ | :------ | :------ | -| `vote` | [`Vote`](Vote.md) \| [`AnonymousVote`](AnonymousVote.md) \| [`CspVote`](CspVote) | The vote (or votes) to be sent. | +| `vote` | [`Vote`](Vote.md) \| [`CspVote`](CspVote.md) \| [`AnonymousVote`](AnonymousVote) | The vote (or votes) to be sent. | #### Returns @@ -597,7 +669,7 @@ Vote confirmation id. #### Defined in -[client.ts:806](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L806) +[src/client.ts:899](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L899) ___ @@ -611,7 +683,7 @@ Submits a vote by steps. | Name | Type | Description | | :------ | :------ | :------ | -| `vote` | [`Vote`](Vote.md) \| [`AnonymousVote`](AnonymousVote.md) \| [`CspVote`](CspVote) | The vote (or votes) to be sent. | +| `vote` | [`Vote`](Vote.md) \| [`CspVote`](CspVote.md) \| [`AnonymousVote`](AnonymousVote) | The vote (or votes) to be sent. | #### Returns @@ -621,7 +693,7 @@ Vote confirmation id. #### Defined in -[client.ts:823](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L823) +[src/client.ts:916](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L916) ___ @@ -643,7 +715,7 @@ Checks how many times a user can submit their vote #### Defined in -[client.ts:768](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L768) +[src/client.ts:861](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L861) ___ @@ -669,7 +741,7 @@ Resulting CID #### Defined in -[client.ts:1053](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L1053) +[src/client.ts:1146](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L1146) ___ @@ -693,7 +765,7 @@ Account data information updated with new balance #### Defined in -[client.ts:488](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L488) +[src/client.ts:512](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L512) ___ @@ -715,7 +787,7 @@ Publishes the given census. #### Defined in -[client.ts:955](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L955) +[src/client.ts:1048](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L1048) ___ @@ -729,7 +801,7 @@ ___ #### Defined in -[client.ts:991](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L991) +[src/client.ts:1084](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L1084) ___ @@ -750,7 +822,7 @@ ___ #### Defined in -[client.ts:1002](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L1002) +[src/client.ts:1095](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L1095) ___ @@ -772,7 +844,7 @@ ___ #### Defined in -[client.ts:995](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L995) +[src/client.ts:1088](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L1088) ___ @@ -786,7 +858,7 @@ ___ #### Defined in -[client.ts:986](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L986) +[src/client.ts:1079](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L1079) ___ @@ -808,7 +880,7 @@ ___ #### Defined in -[client.ts:1007](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L1007) +[src/client.ts:1100](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L1100) ___ @@ -830,7 +902,7 @@ Fetches the information of a given census. #### Defined in -[client.ts:964](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L964) +[src/client.ts:1057](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L1057) ___ @@ -846,7 +918,7 @@ Fetches blockchain costs information if needed. #### Defined in -[client.ts:1015](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L1015) +[src/client.ts:1108](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L1108) ___ @@ -862,7 +934,7 @@ Fetches blockchain information if needed and returns the chain id. #### Defined in -[client.ts:1023](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L1023) +[src/client.ts:1116](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L1116) ___ @@ -884,7 +956,7 @@ Fetches circuits for anonymous voting #### Defined in -[client.ts:973](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L973) +[src/client.ts:1066](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L1066) ___ @@ -900,7 +972,7 @@ Fetches a faucet payload. Only for development. #### Defined in -[client.ts:1061](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L1061) +[src/client.ts:1154](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L1154) ___ @@ -923,7 +995,7 @@ Fetches proof that an address is part of the specified census. #### Defined in -[client.ts:946](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L946) +[src/client.ts:1039](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L1039) ___ @@ -941,7 +1013,7 @@ The private key. #### Defined in -[client.ts:918](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L918) +[src/client.ts:1011](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L1011) ___ @@ -963,7 +1035,7 @@ Parses a faucet package. #### Defined in -[client.ts:1071](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L1071) +[src/client.ts:1164](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L1164) ___ @@ -985,7 +1057,7 @@ Send tokens from one account to another. #### Defined in -[client.ts:459](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L459) +[src/client.ts:483](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L483) ___ @@ -1007,7 +1079,7 @@ Sets circuits for anonymous voting #### Defined in -[client.ts:982](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L982) +[src/client.ts:1075](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L1075) ___ @@ -1033,7 +1105,7 @@ it fails. #### Defined in -[client.ts:1084](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L1084) +[src/client.ts:1177](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L1177) ___ @@ -1057,7 +1129,7 @@ The deterministic wallet. #### Defined in -[client.ts:930](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L930) +[src/client.ts:1023](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L1023) ## Properties @@ -1067,7 +1139,7 @@ The deterministic wallet. #### Defined in -[client.ts:112](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L112) +[src/client.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L136) ___ @@ -1077,7 +1149,7 @@ ___ #### Defined in -[client.ts:106](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L106) +[src/client.ts:130](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L130) ___ @@ -1087,7 +1159,7 @@ ___ #### Defined in -[client.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L104) +[src/client.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L128) ___ @@ -1097,7 +1169,7 @@ ___ #### Defined in -[client.ts:105](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L105) +[src/client.ts:129](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L129) ___ @@ -1107,7 +1179,7 @@ ___ #### Defined in -[client.ts:107](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L107) +[src/client.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L131) ___ @@ -1117,7 +1189,7 @@ ___ #### Defined in -[client.ts:116](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L116) +[src/client.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L140) ___ @@ -1127,7 +1199,7 @@ ___ #### Defined in -[client.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L108) +[src/client.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L132) ___ @@ -1137,7 +1209,7 @@ ___ #### Defined in -[client.ts:117](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L117) +[src/client.ts:141](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L141) ___ @@ -1147,7 +1219,7 @@ ___ #### Defined in -[client.ts:111](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L111) +[src/client.ts:135](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L135) ___ @@ -1157,7 +1229,7 @@ ___ #### Defined in -[client.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L110) +[src/client.ts:134](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L134) ___ @@ -1167,7 +1239,7 @@ ___ #### Defined in -[client.ts:114](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L114) +[src/client.ts:138](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L138) ___ @@ -1177,14 +1249,14 @@ ___ #### Defined in -[client.ts:109](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L109) +[src/client.ts:133](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L133) ___ ### wallet -• **wallet**: `Signer` \| `Wallet` +• **wallet**: `Signer` \| `Wallet` \| [`RemoteSigner`](RemoteSigner) #### Defined in -[client.ts:115](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L115) +[src/client.ts:139](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L139) diff --git a/docs/sdk/reference/classes/Vote.md b/docs/sdk/reference/classes/Vote.md index 1a63a900a..af09fe74d 100644 --- a/docs/sdk/reference/classes/Vote.md +++ b/docs/sdk/reference/classes/Vote.md @@ -34,7 +34,7 @@ Represents a vote #### Defined in -[types/vote/vote.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/vote/vote.ts#L16) +[src/types/vote/vote.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/vote/vote.ts#L16) • `set` **votes**(`value`): `void` @@ -50,7 +50,7 @@ Represents a vote #### Defined in -[types/vote/vote.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/vote/vote.ts#L20) +[src/types/vote/vote.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/vote/vote.ts#L20) ## Constructors @@ -72,4 +72,4 @@ Constructs a vote #### Defined in -[types/vote/vote.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/vote/vote.ts#L12) +[src/types/vote/vote.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/vote/vote.ts#L12) diff --git a/docs/sdk/reference/classes/VoteAPI.md b/docs/sdk/reference/classes/VoteAPI.md index 0701c960b..072b0098e 100644 --- a/docs/sdk/reference/classes/VoteAPI.md +++ b/docs/sdk/reference/classes/VoteAPI.md @@ -4,7 +4,7 @@ ## Hierarchy -- `API` +- [`API`](API) ↳ **`VoteAPI`** @@ -13,6 +13,7 @@ ### Methods - [info](VoteAPI#info) +- [list](VoteAPI#list) - [submit](VoteAPI#submit) - [verify](VoteAPI#verify) @@ -20,7 +21,7 @@ ### info -▸ **info**(`url`, `voteId`): `Promise`\<[`IVoteInfoResponse`](../interfaces/IVoteInfoResponse)\> +▸ **info**(`url`, `voteId`): `Promise`\<[`VoteInfoResponse`](../sdk-reference#voteinforesponse)\> Vote info @@ -33,11 +34,34 @@ Vote info #### Returns -`Promise`\<[`IVoteInfoResponse`](../interfaces/IVoteInfoResponse)\> +`Promise`\<[`VoteInfoResponse`](../sdk-reference#voteinforesponse)\> #### Defined in -[api/vote.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/vote.ts#L127) +[src/api/vote.ts:143](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/vote.ts#L143) + +___ + +### list + +▸ **list**(`url`, `params?`): `Promise`\<[`IVoteListResponse`](../interfaces/IVoteListResponse)\> + +Fetches the vote list + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `url` | `string` | API endpoint URL | +| `params?` | `Partial`\<[`FetchVotesParametersWithPagination`](../sdk-reference#fetchvotesparameterswithpagination)\> | The parameters to filter the votes | + +#### Returns + +`Promise`\<[`IVoteListResponse`](../interfaces/IVoteListResponse)\> + +#### Defined in + +[src/api/vote.ts:156](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/vote.ts#L156) ___ @@ -45,7 +69,7 @@ ___ ▸ **submit**(`url`, `payload`): `Promise`\<[`IVoteSubmitResponse`](../interfaces/IVoteSubmitResponse)\> -Voting +Submits a payload representing the vote transaction to the chain #### Parameters @@ -60,13 +84,13 @@ Voting #### Defined in -[api/vote.ts:113](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/vote.ts#L113) +[src/api/vote.ts:129](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/vote.ts#L129) ___ ### verify -▸ **verify**(`url`, `processId`, `voteId`): `Promise`\<`boolean`\> +▸ **verify**(`url`, `electionId`, `voteId`): `Promise`\<`boolean`\> Verify vote. A vote exists in a process. @@ -75,7 +99,7 @@ Verify vote. A vote exists in a process. | Name | Type | Description | | :------ | :------ | :------ | | `url` | `string` | API endpoint URL | -| `processId` | `string` | The process identifier | +| `electionId` | `string` | The process identifier | | `voteId` | `string` | The identifier of the vote | #### Returns @@ -86,4 +110,4 @@ Return true if response has status 200 #### Defined in -[api/vote.ts:143](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/vote.ts#L143) +[src/api/vote.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/vote.ts#L173) diff --git a/docs/sdk/reference/classes/VoteService.md b/docs/sdk/reference/classes/VoteService.md index d4648f9dd..7b448b092 100644 --- a/docs/sdk/reference/classes/VoteService.md +++ b/docs/sdk/reference/classes/VoteService.md @@ -54,7 +54,7 @@ Service.constructor #### Defined in -[services/vote.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/vote.ts#L45) +[src/services/vote.ts:52](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/vote.ts#L52) ## Methods @@ -74,13 +74,13 @@ Service.constructor #### Defined in -[services/vote.ts:58](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/vote.ts#L58) +[src/services/vote.ts:69](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/vote.ts#L69) ___ ### info -▸ **info**(`voteId`): `Promise`\<[`IVoteInfoResponse`](../interfaces/IVoteInfoResponse)\> +▸ **info**(`voteId`): `Promise`\<[`VoteInfoResponse`](../sdk-reference#voteinforesponse)\> Get the vote information @@ -92,11 +92,11 @@ Get the vote information #### Returns -`Promise`\<[`IVoteInfoResponse`](../interfaces/IVoteInfoResponse)\> +`Promise`\<[`VoteInfoResponse`](../sdk-reference#voteinforesponse)\> #### Defined in -[services/vote.ts:68](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/vote.ts#L68) +[src/services/vote.ts:79](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/vote.ts#L79) ___ @@ -110,7 +110,7 @@ ___ | :------ | :------ | | `tx` | `Uint8Array` | | `message` | `string` | -| `walletOrSigner` | `Signer` \| `Wallet` | +| `walletOrSigner` | `Signer` \| `Wallet` \| [`RemoteSigner`](RemoteSigner) | #### Returns @@ -118,7 +118,7 @@ ___ #### Defined in -[services/vote.ts:50](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/vote.ts#L50) +[src/services/vote.ts:57](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/vote.ts#L57) ___ @@ -140,7 +140,7 @@ Submit the vote to the chain #### Defined in -[services/vote.ts:79](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/vote.ts#L79) +[src/services/vote.ts:90](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/vote.ts#L90) ## Properties @@ -154,7 +154,7 @@ VoteServiceProperties.chainService #### Defined in -[services/vote.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/vote.ts#L38) +[src/services/vote.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/vote.ts#L45) ___ @@ -168,4 +168,4 @@ ___ #### Defined in -[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/service.ts#L6) +[src/services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/service.ts#L6) diff --git a/docs/sdk/reference/classes/WalletAPI.md b/docs/sdk/reference/classes/WalletAPI.md index cf26df230..573d0fdfc 100644 --- a/docs/sdk/reference/classes/WalletAPI.md +++ b/docs/sdk/reference/classes/WalletAPI.md @@ -4,7 +4,7 @@ ## Hierarchy -- `API` +- [`API`](API) ↳ **`WalletAPI`** @@ -33,4 +33,4 @@ #### Defined in -[api/wallet.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/wallet.ts#L29) +[src/api/wallet.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/wallet.ts#L29) diff --git a/docs/sdk/reference/classes/WeightedCensus.md b/docs/sdk/reference/classes/WeightedCensus.md index 9d016f957..8e0a550b0 100644 --- a/docs/sdk/reference/classes/WeightedCensus.md +++ b/docs/sdk/reference/classes/WeightedCensus.md @@ -48,7 +48,7 @@ OffchainCensus.censusId #### Defined in -[types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L35) +[src/types/census/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L35) • `set` **censusId**(`value`): `void` @@ -68,7 +68,7 @@ OffchainCensus.censusId #### Defined in -[types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L39) +[src/types/census/census.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L39) ___ @@ -86,7 +86,7 @@ OffchainCensus.censusURI #### Defined in -[types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L43) +[src/types/census/census.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L43) • `set` **censusURI**(`value`): `void` @@ -106,7 +106,7 @@ OffchainCensus.censusURI #### Defined in -[types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L47) +[src/types/census/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L47) ___ @@ -124,7 +124,7 @@ OffchainCensus.isPublished #### Defined in -[types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L75) +[src/types/census/census.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L75) ___ @@ -142,7 +142,7 @@ OffchainCensus.participants #### Defined in -[types/census/offchain.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/offchain.ts#L45) +[src/types/census/offchain.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/offchain.ts#L45) • `set` **participants**(`value`): `void` @@ -162,7 +162,7 @@ OffchainCensus.participants #### Defined in -[types/census/offchain.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/offchain.ts#L49) +[src/types/census/offchain.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/offchain.ts#L49) ___ @@ -180,7 +180,7 @@ OffchainCensus.size #### Defined in -[types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L59) +[src/types/census/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L59) • `set` **size**(`value`): `void` @@ -200,7 +200,7 @@ OffchainCensus.size #### Defined in -[types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L63) +[src/types/census/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L63) ___ @@ -218,7 +218,7 @@ OffchainCensus.type #### Defined in -[types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L51) +[src/types/census/census.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L51) • `set` **type**(`value`): `void` @@ -238,7 +238,7 @@ OffchainCensus.type #### Defined in -[types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L55) +[src/types/census/census.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L55) ___ @@ -256,7 +256,7 @@ OffchainCensus.weight #### Defined in -[types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L67) +[src/types/census/census.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L67) • `set` **weight**(`value`): `void` @@ -276,7 +276,7 @@ OffchainCensus.weight #### Defined in -[types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L71) +[src/types/census/census.ts:71](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L71) ## Constructors @@ -296,7 +296,7 @@ OffchainCensus.constructor #### Defined in -[types/census/weighted.ts:10](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/weighted.ts#L10) +[src/types/census/weighted.ts:10](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/weighted.ts#L10) ## Methods @@ -316,7 +316,7 @@ OffchainCensus.constructor #### Defined in -[types/census/weighted.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/weighted.ts#L14) +[src/types/census/weighted.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/weighted.ts#L14) ___ @@ -336,7 +336,7 @@ ___ #### Defined in -[types/census/weighted.ts:18](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/weighted.ts#L18) +[src/types/census/weighted.ts:18](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/weighted.ts#L18) ___ @@ -361,4 +361,4 @@ ___ #### Defined in -[types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L81) +[src/types/census/census.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L81) diff --git a/docs/sdk/reference/classes/ZkAPI.md b/docs/sdk/reference/classes/ZkAPI.md index b65a377fa..570388a42 100644 --- a/docs/sdk/reference/classes/ZkAPI.md +++ b/docs/sdk/reference/classes/ZkAPI.md @@ -4,7 +4,7 @@ ## Hierarchy -- `API` +- [`API`](API) ↳ **`ZkAPI`** @@ -38,7 +38,7 @@ The ZK proof #### Defined in -[api/zk.ts:54](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/zk.ts#L54) +[src/api/zk.ts:54](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/zk.ts#L54) ___ @@ -63,4 +63,4 @@ The ZK proof #### Defined in -[api/zk.ts:68](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/zk.ts#L68) +[src/api/zk.ts:68](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/zk.ts#L68) diff --git a/docs/sdk/reference/enums/CensusOrigin.md b/docs/sdk/reference/enums/CensusOrigin.md index 74b3f7fe6..1a93277a1 100644 --- a/docs/sdk/reference/enums/CensusOrigin.md +++ b/docs/sdk/reference/enums/CensusOrigin.md @@ -25,7 +25,7 @@ #### Defined in -[api/chain/transactions.ts:234](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L234) +[src/api/chain/transactions.ts:235](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L235) ___ @@ -35,7 +35,7 @@ ___ #### Defined in -[api/chain/transactions.ts:240](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L240) +[src/api/chain/transactions.ts:241](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L241) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -[api/chain/transactions.ts:238](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L238) +[src/api/chain/transactions.ts:239](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L239) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -[api/chain/transactions.ts:239](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L239) +[src/api/chain/transactions.ts:240](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L240) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -[api/chain/transactions.ts:241](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L241) +[src/api/chain/transactions.ts:242](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L242) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[api/chain/transactions.ts:242](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L242) +[src/api/chain/transactions.ts:243](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L243) ___ @@ -85,7 +85,7 @@ ___ #### Defined in -[api/chain/transactions.ts:237](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L237) +[src/api/chain/transactions.ts:238](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L238) ___ @@ -95,7 +95,7 @@ ___ #### Defined in -[api/chain/transactions.ts:235](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L235) +[src/api/chain/transactions.ts:236](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L236) ___ @@ -105,7 +105,7 @@ ___ #### Defined in -[api/chain/transactions.ts:236](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L236) +[src/api/chain/transactions.ts:237](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L237) ___ @@ -115,4 +115,4 @@ ___ #### Defined in -[api/chain/transactions.ts:243](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L243) +[src/api/chain/transactions.ts:244](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L244) diff --git a/docs/sdk/reference/enums/CensusType.md b/docs/sdk/reference/enums/CensusType.md index e025287c7..68ee2c9d5 100644 --- a/docs/sdk/reference/enums/CensusType.md +++ b/docs/sdk/reference/enums/CensusType.md @@ -19,7 +19,7 @@ #### Defined in -[types/census/census.ts:3](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L3) +[src/types/census/census.ts:3](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L3) ___ @@ -29,7 +29,7 @@ ___ #### Defined in -[types/census/census.ts:4](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L4) +[src/types/census/census.ts:4](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L4) ___ @@ -39,7 +39,7 @@ ___ #### Defined in -[types/census/census.ts:5](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L5) +[src/types/census/census.ts:5](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L5) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[types/census/census.ts:2](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/census.ts#L2) +[src/types/census/census.ts:2](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/census.ts#L2) diff --git a/docs/sdk/reference/enums/CensusTypeEnum.md b/docs/sdk/reference/enums/CensusTypeEnum.md index 729383d5d..113389c98 100644 --- a/docs/sdk/reference/enums/CensusTypeEnum.md +++ b/docs/sdk/reference/enums/CensusTypeEnum.md @@ -24,7 +24,7 @@ #### Defined in -[api/election.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L150) +[src/api/election.ts:143](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L143) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[api/election.ts:156](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L156) +[src/api/election.ts:149](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L149) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[api/election.ts:154](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L154) +[src/api/election.ts:147](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L147) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[api/election.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L155) +[src/api/election.ts:148](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L148) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[api/election.ts:157](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L157) +[src/api/election.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L150) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[api/election.ts:158](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L158) +[src/api/election.ts:151](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L151) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[api/election.ts:153](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L153) +[src/api/election.ts:146](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L146) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[api/election.ts:151](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L151) +[src/api/election.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L144) ___ @@ -104,4 +104,4 @@ ___ #### Defined in -[api/election.ts:152](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L152) +[src/api/election.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L145) diff --git a/docs/sdk/reference/enums/CspProofType.md b/docs/sdk/reference/enums/CspProofType.md index 1a6c00039..f49866f9a 100644 --- a/docs/sdk/reference/enums/CspProofType.md +++ b/docs/sdk/reference/enums/CspProofType.md @@ -19,7 +19,7 @@ #### Defined in -[services/csp.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/csp.ts#L15) +[src/services/csp.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/csp.ts#L15) ___ @@ -29,7 +29,7 @@ ___ #### Defined in -[services/csp.ts:17](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/csp.ts#L17) +[src/services/csp.ts:17](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/csp.ts#L17) ___ @@ -39,7 +39,7 @@ ___ #### Defined in -[services/csp.ts:18](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/csp.ts#L18) +[src/services/csp.ts:18](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/csp.ts#L18) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[services/csp.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/csp.ts#L16) +[src/services/csp.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/csp.ts#L16) diff --git a/docs/sdk/reference/enums/ElectionCreationSteps.md b/docs/sdk/reference/enums/ElectionCreationSteps.md index 44d954993..b88086a3e 100644 --- a/docs/sdk/reference/enums/ElectionCreationSteps.md +++ b/docs/sdk/reference/enums/ElectionCreationSteps.md @@ -23,7 +23,7 @@ #### Defined in -[services/election.ts:42](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/election.ts#L42) +[src/services/election.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L59) ___ @@ -33,7 +33,7 @@ ___ #### Defined in -[services/election.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/election.ts#L47) +[src/services/election.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L64) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -[services/election.ts:48](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/election.ts#L48) +[src/services/election.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L65) ___ @@ -53,7 +53,7 @@ ___ #### Defined in -[services/election.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/election.ts#L45) +[src/services/election.ts:62](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L62) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[services/election.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/election.ts#L43) +[src/services/election.ts:60](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L60) ___ @@ -73,7 +73,7 @@ ___ #### Defined in -[services/election.ts:41](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/election.ts#L41) +[src/services/election.ts:58](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L58) ___ @@ -83,7 +83,7 @@ ___ #### Defined in -[services/election.ts:44](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/election.ts#L44) +[src/services/election.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L61) ___ @@ -93,4 +93,4 @@ ___ #### Defined in -[services/election.ts:46](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/election.ts#L46) +[src/services/election.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L63) diff --git a/docs/sdk/reference/enums/ElectionResultsTypeNames.md b/docs/sdk/reference/enums/ElectionResultsTypeNames.md index c2fd6adc7..880d4d8bd 100644 --- a/docs/sdk/reference/enums/ElectionResultsTypeNames.md +++ b/docs/sdk/reference/enums/ElectionResultsTypeNames.md @@ -9,6 +9,7 @@ - [APPROVAL](ElectionResultsTypeNames#approval) - [BUDGET](ElectionResultsTypeNames#budget) - [MULTIPLE\_CHOICE](ElectionResultsTypeNames.md#multiple_choice) +- [QUADRATIC](ElectionResultsTypeNames#quadratic) - [SINGLE\_CHOICE\_MULTIQUESTION](ElectionResultsTypeNames.md#single_choice_multiquestion) ## Enumeration Members @@ -19,7 +20,7 @@ #### Defined in -[types/metadata/election.ts:41](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/election.ts#L41) +[src/types/metadata/election.ts:46](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L46) ___ @@ -29,7 +30,7 @@ ___ #### Defined in -[types/metadata/election.ts:40](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/election.ts#L40) +[src/types/metadata/election.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L45) ___ @@ -39,7 +40,17 @@ ___ #### Defined in -[types/metadata/election.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/election.ts#L39) +[src/types/metadata/election.ts:44](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L44) + +___ + +### QUADRATIC + +• **QUADRATIC** = ``"quadratic"`` + +#### Defined in + +[src/types/metadata/election.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L47) ___ @@ -49,4 +60,4 @@ ___ #### Defined in -[types/metadata/election.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/election.ts#L38) +[src/types/metadata/election.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L43) diff --git a/docs/sdk/reference/enums/ElectionStatus.md b/docs/sdk/reference/enums/ElectionStatus.md index da0fe8872..ce894969e 100644 --- a/docs/sdk/reference/enums/ElectionStatus.md +++ b/docs/sdk/reference/enums/ElectionStatus.md @@ -22,7 +22,7 @@ #### Defined in -[types/election/published.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L15) +[src/types/election/published.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L16) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[types/election/published.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L14) +[src/types/election/published.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L15) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[types/election/published.ts:13](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L13) +[src/types/election/published.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L14) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[types/election/published.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L16) +[src/types/election/published.ts:17](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L17) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[types/election/published.ts:11](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L11) +[src/types/election/published.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L12) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[types/election/published.ts:17](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L17) +[src/types/election/published.ts:18](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L18) ___ @@ -82,4 +82,4 @@ ___ #### Defined in -[types/election/published.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L12) +[src/types/election/published.ts:13](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L13) diff --git a/docs/sdk/reference/enums/ElectionStatusReady.md b/docs/sdk/reference/enums/ElectionStatusReady.md index 53437f687..4a3db55b5 100644 --- a/docs/sdk/reference/enums/ElectionStatusReady.md +++ b/docs/sdk/reference/enums/ElectionStatusReady.md @@ -16,4 +16,4 @@ #### Defined in -[types/election/published.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L21) +[src/types/election/published.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L22) diff --git a/docs/sdk/reference/enums/EnvOptions.md b/docs/sdk/reference/enums/EnvOptions.md index 99c10bf44..ace083937 100644 --- a/docs/sdk/reference/enums/EnvOptions.md +++ b/docs/sdk/reference/enums/EnvOptions.md @@ -18,7 +18,7 @@ #### Defined in -[client.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L59) +[src/client.ts:68](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L68) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[client.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L61) +[src/client.ts:70](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L70) ___ @@ -38,4 +38,4 @@ ___ #### Defined in -[client.ts:60](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L60) +[src/client.ts:69](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L69) diff --git a/docs/sdk/reference/enums/TransactionType.md b/docs/sdk/reference/enums/TransactionType.md index 75ababedd..d5074bdee 100644 --- a/docs/sdk/reference/enums/TransactionType.md +++ b/docs/sdk/reference/enums/TransactionType.md @@ -26,7 +26,7 @@ #### Defined in -[api/chain.ts:171](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L171) +[src/api/chain.ts:175](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L175) ___ @@ -36,7 +36,7 @@ ___ #### Defined in -[api/chain.ts:178](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L178) +[src/api/chain.ts:182](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L182) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[api/chain.ts:174](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L174) +[src/api/chain.ts:178](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L178) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[api/chain.ts:170](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L170) +[src/api/chain.ts:174](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L174) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[api/chain.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L173) +[src/api/chain.ts:177](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L177) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[api/chain.ts:175](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L175) +[src/api/chain.ts:179](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L179) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[api/chain.ts:177](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L177) +[src/api/chain.ts:181](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L181) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[api/chain.ts:179](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L179) +[src/api/chain.ts:183](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L183) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[api/chain.ts:172](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L172) +[src/api/chain.ts:176](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L176) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[api/chain.ts:176](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L176) +[src/api/chain.ts:180](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L180) ___ @@ -126,4 +126,4 @@ ___ #### Defined in -[api/chain.ts:169](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L169) +[src/api/chain.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L173) diff --git a/docs/sdk/reference/enums/TxType.md b/docs/sdk/reference/enums/TxType.md index 95fdaa71d..88c276e0e 100644 --- a/docs/sdk/reference/enums/TxType.md +++ b/docs/sdk/reference/enums/TxType.md @@ -40,7 +40,7 @@ #### Defined in -[api/chain/transactions.ts:331](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L331) +[src/api/chain/transactions.ts:331](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L331) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -[api/chain/transactions.ts:334](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L334) +[src/api/chain/transactions.ts:334](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L334) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[api/chain/transactions.ts:320](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L320) +[src/api/chain/transactions.ts:320](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L320) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -[api/chain/transactions.ts:318](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L318) +[src/api/chain/transactions.ts:318](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L318) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[api/chain/transactions.ts:322](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L322) +[src/api/chain/transactions.ts:322](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L322) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[api/chain/transactions.ts:333](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L333) +[src/api/chain/transactions.ts:333](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L333) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[api/chain/transactions.ts:336](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L336) +[src/api/chain/transactions.ts:336](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L336) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[api/chain/transactions.ts:335](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L335) +[src/api/chain/transactions.ts:335](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L335) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[api/chain/transactions.ts:332](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L332) +[src/api/chain/transactions.ts:332](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L332) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[api/chain/transactions.ts:327](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L327) +[src/api/chain/transactions.ts:327](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L327) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[api/chain/transactions.ts:314](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L314) +[src/api/chain/transactions.ts:314](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L314) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[api/chain/transactions.ts:326](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L326) +[src/api/chain/transactions.ts:326](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L326) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[api/chain/transactions.ts:321](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L321) +[src/api/chain/transactions.ts:321](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L321) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[api/chain/transactions.ts:323](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L323) +[src/api/chain/transactions.ts:323](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L323) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[api/chain/transactions.ts:319](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L319) +[src/api/chain/transactions.ts:319](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L319) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[api/chain/transactions.ts:328](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L328) +[src/api/chain/transactions.ts:328](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L328) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -[api/chain/transactions.ts:330](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L330) +[src/api/chain/transactions.ts:330](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L330) ___ @@ -210,7 +210,7 @@ ___ #### Defined in -[api/chain/transactions.ts:316](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L316) +[src/api/chain/transactions.ts:316](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L316) ___ @@ -220,7 +220,7 @@ ___ #### Defined in -[api/chain/transactions.ts:317](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L317) +[src/api/chain/transactions.ts:317](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L317) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -[api/chain/transactions.ts:325](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L325) +[src/api/chain/transactions.ts:325](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L325) ___ @@ -240,7 +240,7 @@ ___ #### Defined in -[api/chain/transactions.ts:315](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L315) +[src/api/chain/transactions.ts:315](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L315) ___ @@ -250,7 +250,7 @@ ___ #### Defined in -[api/chain/transactions.ts:329](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L329) +[src/api/chain/transactions.ts:329](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L329) ___ @@ -260,7 +260,7 @@ ___ #### Defined in -[api/chain/transactions.ts:313](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L313) +[src/api/chain/transactions.ts:313](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L313) ___ @@ -270,7 +270,7 @@ ___ #### Defined in -[api/chain/transactions.ts:337](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L337) +[src/api/chain/transactions.ts:337](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L337) ___ @@ -280,4 +280,4 @@ ___ #### Defined in -[api/chain/transactions.ts:324](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L324) +[src/api/chain/transactions.ts:324](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L324) diff --git a/docs/sdk/reference/enums/VoteSteps.md b/docs/sdk/reference/enums/VoteSteps.md index b65e87deb..25a469b54 100644 --- a/docs/sdk/reference/enums/VoteSteps.md +++ b/docs/sdk/reference/enums/VoteSteps.md @@ -22,7 +22,7 @@ #### Defined in -[services/vote.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/vote.ts#L22) +[src/services/vote.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/vote.ts#L29) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[services/vote.ts:25](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/vote.ts#L25) +[src/services/vote.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/vote.ts#L32) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[services/vote.ts:23](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/vote.ts#L23) +[src/services/vote.ts:30](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/vote.ts#L30) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[services/vote.ts:19](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/vote.ts#L19) +[src/services/vote.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/vote.ts#L26) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[services/vote.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/vote.ts#L20) +[src/services/vote.ts:27](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/vote.ts#L27) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[services/vote.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/vote.ts#L21) +[src/services/vote.ts:28](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/vote.ts#L28) ___ @@ -82,4 +82,4 @@ ___ #### Defined in -[services/vote.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/vote.ts#L24) +[src/services/vote.ts:31](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/vote.ts#L31) diff --git a/docs/sdk/reference/interfaces/AccountMetadata.md b/docs/sdk/reference/interfaces/AccountMetadata.md index 08fabecc3..cec712a27 100644 --- a/docs/sdk/reference/interfaces/AccountMetadata.md +++ b/docs/sdk/reference/interfaces/AccountMetadata.md @@ -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/account.ts#L53) +[src/types/metadata/account.ts:53](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/account.ts#L53) ___ @@ -35,7 +35,7 @@ ___ #### Defined in -[types/metadata/account.ts:50](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/account.ts#L50) +[src/types/metadata/account.ts:50](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/account.ts#L50) ___ @@ -53,7 +53,7 @@ ___ #### Defined in -[types/metadata/account.ts:57](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/account.ts#L57) +[src/types/metadata/account.ts:57](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/account.ts#L57) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[types/metadata/account.ts:62](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/account.ts#L62) +[src/types/metadata/account.ts:62](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/account.ts#L62) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -[types/metadata/account.ts:52](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/account.ts#L52) +[src/types/metadata/account.ts:52](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/account.ts#L52) ___ @@ -87,7 +87,7 @@ ___ #### Defined in -[types/metadata/account.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/account.ts#L55) +[src/types/metadata/account.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/account.ts#L55) ___ @@ -97,4 +97,4 @@ ___ #### Defined in -[types/metadata/account.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/account.ts#L49) +[src/types/metadata/account.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/account.ts#L49) diff --git a/docs/sdk/reference/interfaces/AdminTx.md b/docs/sdk/reference/interfaces/AdminTx.md index ae8e7dd1f..01534fa46 100644 --- a/docs/sdk/reference/interfaces/AdminTx.md +++ b/docs/sdk/reference/interfaces/AdminTx.md @@ -24,7 +24,7 @@ #### Defined in -[api/chain/transactions.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L92) +[src/api/chain/transactions.ts:93](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L93) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[api/chain/transactions.ts:93](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L93) +[src/api/chain/transactions.ts:94](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L94) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[api/chain/transactions.ts:94](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L94) +[src/api/chain/transactions.ts:95](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L95) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[api/chain/transactions.ts:95](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L95) +[src/api/chain/transactions.ts:96](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L96) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[api/chain/transactions.ts:98](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L98) +[src/api/chain/transactions.ts:99](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L99) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[api/chain/transactions.ts:96](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L96) +[src/api/chain/transactions.ts:97](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L97) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[api/chain/transactions.ts:91](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L91) +[src/api/chain/transactions.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L92) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[api/chain/transactions.ts:97](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L97) +[src/api/chain/transactions.ts:98](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L98) ___ @@ -104,4 +104,4 @@ ___ #### Defined in -[api/chain/transactions.ts:90](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L90) +[src/api/chain/transactions.ts:91](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L91) diff --git a/docs/sdk/reference/interfaces/CircuitInputs.md b/docs/sdk/reference/interfaces/CircuitInputs.md index 04ba497d3..2520ec412 100644 --- a/docs/sdk/reference/interfaces/CircuitInputs.md +++ b/docs/sdk/reference/interfaces/CircuitInputs.md @@ -27,7 +27,7 @@ #### Defined in -[services/anonymous.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L43) +[src/services/anonymous.ts:44](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L44) ___ @@ -37,7 +37,7 @@ ___ #### Defined in -[services/anonymous.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L38) +[src/services/anonymous.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L39) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -[services/anonymous.ts:41](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L41) +[src/services/anonymous.ts:42](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L42) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[services/anonymous.ts:48](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L48) +[src/services/anonymous.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L49) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[services/anonymous.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L36) +[src/services/anonymous.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L37) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -[services/anonymous.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L37) +[src/services/anonymous.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L38) ___ @@ -87,7 +87,7 @@ ___ #### Defined in -[services/anonymous.ts:44](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L44) +[src/services/anonymous.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L45) ___ @@ -97,7 +97,7 @@ ___ #### Defined in -[services/anonymous.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L45) +[src/services/anonymous.ts:46](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L46) ___ @@ -107,7 +107,7 @@ ___ #### Defined in -[services/anonymous.ts:40](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L40) +[src/services/anonymous.ts:41](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L41) ___ @@ -117,7 +117,7 @@ ___ #### Defined in -[services/anonymous.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L47) +[src/services/anonymous.ts:48](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L48) ___ @@ -127,7 +127,7 @@ ___ #### Defined in -[services/anonymous.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L39) +[src/services/anonymous.ts:40](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L40) ___ @@ -137,4 +137,4 @@ ___ #### Defined in -[services/anonymous.ts:46](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L46) +[src/services/anonymous.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L47) diff --git a/docs/sdk/reference/interfaces/CollectFaucetTx.md b/docs/sdk/reference/interfaces/CollectFaucetTx.md index ce899779f..bb6824b95 100644 --- a/docs/sdk/reference/interfaces/CollectFaucetTx.md +++ b/docs/sdk/reference/interfaces/CollectFaucetTx.md @@ -18,7 +18,7 @@ #### Defined in -[api/chain/transactions.ts:158](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L158) +[src/api/chain/transactions.ts:159](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L159) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[api/chain/transactions.ts:159](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L159) +[src/api/chain/transactions.ts:160](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L160) ___ @@ -38,4 +38,4 @@ ___ #### Defined in -[api/chain/transactions.ts:157](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L157) +[src/api/chain/transactions.ts:158](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L158) diff --git a/docs/sdk/reference/interfaces/ElectionMetadata.md b/docs/sdk/reference/interfaces/ElectionMetadata.md index 0427da3e7..a06bd50f9 100644 --- a/docs/sdk/reference/interfaces/ElectionMetadata.md +++ b/docs/sdk/reference/interfaces/ElectionMetadata.md @@ -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/election.ts#L127) +[src/types/metadata/election.ts:153](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L153) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[types/metadata/election.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/election.ts#L128) +[src/types/metadata/election.ts:154](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L154) ___ @@ -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/election.ts#L133) +[src/types/metadata/election.ts:159](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L159) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[types/metadata/election.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/election.ts#L136) +[src/types/metadata/election.ts:162](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L162) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[types/metadata/election.ts:126](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/election.ts#L126) +[src/types/metadata/election.ts:152](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L152) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[types/metadata/election.ts:137](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/election.ts#L137) +[src/types/metadata/election.ts:163](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L163) ___ @@ -98,4 +98,4 @@ ___ #### Defined in -[types/metadata/election.ts:125](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/election.ts#L125) +[src/types/metadata/election.ts:151](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L151) diff --git a/docs/sdk/reference/interfaces/FetchAccountsParameters.md b/docs/sdk/reference/interfaces/FetchAccountsParameters.md new file mode 100644 index 000000000..abc3166b9 --- /dev/null +++ b/docs/sdk/reference/interfaces/FetchAccountsParameters.md @@ -0,0 +1,3 @@ +[@vocdoni/sdk](/sdk) / FetchAccountsParameters + +# Interface: FetchAccountsParameters diff --git a/docs/sdk/reference/interfaces/FetchBlocksParameters.md b/docs/sdk/reference/interfaces/FetchBlocksParameters.md new file mode 100644 index 000000000..f2cf6f3e6 --- /dev/null +++ b/docs/sdk/reference/interfaces/FetchBlocksParameters.md @@ -0,0 +1,41 @@ +[@vocdoni/sdk](/sdk) / FetchBlocksParameters + +# Interface: FetchBlocksParameters + +## Table of contents + +### Properties + +- [chainId](FetchBlocksParameters#chainid) +- [hash](FetchBlocksParameters#hash) +- [proposerAddress](FetchBlocksParameters#proposeraddress) + +## Properties + +### chainId + +• **chainId**: `string` + +#### Defined in + +[src/services/chain.ts:50](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L50) + +___ + +### hash + +• **hash**: `string` + +#### Defined in + +[src/services/chain.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L49) + +___ + +### proposerAddress + +• **proposerAddress**: `string` + +#### Defined in + +[src/services/chain.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L51) diff --git a/docs/sdk/reference/interfaces/FetchElectionsParameters.md b/docs/sdk/reference/interfaces/FetchElectionsParameters.md index 6fe66713a..8ba928f1f 100644 --- a/docs/sdk/reference/interfaces/FetchElectionsParameters.md +++ b/docs/sdk/reference/interfaces/FetchElectionsParameters.md @@ -6,25 +6,69 @@ ### Properties -- [account](FetchElectionsParameters#account) -- [page](FetchElectionsParameters#page) +- [electionId](FetchElectionsParameters#electionid) +- [finalResults](FetchElectionsParameters#finalresults) +- [manuallyEnded](FetchElectionsParameters#manuallyended) +- [organizationId](FetchElectionsParameters#organizationid) +- [status](FetchElectionsParameters#status) +- [withResults](FetchElectionsParameters#withresults) ## Properties -### account +### electionId -• **account**: `string` +• **electionId**: `string` #### Defined in -[services/election.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/election.ts#L33) +[src/services/election.ts:44](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L44) ___ -### page +### finalResults -• **page**: `number` +• **finalResults**: `boolean` #### Defined in -[services/election.ts:34](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/election.ts#L34) +[src/services/election.ts:46](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L46) + +___ + +### manuallyEnded + +• **manuallyEnded**: `boolean` + +#### Defined in + +[src/services/election.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L47) + +___ + +### organizationId + +• **organizationId**: `string` + +#### Defined in + +[src/services/election.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L43) + +___ + +### status + +• **status**: [`PROCESS_UNKNOWN`](../enums/ElectionStatus.md#process_unknown) \| [`ENDED`](../enums/ElectionStatus.md#ended) \| [`CANCELED`](../enums/ElectionStatus.md#canceled) \| [`PAUSED`](../enums/ElectionStatus.md#paused) \| [`RESULTS`](../enums/ElectionStatus.md#results) \| [`READY`](../enums/ElectionStatusReady#ready) + +#### Defined in + +[src/services/election.ts:48](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L48) + +___ + +### withResults + +• **withResults**: `boolean` + +#### Defined in + +[src/services/election.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L45) diff --git a/docs/sdk/reference/interfaces/FetchFeesParameters.md b/docs/sdk/reference/interfaces/FetchFeesParameters.md new file mode 100644 index 000000000..96606f475 --- /dev/null +++ b/docs/sdk/reference/interfaces/FetchFeesParameters.md @@ -0,0 +1,41 @@ +[@vocdoni/sdk](/sdk) / FetchFeesParameters + +# Interface: FetchFeesParameters + +## Table of contents + +### Properties + +- [accountId](FetchFeesParameters#accountid) +- [reference](FetchFeesParameters#reference) +- [type](FetchFeesParameters#type) + +## Properties + +### accountId + +• **accountId**: `string` + +#### Defined in + +[src/services/chain.ts:30](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L30) + +___ + +### reference + +• **reference**: `string` + +#### Defined in + +[src/services/chain.ts:28](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L28) + +___ + +### type + +• **type**: `string` + +#### Defined in + +[src/services/chain.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L29) diff --git a/docs/sdk/reference/interfaces/FetchOrganizationParameters.md b/docs/sdk/reference/interfaces/FetchOrganizationParameters.md new file mode 100644 index 000000000..f43eabaaa --- /dev/null +++ b/docs/sdk/reference/interfaces/FetchOrganizationParameters.md @@ -0,0 +1,19 @@ +[@vocdoni/sdk](/sdk) / FetchOrganizationParameters + +# Interface: FetchOrganizationParameters + +## Table of contents + +### Properties + +- [organizationId](FetchOrganizationParameters#organizationid) + +## Properties + +### organizationId + +• **organizationId**: `string` + +#### Defined in + +[src/services/chain.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L24) diff --git a/docs/sdk/reference/interfaces/FetchTransactionsParameters.md b/docs/sdk/reference/interfaces/FetchTransactionsParameters.md new file mode 100644 index 000000000..cb31359ad --- /dev/null +++ b/docs/sdk/reference/interfaces/FetchTransactionsParameters.md @@ -0,0 +1,74 @@ +[@vocdoni/sdk](/sdk) / FetchTransactionsParameters + +# Interface: FetchTransactionsParameters + +## Table of contents + +### Properties + +- [hash](FetchTransactionsParameters#hash) +- [height](FetchTransactionsParameters#height) +- [index](FetchTransactionsParameters#index) +- [signer](FetchTransactionsParameters#signer) +- [subtype](FetchTransactionsParameters#subtype) +- [type](FetchTransactionsParameters#type) + +## Properties + +### hash + +• **hash**: `string` + +#### Defined in + +[src/services/chain.ts:40](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L40) + +___ + +### height + +• **height**: `number` + +#### Defined in + +[src/services/chain.ts:41](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L41) + +___ + +### index + +• **index**: `number` + +#### Defined in + +[src/services/chain.ts:42](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L42) + +___ + +### signer + +• **signer**: `string` + +#### Defined in + +[src/services/chain.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L45) + +___ + +### subtype + +• **subtype**: `string` + +#### Defined in + +[src/services/chain.ts:44](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L44) + +___ + +### type + +• **type**: `string` + +#### Defined in + +[src/services/chain.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L43) diff --git a/docs/sdk/reference/interfaces/FetchTransfersParameters.md b/docs/sdk/reference/interfaces/FetchTransfersParameters.md new file mode 100644 index 000000000..02896e6d5 --- /dev/null +++ b/docs/sdk/reference/interfaces/FetchTransfersParameters.md @@ -0,0 +1,41 @@ +[@vocdoni/sdk](/sdk) / FetchTransfersParameters + +# Interface: FetchTransfersParameters + +## Table of contents + +### Properties + +- [accountId](FetchTransfersParameters#accountid) +- [accountIdFrom](FetchTransfersParameters#accountidfrom) +- [accountIdTo](FetchTransfersParameters#accountidto) + +## Properties + +### accountId + +• **accountId**: `string` + +#### Defined in + +[src/services/chain.ts:34](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L34) + +___ + +### accountIdFrom + +• **accountIdFrom**: `string` + +#### Defined in + +[src/services/chain.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L35) + +___ + +### accountIdTo + +• **accountIdTo**: `string` + +#### Defined in + +[src/services/chain.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L36) diff --git a/docs/sdk/reference/interfaces/FetchVotesParameters.md b/docs/sdk/reference/interfaces/FetchVotesParameters.md new file mode 100644 index 000000000..bd2f6dcd4 --- /dev/null +++ b/docs/sdk/reference/interfaces/FetchVotesParameters.md @@ -0,0 +1,19 @@ +[@vocdoni/sdk](/sdk) / FetchVotesParameters + +# Interface: FetchVotesParameters + +## Table of contents + +### Properties + +- [electionId](FetchVotesParameters#electionid) + +## Properties + +### electionId + +• **electionId**: `string` + +#### Defined in + +[src/services/vote.ts:19](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/vote.ts#L19) diff --git a/docs/sdk/reference/interfaces/IAccount.md b/docs/sdk/reference/interfaces/IAccount.md index 2679471d2..3f2e88fc2 100644 --- a/docs/sdk/reference/interfaces/IAccount.md +++ b/docs/sdk/reference/interfaces/IAccount.md @@ -23,7 +23,7 @@ #### Defined in -[types/account.ts:10](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L10) +[src/types/account.ts:10](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/account.ts#L10) ___ @@ -33,7 +33,7 @@ ___ #### Defined in -[types/account.ts:7](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L7) +[src/types/account.ts:7](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/account.ts#L7) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -[types/account.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L8) +[src/types/account.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/account.ts#L8) ___ @@ -53,7 +53,7 @@ ___ #### Defined in -[types/account.ts:9](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L9) +[src/types/account.ts:9](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/account.ts#L9) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[types/account.ts:5](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L5) +[src/types/account.ts:5](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/account.ts#L5) ___ @@ -73,7 +73,7 @@ ___ #### Defined in -[types/account.ts:11](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L11) +[src/types/account.ts:11](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/account.ts#L11) ___ @@ -83,7 +83,7 @@ ___ #### Defined in -[types/account.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L12) +[src/types/account.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/account.ts#L12) ___ @@ -93,4 +93,4 @@ ___ #### Defined in -[types/account.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L6) +[src/types/account.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/account.ts#L6) diff --git a/docs/sdk/reference/interfaces/IAccountInfoResponse.md b/docs/sdk/reference/interfaces/IAccountInfoResponse.md new file mode 100644 index 000000000..f08ef1a92 --- /dev/null +++ b/docs/sdk/reference/interfaces/IAccountInfoResponse.md @@ -0,0 +1,125 @@ +[@vocdoni/sdk](/sdk) / IAccountInfoResponse + +# Interface: IAccountInfoResponse + +## Table of contents + +### Properties + +- [address](IAccountInfoResponse#address) +- [balance](IAccountInfoResponse#balance) +- [electionIndex](IAccountInfoResponse#electionindex) +- [feesCount](IAccountInfoResponse#feescount) +- [infoURL](IAccountInfoResponse#infourl) +- [metadata](IAccountInfoResponse#metadata) +- [nonce](IAccountInfoResponse#nonce) +- [sik](IAccountInfoResponse#sik) +- [transfersCount](IAccountInfoResponse#transferscount) + +## Properties + +### address + +• **address**: `string` + +The address of the account + +#### Defined in + +[src/api/account.ts:19](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/account.ts#L19) + +___ + +### balance + +• **balance**: `number` + +The current balance in tokens. + +#### Defined in + +[src/api/account.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/account.ts#L24) + +___ + +### electionIndex + +• **electionIndex**: `number` + +The index of the elections created by the account. + +#### Defined in + +[src/api/account.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/account.ts#L39) + +___ + +### feesCount + +• **feesCount**: `number` + +The number of fees of the account. + +#### Defined in + +[src/api/account.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/account.ts#L49) + +___ + +### infoURL + +• `Optional` **infoURL**: `string` + +The information URI of the account + +#### Defined in + +[src/api/account.ts:54](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/account.ts#L54) + +___ + +### metadata + +• **metadata**: [`AccountMetadata`](AccountMetadata) + +The metadata of the account + +#### Defined in + +[src/api/account.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/account.ts#L59) + +___ + +### nonce + +• **nonce**: `number` + +The nonce of the account. + +#### Defined in + +[src/api/account.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/account.ts#L29) + +___ + +### sik + +• **sik**: `string` + +The sik of the account. + +#### Defined in + +[src/api/account.ts:34](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/account.ts#L34) + +___ + +### transfersCount + +• **transfersCount**: `number` + +The number of transfers of the account. + +#### Defined in + +[src/api/account.ts:44](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/account.ts#L44) diff --git a/docs/sdk/reference/interfaces/IAccountTransfersCountResponse.md b/docs/sdk/reference/interfaces/IAccountTransfersCountResponse.md deleted file mode 100644 index 2475616eb..000000000 --- a/docs/sdk/reference/interfaces/IAccountTransfersCountResponse.md +++ /dev/null @@ -1,21 +0,0 @@ -[@vocdoni/sdk](/sdk) / IAccountTransfersCountResponse - -# Interface: IAccountTransfersCountResponse - -## Table of contents - -### Properties - -- [count](IAccountTransfersCountResponse#count) - -## Properties - -### count - -• **count**: `number` - -Number of account's transfers - -#### Defined in - -[api/account.ts:97](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L97) diff --git a/docs/sdk/reference/interfaces/IAccountsCountResponse.md b/docs/sdk/reference/interfaces/IAccountsCountResponse.md deleted file mode 100644 index 960d447b0..000000000 --- a/docs/sdk/reference/interfaces/IAccountsCountResponse.md +++ /dev/null @@ -1,21 +0,0 @@ -[@vocdoni/sdk](/sdk) / IAccountsCountResponse - -# Interface: IAccountsCountResponse - -## Table of contents - -### Properties - -- [count](IAccountsCountResponse#count) - -## Properties - -### count - -• **count**: `number` - -Number of accounts - -#### Defined in - -[api/account.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L104) diff --git a/docs/sdk/reference/interfaces/IAccountsList.md b/docs/sdk/reference/interfaces/IAccountsList.md new file mode 100644 index 000000000..1b47e0db3 --- /dev/null +++ b/docs/sdk/reference/interfaces/IAccountsList.md @@ -0,0 +1,27 @@ +[@vocdoni/sdk](/sdk) / IAccountsList + +# Interface: IAccountsList + +## Hierarchy + +- **`IAccountsList`** + + ↳ [`IAccountsListResponse`](IAccountsListResponse) + +## Table of contents + +### Properties + +- [accounts](IAccountsList#accounts) + +## Properties + +### accounts + +• **accounts**: [`IAccountSummary`](../sdk-reference#iaccountsummary)[] + +List of accounts + +#### Defined in + +[src/api/account.ts:80](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/account.ts#L80) diff --git a/docs/sdk/reference/interfaces/IAccountsListResponse.md b/docs/sdk/reference/interfaces/IAccountsListResponse.md index 1e8b7ccd6..f5650e701 100644 --- a/docs/sdk/reference/interfaces/IAccountsListResponse.md +++ b/docs/sdk/reference/interfaces/IAccountsListResponse.md @@ -2,11 +2,20 @@ # Interface: IAccountsListResponse +## Hierarchy + +- [`IAccountsList`](IAccountsList) + +- [`PaginationResponse`](PaginationResponse) + + ↳ **`IAccountsListResponse`** + ## Table of contents ### Properties - [accounts](IAccountsListResponse#accounts) +- [pagination](IAccountsListResponse#pagination) ## Properties @@ -16,6 +25,34 @@ List of accounts +#### Inherited from + +[IAccountsList](IAccountsList.md).[accounts](IAccountsList#accounts) + +#### Defined in + +[src/api/account.ts:80](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/account.ts#L80) + +___ + +### pagination + +• **pagination**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `currentPage` | `number` | +| `lastPage` | `number` | +| `nextPage` | `number` | +| `previousPage` | `number` | +| `totalItems` | `number` | + +#### Inherited from + +[PaginationResponse](PaginationResponse.md).[pagination](PaginationResponse#pagination) + #### Defined in -[api/account.ts:90](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L90) +[src/api/api.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/api.ts#L131) diff --git a/docs/sdk/reference/interfaces/IApprovalElectionParameters.md b/docs/sdk/reference/interfaces/IApprovalElectionParameters.md index d30a93a41..85801af3f 100644 --- a/docs/sdk/reference/interfaces/IApprovalElectionParameters.md +++ b/docs/sdk/reference/interfaces/IApprovalElectionParameters.md @@ -43,7 +43,7 @@ Used to add the SDK version to the election metadata #### Defined in -[types/election/election.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L168) +[src/types/election/election.ts:164](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L164) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[types/election/election.ts:142](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L142) +[src/types/election/election.ts:138](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L138) ___ @@ -73,7 +73,7 @@ Election description #### Defined in -[types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L127) +[src/types/election/election.ts:123](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L123) ___ @@ -87,7 +87,7 @@ ___ #### Defined in -[types/election/election.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L144) +[src/types/election/election.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L140) ___ @@ -101,7 +101,7 @@ ___ #### Defined in -[types/election/election.ts:141](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L141) +[src/types/election/election.ts:137](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L137) ___ @@ -117,7 +117,7 @@ Election header image url. #### Defined in -[types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L131) +[src/types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L127) ___ @@ -141,7 +141,7 @@ size` error. #### Defined in -[types/election/election.ts:158](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L158) +[src/types/election/election.ts:154](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L154) ___ @@ -157,7 +157,7 @@ Metadata (anything added by the election creator) #### Defined in -[types/election/election.ts:139](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L139) +[src/types/election/election.ts:135](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L135) ___ @@ -171,7 +171,7 @@ ___ #### Defined in -[types/election/election.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L145) +[src/types/election/election.ts:141](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L141) ___ @@ -185,7 +185,7 @@ ___ #### Defined in -[types/election/election.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L140) +[src/types/election/election.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L136) ___ @@ -201,7 +201,7 @@ Election stream Uri (ex: a video url) #### Defined in -[types/election/election.ts:135](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L135) +[src/types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L131) ___ @@ -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:163](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L163) +[src/types/election/election.ts:159](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L159) ___ @@ -233,7 +233,7 @@ Election title #### Defined in -[types/election/election.ts:123](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L123) +[src/types/election/election.ts:119](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L119) ___ @@ -247,4 +247,4 @@ ___ #### Defined in -[types/election/election.ts:143](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L143) +[src/types/election/election.ts:139](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L139) diff --git a/docs/sdk/reference/interfaces/IBlock.md b/docs/sdk/reference/interfaces/IBlock.md new file mode 100644 index 000000000..814e4417d --- /dev/null +++ b/docs/sdk/reference/interfaces/IBlock.md @@ -0,0 +1,85 @@ +[@vocdoni/sdk](/sdk) / IBlock + +# Interface: IBlock + +## Table of contents + +### Properties + +- [chainId](IBlock#chainid) +- [hash](IBlock#hash) +- [height](IBlock#height) +- [lastBlockHash](IBlock#lastblockhash) +- [proposer](IBlock#proposer) +- [time](IBlock#time) +- [txCount](IBlock#txcount) + +## Properties + +### chainId + +• **chainId**: `string` + +#### Defined in + +[src/api/chain.ts:274](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L274) + +___ + +### hash + +• **hash**: `string` + +#### Defined in + +[src/api/chain.ts:277](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L277) + +___ + +### height + +• **height**: `number` + +#### Defined in + +[src/api/chain.ts:275](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L275) + +___ + +### lastBlockHash + +• **lastBlockHash**: `string` + +#### Defined in + +[src/api/chain.ts:279](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L279) + +___ + +### proposer + +• **proposer**: `string` + +#### Defined in + +[src/api/chain.ts:278](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L278) + +___ + +### time + +• **time**: `string` + +#### Defined in + +[src/api/chain.ts:276](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L276) + +___ + +### txCount + +• **txCount**: `number` + +#### Defined in + +[src/api/chain.ts:280](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L280) diff --git a/docs/sdk/reference/interfaces/IBlockTransactionsResponse.md b/docs/sdk/reference/interfaces/IBlockTransactionsResponse.md deleted file mode 100644 index e1d0130d1..000000000 --- a/docs/sdk/reference/interfaces/IBlockTransactionsResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -[@vocdoni/sdk](/sdk) / IBlockTransactionsResponse - -# Interface: IBlockTransactionsResponse - -## Table of contents - -### Properties - -- [blockNumber](IBlockTransactionsResponse#blocknumber) -- [transactionCount](IBlockTransactionsResponse#transactioncount) -- [transactions](IBlockTransactionsResponse#transactions) - -## Properties - -### blockNumber - -• **blockNumber**: `number` - -#### Defined in - -[api/chain.ts:315](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L315) - -___ - -### transactionCount - -• **transactionCount**: `number` - -#### Defined in - -[api/chain.ts:316](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L316) - -___ - -### transactions - -• **transactions**: [`IChainTxReference`](IChainTxReference)[] - -#### Defined in - -[api/chain.ts:317](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L317) diff --git a/docs/sdk/reference/interfaces/IBudgetElectionParametersInfo.md b/docs/sdk/reference/interfaces/IBudgetElectionParametersInfo.md index cc76bf61b..d9eef07bc 100644 --- a/docs/sdk/reference/interfaces/IBudgetElectionParametersInfo.md +++ b/docs/sdk/reference/interfaces/IBudgetElectionParametersInfo.md @@ -49,7 +49,7 @@ Used to add the SDK version to the election metadata #### Defined in -[types/election/election.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L168) +[src/types/election/election.ts:164](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L164) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[types/election/election.ts:142](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L142) +[src/types/election/election.ts:138](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L138) ___ @@ -79,7 +79,7 @@ Election description #### Defined in -[types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L127) +[src/types/election/election.ts:123](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L123) ___ @@ -93,7 +93,7 @@ ___ #### Defined in -[types/election/election.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L144) +[src/types/election/election.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L140) ___ @@ -107,7 +107,7 @@ ___ #### Defined in -[types/election/election.ts:141](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L141) +[src/types/election/election.ts:137](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L137) ___ @@ -117,7 +117,7 @@ ___ #### Defined in -[types/election/budget.ts:9](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/budget.ts#L9) +[src/types/election/budget.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/budget.ts#L15) ___ @@ -133,7 +133,7 @@ Election header image url. #### Defined in -[types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L131) +[src/types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L127) ___ @@ -157,7 +157,7 @@ size` error. #### Defined in -[types/election/election.ts:158](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L158) +[src/types/election/election.ts:154](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L154) ___ @@ -173,7 +173,7 @@ Metadata (anything added by the election creator) #### Defined in -[types/election/election.ts:139](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L139) +[src/types/election/election.ts:135](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L135) ___ @@ -183,7 +183,7 @@ ___ #### Defined in -[types/election/budget.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/budget.ts#L8) +[src/types/election/budget.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/budget.ts#L14) ___ @@ -197,7 +197,7 @@ ___ #### Defined in -[types/election/election.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L145) +[src/types/election/election.ts:141](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L141) ___ @@ -211,7 +211,7 @@ ___ #### Defined in -[types/election/election.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L140) +[src/types/election/election.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L136) ___ @@ -227,7 +227,7 @@ Election stream Uri (ex: a video url) #### Defined in -[types/election/election.ts:135](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L135) +[src/types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L131) ___ @@ -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:163](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L163) +[src/types/election/election.ts:159](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L159) ___ @@ -259,7 +259,7 @@ Election title #### Defined in -[types/election/election.ts:123](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L123) +[src/types/election/election.ts:119](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L119) ___ @@ -273,4 +273,4 @@ ___ #### Defined in -[types/election/election.ts:143](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L143) +[src/types/election/election.ts:139](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L139) diff --git a/docs/sdk/reference/interfaces/IBudgetElectionParametersWithBudget.md b/docs/sdk/reference/interfaces/IBudgetElectionParametersWithBudget.md index 457e224c0..422c85fc7 100644 --- a/docs/sdk/reference/interfaces/IBudgetElectionParametersWithBudget.md +++ b/docs/sdk/reference/interfaces/IBudgetElectionParametersWithBudget.md @@ -47,7 +47,7 @@ Used to add the SDK version to the election metadata #### Defined in -[types/election/election.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L168) +[src/types/election/election.ts:164](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L164) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[types/election/election.ts:142](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L142) +[src/types/election/election.ts:138](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L138) ___ @@ -77,7 +77,7 @@ Election description #### Defined in -[types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L127) +[src/types/election/election.ts:123](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L123) ___ @@ -91,7 +91,7 @@ ___ #### Defined in -[types/election/election.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L144) +[src/types/election/election.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L140) ___ @@ -105,7 +105,7 @@ ___ #### Defined in -[types/election/election.ts:141](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L141) +[src/types/election/election.ts:137](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L137) ___ @@ -119,7 +119,7 @@ ___ #### Defined in -[types/election/budget.ts:9](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/budget.ts#L9) +[src/types/election/budget.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/budget.ts#L15) ___ @@ -135,7 +135,7 @@ Election header image url. #### Defined in -[types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L131) +[src/types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L127) ___ @@ -145,7 +145,7 @@ ___ #### Defined in -[types/election/budget.ts:18](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/budget.ts#L18) +[src/types/election/budget.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/budget.ts#L24) ___ @@ -169,7 +169,7 @@ size` error. #### Defined in -[types/election/election.ts:158](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L158) +[src/types/election/election.ts:154](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L154) ___ @@ -185,7 +185,7 @@ Metadata (anything added by the election creator) #### Defined in -[types/election/election.ts:139](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L139) +[src/types/election/election.ts:135](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L135) ___ @@ -199,7 +199,7 @@ ___ #### Defined in -[types/election/budget.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/budget.ts#L8) +[src/types/election/budget.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/budget.ts#L14) ___ @@ -213,7 +213,7 @@ ___ #### Defined in -[types/election/election.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L145) +[src/types/election/election.ts:141](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L141) ___ @@ -227,7 +227,7 @@ ___ #### Defined in -[types/election/election.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L140) +[src/types/election/election.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L136) ___ @@ -243,7 +243,7 @@ Election stream Uri (ex: a video url) #### Defined in -[types/election/election.ts:135](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L135) +[src/types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L131) ___ @@ -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:163](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L163) +[src/types/election/election.ts:159](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L159) ___ @@ -275,7 +275,7 @@ Election title #### Defined in -[types/election/election.ts:123](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L123) +[src/types/election/election.ts:119](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L119) ___ @@ -285,7 +285,7 @@ ___ #### Defined in -[types/election/budget.ts:17](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/budget.ts#L17) +[src/types/election/budget.ts:23](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/budget.ts#L23) ___ @@ -299,4 +299,4 @@ ___ #### Defined in -[types/election/election.ts:143](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L143) +[src/types/election/election.ts:139](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L139) diff --git a/docs/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight.md b/docs/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight.md index 91919bd66..85f5a1aef 100644 --- a/docs/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight.md +++ b/docs/sdk/reference/interfaces/IBudgetElectionParametersWithCensusWeight.md @@ -46,7 +46,7 @@ Used to add the SDK version to the election metadata #### Defined in -[types/election/election.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L168) +[src/types/election/election.ts:164](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L164) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -[types/election/election.ts:142](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L142) +[src/types/election/election.ts:138](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L138) ___ @@ -76,7 +76,7 @@ Election description #### Defined in -[types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L127) +[src/types/election/election.ts:123](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L123) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[types/election/election.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L144) +[src/types/election/election.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L140) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[types/election/election.ts:141](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L141) +[src/types/election/election.ts:137](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L137) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[types/election/budget.ts:9](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/budget.ts#L9) +[src/types/election/budget.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/budget.ts#L15) ___ @@ -134,7 +134,7 @@ Election header image url. #### Defined in -[types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L131) +[src/types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L127) ___ @@ -158,7 +158,7 @@ size` error. #### Defined in -[types/election/election.ts:158](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L158) +[src/types/election/election.ts:154](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L154) ___ @@ -174,7 +174,7 @@ Metadata (anything added by the election creator) #### Defined in -[types/election/election.ts:139](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L139) +[src/types/election/election.ts:135](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L135) ___ @@ -188,7 +188,7 @@ ___ #### Defined in -[types/election/budget.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/budget.ts#L8) +[src/types/election/budget.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/budget.ts#L14) ___ @@ -202,7 +202,7 @@ ___ #### Defined in -[types/election/election.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L145) +[src/types/election/election.ts:141](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L141) ___ @@ -216,7 +216,7 @@ ___ #### Defined in -[types/election/election.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L140) +[src/types/election/election.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L136) ___ @@ -232,7 +232,7 @@ Election stream Uri (ex: a video url) #### Defined in -[types/election/election.ts:135](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L135) +[src/types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L131) ___ @@ -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:163](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L163) +[src/types/election/election.ts:159](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L159) ___ @@ -264,7 +264,7 @@ Election title #### Defined in -[types/election/election.ts:123](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L123) +[src/types/election/election.ts:119](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L119) ___ @@ -274,7 +274,7 @@ ___ #### Defined in -[types/election/budget.ts:13](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/budget.ts#L13) +[src/types/election/budget.ts:19](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/budget.ts#L19) ___ @@ -288,4 +288,4 @@ ___ #### Defined in -[types/election/election.ts:143](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L143) +[src/types/election/election.ts:139](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L139) diff --git a/docs/sdk/reference/interfaces/ICensus.md b/docs/sdk/reference/interfaces/ICensus.md index f872886dd..94b9154b3 100644 --- a/docs/sdk/reference/interfaces/ICensus.md +++ b/docs/sdk/reference/interfaces/ICensus.md @@ -22,7 +22,7 @@ The type of the census #### Defined in -[api/election.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L21) +[src/api/election.ts:19](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L19) ___ @@ -34,7 +34,7 @@ The root of the census #### Defined in -[api/election.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L26) +[src/api/election.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L24) ___ @@ -46,7 +46,7 @@ The URL of the census #### Defined in -[api/election.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L36) +[src/api/election.ts:34](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L34) ___ @@ -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L41) +[src/api/election.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L39) ___ @@ -70,4 +70,4 @@ The post register root of the census #### Defined in -[api/election.ts:31](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L31) +[src/api/election.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L29) diff --git a/docs/sdk/reference/interfaces/ICensus3CensusListResponse.md b/docs/sdk/reference/interfaces/ICensus3CensusListResponse.md index 7774408aa..3362aa112 100644 --- a/docs/sdk/reference/interfaces/ICensus3CensusListResponse.md +++ b/docs/sdk/reference/interfaces/ICensus3CensusListResponse.md @@ -18,4 +18,4 @@ The list of the strategies identifiers #### Defined in -[api/census3/census.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/census.ts#L15) +[src/api/census3/census.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/census.ts#L15) diff --git a/docs/sdk/reference/interfaces/ICensus3CensusQueueResponse.md b/docs/sdk/reference/interfaces/ICensus3CensusQueueResponse.md index 3216d90e2..c533288a6 100644 --- a/docs/sdk/reference/interfaces/ICensus3CensusQueueResponse.md +++ b/docs/sdk/reference/interfaces/ICensus3CensusQueueResponse.md @@ -21,7 +21,7 @@ The census data #### Defined in -[api/census3/census.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/census.ts#L84) +[src/api/census3/census.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/census.ts#L64) +[src/api/census3/census.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/census.ts#L69) +[src/api/census3/census.ts:69](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/census.ts#L89) +[src/api/census3/census.ts:89](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/census.ts#L89) diff --git a/docs/sdk/reference/interfaces/ICensus3CensusResponse.md b/docs/sdk/reference/interfaces/ICensus3CensusResponse.md index 39879e9cd..1d1b47491 100644 --- a/docs/sdk/reference/interfaces/ICensus3CensusResponse.md +++ b/docs/sdk/reference/interfaces/ICensus3CensusResponse.md @@ -25,7 +25,7 @@ The identifier of the census #### Defined in -[api/census3/census.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/census.ts#L22) +[src/api/census3/census.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/census.ts#L57) +[src/api/census3/census.ts:57](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/census.ts#L52) +[src/api/census3/census.ts:52](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/census.ts#L32) +[src/api/census3/census.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/census.ts#L42) +[src/api/census3/census.ts:42](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/census.ts#L27) +[src/api/census3/census.ts:27](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/census.ts#L37) +[src/api/census3/census.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/census.ts#L47) +[src/api/census3/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/census.ts#L47) diff --git a/docs/sdk/reference/interfaces/ICensus3ServiceInfoResponse.md b/docs/sdk/reference/interfaces/ICensus3ServiceInfoResponse.md index f88a699e9..a0470a18c 100644 --- a/docs/sdk/reference/interfaces/ICensus3ServiceInfoResponse.md +++ b/docs/sdk/reference/interfaces/ICensus3ServiceInfoResponse.md @@ -18,4 +18,4 @@ The list of supported chains #### Defined in -[api/census3/service.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/service.ts#L29) +[src/api/census3/service.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/service.ts#L29) diff --git a/docs/sdk/reference/interfaces/ICensus3StrategiesListResponse.md b/docs/sdk/reference/interfaces/ICensus3StrategiesListResponse.md index a257fd91a..43f3247cd 100644 --- a/docs/sdk/reference/interfaces/ICensus3StrategiesListResponse.md +++ b/docs/sdk/reference/interfaces/ICensus3StrategiesListResponse.md @@ -24,4 +24,4 @@ The list of the strategies identifiers #### Defined in -[api/census3/strategy.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L22) +[src/api/census3/strategy.ts:23](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L23) diff --git a/docs/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated.md b/docs/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated.md index d7d01cbc7..96d84fe55 100644 --- a/docs/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated.md +++ b/docs/sdk/reference/interfaces/ICensus3StrategiesListResponsePaginated.md @@ -25,7 +25,7 @@ The pagination information #### Defined in -[api/census3/strategy.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L29) +[src/api/census3/strategy.ts:30](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L30) ___ @@ -41,4 +41,4 @@ The list of the strategies identifiers #### Defined in -[api/census3/strategy.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L22) +[src/api/census3/strategy.ts:23](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L23) diff --git a/docs/sdk/reference/interfaces/ICensus3StrategiesOperator.md b/docs/sdk/reference/interfaces/ICensus3StrategiesOperator.md index 63643c637..07d1ba082 100644 --- a/docs/sdk/reference/interfaces/ICensus3StrategiesOperator.md +++ b/docs/sdk/reference/interfaces/ICensus3StrategiesOperator.md @@ -19,7 +19,7 @@ The description of the operator #### Defined in -[api/census3/strategy.ts:238](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L238) +[src/api/census3/strategy.ts:257](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L257) ___ @@ -31,4 +31,4 @@ The tag of the operator #### Defined in -[api/census3/strategy.ts:243](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L243) +[src/api/census3/strategy.ts:262](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L262) diff --git a/docs/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse.md b/docs/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse.md index d18d99011..f4dad8db3 100644 --- a/docs/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse.md +++ b/docs/sdk/reference/interfaces/ICensus3StrategiesOperatorsResponse.md @@ -18,4 +18,4 @@ The list of supported operators #### Defined in -[api/census3/strategy.ts:250](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L250) +[src/api/census3/strategy.ts:269](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L269) diff --git a/docs/sdk/reference/interfaces/ICensus3StrategyCreateResponse.md b/docs/sdk/reference/interfaces/ICensus3StrategyCreateResponse.md index 61e6eed61..3c6dc35c8 100644 --- a/docs/sdk/reference/interfaces/ICensus3StrategyCreateResponse.md +++ b/docs/sdk/reference/interfaces/ICensus3StrategyCreateResponse.md @@ -18,4 +18,4 @@ The identifier of the created strategy #### Defined in -[api/census3/strategy.ts:212](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L212) +[src/api/census3/strategy.ts:231](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L231) diff --git a/docs/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse.md b/docs/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse.md index 133e92603..222c817f7 100644 --- a/docs/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse.md +++ b/docs/sdk/reference/interfaces/ICensus3StrategyEstimationQueueResponse.md @@ -29,7 +29,7 @@ The estimation data of the strategy #### Defined in -[api/census3/strategy.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L131) +[src/api/census3/strategy.ts:118](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L118) ___ @@ -41,7 +41,7 @@ If the queue has been done #### Defined in -[api/census3/strategy.ts:111](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L111) +[src/api/census3/strategy.ts:98](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L98) ___ @@ -60,7 +60,7 @@ The error of the queue #### Defined in -[api/census3/strategy.ts:116](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L116) +[src/api/census3/strategy.ts:103](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L103) ___ @@ -72,4 +72,4 @@ The estimation progress #### Defined in -[api/census3/strategy.ts:151](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L151) +[src/api/census3/strategy.ts:138](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L138) diff --git a/docs/sdk/reference/interfaces/ICensus3StrategyHoldersQueueResponse.md b/docs/sdk/reference/interfaces/ICensus3StrategyHoldersQueueResponse.md new file mode 100644 index 000000000..9a86c7f69 --- /dev/null +++ b/docs/sdk/reference/interfaces/ICensus3StrategyHoldersQueueResponse.md @@ -0,0 +1,71 @@ +[@vocdoni/sdk](/sdk) / ICensus3StrategyHoldersQueueResponse + +# Interface: ICensus3StrategyHoldersQueueResponse + +## Table of contents + +### Properties + +- [data](ICensus3StrategyHoldersQueueResponse#data) +- [done](ICensus3StrategyHoldersQueueResponse#done) +- [error](ICensus3StrategyHoldersQueueResponse#error) +- [progress](ICensus3StrategyHoldersQueueResponse#progress) + +## Properties + +### data + +• **data**: `Object` + +The list of the strategy holders + +#### Index signature + +▪ [key: `string`]: `string` + +#### Defined in + +[src/api/census3/strategy.ts:197](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L197) + +___ + +### done + +• **done**: `boolean` + +If the queue has been done + +#### Defined in + +[src/api/census3/strategy.ts:177](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L177) + +___ + +### error + +• **error**: `Object` + +The error of the queue + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `code` | `number` | The code of the error | +| `error` | `string` | The string of the error | + +#### Defined in + +[src/api/census3/strategy.ts:182](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L182) + +___ + +### progress + +• **progress**: `number` + +The importing progress + +#### Defined in + +[src/api/census3/strategy.ts:202](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L202) diff --git a/docs/sdk/reference/interfaces/ICensus3StrategyHoldersResponse.md b/docs/sdk/reference/interfaces/ICensus3StrategyHoldersResponse.md deleted file mode 100644 index 1776c2ff9..000000000 --- a/docs/sdk/reference/interfaces/ICensus3StrategyHoldersResponse.md +++ /dev/null @@ -1,31 +0,0 @@ -[@vocdoni/sdk](/sdk) / ICensus3StrategyHoldersResponse - -# Interface: ICensus3StrategyHoldersResponse - -## Hierarchy - -- **`ICensus3StrategyHoldersResponse`** - - ↳ [`ICensus3StrategyHoldersResponsePaginated`](ICensus3StrategyHoldersResponsePaginated) - -## Table of contents - -### Properties - -- [holders](ICensus3StrategyHoldersResponse#holders) - -## Properties - -### holders - -• **holders**: `Object` - -The list of the strategy holders - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[api/census3/strategy.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L36) diff --git a/docs/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated.md b/docs/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated.md deleted file mode 100644 index 701c02dfb..000000000 --- a/docs/sdk/reference/interfaces/ICensus3StrategyHoldersResponsePaginated.md +++ /dev/null @@ -1,48 +0,0 @@ -[@vocdoni/sdk](/sdk) / ICensus3StrategyHoldersResponsePaginated - -# Interface: ICensus3StrategyHoldersResponsePaginated - -## Hierarchy - -- [`ICensus3StrategyHoldersResponse`](ICensus3StrategyHoldersResponse) - - ↳ **`ICensus3StrategyHoldersResponsePaginated`** - -## Table of contents - -### Properties - -- [holders](ICensus3StrategyHoldersResponsePaginated#holders) -- [pagination](ICensus3StrategyHoldersResponsePaginated#pagination) - -## Properties - -### holders - -• **holders**: `Object` - -The list of the strategy holders - -#### Index signature - -▪ [key: `string`]: `string` - -#### Inherited from - -[ICensus3StrategyHoldersResponse](ICensus3StrategyHoldersResponse.md).[holders](ICensus3StrategyHoldersResponse#holders) - -#### Defined in - -[api/census3/strategy.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L36) - -___ - -### pagination - -• **pagination**: `Census3Pagination` - -The pagination information - -#### Defined in - -[api/census3/strategy.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L43) diff --git a/docs/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse.md b/docs/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse.md index 03a63ed0d..3351a9795 100644 --- a/docs/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse.md +++ b/docs/sdk/reference/interfaces/ICensus3StrategyImportQueueResponse.md @@ -21,7 +21,7 @@ The imported data strategy #### Defined in -[api/census3/strategy.ts:178](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L178) +[src/api/census3/strategy.ts:165](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L165) ___ @@ -33,7 +33,7 @@ If the queue has been done #### Defined in -[api/census3/strategy.ts:158](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L158) +[src/api/census3/strategy.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L145) ___ @@ -52,7 +52,7 @@ The error of the queue #### Defined in -[api/census3/strategy.ts:163](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L163) +[src/api/census3/strategy.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L150) ___ @@ -64,4 +64,4 @@ The importing progress #### Defined in -[api/census3/strategy.ts:183](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L183) +[src/api/census3/strategy.ts:170](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L170) diff --git a/docs/sdk/reference/interfaces/ICensus3StrategyToken.md b/docs/sdk/reference/interfaces/ICensus3StrategyToken.md index 364bc4038..83ae644fc 100644 --- a/docs/sdk/reference/interfaces/ICensus3StrategyToken.md +++ b/docs/sdk/reference/interfaces/ICensus3StrategyToken.md @@ -21,7 +21,7 @@ The id (address) of the token. #### Defined in -[api/census3/strategy.ts:190](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L190) +[src/api/census3/strategy.ts:209](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L209) ___ @@ -33,7 +33,7 @@ The method used for checking balances. #### Defined in -[api/census3/strategy.ts:205](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L205) +[src/api/census3/strategy.ts:224](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L224) ___ @@ -45,7 +45,7 @@ The minimum balance. #### Defined in -[api/census3/strategy.ts:200](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L200) +[src/api/census3/strategy.ts:219](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L219) ___ @@ -57,4 +57,4 @@ The name of the token. #### Defined in -[api/census3/strategy.ts:195](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L195) +[src/api/census3/strategy.ts:214](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L214) diff --git a/docs/sdk/reference/interfaces/ICensus3SupportedChain.md b/docs/sdk/reference/interfaces/ICensus3SupportedChain.md index fff7a6558..9084fd49b 100644 --- a/docs/sdk/reference/interfaces/ICensus3SupportedChain.md +++ b/docs/sdk/reference/interfaces/ICensus3SupportedChain.md @@ -20,7 +20,7 @@ The identifier of the chain #### Defined in -[api/census3/service.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/service.ts#L12) +[src/api/census3/service.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/service.ts#L22) +[src/api/census3/service.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/service.ts#L17) +[src/api/census3/service.ts:17](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/service.ts#L17) diff --git a/docs/sdk/reference/interfaces/ICensus3TokenHolderResponse.md b/docs/sdk/reference/interfaces/ICensus3TokenHolderResponse.md index b7c1df5c8..a13c95802 100644 --- a/docs/sdk/reference/interfaces/ICensus3TokenHolderResponse.md +++ b/docs/sdk/reference/interfaces/ICensus3TokenHolderResponse.md @@ -18,4 +18,4 @@ The balance of the holder #### Defined in -[api/census3/token.ts:117](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/token.ts#L117) +[src/api/census3/token.ts:117](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/token.ts#L117) diff --git a/docs/sdk/reference/interfaces/ICensus3TokenListResponse.md b/docs/sdk/reference/interfaces/ICensus3TokenListResponse.md index 761cd0be3..9fe598375 100644 --- a/docs/sdk/reference/interfaces/ICensus3TokenListResponse.md +++ b/docs/sdk/reference/interfaces/ICensus3TokenListResponse.md @@ -24,4 +24,4 @@ The list of the tokens #### Defined in -[api/census3/token.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/token.ts#L110) +[src/api/census3/token.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/token.ts#L110) diff --git a/docs/sdk/reference/interfaces/ICensus3TokenListResponsePaginated.md b/docs/sdk/reference/interfaces/ICensus3TokenListResponsePaginated.md index 67fb659c2..530009206 100644 --- a/docs/sdk/reference/interfaces/ICensus3TokenListResponsePaginated.md +++ b/docs/sdk/reference/interfaces/ICensus3TokenListResponsePaginated.md @@ -25,7 +25,7 @@ The pagination information #### Defined in -[api/census3/token.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/token.ts#L124) +[src/api/census3/token.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/token.ts#L124) ___ @@ -41,4 +41,4 @@ The list of the tokens #### Defined in -[api/census3/token.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/token.ts#L110) +[src/api/census3/token.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/token.ts#L110) diff --git a/docs/sdk/reference/interfaces/ICensus3TokenTypesResponse.md b/docs/sdk/reference/interfaces/ICensus3TokenTypesResponse.md index d6259971c..39f4f33c7 100644 --- a/docs/sdk/reference/interfaces/ICensus3TokenTypesResponse.md +++ b/docs/sdk/reference/interfaces/ICensus3TokenTypesResponse.md @@ -18,4 +18,4 @@ The list of the tokens types #### Defined in -[api/census3/token.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/token.ts#L131) +[src/api/census3/token.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/token.ts#L131) diff --git a/docs/sdk/reference/interfaces/ICensus3ValidatePredicateChild.md b/docs/sdk/reference/interfaces/ICensus3ValidatePredicateChild.md index dc2460739..933ad23fd 100644 --- a/docs/sdk/reference/interfaces/ICensus3ValidatePredicateChild.md +++ b/docs/sdk/reference/interfaces/ICensus3ValidatePredicateChild.md @@ -19,7 +19,7 @@ The operator used in the predicate #### Defined in -[api/census3/strategy.ts:226](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L226) +[src/api/census3/strategy.ts:245](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L245) ___ @@ -31,4 +31,4 @@ The list of tokens of the predicate #### Defined in -[api/census3/strategy.ts:231](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L231) +[src/api/census3/strategy.ts:250](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L250) diff --git a/docs/sdk/reference/interfaces/ICensus3ValidatePredicateResponse.md b/docs/sdk/reference/interfaces/ICensus3ValidatePredicateResponse.md index 04d219337..d7427d5db 100644 --- a/docs/sdk/reference/interfaces/ICensus3ValidatePredicateResponse.md +++ b/docs/sdk/reference/interfaces/ICensus3ValidatePredicateResponse.md @@ -24,4 +24,4 @@ The parsed version of the predicate #### Defined in -[api/census3/strategy.ts:257](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L257) +[src/api/census3/strategy.ts:276](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L276) diff --git a/docs/sdk/reference/interfaces/ICensus3ValidatePredicateToken.md b/docs/sdk/reference/interfaces/ICensus3ValidatePredicateToken.md index d6d6864a2..363df0be9 100644 --- a/docs/sdk/reference/interfaces/ICensus3ValidatePredicateToken.md +++ b/docs/sdk/reference/interfaces/ICensus3ValidatePredicateToken.md @@ -18,4 +18,4 @@ The literal of the predicate #### Defined in -[api/census3/strategy.ts:219](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L219) +[src/api/census3/strategy.ts:238](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L238) diff --git a/docs/sdk/reference/interfaces/ICensusExportResponse.md b/docs/sdk/reference/interfaces/ICensusExportResponse.md index 424520d16..3b5e480db 100644 --- a/docs/sdk/reference/interfaces/ICensusExportResponse.md +++ b/docs/sdk/reference/interfaces/ICensusExportResponse.md @@ -21,7 +21,7 @@ The data of the census #### Defined in -[api/census.ts:54](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census.ts#L54) +[src/api/census.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census.ts#L64) ___ @@ -33,7 +33,7 @@ The max levels of the census #### Defined in -[api/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census.ts#L59) +[src/api/census.ts:69](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census.ts#L69) ___ @@ -45,7 +45,7 @@ The root hash of the census #### Defined in -[api/census.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census.ts#L49) +[src/api/census.ts:59](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census.ts#L59) ___ @@ -57,4 +57,4 @@ The type of the census #### Defined in -[api/census.ts:44](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census.ts#L44) +[src/api/census.ts:54](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census.ts#L54) diff --git a/docs/sdk/reference/interfaces/ICensusParticipant.md b/docs/sdk/reference/interfaces/ICensusParticipant.md index b289f3548..fac4927b9 100644 --- a/docs/sdk/reference/interfaces/ICensusParticipant.md +++ b/docs/sdk/reference/interfaces/ICensusParticipant.md @@ -17,7 +17,7 @@ #### Defined in -[types/census/offchain.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/offchain.ts#L6) +[src/types/census/offchain.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/offchain.ts#L6) ___ @@ -27,4 +27,4 @@ ___ #### Defined in -[types/census/offchain.ts:7](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/census/offchain.ts#L7) +[src/types/census/offchain.ts:7](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/census/offchain.ts#L7) diff --git a/docs/sdk/reference/interfaces/ICensusProofResponse.md b/docs/sdk/reference/interfaces/ICensusProofResponse.md index 845eb41f5..a685ae013 100644 --- a/docs/sdk/reference/interfaces/ICensusProofResponse.md +++ b/docs/sdk/reference/interfaces/ICensusProofResponse.md @@ -23,7 +23,7 @@ The proof for the given key #### Defined in -[api/census.ts:83](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census.ts#L83) +[src/api/census.ts:93](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census.ts#L93) ___ @@ -35,7 +35,7 @@ The root (id) of the census #### Defined in -[api/census.ts:78](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census.ts#L78) +[src/api/census.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census.ts#L88) ___ @@ -47,7 +47,7 @@ The census siblings #### Defined in -[api/census.ts:93](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census.ts#L93) +[src/api/census.ts:103](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census.ts#L103) ___ @@ -59,7 +59,7 @@ The type of the census #### Defined in -[api/census.ts:68](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census.ts#L68) +[src/api/census.ts:78](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census.ts#L78) ___ @@ -71,7 +71,7 @@ The value for the given key #### Defined in -[api/census.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census.ts#L88) +[src/api/census.ts:98](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census.ts#L98) ___ @@ -83,4 +83,4 @@ The weight as a string #### Defined in -[api/census.ts:73](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census.ts#L73) +[src/api/census.ts:83](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census.ts#L83) diff --git a/docs/sdk/reference/interfaces/ICensusPublishAsyncResponse.md b/docs/sdk/reference/interfaces/ICensusPublishAsyncResponse.md new file mode 100644 index 000000000..40ed46791 --- /dev/null +++ b/docs/sdk/reference/interfaces/ICensusPublishAsyncResponse.md @@ -0,0 +1,21 @@ +[@vocdoni/sdk](/sdk) / ICensusPublishAsyncResponse + +# Interface: ICensusPublishAsyncResponse + +## Table of contents + +### Properties + +- [censusID](ICensusPublishAsyncResponse#censusid) + +## Properties + +### censusID + +• **censusID**: `string` + +The identifier of the published census + +#### Defined in + +[src/api/census.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census.ts#L47) diff --git a/docs/sdk/reference/interfaces/ICensusPublishResponse.md b/docs/sdk/reference/interfaces/ICensusPublishResponse.md index 4c1b91aca..948a9c084 100644 --- a/docs/sdk/reference/interfaces/ICensusPublishResponse.md +++ b/docs/sdk/reference/interfaces/ICensusPublishResponse.md @@ -19,7 +19,7 @@ The identifier of the published census #### Defined in -[api/census.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census.ts#L32) +[src/api/census.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census.ts#L35) ___ @@ -31,4 +31,4 @@ The URI of the published census #### Defined in -[api/census.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census.ts#L37) +[src/api/census.ts:40](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census.ts#L40) diff --git a/docs/sdk/reference/interfaces/IChainBlockInfoResponse.md b/docs/sdk/reference/interfaces/IChainBlockInfoResponse.md index f477b9f81..fc30ea08c 100644 --- a/docs/sdk/reference/interfaces/IChainBlockInfoResponse.md +++ b/docs/sdk/reference/interfaces/IChainBlockInfoResponse.md @@ -6,53 +6,19 @@ ### Properties -- [data](IChainBlockInfoResponse#data) -- [evidence](IChainBlockInfoResponse#evidence) - [hash](IChainBlockInfoResponse#hash) - [header](IChainBlockInfoResponse#header) -- [lastCommit](IChainBlockInfoResponse#lastcommit) +- [txCount](IChainBlockInfoResponse#txcount) ## Properties -### data - -• **data**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `txs` | `string`[] | - -#### Defined in - -[api/chain.ts:275](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L275) - -___ - -### evidence - -• **evidence**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `evidence` | `string`[] | - -#### Defined in - -[api/chain.ts:278](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L278) - -___ - ### hash • **hash**: `string` #### Defined in -[api/chain.ts:281](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L281) +[src/api/chain.ts:331](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L331) ___ @@ -83,23 +49,14 @@ ___ #### Defined in -[api/chain.ts:282](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L282) +[src/api/chain.ts:332](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L332) ___ -### lastCommit - -• **lastCommit**: `Object` - -#### Type declaration +### txCount -| Name | Type | -| :------ | :------ | -| `blockId` | `BlockID` | -| `height` | `number` | -| `round` | `number` | -| `signatures` | \{ `blockIdFlag`: `number` ; `signature`: `string` ; `timestamp`: `string` ; `validatorAddress`: `string` }[] | +• **txCount**: `number` #### Defined in -[api/chain.ts:301](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L301) +[src/api/chain.ts:351](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L351) diff --git a/docs/sdk/reference/interfaces/IChainBlocksList.md b/docs/sdk/reference/interfaces/IChainBlocksList.md new file mode 100644 index 000000000..b3b798be6 --- /dev/null +++ b/docs/sdk/reference/interfaces/IChainBlocksList.md @@ -0,0 +1,27 @@ +[@vocdoni/sdk](/sdk) / IChainBlocksList + +# Interface: IChainBlocksList + +## Hierarchy + +- **`IChainBlocksList`** + + ↳ [`IChainBlocksListResponse`](IChainBlocksListResponse) + +## Table of contents + +### Properties + +- [blocks](IChainBlocksList#blocks) + +## Properties + +### blocks + +• **blocks**: [`IBlock`](IBlock)[] + +List of blocks + +#### Defined in + +[src/api/chain.ts:270](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L270) diff --git a/docs/sdk/reference/interfaces/IChainBlocksListResponse.md b/docs/sdk/reference/interfaces/IChainBlocksListResponse.md new file mode 100644 index 000000000..660adbc23 --- /dev/null +++ b/docs/sdk/reference/interfaces/IChainBlocksListResponse.md @@ -0,0 +1,58 @@ +[@vocdoni/sdk](/sdk) / IChainBlocksListResponse + +# Interface: IChainBlocksListResponse + +## Hierarchy + +- [`IChainBlocksList`](IChainBlocksList) + +- [`PaginationResponse`](PaginationResponse) + + ↳ **`IChainBlocksListResponse`** + +## Table of contents + +### Properties + +- [blocks](IChainBlocksListResponse#blocks) +- [pagination](IChainBlocksListResponse#pagination) + +## Properties + +### blocks + +• **blocks**: [`IBlock`](IBlock)[] + +List of blocks + +#### Inherited from + +[IChainBlocksList](IChainBlocksList.md).[blocks](IChainBlocksList#blocks) + +#### Defined in + +[src/api/chain.ts:270](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L270) + +___ + +### pagination + +• **pagination**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `currentPage` | `number` | +| `lastPage` | `number` | +| `nextPage` | `number` | +| `previousPage` | `number` | +| `totalItems` | `number` | + +#### Inherited from + +[PaginationResponse](PaginationResponse.md).[pagination](PaginationResponse#pagination) + +#### Defined in + +[src/api/api.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/api.ts#L131) diff --git a/docs/sdk/reference/interfaces/IChainFeesListResponse.md b/docs/sdk/reference/interfaces/IChainFeesListResponse.md index f426f46d4..bf24f567e 100644 --- a/docs/sdk/reference/interfaces/IChainFeesListResponse.md +++ b/docs/sdk/reference/interfaces/IChainFeesListResponse.md @@ -2,11 +2,20 @@ # Interface: IChainFeesListResponse +## Hierarchy + +- [`IFeesList`](IFeesList) + +- [`PaginationResponse`](PaginationResponse) + + ↳ **`IChainFeesListResponse`** + ## Table of contents ### Properties - [fees](IChainFeesListResponse#fees) +- [pagination](IChainFeesListResponse#pagination) ## Properties @@ -16,6 +25,34 @@ The list of fees +#### Inherited from + +[IFeesList](IFeesList.md).[fees](IFeesList#fees) + +#### Defined in + +[src/api/chain.ts:454](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L454) + +___ + +### pagination + +• **pagination**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `currentPage` | `number` | +| `lastPage` | `number` | +| `nextPage` | `number` | +| `previousPage` | `number` | +| `totalItems` | `number` | + +#### Inherited from + +[PaginationResponse](PaginationResponse.md).[pagination](PaginationResponse#pagination) + #### Defined in -[api/chain.ts:393](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L393) +[src/api/api.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/api.ts#L131) diff --git a/docs/sdk/reference/interfaces/IChainGetCircuitResponse.md b/docs/sdk/reference/interfaces/IChainGetCircuitResponse.md index a69406d9d..a9b69b54e 100644 --- a/docs/sdk/reference/interfaces/IChainGetCircuitResponse.md +++ b/docs/sdk/reference/interfaces/IChainGetCircuitResponse.md @@ -26,7 +26,7 @@ The path of the circuit. #### Defined in -[api/chain.ts:130](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L130) +[src/api/chain.ts:134](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L134) ___ @@ -38,7 +38,7 @@ The circuit levels. #### Defined in -[api/chain.ts:135](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L135) +[src/api/chain.ts:139](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L139) ___ @@ -50,7 +50,7 @@ The base uri of the files. #### Defined in -[api/chain.ts:125](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L125) +[src/api/chain.ts:129](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L129) ___ @@ -62,7 +62,7 @@ The name of the verification key file. #### Defined in -[api/chain.ts:155](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L155) +[src/api/chain.ts:159](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L159) ___ @@ -74,7 +74,7 @@ The hash of the verification key file. #### Defined in -[api/chain.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L150) +[src/api/chain.ts:154](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L154) ___ @@ -86,7 +86,7 @@ The name of the WASM file. #### Defined in -[api/chain.ts:165](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L165) +[src/api/chain.ts:169](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L169) ___ @@ -98,7 +98,7 @@ The hash of the WASM file. #### Defined in -[api/chain.ts:160](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L160) +[src/api/chain.ts:164](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L164) ___ @@ -110,7 +110,7 @@ The name of the proving key file. #### Defined in -[api/chain.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L145) +[src/api/chain.ts:149](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L149) ___ @@ -122,4 +122,4 @@ The hash of the proving key file. #### Defined in -[api/chain.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L140) +[src/api/chain.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L144) diff --git a/docs/sdk/reference/interfaces/IChainGetCostsResponse.md b/docs/sdk/reference/interfaces/IChainGetCostsResponse.md index 95d6d4743..ebdbb6d3d 100644 --- a/docs/sdk/reference/interfaces/IChainGetCostsResponse.md +++ b/docs/sdk/reference/interfaces/IChainGetCostsResponse.md @@ -20,7 +20,7 @@ The base price. #### Defined in -[api/chain.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L100) +[src/api/chain.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L104) ___ @@ -32,7 +32,7 @@ The capacity of the chain. #### Defined in -[api/chain.ts:105](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L105) +[src/api/chain.ts:109](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L109) ___ @@ -56,4 +56,4 @@ The factors. #### Defined in -[api/chain.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L110) +[src/api/chain.ts:114](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L114) diff --git a/docs/sdk/reference/interfaces/IChainGetInfoResponse.md b/docs/sdk/reference/interfaces/IChainGetInfoResponse.md index e68edcfac..7696176c9 100644 --- a/docs/sdk/reference/interfaces/IChainGetInfoResponse.md +++ b/docs/sdk/reference/interfaces/IChainGetInfoResponse.md @@ -30,7 +30,7 @@ The different block times from the chain. #### Defined in -[api/chain.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L38) +[src/api/chain.ts:42](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L42) ___ @@ -42,7 +42,7 @@ The timestamp of the actual block. #### Defined in -[api/chain.ts:68](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L68) +[src/api/chain.ts:72](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L72) ___ @@ -54,7 +54,7 @@ The id of the current chain #### Defined in -[api/chain.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L33) +[src/api/chain.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L37) ___ @@ -66,7 +66,7 @@ The circuit configuration tag. #### Defined in -[api/chain.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L88) +[src/api/chain.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L92) ___ @@ -78,7 +78,7 @@ The number of elections existing on the Vochain. #### Defined in -[api/chain.ts:43](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L43) +[src/api/chain.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L47) ___ @@ -90,7 +90,7 @@ The time of the genesis block. #### Defined in -[api/chain.ts:53](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L53) +[src/api/chain.ts:57](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L57) ___ @@ -102,7 +102,7 @@ The height or actual block of the current chain. #### Defined in -[api/chain.ts:58](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L58) +[src/api/chain.ts:62](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L62) ___ @@ -114,7 +114,7 @@ The maximum size of a census. #### Defined in -[api/chain.ts:93](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L93) +[src/api/chain.ts:97](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L97) ___ @@ -126,7 +126,7 @@ The number of organizations existing on the Vochain. #### Defined in -[api/chain.ts:48](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L48) +[src/api/chain.ts:52](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L52) ___ @@ -138,7 +138,7 @@ Whether the blockchain is syncing. #### Defined in -[api/chain.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L63) +[src/api/chain.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L67) ___ @@ -150,7 +150,7 @@ The number of transactions. #### Defined in -[api/chain.ts:73](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L73) +[src/api/chain.ts:77](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L77) ___ @@ -162,7 +162,7 @@ The number of validators. #### Defined in -[api/chain.ts:78](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L78) +[src/api/chain.ts:82](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L82) ___ @@ -174,4 +174,4 @@ The number of votes. #### Defined in -[api/chain.ts:83](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L83) +[src/api/chain.ts:87](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L87) diff --git a/docs/sdk/reference/interfaces/IChainOrganizationCountResponse.md b/docs/sdk/reference/interfaces/IChainOrganizationCountResponse.md deleted file mode 100644 index b218531a7..000000000 --- a/docs/sdk/reference/interfaces/IChainOrganizationCountResponse.md +++ /dev/null @@ -1,21 +0,0 @@ -[@vocdoni/sdk](/sdk) / IChainOrganizationCountResponse - -# Interface: IChainOrganizationCountResponse - -## Table of contents - -### Properties - -- [count](IChainOrganizationCountResponse#count) - -## Properties - -### count - -• **count**: `number` - -The number of organizations - -#### Defined in - -[api/chain.ts:244](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L244) diff --git a/docs/sdk/reference/interfaces/IChainOrganizationListResponse.md b/docs/sdk/reference/interfaces/IChainOrganizationListResponse.md index 709ab2cb9..47fb6eaae 100644 --- a/docs/sdk/reference/interfaces/IChainOrganizationListResponse.md +++ b/docs/sdk/reference/interfaces/IChainOrganizationListResponse.md @@ -2,11 +2,20 @@ # Interface: IChainOrganizationListResponse +## Hierarchy + +- [`OrganizationList`](OrganizationList) + +- [`PaginationResponse`](PaginationResponse) + + ↳ **`IChainOrganizationListResponse`** + ## Table of contents ### Properties - [organizations](IChainOrganizationListResponse#organizations) +- [pagination](IChainOrganizationListResponse#pagination) ## Properties @@ -16,6 +25,34 @@ The list of organizations +#### Inherited from + +[OrganizationList](OrganizationList.md).[organizations](OrganizationList#organizations) + +#### Defined in + +[src/api/chain.ts:319](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L319) + +___ + +### pagination + +• **pagination**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `currentPage` | `number` | +| `lastPage` | `number` | +| `nextPage` | `number` | +| `previousPage` | `number` | +| `totalItems` | `number` | + +#### Inherited from + +[PaginationResponse](PaginationResponse.md).[pagination](PaginationResponse#pagination) + #### Defined in -[api/chain.ts:263](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L263) +[src/api/api.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/api.ts#L131) diff --git a/docs/sdk/reference/interfaces/IChainOrganizationResponse.md b/docs/sdk/reference/interfaces/IChainOrganizationResponse.md index 8af489dec..d7330a62f 100644 --- a/docs/sdk/reference/interfaces/IChainOrganizationResponse.md +++ b/docs/sdk/reference/interfaces/IChainOrganizationResponse.md @@ -19,7 +19,7 @@ The number of elections #### Defined in -[api/chain.ts:256](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L256) +[src/api/chain.ts:310](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L310) ___ @@ -31,4 +31,4 @@ The identifier of the organization #### Defined in -[api/chain.ts:251](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L251) +[src/api/chain.ts:305](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L305) diff --git a/docs/sdk/reference/interfaces/IChainSubmitTxResponse.md b/docs/sdk/reference/interfaces/IChainSubmitTxResponse.md index 9ad46ba2c..620cbab5b 100644 --- a/docs/sdk/reference/interfaces/IChainSubmitTxResponse.md +++ b/docs/sdk/reference/interfaces/IChainSubmitTxResponse.md @@ -20,7 +20,7 @@ The response code #### Defined in -[api/chain.ts:230](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L230) +[src/api/chain.ts:252](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L252) ___ @@ -32,7 +32,7 @@ The hash of the transaction #### Defined in -[api/chain.ts:220](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L220) +[src/api/chain.ts:242](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L242) ___ @@ -44,4 +44,4 @@ The response data (can vary depending on the transaction type) #### Defined in -[api/chain.ts:225](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L225) +[src/api/chain.ts:247](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L247) diff --git a/docs/sdk/reference/interfaces/IChainTransfersList.md b/docs/sdk/reference/interfaces/IChainTransfersList.md new file mode 100644 index 000000000..078afa869 --- /dev/null +++ b/docs/sdk/reference/interfaces/IChainTransfersList.md @@ -0,0 +1,27 @@ +[@vocdoni/sdk](/sdk) / IChainTransfersList + +# Interface: IChainTransfersList + +## Hierarchy + +- **`IChainTransfersList`** + + ↳ [`IChainTransfersListResponse`](IChainTransfersListResponse) + +## Table of contents + +### Properties + +- [transfers](IChainTransfersList#transfers) + +## Properties + +### transfers + +• **transfers**: [`ITransfer`](ITransfer)[] + +List of transfers + +#### Defined in + +[src/api/chain.ts:289](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L289) diff --git a/docs/sdk/reference/interfaces/IChainTransfersListResponse.md b/docs/sdk/reference/interfaces/IChainTransfersListResponse.md new file mode 100644 index 000000000..028f6e246 --- /dev/null +++ b/docs/sdk/reference/interfaces/IChainTransfersListResponse.md @@ -0,0 +1,58 @@ +[@vocdoni/sdk](/sdk) / IChainTransfersListResponse + +# Interface: IChainTransfersListResponse + +## Hierarchy + +- [`IChainTransfersList`](IChainTransfersList) + +- [`PaginationResponse`](PaginationResponse) + + ↳ **`IChainTransfersListResponse`** + +## Table of contents + +### Properties + +- [pagination](IChainTransfersListResponse#pagination) +- [transfers](IChainTransfersListResponse#transfers) + +## Properties + +### pagination + +• **pagination**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `currentPage` | `number` | +| `lastPage` | `number` | +| `nextPage` | `number` | +| `previousPage` | `number` | +| `totalItems` | `number` | + +#### Inherited from + +[PaginationResponse](PaginationResponse.md).[pagination](PaginationResponse#pagination) + +#### Defined in + +[src/api/api.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/api.ts#L131) + +___ + +### transfers + +• **transfers**: [`ITransfer`](ITransfer)[] + +List of transfers + +#### Inherited from + +[IChainTransfersList](IChainTransfersList.md).[transfers](IChainTransfersList#transfers) + +#### Defined in + +[src/api/chain.ts:289](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L289) diff --git a/docs/sdk/reference/interfaces/IChainTxCosts.md b/docs/sdk/reference/interfaces/IChainTxCosts.md new file mode 100644 index 000000000..5481268ef --- /dev/null +++ b/docs/sdk/reference/interfaces/IChainTxCosts.md @@ -0,0 +1,39 @@ +[@vocdoni/sdk](/sdk) / IChainTxCosts + +# Interface: IChainTxCosts + +## Table of contents + +### Properties + +- [costs](IChainTxCosts#costs) + +## Properties + +### costs + +• **costs**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `AddDelegateForAccount` | `number` | +| `CollectFaucet` | `number` | +| `CreateAccount` | `number` | +| `DelAccountSIK` | `number` | +| `DelDelegateForAccount` | `number` | +| `NewProcess` | `number` | +| `RegisterKey` | `number` | +| `SendTokens` | `number` | +| `SetAccountInfoURI` | `number` | +| `SetAccountSIK` | `number` | +| `SetAccountValidator` | `number` | +| `SetProcessCensus` | `number` | +| `SetProcessDuration` | `number` | +| `SetProcessQuestionIndex` | `number` | +| `SetProcessStatus` | `number` | + +#### Defined in + +[src/api/chain.ts:187](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L187) diff --git a/docs/sdk/reference/interfaces/IChainTxCountResponse.md b/docs/sdk/reference/interfaces/IChainTxCountResponse.md deleted file mode 100644 index c7f635bce..000000000 --- a/docs/sdk/reference/interfaces/IChainTxCountResponse.md +++ /dev/null @@ -1,21 +0,0 @@ -[@vocdoni/sdk](/sdk) / IChainTxCountResponse - -# Interface: IChainTxCountResponse - -## Table of contents - -### Properties - -- [count](IChainTxCountResponse#count) - -## Properties - -### count - -• **count**: `number` - -The number of transactions - -#### Defined in - -[api/chain.ts:213](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L213) diff --git a/docs/sdk/reference/interfaces/IChainTxList.md b/docs/sdk/reference/interfaces/IChainTxList.md new file mode 100644 index 000000000..27828879f --- /dev/null +++ b/docs/sdk/reference/interfaces/IChainTxList.md @@ -0,0 +1,27 @@ +[@vocdoni/sdk](/sdk) / IChainTxList + +# Interface: IChainTxList + +## Hierarchy + +- **`IChainTxList`** + + ↳ [`IChainTxListResponse`](IChainTxListResponse) + +## Table of contents + +### Properties + +- [transactions](IChainTxList#transactions) + +## Properties + +### transactions + +• **transactions**: [`IChainTxReference`](IChainTxReference)[] + +List of transactions + +#### Defined in + +[src/api/chain.ts:261](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L261) diff --git a/docs/sdk/reference/interfaces/IChainTxListResponse.md b/docs/sdk/reference/interfaces/IChainTxListResponse.md index 0e9e981a8..e05a7e107 100644 --- a/docs/sdk/reference/interfaces/IChainTxListResponse.md +++ b/docs/sdk/reference/interfaces/IChainTxListResponse.md @@ -2,20 +2,57 @@ # Interface: IChainTxListResponse +## Hierarchy + +- [`IChainTxList`](IChainTxList) + +- [`PaginationResponse`](PaginationResponse) + + ↳ **`IChainTxListResponse`** + ## Table of contents ### Properties +- [pagination](IChainTxListResponse#pagination) - [transactions](IChainTxListResponse#transactions) ## Properties +### pagination + +• **pagination**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `currentPage` | `number` | +| `lastPage` | `number` | +| `nextPage` | `number` | +| `previousPage` | `number` | +| `totalItems` | `number` | + +#### Inherited from + +[PaginationResponse](PaginationResponse.md).[pagination](PaginationResponse#pagination) + +#### Defined in + +[src/api/api.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/api.ts#L131) + +___ + ### transactions • **transactions**: [`IChainTxReference`](IChainTxReference)[] -List of transactions reference +List of transactions + +#### Inherited from + +[IChainTxList](IChainTxList.md).[transactions](IChainTxList#transactions) #### Defined in -[api/chain.ts:237](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L237) +[src/api/chain.ts:261](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L261) diff --git a/docs/sdk/reference/interfaces/IChainTxReference.md b/docs/sdk/reference/interfaces/IChainTxReference.md index a6bf89f98..aaa088121 100644 --- a/docs/sdk/reference/interfaces/IChainTxReference.md +++ b/docs/sdk/reference/interfaces/IChainTxReference.md @@ -6,68 +6,81 @@ ### Properties -- [blockHeight](IChainTxReference#blockheight) -- [transactionHash](IChainTxReference#transactionhash) -- [transactionIndex](IChainTxReference#transactionindex) -- [transactionNumber](IChainTxReference#transactionnumber) -- [transactionType](IChainTxReference#transactiontype) +- [hash](IChainTxReference#hash) +- [height](IChainTxReference#height) +- [index](IChainTxReference#index) +- [signer](IChainTxReference#signer) +- [subtype](IChainTxReference#subtype) +- [type](IChainTxReference#type) ## Properties -### blockHeight +### hash -• **blockHeight**: `number` +• **hash**: `string` -The number of the block where the transaction is. +The hash of the transaction. #### Defined in -[api/chain.ts:196](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L196) +[src/api/chain.ts:210](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L210) ___ -### transactionHash +### height -• **transactionHash**: `string` +• **height**: `number` -The hash of the transaction. +The number of the block where the transaction is. #### Defined in -[api/chain.ts:191](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L191) +[src/api/chain.ts:215](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L215) ___ -### transactionIndex +### index -• **transactionIndex**: `number` +• **index**: `number` The index of the transaction inside the block. #### Defined in -[api/chain.ts:201](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L201) +[src/api/chain.ts:220](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L220) + +___ + +### signer + +• **signer**: `string` + +The signer of the transaction. + +#### Defined in + +[src/api/chain.ts:235](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L235) ___ -### transactionNumber +### subtype -• **transactionNumber**: `number` +• **subtype**: `string` -The number of the transaction. +The subtype of the transaction. #### Defined in -[api/chain.ts:186](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L186) +[src/api/chain.ts:230](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L230) ___ -### transactionType +### type -• **transactionType**: [`TransactionType`](../enums/TransactionType) +• **type**: [`TransactionType`](../enums/TransactionType) The type of the transaction. #### Defined in -[api/chain.ts:206](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L206) +[src/api/chain.ts:225](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L225) diff --git a/docs/sdk/reference/interfaces/IChainValidator.md b/docs/sdk/reference/interfaces/IChainValidator.md index eb5cdfe00..d8e19d948 100644 --- a/docs/sdk/reference/interfaces/IChainValidator.md +++ b/docs/sdk/reference/interfaces/IChainValidator.md @@ -7,9 +7,14 @@ ### Properties - [address](IChainValidator#address) +- [joinHeight](IChainValidator#joinheight) - [name](IChainValidator#name) - [power](IChainValidator#power) +- [proposals](IChainValidator#proposals) - [pubKey](IChainValidator#pubkey) +- [score](IChainValidator#score) +- [validatorAddress](IChainValidator#validatoraddress) +- [votes](IChainValidator#votes) ## Properties @@ -21,7 +26,19 @@ Validator address #### Defined in -[api/chain.ts:342](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L342) +[src/api/chain.ts:376](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L376) + +___ + +### joinHeight + +• **joinHeight**: `number` + +Block height when validator joint + +#### Defined in + +[src/api/chain.ts:386](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L386) ___ @@ -33,7 +50,7 @@ Validator name reference. Could be empty. #### Defined in -[api/chain.ts:347](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L347) +[src/api/chain.ts:381](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L381) ___ @@ -45,7 +62,19 @@ Current power of the validator #### Defined in -[api/chain.ts:332](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L332) +[src/api/chain.ts:366](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L366) + +___ + +### proposals + +• **proposals**: `number` + +Total block proposals count + +#### Defined in + +[src/api/chain.ts:391](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L391) ___ @@ -57,4 +86,40 @@ Validator public key #### Defined in -[api/chain.ts:337](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L337) +[src/api/chain.ts:371](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L371) + +___ + +### score + +• **score**: `number` + +Validatos effectivity. Between 0 and 100 + +#### Defined in + +[src/api/chain.ts:396](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L396) + +___ + +### validatorAddress + +• **validatorAddress**: `string` + +Validator address + +#### Defined in + +[src/api/chain.ts:401](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L401) + +___ + +### votes + +• **votes**: `number` + +Number ob validated blocks (not created) + +#### Defined in + +[src/api/chain.ts:406](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L406) diff --git a/docs/sdk/reference/interfaces/IChainValidatorsListResponse.md b/docs/sdk/reference/interfaces/IChainValidatorsListResponse.md index d3596b6f3..de4f1db50 100644 --- a/docs/sdk/reference/interfaces/IChainValidatorsListResponse.md +++ b/docs/sdk/reference/interfaces/IChainValidatorsListResponse.md @@ -18,4 +18,4 @@ The list of validators #### Defined in -[api/chain.ts:354](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L354) +[src/api/chain.ts:413](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L413) diff --git a/docs/sdk/reference/interfaces/IChoice.md b/docs/sdk/reference/interfaces/IChoice.md index 1a233dd55..11e2ed530 100644 --- a/docs/sdk/reference/interfaces/IChoice.md +++ b/docs/sdk/reference/interfaces/IChoice.md @@ -7,6 +7,7 @@ ### Properties - [answer](IChoice#answer) +- [meta](IChoice#meta) - [results](IChoice#results) - [title](IChoice#title) - [value](IChoice#value) @@ -19,7 +20,17 @@ #### Defined in -[types/metadata/election.ts:27](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/election.ts#L27) +[src/types/metadata/election.ts:31](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L31) + +___ + +### meta + +• `Optional` **meta**: `any` + +#### Defined in + +[src/types/metadata/election.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L29) ___ @@ -29,7 +40,7 @@ ___ #### Defined in -[types/metadata/election.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/election.ts#L26) +[src/types/metadata/election.ts:30](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L30) ___ @@ -39,7 +50,7 @@ ___ #### Defined in -[types/metadata/election.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/election.ts#L24) +[src/types/metadata/election.ts:27](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L27) ___ @@ -49,4 +60,4 @@ ___ #### Defined in -[types/metadata/election.ts:25](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/election.ts#L25) +[src/types/metadata/election.ts:28](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L28) diff --git a/docs/sdk/reference/interfaces/ICspAuthStep.md b/docs/sdk/reference/interfaces/ICspAuthStep.md index a79b5ee95..7c01fa190 100644 --- a/docs/sdk/reference/interfaces/ICspAuthStep.md +++ b/docs/sdk/reference/interfaces/ICspAuthStep.md @@ -19,7 +19,7 @@ The title of the step #### Defined in -[api/csp.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/csp.ts#L15) +[src/api/csp.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/csp.ts#L15) ___ @@ -31,4 +31,4 @@ The type of data of the step #### Defined in -[api/csp.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/csp.ts#L20) +[src/api/csp.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/csp.ts#L20) diff --git a/docs/sdk/reference/interfaces/ICspFinalStepResponse.md b/docs/sdk/reference/interfaces/ICspFinalStepResponse.md index e0022cdde..d74d380fe 100644 --- a/docs/sdk/reference/interfaces/ICspFinalStepResponse.md +++ b/docs/sdk/reference/interfaces/ICspFinalStepResponse.md @@ -18,4 +18,4 @@ The final token #### Defined in -[api/csp.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/csp.ts#L61) +[src/api/csp.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/csp.ts#L61) diff --git a/docs/sdk/reference/interfaces/ICspInfoResponse.md b/docs/sdk/reference/interfaces/ICspInfoResponse.md index 699fd8ae4..060dc32c4 100644 --- a/docs/sdk/reference/interfaces/ICspInfoResponse.md +++ b/docs/sdk/reference/interfaces/ICspInfoResponse.md @@ -21,7 +21,7 @@ The auth steps to follow in order to get a blind signature #### Defined in -[api/csp.ts:42](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/csp.ts#L42) +[src/api/csp.ts:42](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/csp.ts#L42) ___ @@ -33,7 +33,7 @@ The authentication type of the CSP #### Defined in -[api/csp.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/csp.ts#L37) +[src/api/csp.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/csp.ts#L37) ___ @@ -45,7 +45,7 @@ The types of signature of the CSP #### Defined in -[api/csp.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/csp.ts#L32) +[src/api/csp.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/csp.ts#L32) ___ @@ -57,4 +57,4 @@ The title of the CSP Information #### Defined in -[api/csp.ts:27](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/csp.ts#L27) +[src/api/csp.ts:27](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/csp.ts#L27) diff --git a/docs/sdk/reference/interfaces/ICspIntermediateStepResponse.md b/docs/sdk/reference/interfaces/ICspIntermediateStepResponse.md index bd8fd3bc9..4aeb94f54 100644 --- a/docs/sdk/reference/interfaces/ICspIntermediateStepResponse.md +++ b/docs/sdk/reference/interfaces/ICspIntermediateStepResponse.md @@ -19,7 +19,7 @@ The auth token for the following requests #### Defined in -[api/csp.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/csp.ts#L49) +[src/api/csp.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/csp.ts#L49) ___ @@ -31,4 +31,4 @@ The response of the CSP #### Defined in -[api/csp.ts:54](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/csp.ts#L54) +[src/api/csp.ts:54](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/csp.ts#L54) diff --git a/docs/sdk/reference/interfaces/ICspSignResponse.md b/docs/sdk/reference/interfaces/ICspSignResponse.md index cab049f9e..97ad361fd 100644 --- a/docs/sdk/reference/interfaces/ICspSignResponse.md +++ b/docs/sdk/reference/interfaces/ICspSignResponse.md @@ -18,4 +18,4 @@ The blind signature #### Defined in -[api/csp.ts:68](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/csp.ts#L68) +[src/api/csp.ts:68](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/csp.ts#L68) diff --git a/docs/sdk/reference/interfaces/IElectionCreateResponse.md b/docs/sdk/reference/interfaces/IElectionCreateResponse.md index a32c2f3b3..a3c9566da 100644 --- a/docs/sdk/reference/interfaces/IElectionCreateResponse.md +++ b/docs/sdk/reference/interfaces/IElectionCreateResponse.md @@ -20,7 +20,7 @@ The election identifier #### Defined in -[api/election.ts:134](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L134) +[src/api/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L127) ___ @@ -32,7 +32,7 @@ The metadata URL #### Defined in -[api/election.ts:139](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L139) +[src/api/election.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L132) ___ @@ -44,4 +44,4 @@ The hash of the transaction #### Defined in -[api/election.ts:129](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L129) +[src/api/election.ts:122](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L122) diff --git a/docs/sdk/reference/interfaces/IElectionInfoResponse.md b/docs/sdk/reference/interfaces/IElectionInfoResponse.md index a1c0e919d..c29158875 100644 --- a/docs/sdk/reference/interfaces/IElectionInfoResponse.md +++ b/docs/sdk/reference/interfaces/IElectionInfoResponse.md @@ -13,7 +13,6 @@ - [electionMode](IElectionInfoResponse#electionmode) - [endDate](IElectionInfoResponse#enddate) - [finalResults](IElectionInfoResponse#finalresults) -- [fromArchive](IElectionInfoResponse#fromarchive) - [manuallyEnded](IElectionInfoResponse#manuallyended) - [metadata](IElectionInfoResponse#metadata) - [metadataURL](IElectionInfoResponse#metadataurl) @@ -35,7 +34,7 @@ The census of the election #### Defined in -[api/election.ts:220](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L220) +[src/api/election.ts:208](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L208) ___ @@ -47,7 +46,7 @@ The chain identifier of the election #### Defined in -[api/election.ts:215](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L215) +[src/api/election.ts:203](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L203) ___ @@ -59,7 +58,7 @@ The date of creation of the election #### Defined in -[api/election.ts:230](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L230) +[src/api/election.ts:218](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L218) ___ @@ -71,7 +70,7 @@ The id of the election #### Defined in -[api/election.ts:165](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L165) +[src/api/election.ts:158](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L158) ___ @@ -83,7 +82,7 @@ The election mode of the election #### Defined in -[api/election.ts:240](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L240) +[src/api/election.ts:228](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L228) ___ @@ -95,7 +94,7 @@ The end date of the election #### Defined in -[api/election.ts:185](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L185) +[src/api/election.ts:178](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L178) ___ @@ -107,19 +106,7 @@ If the election has the final results #### Defined in -[api/election.ts:195](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L195) - -___ - -### fromArchive - -• **fromArchive**: `boolean` - -If the election comes from the archive - -#### Defined in - -[api/election.ts:210](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L210) +[src/api/election.ts:188](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L188) ___ @@ -131,7 +118,7 @@ If the election has been ended manually #### Defined in -[api/election.ts:205](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L205) +[src/api/election.ts:198](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L198) ___ @@ -143,7 +130,7 @@ The metadata of the election (can be encrypted) #### Defined in -[api/election.ts:250](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L250) +[src/api/election.ts:238](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L238) ___ @@ -155,7 +142,7 @@ The URL of the metadata #### Defined in -[api/election.ts:225](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L225) +[src/api/election.ts:213](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L213) ___ @@ -167,7 +154,7 @@ The id of the organization that created the election #### Defined in -[api/election.ts:170](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L170) +[src/api/election.ts:163](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L163) ___ @@ -179,7 +166,7 @@ The result of the election #### Defined in -[api/election.ts:200](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L200) +[src/api/election.ts:193](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L193) ___ @@ -191,7 +178,7 @@ The start date of the election #### Defined in -[api/election.ts:180](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L180) +[src/api/election.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L173) ___ @@ -203,7 +190,7 @@ The status of the election #### Defined in -[api/election.ts:175](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L175) +[src/api/election.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L168) ___ @@ -215,7 +202,7 @@ The tally mode of the vote #### Defined in -[api/election.ts:245](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L245) +[src/api/election.ts:233](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L233) ___ @@ -227,7 +214,7 @@ The number of votes of the election #### Defined in -[api/election.ts:190](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L190) +[src/api/election.ts:183](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L183) ___ @@ -239,4 +226,4 @@ The voting mode of the election #### Defined in -[api/election.ts:235](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L235) +[src/api/election.ts:223](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L223) diff --git a/docs/sdk/reference/interfaces/IElectionKeysResponse.md b/docs/sdk/reference/interfaces/IElectionKeysResponse.md index 33e413889..35976db0f 100644 --- a/docs/sdk/reference/interfaces/IElectionKeysResponse.md +++ b/docs/sdk/reference/interfaces/IElectionKeysResponse.md @@ -17,7 +17,7 @@ #### Defined in -[api/election.ts:267](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L267) +[src/api/election.ts:255](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L255) ___ @@ -27,4 +27,4 @@ ___ #### Defined in -[api/election.ts:266](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L266) +[src/api/election.ts:254](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L254) diff --git a/docs/sdk/reference/interfaces/IElectionList.md b/docs/sdk/reference/interfaces/IElectionList.md new file mode 100644 index 000000000..f94a33ed5 --- /dev/null +++ b/docs/sdk/reference/interfaces/IElectionList.md @@ -0,0 +1,27 @@ +[@vocdoni/sdk](/sdk) / IElectionList + +# Interface: IElectionList + +## Hierarchy + +- **`IElectionList`** + + ↳ [`IElectionListResponse`](IElectionListResponse) + +## Table of contents + +### Properties + +- [elections](IElectionList#elections) + +## Properties + +### elections + +• **elections**: [`IElectionSummary`](IElectionSummary)[] + +List of election summaries + +#### Defined in + +[src/api/election.ts:318](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L318) diff --git a/docs/sdk/reference/interfaces/IElectionListFilter.md b/docs/sdk/reference/interfaces/IElectionListFilter.md deleted file mode 100644 index 033821b2d..000000000 --- a/docs/sdk/reference/interfaces/IElectionListFilter.md +++ /dev/null @@ -1,52 +0,0 @@ -[@vocdoni/sdk](/sdk) / IElectionListFilter - -# Interface: IElectionListFilter - -## Table of contents - -### Properties - -- [electionId](IElectionListFilter#electionid) -- [organizationId](IElectionListFilter#organizationid) -- [status](IElectionListFilter#status) -- [withResults](IElectionListFilter#withresults) - -## Properties - -### electionId - -• `Optional` **electionId**: `string` - -#### Defined in - -[api/election.ts:364](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L364) - -___ - -### organizationId - -• `Optional` **organizationId**: `string` - -#### Defined in - -[api/election.ts:363](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L363) - -___ - -### status - -• `Optional` **status**: [`PROCESS_UNKNOWN`](../enums/ElectionStatus.md#process_unknown) \| [`ENDED`](../enums/ElectionStatus.md#ended) \| [`CANCELED`](../enums/ElectionStatus.md#canceled) \| [`PAUSED`](../enums/ElectionStatus.md#paused) \| [`RESULTS`](../enums/ElectionStatus.md#results) \| [`READY`](../enums/ElectionStatusReady#ready) - -#### Defined in - -[api/election.ts:366](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L366) - -___ - -### withResults - -• `Optional` **withResults**: `boolean` - -#### Defined in - -[api/election.ts:365](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L365) diff --git a/docs/sdk/reference/interfaces/IElectionListResponse.md b/docs/sdk/reference/interfaces/IElectionListResponse.md index 54bd5f190..6fd243964 100644 --- a/docs/sdk/reference/interfaces/IElectionListResponse.md +++ b/docs/sdk/reference/interfaces/IElectionListResponse.md @@ -2,11 +2,20 @@ # Interface: IElectionListResponse +## Hierarchy + +- [`IElectionList`](IElectionList) + +- [`PaginationResponse`](PaginationResponse) + + ↳ **`IElectionListResponse`** + ## Table of contents ### Properties - [elections](IElectionListResponse#elections) +- [pagination](IElectionListResponse#pagination) ## Properties @@ -16,6 +25,34 @@ List of election summaries +#### Inherited from + +[IElectionList](IElectionList.md).[elections](IElectionList#elections) + +#### Defined in + +[src/api/election.ts:318](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L318) + +___ + +### pagination + +• **pagination**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `currentPage` | `number` | +| `lastPage` | `number` | +| `nextPage` | `number` | +| `previousPage` | `number` | +| `totalItems` | `number` | + +#### Inherited from + +[PaginationResponse](PaginationResponse.md).[pagination](PaginationResponse#pagination) + #### Defined in -[api/election.ts:359](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L359) +[src/api/api.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/api.ts#L131) diff --git a/docs/sdk/reference/interfaces/IElectionMode.md b/docs/sdk/reference/interfaces/IElectionMode.md index 2c63b0991..1ee9018a7 100644 --- a/docs/sdk/reference/interfaces/IElectionMode.md +++ b/docs/sdk/reference/interfaces/IElectionMode.md @@ -6,7 +6,6 @@ ### Properties -- [autoStart](IElectionMode#autostart) - [dynamicCensus](IElectionMode#dynamiccensus) - [encryptedMetaData](IElectionMode#encryptedmetadata) - [interruptible](IElectionMode#interruptible) @@ -14,18 +13,6 @@ ## Properties -### autoStart - -• **autoStart**: `boolean` - -If the election should start automatically - -#### Defined in - -[api/election.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L75) - -___ - ### dynamicCensus • **dynamicCensus**: `boolean` @@ -34,7 +21,7 @@ If the election has a dynamic census #### Defined in -[api/election.ts:85](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L85) +[src/api/election.ts:78](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L78) ___ @@ -46,7 +33,7 @@ If the election has encrypted metadata #### Defined in -[api/election.ts:90](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L90) +[src/api/election.ts:83](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L83) ___ @@ -58,7 +45,7 @@ If the election is interruptible #### Defined in -[api/election.ts:80](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L80) +[src/api/election.ts:73](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L73) ___ @@ -70,4 +57,4 @@ If the election has preregister phase #### Defined in -[api/election.ts:95](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L95) +[src/api/election.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L88) diff --git a/docs/sdk/reference/interfaces/IElectionNextIdResponse.md b/docs/sdk/reference/interfaces/IElectionNextIdResponse.md index 61aaf6ddd..74461b882 100644 --- a/docs/sdk/reference/interfaces/IElectionNextIdResponse.md +++ b/docs/sdk/reference/interfaces/IElectionNextIdResponse.md @@ -18,4 +18,4 @@ The next election identifier #### Defined in -[api/election.ts:146](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L146) +[src/api/election.ts:139](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L139) diff --git a/docs/sdk/reference/interfaces/IElectionParameters.md b/docs/sdk/reference/interfaces/IElectionParameters.md index d6f49e611..306812ba8 100644 --- a/docs/sdk/reference/interfaces/IElectionParameters.md +++ b/docs/sdk/reference/interfaces/IElectionParameters.md @@ -45,7 +45,7 @@ Used to add the SDK version to the election metadata #### Defined in -[types/election/election.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L168) +[src/types/election/election.ts:164](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L164) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -[types/election/election.ts:142](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L142) +[src/types/election/election.ts:138](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L138) ___ @@ -67,7 +67,7 @@ Election description #### Defined in -[types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L127) +[src/types/election/election.ts:123](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L123) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -[types/election/election.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L144) +[src/types/election/election.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L140) ___ @@ -87,7 +87,7 @@ ___ #### Defined in -[types/election/election.ts:141](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L141) +[src/types/election/election.ts:137](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L137) ___ @@ -99,7 +99,7 @@ Election header image url. #### Defined in -[types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L131) +[src/types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L127) ___ @@ -119,7 +119,7 @@ size` error. #### Defined in -[types/election/election.ts:158](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L158) +[src/types/election/election.ts:154](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L154) ___ @@ -131,7 +131,7 @@ Metadata (anything added by the election creator) #### Defined in -[types/election/election.ts:139](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L139) +[src/types/election/election.ts:135](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L135) ___ @@ -141,7 +141,7 @@ ___ #### Defined in -[types/election/election.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L145) +[src/types/election/election.ts:141](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L141) ___ @@ -151,7 +151,7 @@ ___ #### Defined in -[types/election/election.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L140) +[src/types/election/election.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L136) ___ @@ -163,7 +163,7 @@ Election stream Uri (ex: a video url) #### Defined in -[types/election/election.ts:135](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L135) +[src/types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L131) ___ @@ -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:163](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L163) +[src/types/election/election.ts:159](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L159) ___ @@ -187,7 +187,7 @@ Election title #### Defined in -[types/election/election.ts:123](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L123) +[src/types/election/election.ts:119](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L119) ___ @@ -197,4 +197,4 @@ ___ #### Defined in -[types/election/election.ts:143](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L143) +[src/types/election/election.ts:139](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L139) diff --git a/docs/sdk/reference/interfaces/IElectionSummary.md b/docs/sdk/reference/interfaces/IElectionSummary.md index 0465ee045..aaa8223c3 100644 --- a/docs/sdk/reference/interfaces/IElectionSummary.md +++ b/docs/sdk/reference/interfaces/IElectionSummary.md @@ -6,9 +6,11 @@ ### Properties +- [chainId](IElectionSummary#chainid) - [electionId](IElectionSummary#electionid) - [endDate](IElectionSummary#enddate) - [finalResults](IElectionSummary#finalresults) +- [manuallyEnded](IElectionSummary#manuallyended) - [organizationId](IElectionSummary#organizationid) - [startDate](IElectionSummary#startdate) - [status](IElectionSummary#status) @@ -16,6 +18,18 @@ ## Properties +### chainId + +• **chainId**: `string` + +The chain identifier + +#### Defined in + +[src/api/election.ts:309](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L309) + +___ + ### electionId • **electionId**: `string` @@ -24,7 +38,7 @@ The id of the election #### Defined in -[api/election.ts:322](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L322) +[src/api/election.ts:269](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L269) ___ @@ -36,7 +50,7 @@ The end date of the election #### Defined in -[api/election.ts:342](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L342) +[src/api/election.ts:289](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L289) ___ @@ -48,7 +62,19 @@ If the election has the final results #### Defined in -[api/election.ts:352](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L352) +[src/api/election.ts:299](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L299) + +___ + +### manuallyEnded + +• **manuallyEnded**: `boolean` + +If the election has been ended manually + +#### Defined in + +[src/api/election.ts:304](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L304) ___ @@ -60,7 +86,7 @@ The id of the organization #### Defined in -[api/election.ts:327](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L327) +[src/api/election.ts:274](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L274) ___ @@ -72,7 +98,7 @@ The start date of the election #### Defined in -[api/election.ts:337](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L337) +[src/api/election.ts:284](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L284) ___ @@ -84,7 +110,7 @@ The status of the election #### Defined in -[api/election.ts:332](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L332) +[src/api/election.ts:279](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L279) ___ @@ -96,4 +122,4 @@ The number of votes of the election #### Defined in -[api/election.ts:347](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L347) +[src/api/election.ts:294](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L294) diff --git a/docs/sdk/reference/interfaces/IElectionType.md b/docs/sdk/reference/interfaces/IElectionType.md index 3aefc03f9..896418ac8 100644 --- a/docs/sdk/reference/interfaces/IElectionType.md +++ b/docs/sdk/reference/interfaces/IElectionType.md @@ -7,7 +7,6 @@ ### Properties - [anonymous](IElectionType#anonymous) -- [autoStart](IElectionType#autostart) - [dynamicCensus](IElectionType#dynamiccensus) - [interruptible](IElectionType#interruptible) - [metadata](IElectionType#metadata) @@ -23,19 +22,7 @@ Enable anonymous voting. #### Defined in -[types/election/election.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L92) - -___ - -### autoStart - -• `Optional` **autoStart**: `boolean` - -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L76) +[src/types/election/election.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L88) ___ @@ -47,7 +34,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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L84) +[src/types/election/election.ts:80](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L80) ___ @@ -59,7 +46,7 @@ The process can be paused and resumed. #### Defined in -[types/election/election.ts:80](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L80) +[src/types/election/election.ts:76](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L76) ___ @@ -78,7 +65,7 @@ If the metadata has to be encrypted or not. #### Defined in -[types/election/election.ts:96](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L96) +[src/types/election/election.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L92) ___ @@ -90,4 +77,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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L88) +[src/types/election/election.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L84) diff --git a/docs/sdk/reference/interfaces/IElectionVote.md b/docs/sdk/reference/interfaces/IElectionVote.md deleted file mode 100644 index 5073e54c0..000000000 --- a/docs/sdk/reference/interfaces/IElectionVote.md +++ /dev/null @@ -1,73 +0,0 @@ -[@vocdoni/sdk](/sdk) / IElectionVote - -# Interface: IElectionVote - -## Table of contents - -### Properties - -- [blockHeight](IElectionVote#blockheight) -- [transactionIndex](IElectionVote#transactionindex) -- [txHash](IElectionVote#txhash) -- [voteID](IElectionVote#voteid) -- [voterID](IElectionVote#voterid) - -## Properties - -### blockHeight - -• **blockHeight**: `number` - -Block containing the vote transaction - -#### Defined in - -[api/election.ts:303](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L303) - -___ - -### transactionIndex - -• **transactionIndex**: `number` - -Transaction number on the block - -#### Defined in - -[api/election.ts:308](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L308) - -___ - -### txHash - -• **txHash**: `string` - -Containing transaction hash - -#### Defined in - -[api/election.ts:288](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L288) - -___ - -### voteID - -• **voteID**: `string` - -Vote unique identifier also known as vote nullifier - -#### Defined in - -[api/election.ts:293](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L293) - -___ - -### voterID - -• **voterID**: `string` - -Account that emit the vote - -#### Defined in - -[api/election.ts:298](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L298) diff --git a/docs/sdk/reference/interfaces/IElectionVoteListResponse.md b/docs/sdk/reference/interfaces/IElectionVoteListResponse.md deleted file mode 100644 index b3cc1c5ca..000000000 --- a/docs/sdk/reference/interfaces/IElectionVoteListResponse.md +++ /dev/null @@ -1,21 +0,0 @@ -[@vocdoni/sdk](/sdk) / IElectionVoteListResponse - -# Interface: IElectionVoteListResponse - -## Table of contents - -### Properties - -- [votes](IElectionVoteListResponse#votes) - -## Properties - -### votes - -• **votes**: [`IElectionVote`](IElectionVote)[] - -List of votes - -#### Defined in - -[api/election.ts:315](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L315) diff --git a/docs/sdk/reference/interfaces/IEncryptionKey.md b/docs/sdk/reference/interfaces/IEncryptionKey.md index 8b616b5af..7ed66bff6 100644 --- a/docs/sdk/reference/interfaces/IEncryptionKey.md +++ b/docs/sdk/reference/interfaces/IEncryptionKey.md @@ -19,7 +19,7 @@ The index of the encryption key #### Defined in -[api/election.ts:257](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L257) +[src/api/election.ts:245](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L245) ___ @@ -31,4 +31,4 @@ The encryption key #### Defined in -[api/election.ts:262](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L262) +[src/api/election.ts:250](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L250) diff --git a/docs/sdk/reference/interfaces/IFeesList.md b/docs/sdk/reference/interfaces/IFeesList.md new file mode 100644 index 000000000..97f4c07e9 --- /dev/null +++ b/docs/sdk/reference/interfaces/IFeesList.md @@ -0,0 +1,27 @@ +[@vocdoni/sdk](/sdk) / IFeesList + +# Interface: IFeesList + +## Hierarchy + +- **`IFeesList`** + + ↳ [`IChainFeesListResponse`](IChainFeesListResponse) + +## Table of contents + +### Properties + +- [fees](IFeesList#fees) + +## Properties + +### fees + +• **fees**: [`Fee`](../sdk-reference#fee)[] + +The list of fees + +#### Defined in + +[src/api/chain.ts:454](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L454) diff --git a/docs/sdk/reference/interfaces/IInvalidElectionParameters.md b/docs/sdk/reference/interfaces/IInvalidElectionParameters.md index fb4e8fee4..345a17312 100644 --- a/docs/sdk/reference/interfaces/IInvalidElectionParameters.md +++ b/docs/sdk/reference/interfaces/IInvalidElectionParameters.md @@ -16,4 +16,4 @@ #### Defined in -[types/election/invalid.ts:2](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/invalid.ts#L2) +[src/types/election/invalid.ts:2](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/invalid.ts#L2) diff --git a/docs/sdk/reference/interfaces/IMultiChoiceElectionParameters.md b/docs/sdk/reference/interfaces/IMultiChoiceElectionParameters.md index b68574bbe..cae7ab2e9 100644 --- a/docs/sdk/reference/interfaces/IMultiChoiceElectionParameters.md +++ b/docs/sdk/reference/interfaces/IMultiChoiceElectionParameters.md @@ -25,6 +25,7 @@ Define election parameters. - [maxCensusSize](IMultiChoiceElectionParameters#maxcensussize) - [maxNumberOfChoices](IMultiChoiceElectionParameters#maxnumberofchoices) - [meta](IMultiChoiceElectionParameters#meta) +- [minNumberOfChoices](IMultiChoiceElectionParameters#minnumberofchoices) - [questions](IMultiChoiceElectionParameters#questions) - [startDate](IMultiChoiceElectionParameters#startdate) - [streamUri](IMultiChoiceElectionParameters#streamuri) @@ -46,7 +47,7 @@ Used to add the SDK version to the election metadata #### Defined in -[types/election/election.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L168) +[src/types/election/election.ts:164](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L164) ___ @@ -56,7 +57,7 @@ ___ #### Defined in -[types/election/multichoice.ts:10](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/multichoice.ts#L10) +[src/types/election/multichoice.ts:17](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/multichoice.ts#L17) ___ @@ -66,7 +67,7 @@ ___ #### Defined in -[types/election/multichoice.ts:9](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/multichoice.ts#L9) +[src/types/election/multichoice.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/multichoice.ts#L16) ___ @@ -80,7 +81,7 @@ ___ #### Defined in -[types/election/election.ts:142](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L142) +[src/types/election/election.ts:138](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L138) ___ @@ -96,7 +97,7 @@ Election description #### Defined in -[types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L127) +[src/types/election/election.ts:123](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L123) ___ @@ -110,7 +111,7 @@ ___ #### Defined in -[types/election/election.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L144) +[src/types/election/election.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L140) ___ @@ -124,7 +125,7 @@ ___ #### Defined in -[types/election/election.ts:141](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L141) +[src/types/election/election.ts:137](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L137) ___ @@ -140,7 +141,7 @@ Election header image url. #### Defined in -[types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L131) +[src/types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L127) ___ @@ -164,7 +165,7 @@ size` error. #### Defined in -[types/election/election.ts:158](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L158) +[src/types/election/election.ts:154](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L154) ___ @@ -174,7 +175,7 @@ ___ #### Defined in -[types/election/multichoice.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/multichoice.ts#L8) +[src/types/election/multichoice.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/multichoice.ts#L14) ___ @@ -190,7 +191,17 @@ Metadata (anything added by the election creator) #### Defined in -[types/election/election.ts:139](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L139) +[src/types/election/election.ts:135](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L135) + +___ + +### minNumberOfChoices + +• **minNumberOfChoices**: `number` + +#### Defined in + +[src/types/election/multichoice.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/multichoice.ts#L15) ___ @@ -204,7 +215,7 @@ ___ #### Defined in -[types/election/election.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L145) +[src/types/election/election.ts:141](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L141) ___ @@ -218,7 +229,7 @@ ___ #### Defined in -[types/election/election.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L140) +[src/types/election/election.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L136) ___ @@ -234,7 +245,7 @@ Election stream Uri (ex: a video url) #### Defined in -[types/election/election.ts:135](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L135) +[src/types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L131) ___ @@ -250,7 +261,7 @@ Is used to remove the secret identities of the voters once the process is done. #### Defined in -[types/election/election.ts:163](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L163) +[src/types/election/election.ts:159](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L159) ___ @@ -266,7 +277,7 @@ Election title #### Defined in -[types/election/election.ts:123](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L123) +[src/types/election/election.ts:119](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L119) ___ @@ -280,4 +291,4 @@ ___ #### Defined in -[types/election/election.ts:143](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L143) +[src/types/election/election.ts:139](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L139) diff --git a/docs/sdk/reference/interfaces/IPublishedElectionParameters.md b/docs/sdk/reference/interfaces/IPublishedElectionParameters.md index c33ee5b77..537cd11d8 100644 --- a/docs/sdk/reference/interfaces/IPublishedElectionParameters.md +++ b/docs/sdk/reference/interfaces/IPublishedElectionParameters.md @@ -22,7 +22,6 @@ Define election parameters. - [electionType](IPublishedElectionParameters#electiontype) - [endDate](IPublishedElectionParameters#enddate) - [finalResults](IPublishedElectionParameters#finalresults) -- [fromArchive](IPublishedElectionParameters#fromarchive) - [header](IPublishedElectionParameters#header) - [id](IPublishedElectionParameters#id) - [manuallyEnded](IPublishedElectionParameters#manuallyended) @@ -56,7 +55,7 @@ Used to add the SDK version to the election metadata #### Defined in -[types/election/election.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L168) +[src/types/election/election.ts:164](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L164) ___ @@ -70,7 +69,7 @@ ___ #### Defined in -[types/election/election.ts:142](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L142) +[src/types/election/election.ts:138](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L138) ___ @@ -80,7 +79,7 @@ ___ #### Defined in -[types/election/published.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L35) +[src/types/election/published.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L35) ___ @@ -90,7 +89,7 @@ ___ #### Defined in -[types/election/published.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L36) +[src/types/election/published.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L36) ___ @@ -106,7 +105,7 @@ Election description #### Defined in -[types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L127) +[src/types/election/election.ts:123](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L123) ___ @@ -120,7 +119,7 @@ ___ #### Defined in -[types/election/election.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L144) +[src/types/election/election.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L140) ___ @@ -134,7 +133,7 @@ ___ #### Defined in -[types/election/election.ts:141](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L141) +[src/types/election/election.ts:137](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L137) ___ @@ -144,17 +143,7 @@ ___ #### Defined in -[types/election/published.ts:31](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L31) - -___ - -### fromArchive - -• **fromArchive**: `boolean` - -#### Defined in - -[types/election/published.ts:34](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L34) +[src/types/election/published.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L32) ___ @@ -170,7 +159,7 @@ Election header image url. #### Defined in -[types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L131) +[src/types/election/election.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L127) ___ @@ -180,7 +169,7 @@ ___ #### Defined in -[types/election/published.ts:27](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L27) +[src/types/election/published.ts:28](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L28) ___ @@ -190,7 +179,7 @@ ___ #### Defined in -[types/election/published.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L33) +[src/types/election/published.ts:34](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L34) ___ @@ -214,7 +203,7 @@ size` error. #### Defined in -[types/election/election.ts:158](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L158) +[src/types/election/election.ts:154](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L154) ___ @@ -230,7 +219,7 @@ Metadata (anything added by the election creator) #### Defined in -[types/election/election.ts:139](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L139) +[src/types/election/election.ts:135](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L135) ___ @@ -240,7 +229,7 @@ ___ #### Defined in -[types/election/published.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L37) +[src/types/election/published.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L37) ___ @@ -250,7 +239,7 @@ ___ #### Defined in -[types/election/published.ts:28](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L28) +[src/types/election/published.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L29) ___ @@ -264,7 +253,7 @@ ___ #### Defined in -[types/election/election.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L145) +[src/types/election/election.ts:141](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L141) ___ @@ -274,7 +263,7 @@ ___ #### Defined in -[types/election/published.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L39) +[src/types/election/published.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L39) ___ @@ -284,7 +273,7 @@ ___ #### Defined in -[types/election/published.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L32) +[src/types/election/published.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L33) ___ @@ -294,7 +283,7 @@ ___ #### Defined in -[types/election/published.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L38) +[src/types/election/published.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L38) ___ @@ -308,7 +297,7 @@ ___ #### Defined in -[types/election/election.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L140) +[src/types/election/election.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L136) ___ @@ -318,7 +307,7 @@ ___ #### Defined in -[types/election/published.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L29) +[src/types/election/published.ts:30](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L30) ___ @@ -334,7 +323,7 @@ Election stream Uri (ex: a video url) #### Defined in -[types/election/election.ts:135](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L135) +[src/types/election/election.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L131) ___ @@ -350,7 +339,7 @@ Is used to remove the secret identities of the voters once the process is done. #### Defined in -[types/election/election.ts:163](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L163) +[src/types/election/election.ts:159](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L159) ___ @@ -366,7 +355,7 @@ Election title #### Defined in -[types/election/election.ts:123](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L123) +[src/types/election/election.ts:119](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L119) ___ @@ -376,7 +365,7 @@ ___ #### Defined in -[types/election/published.ts:30](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L30) +[src/types/election/published.ts:31](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L31) ___ @@ -390,4 +379,4 @@ ___ #### Defined in -[types/election/election.ts:143](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L143) +[src/types/election/election.ts:139](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L139) diff --git a/docs/sdk/reference/interfaces/IQuestion.md b/docs/sdk/reference/interfaces/IQuestion.md index 806237994..b2b4b10ff 100644 --- a/docs/sdk/reference/interfaces/IQuestion.md +++ b/docs/sdk/reference/interfaces/IQuestion.md @@ -8,6 +8,7 @@ - [choices](IQuestion#choices) - [description](IQuestion#description) +- [meta](IQuestion#meta) - [numAbstains](IQuestion#numabstains) - [title](IQuestion#title) @@ -19,7 +20,7 @@ #### Defined in -[types/metadata/election.ts:34](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/election.ts#L34) +[src/types/metadata/election.ts:39](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L39) ___ @@ -29,7 +30,17 @@ ___ #### Defined in -[types/metadata/election.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/election.ts#L32) +[src/types/metadata/election.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L36) + +___ + +### meta + +• `Optional` **meta**: `any` + +#### Defined in + +[src/types/metadata/election.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L38) ___ @@ -39,7 +50,7 @@ ___ #### Defined in -[types/metadata/election.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/election.ts#L33) +[src/types/metadata/election.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L37) ___ @@ -49,4 +60,4 @@ ___ #### Defined in -[types/metadata/election.ts:31](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/election.ts#L31) +[src/types/metadata/election.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L35) diff --git a/docs/sdk/reference/interfaces/IRemoteSignerAddressesResponse.md b/docs/sdk/reference/interfaces/IRemoteSignerAddressesResponse.md new file mode 100644 index 000000000..2d6689b24 --- /dev/null +++ b/docs/sdk/reference/interfaces/IRemoteSignerAddressesResponse.md @@ -0,0 +1,21 @@ +[@vocdoni/sdk](/sdk) / IRemoteSignerAddressesResponse + +# Interface: IRemoteSignerAddressesResponse + +## Table of contents + +### Properties + +- [addresses](IRemoteSignerAddressesResponse#addresses) + +## Properties + +### addresses + +• **addresses**: `string`[] + +The list of addresses + +#### Defined in + +[src/api/remote-signer.ts:40](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/remote-signer.ts#L40) diff --git a/docs/sdk/reference/interfaces/IRemoteSignerLoginResponse.md b/docs/sdk/reference/interfaces/IRemoteSignerLoginResponse.md new file mode 100644 index 000000000..583a36e96 --- /dev/null +++ b/docs/sdk/reference/interfaces/IRemoteSignerLoginResponse.md @@ -0,0 +1,34 @@ +[@vocdoni/sdk](/sdk) / IRemoteSignerLoginResponse + +# Interface: IRemoteSignerLoginResponse + +## Table of contents + +### Properties + +- [expirity](IRemoteSignerLoginResponse#expirity) +- [token](IRemoteSignerLoginResponse#token) + +## Properties + +### expirity + +• **expirity**: `string` + +The JWT token expiry + +#### Defined in + +[src/api/remote-signer.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/remote-signer.ts#L21) + +___ + +### token + +• **token**: `string` + +The JWT token + +#### Defined in + +[src/api/remote-signer.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/remote-signer.ts#L16) diff --git a/docs/sdk/reference/interfaces/IRemoteSignerRefreshResponse.md b/docs/sdk/reference/interfaces/IRemoteSignerRefreshResponse.md new file mode 100644 index 000000000..501d6538c --- /dev/null +++ b/docs/sdk/reference/interfaces/IRemoteSignerRefreshResponse.md @@ -0,0 +1,34 @@ +[@vocdoni/sdk](/sdk) / IRemoteSignerRefreshResponse + +# Interface: IRemoteSignerRefreshResponse + +## Table of contents + +### Properties + +- [expirity](IRemoteSignerRefreshResponse#expirity) +- [token](IRemoteSignerRefreshResponse#token) + +## Properties + +### expirity + +• **expirity**: `string` + +The JWT token expiry + +#### Defined in + +[src/api/remote-signer.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/remote-signer.ts#L33) + +___ + +### token + +• **token**: `string` + +The JWT token + +#### Defined in + +[src/api/remote-signer.ts:28](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/remote-signer.ts#L28) diff --git a/docs/sdk/reference/interfaces/IRemoteSignerSignResponse.md b/docs/sdk/reference/interfaces/IRemoteSignerSignResponse.md new file mode 100644 index 000000000..ff3635edf --- /dev/null +++ b/docs/sdk/reference/interfaces/IRemoteSignerSignResponse.md @@ -0,0 +1,21 @@ +[@vocdoni/sdk](/sdk) / IRemoteSignerSignResponse + +# Interface: IRemoteSignerSignResponse + +## Table of contents + +### Properties + +- [signature](IRemoteSignerSignResponse#signature) + +## Properties + +### signature + +• **signature**: `string` + +The signed payload + +#### Defined in + +[src/api/remote-signer.ts:54](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/remote-signer.ts#L54) diff --git a/docs/sdk/reference/interfaces/IRemoteSignerSignTxResponse.md b/docs/sdk/reference/interfaces/IRemoteSignerSignTxResponse.md new file mode 100644 index 000000000..cf5d640b1 --- /dev/null +++ b/docs/sdk/reference/interfaces/IRemoteSignerSignTxResponse.md @@ -0,0 +1,21 @@ +[@vocdoni/sdk](/sdk) / IRemoteSignerSignTxResponse + +# Interface: IRemoteSignerSignTxResponse + +## Table of contents + +### Properties + +- [txPayload](IRemoteSignerSignTxResponse#txpayload) + +## Properties + +### txPayload + +• **txPayload**: `string` + +The signed transaction payload + +#### Defined in + +[src/api/remote-signer.ts:47](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/remote-signer.ts#L47) diff --git a/docs/sdk/reference/interfaces/ITallyMode.md b/docs/sdk/reference/interfaces/ITallyMode.md index e9ff2657f..b3833158d 100644 --- a/docs/sdk/reference/interfaces/ITallyMode.md +++ b/docs/sdk/reference/interfaces/ITallyMode.md @@ -22,7 +22,7 @@ The cost exponent of the vote #### Defined in -[api/election.ts:122](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L122) +[src/api/election.ts:115](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L115) ___ @@ -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L102) +[src/api/election.ts:95](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L95) ___ @@ -46,7 +46,7 @@ The max total cost of the votes #### Defined in -[api/election.ts:117](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L117) +[src/api/election.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L110) ___ @@ -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L107) +[src/api/election.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L100) ___ @@ -70,4 +70,4 @@ The max number of votes overwrites #### Defined in -[api/election.ts:112](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L112) +[src/api/election.ts:105](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L105) diff --git a/docs/sdk/reference/interfaces/ITransfer.md b/docs/sdk/reference/interfaces/ITransfer.md new file mode 100644 index 000000000..56c6de345 --- /dev/null +++ b/docs/sdk/reference/interfaces/ITransfer.md @@ -0,0 +1,74 @@ +[@vocdoni/sdk](/sdk) / ITransfer + +# Interface: ITransfer + +## Table of contents + +### Properties + +- [amount](ITransfer#amount) +- [from](ITransfer#from) +- [height](ITransfer#height) +- [timestamp](ITransfer#timestamp) +- [to](ITransfer#to) +- [txHash](ITransfer#txhash) + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +[src/api/chain.ts:293](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L293) + +___ + +### from + +• **from**: `string` + +#### Defined in + +[src/api/chain.ts:294](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L294) + +___ + +### height + +• **height**: `number` + +#### Defined in + +[src/api/chain.ts:295](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L295) + +___ + +### timestamp + +• **timestamp**: `string` + +#### Defined in + +[src/api/chain.ts:297](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L297) + +___ + +### to + +• **to**: `string` + +#### Defined in + +[src/api/chain.ts:298](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L298) + +___ + +### txHash + +• **txHash**: `string` + +#### Defined in + +[src/api/chain.ts:296](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L296) diff --git a/docs/sdk/reference/interfaces/IVoteEncryptedPackage.md b/docs/sdk/reference/interfaces/IVoteEncryptedPackage.md index 359e05034..8dddcf368 100644 --- a/docs/sdk/reference/interfaces/IVoteEncryptedPackage.md +++ b/docs/sdk/reference/interfaces/IVoteEncryptedPackage.md @@ -18,4 +18,4 @@ The base64 encrypted vote package #### Defined in -[api/vote.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/vote.ts#L38) +[src/api/vote.ts:40](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/vote.ts#L40) diff --git a/docs/sdk/reference/interfaces/IVoteInfoResponse.md b/docs/sdk/reference/interfaces/IVoteInfoResponse.md deleted file mode 100644 index ce580dce5..000000000 --- a/docs/sdk/reference/interfaces/IVoteInfoResponse.md +++ /dev/null @@ -1,151 +0,0 @@ -[@vocdoni/sdk](/sdk) / IVoteInfoResponse - -# Interface: IVoteInfoResponse - -## Table of contents - -### Properties - -- [blockHeight](IVoteInfoResponse#blockheight) -- [date](IVoteInfoResponse#date) -- [electionID](IVoteInfoResponse#electionid) -- [encryptionKeys](IVoteInfoResponse#encryptionkeys) -- [overwriteCount](IVoteInfoResponse#overwritecount) -- [package](IVoteInfoResponse#package) -- [transactionIndex](IVoteInfoResponse#transactionindex) -- [txHash](IVoteInfoResponse#txhash) -- [voteID](IVoteInfoResponse#voteid) -- [voterID](IVoteInfoResponse#voterid) -- [weight](IVoteInfoResponse#weight) - -## Properties - -### blockHeight - -• **blockHeight**: `number` - -The block number where the transaction is mined. - -#### Defined in - -[api/vote.ts:80](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/vote.ts#L80) - -___ - -### date - -• **date**: `string` - -Date when the vote was emitted - -#### Defined in - -[api/vote.ts:95](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/vote.ts#L95) - -___ - -### electionID - -• **electionID**: `string` - -The identifier of the election. - -#### Defined in - -[api/vote.ts:70](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/vote.ts#L70) - -___ - -### encryptionKeys - -• `Optional` **encryptionKeys**: `number`[] - -Encryption key indexes used - -#### Defined in - -[api/vote.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/vote.ts#L55) - -___ - -### overwriteCount - -• **overwriteCount**: `number` - -The number of votes overwrites. - -#### Defined in - -[api/vote.ts:90](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/vote.ts#L90) - -___ - -### package - -• **package**: [`IVotePackage`](IVotePackage.md) \| [`IVoteEncryptedPackage`](IVoteEncryptedPackage) - -The vote package. - -#### Defined in - -[api/vote.ts:60](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/vote.ts#L60) - -___ - -### transactionIndex - -• **transactionIndex**: `number` - -The index inside the block where the transaction is mined. - -#### Defined in - -[api/vote.ts:85](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/vote.ts#L85) - -___ - -### txHash - -• **txHash**: `string` - -The hash of the transaction - -#### Defined in - -[api/vote.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/vote.ts#L45) - -___ - -### voteID - -• **voteID**: `string` - -The identifier of the vote, also called nullifier. - -#### Defined in - -[api/vote.ts:50](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/vote.ts#L50) - -___ - -### voterID - -• **voterID**: `string` - -The identifier of the voter. - -#### Defined in - -[api/vote.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/vote.ts#L75) - -___ - -### weight - -• **weight**: `string` - -The weight of the vote. - -#### Defined in - -[api/vote.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/vote.ts#L65) diff --git a/docs/sdk/reference/interfaces/IVoteListResponse.md b/docs/sdk/reference/interfaces/IVoteListResponse.md new file mode 100644 index 000000000..f16f1e92f --- /dev/null +++ b/docs/sdk/reference/interfaces/IVoteListResponse.md @@ -0,0 +1,58 @@ +[@vocdoni/sdk](/sdk) / IVoteListResponse + +# Interface: IVoteListResponse + +## Hierarchy + +- [`VotesList`](VotesList) + +- [`PaginationResponse`](PaginationResponse) + + ↳ **`IVoteListResponse`** + +## Table of contents + +### Properties + +- [pagination](IVoteListResponse#pagination) +- [votes](IVoteListResponse#votes) + +## Properties + +### pagination + +• **pagination**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `currentPage` | `number` | +| `lastPage` | `number` | +| `nextPage` | `number` | +| `previousPage` | `number` | +| `totalItems` | `number` | + +#### Inherited from + +[PaginationResponse](PaginationResponse.md).[pagination](PaginationResponse#pagination) + +#### Defined in + +[src/api/api.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/api.ts#L131) + +___ + +### votes + +• **votes**: [`VoteSummary`](../sdk-reference#votesummary)[] + +The list of votes + +#### Inherited from + +[VotesList](VotesList.md).[votes](VotesList#votes) + +#### Defined in + +[src/api/vote.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/vote.ts#L49) diff --git a/docs/sdk/reference/interfaces/IVoteMode.md b/docs/sdk/reference/interfaces/IVoteMode.md index b7b5e0506..0611c7136 100644 --- a/docs/sdk/reference/interfaces/IVoteMode.md +++ b/docs/sdk/reference/interfaces/IVoteMode.md @@ -22,7 +22,7 @@ If the vote is anonymous #### Defined in -[api/election.ts:53](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L53) +[src/api/election.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L51) ___ @@ -34,7 +34,7 @@ Cost from weight of the election #### Defined in -[api/election.ts:68](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L68) +[src/api/election.ts:66](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L66) ___ @@ -46,7 +46,7 @@ If the vote is encrypted #### Defined in -[api/election.ts:58](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L58) +[src/api/election.ts:56](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L56) ___ @@ -58,7 +58,7 @@ If the vote is serial #### Defined in -[api/election.ts:48](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L48) +[src/api/election.ts:46](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L46) ___ @@ -70,4 +70,4 @@ If the vote values are unique #### Defined in -[api/election.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/election.ts#L63) +[src/api/election.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/election.ts#L61) diff --git a/docs/sdk/reference/interfaces/IVotePackage.md b/docs/sdk/reference/interfaces/IVotePackage.md index 15ac362c0..970f820b9 100644 --- a/docs/sdk/reference/interfaces/IVotePackage.md +++ b/docs/sdk/reference/interfaces/IVotePackage.md @@ -19,7 +19,7 @@ The nonce of the vote package #### Defined in -[api/vote.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/vote.ts#L26) +[src/api/vote.ts:28](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/vote.ts#L28) ___ @@ -31,4 +31,4 @@ The raw vote package #### Defined in -[api/vote.ts:31](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/vote.ts#L31) +[src/api/vote.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/vote.ts#L33) diff --git a/docs/sdk/reference/interfaces/IVoteSubmitResponse.md b/docs/sdk/reference/interfaces/IVoteSubmitResponse.md index d54648f65..d30b030c6 100644 --- a/docs/sdk/reference/interfaces/IVoteSubmitResponse.md +++ b/docs/sdk/reference/interfaces/IVoteSubmitResponse.md @@ -19,7 +19,7 @@ The hash of the transaction #### Defined in -[api/vote.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/vote.ts#L14) +[src/api/vote.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/vote.ts#L16) ___ @@ -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/vote.ts#L19) +[src/api/vote.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/vote.ts#L21) diff --git a/docs/sdk/reference/interfaces/IVoteType.md b/docs/sdk/reference/interfaces/IVoteType.md index 8124d3632..192e18fcd 100644 --- a/docs/sdk/reference/interfaces/IVoteType.md +++ b/docs/sdk/reference/interfaces/IVoteType.md @@ -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L46) +[src/types/election/election.ts:46](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L20) +[src/types/election/election.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L62) +[src/types/election/election.ts:62](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L69) +[src/types/election/election.ts:69](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L53) +[src/types/election/election.ts:53](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L15) +[src/types/election/election.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L11) +[src/types/election/election.ts:11](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L11) diff --git a/docs/sdk/reference/interfaces/IZkProofResponse.md b/docs/sdk/reference/interfaces/IZkProofResponse.md index 14d295551..404cf8b25 100644 --- a/docs/sdk/reference/interfaces/IZkProofResponse.md +++ b/docs/sdk/reference/interfaces/IZkProofResponse.md @@ -21,7 +21,7 @@ The proof for the given key #### Defined in -[api/zk.ts:19](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/zk.ts#L19) +[src/api/zk.ts:19](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/zk.ts#L19) ___ @@ -33,7 +33,7 @@ The root (id) of the census #### Defined in -[api/zk.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/zk.ts#L14) +[src/api/zk.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/zk.ts#L14) ___ @@ -45,7 +45,7 @@ The value for the census siblings #### Defined in -[api/zk.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/zk.ts#L29) +[src/api/zk.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/zk.ts#L29) ___ @@ -57,4 +57,4 @@ The value for the given key #### Defined in -[api/zk.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/zk.ts#L24) +[src/api/zk.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/zk.ts#L24) diff --git a/docs/sdk/reference/interfaces/IZkSIKResponse.md b/docs/sdk/reference/interfaces/IZkSIKResponse.md index 443685df3..ecafbe60d 100644 --- a/docs/sdk/reference/interfaces/IZkSIKResponse.md +++ b/docs/sdk/reference/interfaces/IZkSIKResponse.md @@ -18,4 +18,4 @@ The sik of the address #### Defined in -[api/zk.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/zk.ts#L36) +[src/api/zk.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/zk.ts#L36) diff --git a/docs/sdk/reference/interfaces/MintTokensTx.md b/docs/sdk/reference/interfaces/MintTokensTx.md index fc1d7ab05..18a6ed0f5 100644 --- a/docs/sdk/reference/interfaces/MintTokensTx.md +++ b/docs/sdk/reference/interfaces/MintTokensTx.md @@ -19,7 +19,7 @@ #### Defined in -[api/chain/transactions.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L128) +[src/api/chain/transactions.ts:129](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L129) ___ @@ -29,7 +29,7 @@ ___ #### Defined in -[api/chain/transactions.ts:129](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L129) +[src/api/chain/transactions.ts:130](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L130) ___ @@ -39,7 +39,7 @@ ___ #### Defined in -[api/chain/transactions.ts:127](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L127) +[src/api/chain/transactions.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L128) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[api/chain/transactions.ts:130](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L130) +[src/api/chain/transactions.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L131) diff --git a/docs/sdk/reference/interfaces/NewProcessTx.md b/docs/sdk/reference/interfaces/NewProcessTx.md index afaa8257b..b504663fc 100644 --- a/docs/sdk/reference/interfaces/NewProcessTx.md +++ b/docs/sdk/reference/interfaces/NewProcessTx.md @@ -18,7 +18,7 @@ #### Defined in -[api/chain/transactions.ts:85](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L85) +[src/api/chain/transactions.ts:86](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L86) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[api/chain/transactions.ts:86](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L86) +[src/api/chain/transactions.ts:87](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L87) ___ @@ -38,4 +38,4 @@ ___ #### Defined in -[api/chain/transactions.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L84) +[src/api/chain/transactions.ts:85](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L85) diff --git a/docs/sdk/reference/interfaces/OrganizationList.md b/docs/sdk/reference/interfaces/OrganizationList.md new file mode 100644 index 000000000..46ff5cc5f --- /dev/null +++ b/docs/sdk/reference/interfaces/OrganizationList.md @@ -0,0 +1,27 @@ +[@vocdoni/sdk](/sdk) / OrganizationList + +# Interface: OrganizationList + +## Hierarchy + +- **`OrganizationList`** + + ↳ [`IChainOrganizationListResponse`](IChainOrganizationListResponse) + +## Table of contents + +### Properties + +- [organizations](OrganizationList#organizations) + +## Properties + +### organizations + +• **organizations**: [`IChainOrganizationResponse`](IChainOrganizationResponse)[] + +The list of organizations + +#### Defined in + +[src/api/chain.ts:319](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L319) diff --git a/docs/sdk/reference/interfaces/PaginationResponse.md b/docs/sdk/reference/interfaces/PaginationResponse.md new file mode 100644 index 000000000..80900986e --- /dev/null +++ b/docs/sdk/reference/interfaces/PaginationResponse.md @@ -0,0 +1,49 @@ +[@vocdoni/sdk](/sdk) / PaginationResponse + +# Interface: PaginationResponse + +## Hierarchy + +- **`PaginationResponse`** + + ↳ [`IAccountsListResponse`](IAccountsListResponse) + + ↳ [`IChainTxListResponse`](IChainTxListResponse) + + ↳ [`IChainBlocksListResponse`](IChainBlocksListResponse) + + ↳ [`IChainTransfersListResponse`](IChainTransfersListResponse) + + ↳ [`IChainOrganizationListResponse`](IChainOrganizationListResponse) + + ↳ [`IChainFeesListResponse`](IChainFeesListResponse) + + ↳ [`IElectionListResponse`](IElectionListResponse) + + ↳ [`IVoteListResponse`](IVoteListResponse) + +## Table of contents + +### Properties + +- [pagination](PaginationResponse#pagination) + +## Properties + +### pagination + +• **pagination**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `currentPage` | `number` | +| `lastPage` | `number` | +| `nextPage` | `number` | +| `previousPage` | `number` | +| `totalItems` | `number` | + +#### Defined in + +[src/api/api.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/api.ts#L131) diff --git a/docs/sdk/reference/interfaces/Process.md b/docs/sdk/reference/interfaces/Process.md index 5c80aa38c..31dc7a829 100644 --- a/docs/sdk/reference/interfaces/Process.md +++ b/docs/sdk/reference/interfaces/Process.md @@ -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L174) +[src/api/chain/transactions.ts:175](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L175) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[api/chain/transactions.ts:192](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L192) +[src/api/chain/transactions.ts:193](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L193) ___ @@ -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L176) +[src/api/chain/transactions.ts:177](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L177) ___ @@ -82,7 +82,7 @@ CensusURI where to find the census #### Defined in -[api/chain/transactions.ts:178](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L178) +[src/api/chain/transactions.ts:179](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L179) ___ @@ -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L180) +[src/api/chain/transactions.ts:181](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L181) ___ @@ -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L182) +[src/api/chain/transactions.ts:183](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L183) ___ @@ -118,7 +118,7 @@ EntityId identifies unequivocally an entity #### Defined in -[api/chain/transactions.ts:170](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L170) +[src/api/chain/transactions.ts:171](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L171) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[api/chain/transactions.ts:187](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L187) +[src/api/chain/transactions.ts:188](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L188) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -[api/chain/transactions.ts:195](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L195) +[src/api/chain/transactions.ts:196](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L196) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -[api/chain/transactions.ts:183](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L183) +[src/api/chain/transactions.ts:184](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L184) ___ @@ -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L205) +[src/api/chain/transactions.ts:206](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L206) ___ @@ -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L201) +[src/api/chain/transactions.ts:202](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L202) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[api/chain/transactions.ts:188](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L188) +[src/api/chain/transactions.ts:189](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L189) ___ @@ -192,7 +192,7 @@ ___ #### Defined in -[api/chain/transactions.ts:186](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L186) +[src/api/chain/transactions.ts:187](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L187) ___ @@ -205,7 +205,7 @@ Used when Mode.PreRegister = true. #### Defined in -[api/chain/transactions.ts:220](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L220) +[src/api/chain/transactions.ts:221](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L221) ___ @@ -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L199) +[src/api/chain/transactions.ts:200](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L200) ___ @@ -227,7 +227,7 @@ ___ #### Defined in -[api/chain/transactions.ts:185](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L185) +[src/api/chain/transactions.ts:186](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L186) ___ @@ -237,7 +237,7 @@ ___ #### Defined in -[api/chain/transactions.ts:168](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L168) +[src/api/chain/transactions.ts:169](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L169) ___ @@ -247,7 +247,7 @@ ___ #### Defined in -[api/chain/transactions.ts:190](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L190) +[src/api/chain/transactions.ts:191](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L191) ___ @@ -257,7 +257,7 @@ ___ #### Defined in -[api/chain/transactions.ts:189](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L189) +[src/api/chain/transactions.ts:190](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L190) ___ @@ -267,7 +267,7 @@ ___ #### Defined in -[api/chain/transactions.ts:193](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L193) +[src/api/chain/transactions.ts:194](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L194) ___ @@ -277,7 +277,7 @@ ___ #### Defined in -[api/chain/transactions.ts:194](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L194) +[src/api/chain/transactions.ts:195](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L195) ___ @@ -290,7 +290,7 @@ vocdoni-node when Mode.Process = true #### Defined in -[api/chain/transactions.ts:210](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L210) +[src/api/chain/transactions.ts:211](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L211) ___ @@ -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L215) +[src/api/chain/transactions.ts:216](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L216) ___ @@ -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L197) +[src/api/chain/transactions.ts:198](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L198) ___ @@ -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L225) +[src/api/chain/transactions.ts:226](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L226) ___ @@ -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L203) +[src/api/chain/transactions.ts:204](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L204) ___ @@ -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L172) +[src/api/chain/transactions.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L173) ___ @@ -362,7 +362,7 @@ ___ #### Defined in -[api/chain/transactions.ts:184](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L184) +[src/api/chain/transactions.ts:185](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L185) ___ @@ -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L230) +[src/api/chain/transactions.ts:231](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L231) ___ @@ -385,4 +385,4 @@ ___ #### Defined in -[api/chain/transactions.ts:191](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L191) +[src/api/chain/transactions.ts:192](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L192) diff --git a/docs/sdk/reference/interfaces/Proof.md b/docs/sdk/reference/interfaces/Proof.md index 45a44fee1..08335af5d 100644 --- a/docs/sdk/reference/interfaces/Proof.md +++ b/docs/sdk/reference/interfaces/Proof.md @@ -16,4 +16,4 @@ #### Defined in -[api/chain/transactions.ts:341](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L341) +[src/api/chain/transactions.ts:341](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L341) diff --git a/docs/sdk/reference/interfaces/RegisterKeyTx.md b/docs/sdk/reference/interfaces/RegisterKeyTx.md index 14ae90ee3..4b9089387 100644 --- a/docs/sdk/reference/interfaces/RegisterKeyTx.md +++ b/docs/sdk/reference/interfaces/RegisterKeyTx.md @@ -22,7 +22,7 @@ New key to register #### Defined in -[api/chain/transactions.ts:121](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L121) +[src/api/chain/transactions.ts:122](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L122) ___ @@ -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L115) +[src/api/chain/transactions.ts:116](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L116) ___ @@ -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L117) +[src/api/chain/transactions.ts:118](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L118) ___ @@ -58,7 +58,7 @@ Franchise proof #### Defined in -[api/chain/transactions.ts:119](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L119) +[src/api/chain/transactions.ts:120](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L120) ___ @@ -70,4 +70,4 @@ Weight to delegate to newKey #### Defined in -[api/chain/transactions.ts:123](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L123) +[src/api/chain/transactions.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L124) diff --git a/docs/sdk/reference/interfaces/SendTokensTx.md b/docs/sdk/reference/interfaces/SendTokensTx.md index cb023edce..cbadebcfd 100644 --- a/docs/sdk/reference/interfaces/SendTokensTx.md +++ b/docs/sdk/reference/interfaces/SendTokensTx.md @@ -20,7 +20,7 @@ #### Defined in -[api/chain/transactions.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L136) +[src/api/chain/transactions.ts:137](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L137) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[api/chain/transactions.ts:135](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L135) +[src/api/chain/transactions.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L136) ___ @@ -40,7 +40,7 @@ ___ #### Defined in -[api/chain/transactions.ts:137](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L137) +[src/api/chain/transactions.ts:138](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L138) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -[api/chain/transactions.ts:134](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L134) +[src/api/chain/transactions.ts:135](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L135) ___ @@ -60,4 +60,4 @@ ___ #### Defined in -[api/chain/transactions.ts:138](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L138) +[src/api/chain/transactions.ts:139](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L139) diff --git a/docs/sdk/reference/interfaces/ServiceProperties.md b/docs/sdk/reference/interfaces/ServiceProperties.md index 327b04abe..0013934a8 100644 --- a/docs/sdk/reference/interfaces/ServiceProperties.md +++ b/docs/sdk/reference/interfaces/ServiceProperties.md @@ -20,4 +20,4 @@ #### Defined in -[services/service.ts:2](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/service.ts#L2) +[src/services/service.ts:2](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/service.ts#L2) diff --git a/docs/sdk/reference/interfaces/SetAccountTx.md b/docs/sdk/reference/interfaces/SetAccountTx.md index 1e79af8fd..092596b50 100644 --- a/docs/sdk/reference/interfaces/SetAccountTx.md +++ b/docs/sdk/reference/interfaces/SetAccountTx.md @@ -21,7 +21,7 @@ #### Defined in -[api/chain/transactions.ts:151](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L151) +[src/api/chain/transactions.ts:152](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L152) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -[api/chain/transactions.ts:153](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L153) +[src/api/chain/transactions.ts:154](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L154) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[api/chain/transactions.ts:152](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L152) +[src/api/chain/transactions.ts:153](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L153) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[api/chain/transactions.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L150) +[src/api/chain/transactions.ts:151](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L151) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[api/chain/transactions.ts:149](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L149) +[src/api/chain/transactions.ts:150](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L150) ___ @@ -71,4 +71,4 @@ ___ #### Defined in -[api/chain/transactions.ts:148](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L148) +[src/api/chain/transactions.ts:149](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L149) diff --git a/docs/sdk/reference/interfaces/SetProcessTx.md b/docs/sdk/reference/interfaces/SetProcessTx.md index 0be41a059..9f9bd4300 100644 --- a/docs/sdk/reference/interfaces/SetProcessTx.md +++ b/docs/sdk/reference/interfaces/SetProcessTx.md @@ -24,7 +24,7 @@ #### Defined in -[api/chain/transactions.ts:107](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L107) +[src/api/chain/transactions.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L108) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[api/chain/transactions.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L108) +[src/api/chain/transactions.ts:109](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L109) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[api/chain/transactions.ts:103](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L103) +[src/api/chain/transactions.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L104) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[api/chain/transactions.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L104) +[src/api/chain/transactions.ts:105](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L105) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[api/chain/transactions.ts:109](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L109) +[src/api/chain/transactions.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L110) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[api/chain/transactions.ts:106](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L106) +[src/api/chain/transactions.ts:107](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L107) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[api/chain/transactions.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L110) +[src/api/chain/transactions.ts:111](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L111) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[api/chain/transactions.ts:105](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L105) +[src/api/chain/transactions.ts:106](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L106) ___ @@ -104,4 +104,4 @@ ___ #### Defined in -[api/chain/transactions.ts:102](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L102) +[src/api/chain/transactions.ts:103](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L103) diff --git a/docs/sdk/reference/interfaces/SetTransactionCostsTx.md b/docs/sdk/reference/interfaces/SetTransactionCostsTx.md index 9cb213d66..c94eea740 100644 --- a/docs/sdk/reference/interfaces/SetTransactionCostsTx.md +++ b/docs/sdk/reference/interfaces/SetTransactionCostsTx.md @@ -18,7 +18,7 @@ #### Defined in -[api/chain/transactions.ts:143](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L143) +[src/api/chain/transactions.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L144) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[api/chain/transactions.ts:142](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L142) +[src/api/chain/transactions.ts:143](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L143) ___ @@ -38,4 +38,4 @@ ___ #### Defined in -[api/chain/transactions.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L144) +[src/api/chain/transactions.ts:145](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L145) diff --git a/docs/sdk/reference/interfaces/Tx.md b/docs/sdk/reference/interfaces/Tx.md index 5fb63e522..08b52bf75 100644 --- a/docs/sdk/reference/interfaces/Tx.md +++ b/docs/sdk/reference/interfaces/Tx.md @@ -6,18 +6,29 @@ ### Properties +- [signature](Tx#signature) - [tx](Tx#tx) - [txInfo](Tx#txinfo) ## Properties +### signature + +• **signature**: `string` + +#### Defined in + +[src/api/chain/transactions.ts:54](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L54) + +___ + ### tx • `Optional` **tx**: \{ `$case`: ``"vote"`` ; `vote`: [`VoteEnvelope`](VoteEnvelope.md) } \| \{ `$case`: ``"newProcess"`` ; `newProcess`: [`NewProcessTx`](NewProcessTx.md) } \| \{ `$case`: ``"admin"`` ; `admin`: [`AdminTx`](AdminTx.md) } \| \{ `$case`: ``"setProcess"`` ; `setProcess`: [`SetProcessTx`](SetProcessTx.md) } \| \{ `$case`: ``"registerKey"`` ; `registerKey`: [`RegisterKeyTx`](RegisterKeyTx.md) } \| \{ `$case`: ``"mintTokens"`` ; `mintTokens`: [`MintTokensTx`](MintTokensTx.md) } \| \{ `$case`: ``"sendTokens"`` ; `sendTokens`: [`SendTokensTx`](SendTokensTx.md) } \| \{ `$case`: ``"setTransactionCosts"`` ; `setTransactionCosts`: [`SetTransactionCostsTx`](SetTransactionCostsTx.md) } \| \{ `$case`: ``"setAccount"`` ; `setAccountInfo`: [`SetAccountTx`](SetAccountTx.md) } \| \{ `$case`: ``"collectFaucet"`` ; `collectFaucet`: [`CollectFaucetTx`](CollectFaucetTx) } #### Defined in -[api/chain/transactions.ts:4](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L4) +[src/api/chain/transactions.ts:4](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L4) ___ @@ -27,4 +38,4 @@ ___ #### Defined in -[api/chain/transactions.ts:53](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L53) +[src/api/chain/transactions.ts:53](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L53) diff --git a/docs/sdk/reference/interfaces/VoteEnvelope.md b/docs/sdk/reference/interfaces/VoteEnvelope.md index 21f190841..e1ddf3a0a 100644 --- a/docs/sdk/reference/interfaces/VoteEnvelope.md +++ b/docs/sdk/reference/interfaces/VoteEnvelope.md @@ -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L80) +[src/api/chain/transactions.ts:81](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L81) ___ @@ -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L60) +[src/api/chain/transactions.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L61) ___ @@ -47,7 +47,7 @@ Hash of the private key + processId #### Defined in -[api/chain/transactions.ts:76](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L76) +[src/api/chain/transactions.ts:77](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L77) ___ @@ -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L64) +[src/api/chain/transactions.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L65) ___ @@ -71,7 +71,7 @@ Franchise proof #### Defined in -[api/chain/transactions.ts:68](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L68) +[src/api/chain/transactions.ts:69](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L69) ___ @@ -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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain/transactions.ts#L72) +[src/api/chain/transactions.ts:73](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain/transactions.ts#L73) diff --git a/docs/sdk/reference/interfaces/VotesList.md b/docs/sdk/reference/interfaces/VotesList.md new file mode 100644 index 000000000..f69628b92 --- /dev/null +++ b/docs/sdk/reference/interfaces/VotesList.md @@ -0,0 +1,27 @@ +[@vocdoni/sdk](/sdk) / VotesList + +# Interface: VotesList + +## Hierarchy + +- **`VotesList`** + + ↳ [`IVoteListResponse`](IVoteListResponse) + +## Table of contents + +### Properties + +- [votes](VotesList#votes) + +## Properties + +### votes + +• **votes**: [`VoteSummary`](../sdk-reference#votesummary)[] + +The list of votes + +#### Defined in + +[src/api/vote.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/vote.ts#L49) diff --git a/docs/sdk/reference/sdk-reference.md b/docs/sdk/reference/sdk-reference.md index 60971d85e..c7da40e3f 100644 --- a/docs/sdk/reference/sdk-reference.md +++ b/docs/sdk/reference/sdk-reference.md @@ -4,13 +4,13 @@ ### Classes +- [API](classes/API) - [Account](classes/Account) - [AccountAPI](classes/AccountAPI) - [AccountService](classes/AccountService) - [AnonymousService](classes/AnonymousService) - [AnonymousVote](classes/AnonymousVote) - [ApprovalElection](classes/ApprovalElection) -- [ArchivedElection](classes/ArchivedElection) - [BudgetElection](classes/BudgetElection) - [Census](classes/Census) - [Census3CensusAPI](classes/Census3CensusAPI) @@ -19,28 +19,142 @@ - [Census3TokenAPI](classes/Census3TokenAPI) - [CensusAPI](classes/CensusAPI) - [CensusService](classes/CensusService) +- [CensusStillNotPublished](classes/CensusStillNotPublished) - [ChainAPI](classes/ChainAPI) - [ChainService](classes/ChainService) +- [CouldNotCreateFaucetPackageError](classes/CouldNotCreateFaucetPackageError) +- [CouldNotSignTransactionError](classes/CouldNotSignTransactionError) - [CspAPI](classes/CspAPI) - [CspCensus](classes/CspCensus) - [CspService](classes/CspService) - [CspVote](classes/CspVote) +- [DuplicateConflictError](classes/DuplicateConflictError) - [Election](classes/Election) - [ElectionAPI](classes/ElectionAPI) - [ElectionService](classes/ElectionService) +- [EmailMalformedError](classes/EmailMalformedError) +- [ErrAPI](classes/ErrAPI) +- [ErrAccountAlreadyExists](classes/ErrAccountAlreadyExists) +- [ErrAccountNotFound](classes/ErrAccountNotFound) +- [ErrAddressMalformed](classes/ErrAddressMalformed) +- [ErrBlockNotFound](classes/ErrBlockNotFound) +- [ErrCantABIEncodeResults](classes/ErrCantABIEncodeResults) +- [ErrCantAddKeyAndValueToTree](classes/ErrCantAddKeyAndValueToTree) +- [ErrCantAddKeyToTree](classes/ErrCantAddKeyToTree) +- [ErrCantCheckTxType](classes/ErrCantCheckTxType) +- [ErrCantComputeKeyHash](classes/ErrCantComputeKeyHash) +- [ErrCantCountVotes](classes/ErrCantCountVotes) +- [ErrCantEstimateBlockHeight](classes/ErrCantEstimateBlockHeight) +- [ErrCantExtractMetadataURI](classes/ErrCantExtractMetadataURI) +- [ErrCantFetchElection](classes/ErrCantFetchElection) +- [ErrCantFetchEnvelope](classes/ErrCantFetchEnvelope) +- [ErrCantFetchEnvelopeHeight](classes/ErrCantFetchEnvelopeHeight) +- [ErrCantFetchTokenFees](classes/ErrCantFetchTokenFees) +- [ErrCantFetchTokenTransfers](classes/ErrCantFetchTokenTransfers) +- [ErrCantGenerateFaucetPkg](classes/ErrCantGenerateFaucetPkg) +- [ErrCantGetCircomSiblings](classes/ErrCantGetCircomSiblings) +- [ErrCantMarshalMetadata](classes/ErrCantMarshalMetadata) +- [ErrCantParseAccountID](classes/ErrCantParseAccountID) +- [ErrCantParseBearerToken](classes/ErrCantParseBearerToken) +- [ErrCantParseBoolean](classes/ErrCantParseBoolean) +- [ErrCantParseDataAsJSON](classes/ErrCantParseDataAsJSON) +- [ErrCantParseElectionID](classes/ErrCantParseElectionID) +- [ErrCantParseHexString](classes/ErrCantParseHexString) +- [ErrCantParseMetadataAsJSON](classes/ErrCantParseMetadataAsJSON) +- [ErrCantParseNumber](classes/ErrCantParseNumber) +- [ErrCantParseOrgID](classes/ErrCantParseOrgID) +- [ErrCantParsePayloadAsJSON](classes/ErrCantParsePayloadAsJSON) +- [ErrCantParseVoteID](classes/ErrCantParseVoteID) +- [ErrCantPublishMetadata](classes/ErrCantPublishMetadata) +- [ErrCensusBuild](classes/ErrCensusBuild) +- [ErrCensusIDLengthInvalid](classes/ErrCensusIDLengthInvalid) +- [ErrCensusIndexedFlagMismatch](classes/ErrCensusIndexedFlagMismatch) +- [ErrCensusNotFound](classes/ErrCensusNotFound) +- [ErrCensusProofVerificationFailed](classes/ErrCensusProofVerificationFailed) +- [ErrCensusRootHashMismatch](classes/ErrCensusRootHashMismatch) +- [ErrCensusRootIsNil](classes/ErrCensusRootIsNil) +- [ErrCensusTypeMismatch](classes/ErrCensusTypeMismatch) +- [ErrCensusTypeUnknown](classes/ErrCensusTypeUnknown) +- [ErrDstAccountUnknown](classes/ErrDstAccountUnknown) +- [ErrDstAddressMalformed](classes/ErrDstAddressMalformed) +- [ErrElectionEndDateBeforeStart](classes/ErrElectionEndDateBeforeStart) +- [ErrElectionEndDateInThePast](classes/ErrElectionEndDateInThePast) +- [ErrElectionFinished](classes/ErrElectionFinished) +- [ErrElectionIsNil](classes/ErrElectionIsNil) +- [ErrElectionNotFound](classes/ErrElectionNotFound) +- [ErrElectionNotStarted](classes/ErrElectionNotStarted) +- [ErrElectionResultsIsNil](classes/ErrElectionResultsIsNil) +- [ErrElectionResultsMismatch](classes/ErrElectionResultsMismatch) +- [ErrElectionResultsNotYetAvailable](classes/ErrElectionResultsNotYetAvailable) +- [ErrFaucetAlreadyFunded](classes/ErrFaucetAlreadyFunded) +- [ErrFileSizeTooBig](classes/ErrFileSizeTooBig) +- [ErrGettingSIK](classes/ErrGettingSIK) +- [ErrIndexedCensusCantUseWeight](classes/ErrIndexedCensusCantUseWeight) +- [ErrIndexerQueryFailed](classes/ErrIndexerQueryFailed) +- [ErrInvalidCensusKeyLength](classes/ErrInvalidCensusKeyLength) +- [ErrInvalidStatus](classes/ErrInvalidStatus) +- [ErrKeyNotFoundInCensus](classes/ErrKeyNotFoundInCensus) +- [ErrMarshalingJSONFailed](classes/ErrMarshalingJSONFailed) +- [ErrMarshalingServerJSONFailed](classes/ErrMarshalingServerJSONFailed) +- [ErrMarshalingServerProto](classes/ErrMarshalingServerProto) +- [ErrMetadataProvidedButNoURI](classes/ErrMetadataProvidedButNoURI) +- [ErrMetadataURINotMatchContent](classes/ErrMetadataURINotMatchContent) +- [ErrMissingParameter](classes/ErrMissingParameter) +- [ErrNoElectionKeys](classes/ErrNoElectionKeys) +- [ErrOrgNotFound](classes/ErrOrgNotFound) +- [ErrPageNotFound](classes/ErrPageNotFound) +- [ErrParamDumpOrRootMissing](classes/ErrParamDumpOrRootMissing) +- [ErrParamKeyOrProofMissing](classes/ErrParamKeyOrProofMissing) +- [ErrParamNetworkInvalid](classes/ErrParamNetworkInvalid) +- [ErrParamParticipantsMissing](classes/ErrParamParticipantsMissing) +- [ErrParamParticipantsTooBig](classes/ErrParamParticipantsTooBig) +- [ErrParamRootInvalid](classes/ErrParamRootInvalid) +- [ErrParamStatusInvalid](classes/ErrParamStatusInvalid) +- [ErrParamToInvalid](classes/ErrParamToInvalid) +- [ErrParticipantKeyMissing](classes/ErrParticipantKeyMissing) +- [ErrSIKNotFound](classes/ErrSIKNotFound) +- [ErrTransactionNotFound](classes/ErrTransactionNotFound) +- [ErrTxTypeMismatch](classes/ErrTxTypeMismatch) +- [ErrUnmarshalingServerProto](classes/ErrUnmarshalingServerProto) +- [ErrVochainEmptyReply](classes/ErrVochainEmptyReply) +- [ErrVochainGetTxFailed](classes/ErrVochainGetTxFailed) +- [ErrVochainOverloaded](classes/ErrVochainOverloaded) +- [ErrVochainReturnedErrorCode](classes/ErrVochainReturnedErrorCode) +- [ErrVochainReturnedInvalidElectionID](classes/ErrVochainReturnedInvalidElectionID) +- [ErrVochainReturnedWrongMetadataCID](classes/ErrVochainReturnedWrongMetadataCID) +- [ErrVochainSendTxFailed](classes/ErrVochainSendTxFailed) +- [ErrVoteIDMalformed](classes/ErrVoteIDMalformed) +- [ErrVoteNotFound](classes/ErrVoteNotFound) +- [ErrWalletNotFound](classes/ErrWalletNotFound) +- [ErrWalletPrivKeyAlreadyExists](classes/ErrWalletPrivKeyAlreadyExists) - [FaucetAPI](classes/FaucetAPI) - [FaucetService](classes/FaucetService) - [FileAPI](classes/FileAPI) - [FileService](classes/FileService) +- [GenericInternalServerError](classes/GenericInternalServerError) - [InvalidElection](classes/InvalidElection) +- [InvalidTxFormatError](classes/InvalidTxFormatError) +- [InvalidUserDataError](classes/InvalidUserDataError) +- [MalformedBodyError](classes/MalformedBodyError) +- [MalformedURLParamError](classes/MalformedURLParamError) +- [MarshalingServerJSONFailedError](classes/MarshalingServerJSONFailedError) - [MultiChoiceElection](classes/MultiChoiceElection) +- [NoOrganizationProvidedError](classes/NoOrganizationProvidedError) +- [NoOrganizationsError](classes/NoOrganizationsError) - [OffchainCensus](classes/OffchainCensus) +- [OrganizationNotFoundError](classes/OrganizationNotFoundError) +- [PasswordTooShortError](classes/PasswordTooShortError) - [PlainCensus](classes/PlainCensus) - [PublishedCensus](classes/PublishedCensus) - [PublishedElection](classes/PublishedElection) +- [RemoteSigner](classes/RemoteSigner) +- [RemoteSignerAPI](classes/RemoteSignerAPI) +- [RemoteSignerService](classes/RemoteSignerService) - [Service](classes/Service) - [StrategyCensus](classes/StrategyCensus) - [TokenCensus](classes/TokenCensus) +- [TxTypeNotAllowedError](classes/TxTypeNotAllowedError) +- [UnauthorizedError](classes/UnauthorizedError) - [UnpublishedElection](classes/UnpublishedElection) - [VocdoniCensus3Client](classes/VocdoniCensus3Client) - [VocdoniSDKClient](classes/VocdoniSDKClient) @@ -58,13 +172,20 @@ - [CircuitInputs](interfaces/CircuitInputs) - [CollectFaucetTx](interfaces/CollectFaucetTx) - [ElectionMetadata](interfaces/ElectionMetadata) +- [FetchAccountsParameters](interfaces/FetchAccountsParameters) +- [FetchBlocksParameters](interfaces/FetchBlocksParameters) - [FetchElectionsParameters](interfaces/FetchElectionsParameters) +- [FetchFeesParameters](interfaces/FetchFeesParameters) +- [FetchOrganizationParameters](interfaces/FetchOrganizationParameters) +- [FetchTransactionsParameters](interfaces/FetchTransactionsParameters) +- [FetchTransfersParameters](interfaces/FetchTransfersParameters) +- [FetchVotesParameters](interfaces/FetchVotesParameters) - [IAccount](interfaces/IAccount) -- [IAccountTransfersCountResponse](interfaces/IAccountTransfersCountResponse) -- [IAccountsCountResponse](interfaces/IAccountsCountResponse) +- [IAccountInfoResponse](interfaces/IAccountInfoResponse) +- [IAccountsList](interfaces/IAccountsList) - [IAccountsListResponse](interfaces/IAccountsListResponse) - [IApprovalElectionParameters](interfaces/IApprovalElectionParameters) -- [IBlockTransactionsResponse](interfaces/IBlockTransactionsResponse) +- [IBlock](interfaces/IBlock) - [IBudgetElectionParametersInfo](interfaces/IBudgetElectionParametersInfo) - [IBudgetElectionParametersWithBudget](interfaces/IBudgetElectionParametersWithBudget) - [IBudgetElectionParametersWithCensusWeight](interfaces/IBudgetElectionParametersWithCensusWeight) @@ -79,8 +200,7 @@ - [ICensus3StrategiesOperatorsResponse](interfaces/ICensus3StrategiesOperatorsResponse) - [ICensus3StrategyCreateResponse](interfaces/ICensus3StrategyCreateResponse) - [ICensus3StrategyEstimationQueueResponse](interfaces/ICensus3StrategyEstimationQueueResponse) -- [ICensus3StrategyHoldersResponse](interfaces/ICensus3StrategyHoldersResponse) -- [ICensus3StrategyHoldersResponsePaginated](interfaces/ICensus3StrategyHoldersResponsePaginated) +- [ICensus3StrategyHoldersQueueResponse](interfaces/ICensus3StrategyHoldersQueueResponse) - [ICensus3StrategyImportQueueResponse](interfaces/ICensus3StrategyImportQueueResponse) - [ICensus3StrategyToken](interfaces/ICensus3StrategyToken) - [ICensus3SupportedChain](interfaces/ICensus3SupportedChain) @@ -95,17 +215,22 @@ - [ICensusImportResponse](interfaces/ICensusImportResponse) - [ICensusParticipant](interfaces/ICensusParticipant) - [ICensusProofResponse](interfaces/ICensusProofResponse) +- [ICensusPublishAsyncResponse](interfaces/ICensusPublishAsyncResponse) - [ICensusPublishResponse](interfaces/ICensusPublishResponse) - [IChainBlockInfoResponse](interfaces/IChainBlockInfoResponse) +- [IChainBlocksList](interfaces/IChainBlocksList) +- [IChainBlocksListResponse](interfaces/IChainBlocksListResponse) - [IChainFeesListResponse](interfaces/IChainFeesListResponse) - [IChainGetCircuitResponse](interfaces/IChainGetCircuitResponse) - [IChainGetCostsResponse](interfaces/IChainGetCostsResponse) - [IChainGetInfoResponse](interfaces/IChainGetInfoResponse) -- [IChainOrganizationCountResponse](interfaces/IChainOrganizationCountResponse) - [IChainOrganizationListResponse](interfaces/IChainOrganizationListResponse) - [IChainOrganizationResponse](interfaces/IChainOrganizationResponse) - [IChainSubmitTxResponse](interfaces/IChainSubmitTxResponse) -- [IChainTxCountResponse](interfaces/IChainTxCountResponse) +- [IChainTransfersList](interfaces/IChainTransfersList) +- [IChainTransfersListResponse](interfaces/IChainTransfersListResponse) +- [IChainTxCosts](interfaces/IChainTxCosts) +- [IChainTxList](interfaces/IChainTxList) - [IChainTxListResponse](interfaces/IChainTxListResponse) - [IChainTxReference](interfaces/IChainTxReference) - [IChainValidator](interfaces/IChainValidator) @@ -119,23 +244,28 @@ - [IElectionCreateResponse](interfaces/IElectionCreateResponse) - [IElectionInfoResponse](interfaces/IElectionInfoResponse) - [IElectionKeysResponse](interfaces/IElectionKeysResponse) -- [IElectionListFilter](interfaces/IElectionListFilter) +- [IElectionList](interfaces/IElectionList) - [IElectionListResponse](interfaces/IElectionListResponse) - [IElectionMode](interfaces/IElectionMode) - [IElectionNextIdResponse](interfaces/IElectionNextIdResponse) - [IElectionParameters](interfaces/IElectionParameters) - [IElectionSummary](interfaces/IElectionSummary) - [IElectionType](interfaces/IElectionType) -- [IElectionVote](interfaces/IElectionVote) -- [IElectionVoteListResponse](interfaces/IElectionVoteListResponse) - [IEncryptionKey](interfaces/IEncryptionKey) +- [IFeesList](interfaces/IFeesList) - [IInvalidElectionParameters](interfaces/IInvalidElectionParameters) - [IMultiChoiceElectionParameters](interfaces/IMultiChoiceElectionParameters) - [IPublishedElectionParameters](interfaces/IPublishedElectionParameters) - [IQuestion](interfaces/IQuestion) +- [IRemoteSignerAddressesResponse](interfaces/IRemoteSignerAddressesResponse) +- [IRemoteSignerLoginResponse](interfaces/IRemoteSignerLoginResponse) +- [IRemoteSignerRefreshResponse](interfaces/IRemoteSignerRefreshResponse) +- [IRemoteSignerSignResponse](interfaces/IRemoteSignerSignResponse) +- [IRemoteSignerSignTxResponse](interfaces/IRemoteSignerSignTxResponse) - [ITallyMode](interfaces/ITallyMode) +- [ITransfer](interfaces/ITransfer) - [IVoteEncryptedPackage](interfaces/IVoteEncryptedPackage) -- [IVoteInfoResponse](interfaces/IVoteInfoResponse) +- [IVoteListResponse](interfaces/IVoteListResponse) - [IVoteMode](interfaces/IVoteMode) - [IVotePackage](interfaces/IVotePackage) - [IVoteSubmitResponse](interfaces/IVoteSubmitResponse) @@ -144,6 +274,8 @@ - [IZkSIKResponse](interfaces/IZkSIKResponse) - [MintTokensTx](interfaces/MintTokensTx) - [NewProcessTx](interfaces/NewProcessTx) +- [OrganizationList](interfaces/OrganizationList) +- [PaginationResponse](interfaces/PaginationResponse) - [Process](interfaces/Process) - [Proof](interfaces/Proof) - [RegisterKeyTx](interfaces/RegisterKeyTx) @@ -154,6 +286,7 @@ - [SetTransactionCostsTx](interfaces/SetTransactionCostsTx) - [Tx](interfaces/Tx) - [VoteEnvelope](interfaces/VoteEnvelope) +- [VotesList](interfaces/VotesList) ### Enumerations @@ -180,14 +313,18 @@ - [ensure0x](sdk-reference#ensure0x) - [formatUnits](sdk-reference#formatunits) - [getBytes](sdk-reference#getbytes) +- [getElectionMetadataTemplate](sdk-reference#getelectionmetadatatemplate) - [getHex](sdk-reference#gethex) - [strip0x](sdk-reference#strip0x) ### Type Aliases +- [AbstainProperties](sdk-reference#abstainproperties) - [AccountData](sdk-reference#accountdata) - [AllElectionStatus](sdk-reference#allelectionstatus) +- [ApprovalProperties](sdk-reference#approvalproperties) - [ArchivedAccountData](sdk-reference#archivedaccountdata) +- [BudgetProperties](sdk-reference#budgetproperties) - [Census3Census](sdk-reference#census3census) - [Census3CreateStrategyToken](sdk-reference#census3createstrategytoken) - [Census3Strategy](sdk-reference#census3strategy) @@ -200,23 +337,39 @@ - [ChainCosts](sdk-reference#chaincosts) - [ChainData](sdk-reference#chaindata) - [ChainTx](sdk-reference#chaintx) +- [Choice](sdk-reference#choice) +- [ChoiceProperties](sdk-reference#choiceproperties) - [ClientOptions](sdk-reference#clientoptions) - [CspCensusProof](sdk-reference#cspcensusproof) +- [CustomMeta](sdk-reference#custommeta) - [ElectionCreatedInformation](sdk-reference#electioncreatedinformation) - [ElectionCreationStepValue](sdk-reference#electioncreationstepvalue) - [ElectionIdOption](sdk-reference#electionidoption) - [ElectionKeys](sdk-reference#electionkeys) -- [ElectionMeta](sdk-reference#electionmeta) +- [ElectionList](sdk-reference#electionlist) +- [ElectionListWithPagination](sdk-reference#electionlistwithpagination) - [ElectionResultsType](sdk-reference#electionresultstype) - [FaucetOptions](sdk-reference#faucetoptions) - [FaucetPackage](sdk-reference#faucetpackage) - [Fee](sdk-reference#fee) +- [FetchAccountsParametersWithPagination](sdk-reference#fetchaccountsparameterswithpagination) +- [FetchBlocksParametersWithPagination](sdk-reference#fetchblocksparameterswithpagination) +- [FetchElectionsParametersWithPagination](sdk-reference#fetchelectionsparameterswithpagination) +- [FetchFeesParametersWithPagination](sdk-reference#fetchfeesparameterswithpagination) +- [FetchOrganizationParametersWithPagination](sdk-reference#fetchorganizationparameterswithpagination) +- [FetchTransactionsParametersWithPagination](sdk-reference#fetchtransactionsparameterswithpagination) +- [FetchTransfersParametersWithPagination](sdk-reference#fetchtransfersparameterswithpagination) +- [FetchVotesParametersWithPagination](sdk-reference#fetchvotesparameterswithpagination) - [HasAlreadyVotedOptions](sdk-reference#hasalreadyvotedoptions) - [IAccountSummary](sdk-reference#iaccountsummary) - [IBudgetElectionParameters](sdk-reference#ibudgetelectionparameters) - [IsAbleToVoteOptions](sdk-reference#isabletovoteoptions) - [IsInCensusOptions](sdk-reference#isincensusoptions) +- [PaginationRequest](sdk-reference#paginationrequest) - [ParsedPredicate](sdk-reference#parsedpredicate) +- [Question](sdk-reference#question) +- [RemoteSignerCredentials](sdk-reference#remotesignercredentials) +- [RemoteSignerProperties](sdk-reference#remotesignerproperties) - [SendTokensOptions](sdk-reference#sendtokensoptions) - [Strategy](sdk-reference#strategy) - [StrategyHolder](sdk-reference#strategyholder) @@ -229,8 +382,10 @@ - [TxWaitOptions](sdk-reference#txwaitoptions) - [VoteIdOption](sdk-reference#voteidoption) - [VoteInfo](sdk-reference#voteinfo) +- [VoteInfoResponse](sdk-reference#voteinforesponse) - [VoteStepValue](sdk-reference#votestepvalue) - [VoteSubmit](sdk-reference#votesubmit) +- [VoteSummary](sdk-reference#votesummary) - [VotesLeftCountOptions](sdk-reference#votesleftcountoptions) - [WalletOption](sdk-reference#walletoption) - [ZkProof](sdk-reference#zkproof) @@ -262,7 +417,7 @@ have hex prefix and are lowercase. #### Defined in -[util/common.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/util/common.ts#L35) +[src/util/common.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/util/common.ts#L35) ___ @@ -285,7 +440,7 @@ Throws an exception if it is not. #### Defined in -[types/metadata/account.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/account.ts#L8) +[src/types/metadata/account.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/account.ts#L8) ___ @@ -308,7 +463,7 @@ Throws an exception if it is not. #### Defined in -[types/metadata/election.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/election.ts#L8) +[src/types/metadata/election.ts:9](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L9) ___ @@ -328,7 +483,7 @@ ___ #### Defined in -[util/common.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/util/common.ts#L6) +[src/util/common.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/util/common.ts#L6) ___ @@ -354,7 +509,7 @@ Return the object data #### Defined in -[util/common.ts:60](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/util/common.ts#L60) +[src/util/common.ts:60](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/util/common.ts#L60) ___ @@ -374,7 +529,7 @@ ___ #### Defined in -[util/common.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/util/common.ts#L12) +[src/util/common.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/util/common.ts#L12) ___ @@ -399,7 +554,7 @@ The formatted string #### Defined in -[util/common.ts:48](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/util/common.ts#L48) +[src/util/common.ts:48](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/util/common.ts#L48) ___ @@ -419,7 +574,21 @@ ___ #### Defined in -[util/common.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/util/common.ts#L16) +[src/util/common.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/util/common.ts#L16) + +___ + +### getElectionMetadataTemplate + +▸ **getElectionMetadataTemplate**(): `any` + +#### Returns + +`any` + +#### Defined in + +[src/types/metadata/election.ts:209](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L209) ___ @@ -435,7 +604,7 @@ Generates a random seed and returns a 32 byte keccak256 hash of it (starting wit #### Defined in -[util/common.ts:23](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/util/common.ts#L23) +[src/util/common.ts:23](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/util/common.ts#L23) ___ @@ -455,29 +624,34 @@ ___ #### Defined in -[util/common.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/util/common.ts#L8) +[src/util/common.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/util/common.ts#L8) ## Type Aliases -### AccountData +### AbstainProperties -Ƭ **AccountData**: `Object` +Ƭ **AbstainProperties**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `account` | [`Account`](classes/Account) | -| `address` | `string` | -| `balance` | `number` | -| `electionIndex` | `number` | -| `infoURL?` | `string` | -| `nonce` | `number` | -| `sik?` | `string` | +| `abstainValues` | `string`[] | +| `canAbstain` | `boolean` | #### Defined in -[services/account.ts:25](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/account.ts#L25) +[src/types/metadata/election.ts:50](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L50) + +___ + +### AccountData + +Ƭ **AccountData**: \{ `account`: [`Account`](classes/Account.md) } & `Pick`\<[`IAccountInfoResponse`](interfaces/IAccountInfoResponse), ``"address"`` \| ``"balance"`` \| ``"nonce"`` \| ``"electionIndex"`` \| ``"infoURL"`` \| ``"sik"`` \| ``"transfersCount"`` \| ``"feesCount"``\> + +#### Defined in + +[src/services/account.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/account.ts#L29) ___ @@ -487,7 +661,24 @@ ___ #### Defined in -[types/election/published.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/published.ts#L24) +[src/types/election/published.ts:25](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/published.ts#L25) + +___ + +### ApprovalProperties + +Ƭ **ApprovalProperties**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `acceptValue` | `number` | +| `rejectValue` | `number` | + +#### Defined in + +[src/types/metadata/election.ts:70](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L70) ___ @@ -497,7 +688,26 @@ ___ #### Defined in -[services/account.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/account.ts#L35) +[src/services/account.ts:36](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/account.ts#L36) + +___ + +### BudgetProperties + +Ƭ **BudgetProperties**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `forceFullBudget` | `boolean` | +| `maxBudget` | `number` | +| `minStep` | `number` | +| `useCensusWeightAsBudget` | `boolean` | + +#### Defined in + +[src/types/metadata/election.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L63) ___ @@ -507,7 +717,7 @@ ___ #### Defined in -[census3.ts:31](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L31) +[src/census3.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L29) ___ @@ -517,7 +727,7 @@ ___ #### Defined in -[api/census3/strategy.ts:105](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L105) +[src/api/census3/strategy.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L92) ___ @@ -537,7 +747,7 @@ ___ #### Defined in -[api/census3/strategy.ts:46](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L46) +[src/api/census3/strategy.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L33) ___ @@ -558,7 +768,7 @@ ___ #### Defined in -[api/census3/strategy.ts:73](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/strategy.ts#L73) +[src/api/census3/strategy.ts:60](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/strategy.ts#L60) ___ @@ -568,7 +778,7 @@ ___ #### Defined in -[api/census3/token.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/token.ts#L12) +[src/api/census3/token.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/token.ts#L12) ___ @@ -601,7 +811,7 @@ ___ #### Defined in -[api/census3/token.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/census3/token.ts#L14) +[src/api/census3/token.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/census3/token.ts#L14) ___ @@ -620,7 +830,7 @@ ___ #### Defined in -[services/census.ts:42](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/census.ts#L42) +[src/services/census.ts:49](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/census.ts#L49) ___ @@ -641,7 +851,7 @@ ___ #### Defined in -[services/census.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/census.ts#L26) +[src/services/census.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/census.ts#L33) ___ @@ -665,7 +875,7 @@ ___ #### Defined in -[services/anonymous.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L51) +[src/services/anonymous.ts:52](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L52) ___ @@ -675,7 +885,7 @@ ___ #### Defined in -[services/chain.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/chain.ts#L14) +[src/services/chain.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L14) ___ @@ -695,17 +905,46 @@ ___ #### Defined in -[services/chain.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/chain.ts#L29) +[src/services/chain.ts:66](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L66) ___ ### ChainTx -Ƭ **ChainTx**: [`IChainTxReference`](interfaces/IChainTxReference) +Ƭ **ChainTx**: [`Tx`](interfaces/Tx) #### Defined in -[services/chain.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/chain.ts#L15) +[src/services/chain.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L15) + +___ + +### Choice + +Ƭ **Choice**: `Pick`\<[`IChoice`](interfaces/IChoice), ``"title"`` \| ``"value"`` \| ``"meta"``\> + +#### Defined in + +[src/types/metadata/election.ts:23](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L23) + +___ + +### ChoiceProperties + +Ƭ **ChoiceProperties**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `numChoices` | \{ `max`: `number` ; `min`: `number` } | +| `numChoices.max` | `number` | +| `numChoices.min` | `number` | +| `repeatChoice` | `boolean` | + +#### Defined in + +[src/types/metadata/election.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L55) ___ @@ -720,15 +959,16 @@ Optional VocdoniSDKClient arguments | Name | Type | | :------ | :------ | | `api_url?` | `string` | +| `census?` | `CensusOptions` | | `electionId?` | `string` | | `env` | [`EnvOptions`](enums/EnvOptions) | | `faucet?` | `Partial`\<[`FaucetOptions`](sdk-reference#faucetoptions)\> | | `tx_wait?` | `TxWaitOptions` | -| `wallet?` | `Wallet` \| `Signer` | +| `wallet?` | `Wallet` \| `Signer` \| [`RemoteSigner`](classes/RemoteSigner) | #### Defined in -[client.ts:86](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/client.ts#L86) +[src/client.ts:109](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/client.ts#L109) ___ @@ -748,7 +988,17 @@ ___ #### Defined in -[services/census.ts:56](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/census.ts#L56) +[src/services/census.ts:63](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/census.ts#L63) + +___ + +### CustomMeta + +Ƭ **CustomMeta**: `AnyJson` \| `JsonArray` \| `JsonMap` + +#### Defined in + +[src/types/election/election.ts:110](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/election.ts#L110) ___ @@ -758,7 +1008,7 @@ ___ #### Defined in -[services/election.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/election.ts#L38) +[src/services/election.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L55) ___ @@ -768,7 +1018,7 @@ ___ #### Defined in -[services/election.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/election.ts#L51) +[src/services/election.ts:68](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L68) ___ @@ -784,7 +1034,7 @@ ___ #### Defined in -[types/client/account.ts:5](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/client/account.ts#L5) +[src/types/client/account.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/client/account.ts#L6) ___ @@ -794,27 +1044,37 @@ ___ #### Defined in -[services/election.ts:37](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/election.ts#L37) +[src/services/election.ts:54](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L54) + +___ + +### ElectionList + +Ƭ **ElectionList**: ([`PublishedElection`](classes/PublishedElection.md) \| [`InvalidElection`](classes/InvalidElection))[] + +#### Defined in + +[src/services/election.ts:51](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L51) ___ -### ElectionMeta +### ElectionListWithPagination -Ƭ **ElectionMeta**: `AnyJson` \| `JsonArray` \| `JsonMap` +Ƭ **ElectionListWithPagination**: \{ `elections`: [`ElectionList`](sdk-reference.md#electionlist) } & [`PaginationResponse`](interfaces/PaginationResponse) #### Defined in -[types/election/election.ts:114](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/election.ts#L114) +[src/services/election.ts:52](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L52) ___ ### ElectionResultsType -Ƭ **ElectionResultsType**: \{ `name`: [`SINGLE_CHOICE_MULTIQUESTION`](enums/ElectionResultsTypeNames.md#single_choice_multiquestion) ; `properties`: {} } \| \{ `name`: [`MULTIPLE_CHOICE`](enums/ElectionResultsTypeNames.md#multiple_choice) ; `properties`: \{ `abstainValues`: `string`[] ; `canAbstain`: `boolean` ; `repeatChoice`: `boolean` } } \| \{ `name`: [`BUDGET`](enums/ElectionResultsTypeNames.md#budget) ; `properties`: \{ `forceFullBudget`: `boolean` ; `maxBudget`: `number` ; `minStep`: `number` ; `useCensusWeightAsBudget`: `boolean` } } \| \{ `name`: [`APPROVAL`](enums/ElectionResultsTypeNames#approval) ; `properties`: \{ `acceptValue`: `number` ; `rejectValue`: `number` } } +Ƭ **ElectionResultsType**: \{ `name`: [`SINGLE_CHOICE_MULTIQUESTION`](enums/ElectionResultsTypeNames.md#single_choice_multiquestion) ; `properties`: {} } \| \{ `name`: [`MULTIPLE_CHOICE`](enums/ElectionResultsTypeNames.md#multiple_choice) ; `properties`: [`AbstainProperties`](sdk-reference.md#abstainproperties) & [`ChoiceProperties`](sdk-reference.md#choiceproperties) } \| \{ `name`: [`BUDGET`](enums/ElectionResultsTypeNames.md#budget) ; `properties`: [`BudgetProperties`](sdk-reference.md#budgetproperties) } \| \{ `name`: [`APPROVAL`](enums/ElectionResultsTypeNames.md#approval) ; `properties`: [`ApprovalProperties`](sdk-reference.md#approvalproperties) } \| \{ `name`: [`QUADRATIC`](enums/ElectionResultsTypeNames.md#quadratic) ; `properties`: [`BudgetProperties`](sdk-reference#budgetproperties) & \{ `quadraticCost`: `number` } } #### Defined in -[types/metadata/election.ts:44](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/election.ts#L44) +[src/types/metadata/election.ts:75](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L75) ___ @@ -824,7 +1084,7 @@ ___ #### Defined in -[services/faucet.ts:28](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/faucet.ts#L28) +[src/services/faucet.ts:28](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/faucet.ts#L28) ___ @@ -841,7 +1101,7 @@ ___ #### Defined in -[services/faucet.ts:23](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/faucet.ts#L23) +[src/services/faucet.ts:23](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/faucet.ts#L23) ___ @@ -862,7 +1122,87 @@ ___ #### Defined in -[api/chain.ts:357](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/chain.ts#L357) +[src/api/chain.ts:416](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/chain.ts#L416) + +___ + +### FetchAccountsParametersWithPagination + +Ƭ **FetchAccountsParametersWithPagination**: [`FetchAccountsParameters`](interfaces/FetchAccountsParameters.md) & [`PaginationRequest`](sdk-reference#paginationrequest) + +#### Defined in + +[src/services/account.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/account.ts#L14) + +___ + +### FetchBlocksParametersWithPagination + +Ƭ **FetchBlocksParametersWithPagination**: [`FetchBlocksParameters`](interfaces/FetchBlocksParameters.md) & [`PaginationRequest`](sdk-reference#paginationrequest) + +#### Defined in + +[src/services/chain.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L21) + +___ + +### FetchElectionsParametersWithPagination + +Ƭ **FetchElectionsParametersWithPagination**: [`FetchElectionsParameters`](interfaces/FetchElectionsParameters.md) & [`PaginationRequest`](sdk-reference#paginationrequest) + +#### Defined in + +[src/services/election.ts:40](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/election.ts#L40) + +___ + +### FetchFeesParametersWithPagination + +Ƭ **FetchFeesParametersWithPagination**: [`FetchFeesParameters`](interfaces/FetchFeesParameters.md) & [`PaginationRequest`](sdk-reference#paginationrequest) + +#### Defined in + +[src/services/chain.ts:18](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L18) + +___ + +### FetchOrganizationParametersWithPagination + +Ƭ **FetchOrganizationParametersWithPagination**: [`FetchOrganizationParameters`](interfaces/FetchOrganizationParameters.md) & [`PaginationRequest`](sdk-reference#paginationrequest) + +#### Defined in + +[src/services/chain.ts:17](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L17) + +___ + +### FetchTransactionsParametersWithPagination + +Ƭ **FetchTransactionsParametersWithPagination**: [`FetchTransactionsParameters`](interfaces/FetchTransactionsParameters.md) & [`PaginationRequest`](sdk-reference#paginationrequest) + +#### Defined in + +[src/services/chain.ts:19](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L19) + +___ + +### FetchTransfersParametersWithPagination + +Ƭ **FetchTransfersParametersWithPagination**: [`FetchTransfersParameters`](interfaces/FetchTransfersParameters.md) & [`PaginationRequest`](sdk-reference#paginationrequest) + +#### Defined in + +[src/services/chain.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L20) + +___ + +### FetchVotesParametersWithPagination + +Ƭ **FetchVotesParametersWithPagination**: [`FetchVotesParameters`](interfaces/FetchVotesParameters.md) & [`PaginationRequest`](sdk-reference#paginationrequest) + +#### Defined in + +[src/services/vote.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/vote.ts#L16) ___ @@ -872,17 +1212,17 @@ ___ #### Defined in -[types/client/account.ts:10](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/client/account.ts#L10) +[src/types/client/account.ts:11](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/client/account.ts#L11) ___ ### IAccountSummary -Ƭ **IAccountSummary**: `Pick`\<`IAccountInfoResponse`, ``"address"`` \| ``"balance"`` \| ``"nonce"``\> +Ƭ **IAccountSummary**: `Pick`\<[`IAccountInfoResponse`](interfaces/IAccountInfoResponse), ``"address"`` \| ``"balance"`` \| ``"nonce"``\> #### Defined in -[api/account.ts:19](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L19) +[src/api/account.ts:13](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/account.ts#L13) ___ @@ -892,7 +1232,7 @@ ___ #### Defined in -[types/election/budget.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/election/budget.ts#L21) +[src/types/election/budget.ts:27](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/election/budget.ts#L27) ___ @@ -902,7 +1242,7 @@ ___ #### Defined in -[types/client/account.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/client/account.ts#L12) +[src/types/client/account.ts:13](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/client/account.ts#L13) ___ @@ -912,7 +1252,24 @@ ___ #### Defined in -[types/client/account.ts:9](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/client/account.ts#L9) +[src/types/client/account.ts:10](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/client/account.ts#L10) + +___ + +### PaginationRequest + +Ƭ **PaginationRequest**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `limit` | `number` | +| `page` | `number` | + +#### Defined in + +[src/api/api.ts:125](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/api.ts#L125) ___ @@ -922,7 +1279,52 @@ ___ #### Defined in -[census3.ts:34](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L34) +[src/census3.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L32) + +___ + +### Question + +Ƭ **Question**: `Pick`\<[`IQuestion`](interfaces/IQuestion), ``"title"`` \| ``"description"`` \| ``"choices"`` \| ``"meta"``\> + +#### Defined in + +[src/types/metadata/election.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L24) + +___ + +### RemoteSignerCredentials + +Ƭ **RemoteSignerCredentials**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `email` | `string` | +| `password` | `string` | + +#### Defined in + +[src/types/remote-signer.ts:14](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/remote-signer.ts#L14) + +___ + +### RemoteSignerProperties + +Ƭ **RemoteSignerProperties**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `credentials` | [`RemoteSignerCredentials`](sdk-reference#remotesignercredentials) | +| `token` | `string` | +| `url` | `string` | + +#### Defined in + +[src/types/remote-signer.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/remote-signer.ts#L8) ___ @@ -932,7 +1334,7 @@ ___ #### Defined in -[types/client/account.ts:8](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/client/account.ts#L8) +[src/types/client/account.ts:9](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/client/account.ts#L9) ___ @@ -942,7 +1344,7 @@ ___ #### Defined in -[census3.ts:27](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L27) +[src/census3.ts:25](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L25) ___ @@ -959,24 +1361,17 @@ ___ #### Defined in -[census3.ts:28](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L28) +[src/census3.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L26) ___ ### StrategyHolders -Ƭ **StrategyHolders**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `holders` | [`StrategyHolder`](sdk-reference#strategyholder)[] | -| `pagination` | `Census3Pagination` | +Ƭ **StrategyHolders**: [`StrategyHolder`](sdk-reference#strategyholder)[] #### Defined in -[census3.ts:29](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L29) +[src/census3.ts:27](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L27) ___ @@ -986,7 +1381,7 @@ ___ #### Defined in -[census3.ts:30](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L30) +[src/census3.ts:28](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L28) ___ @@ -996,7 +1391,7 @@ ___ #### Defined in -[census3.ts:32](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L32) +[src/census3.ts:30](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L30) ___ @@ -1006,7 +1401,7 @@ ___ #### Defined in -[census3.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L33) +[src/census3.ts:31](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L31) ___ @@ -1016,7 +1411,7 @@ ___ #### Defined in -[census3.ts:25](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L25) +[src/census3.ts:23](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L23) ___ @@ -1026,7 +1421,7 @@ ___ #### Defined in -[census3.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/census3.ts#L26) +[src/census3.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/census3.ts#L24) ___ @@ -1045,7 +1440,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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/chain.ts#L24) +[src/services/chain.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/chain.ts#L61) ___ @@ -1061,17 +1456,43 @@ ___ #### Defined in -[types/client/account.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/client/account.ts#L6) +[src/types/client/account.ts:7](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/client/account.ts#L7) ___ ### VoteInfo -Ƭ **VoteInfo**: [`IVoteInfoResponse`](interfaces/IVoteInfoResponse) +Ƭ **VoteInfo**: [`VoteInfoResponse`](sdk-reference#voteinforesponse) #### Defined in -[services/vote.ts:15](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/vote.ts#L15) +[src/services/vote.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/vote.ts#L22) + +___ + +### VoteInfoResponse + +Ƭ **VoteInfoResponse**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `blockHeight` | `number` | The block number where the transaction is mined. | +| `date` | `string` | Date when the vote was emitted | +| `electionID` | `string` | The identifier of the election. | +| `encryptionKeys?` | `number`[] | Encryption key indexes used | +| `overwriteCount` | `number` | The number of votes overwrites. | +| `package` | [`IVotePackage`](interfaces/IVotePackage.md) \| [`IVoteEncryptedPackage`](interfaces/IVoteEncryptedPackage) | The vote package. | +| `transactionIndex` | `number` | The index inside the block where the transaction is mined. | +| `txHash` | `string` | The hash of the transaction | +| `voteID` | `string` | The identifier of the vote, also called nullifier. | +| `voterID` | `string` | The identifier of the voter. | +| `weight` | `string` | The weight of the vote. | + +#### Defined in + +[src/api/vote.ts:57](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/vote.ts#L57) ___ @@ -1081,7 +1502,7 @@ ___ #### Defined in -[services/vote.ts:28](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/vote.ts#L28) +[src/services/vote.ts:35](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/vote.ts#L35) ___ @@ -1091,7 +1512,17 @@ ___ #### Defined in -[services/vote.ts:16](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/vote.ts#L16) +[src/services/vote.ts:23](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/vote.ts#L23) + +___ + +### VoteSummary + +Ƭ **VoteSummary**: `Pick`\<[`VoteInfoResponse`](sdk-reference#voteinforesponse), ``"txHash"`` \| ``"voteID"`` \| ``"voterID"`` \| ``"electionID"`` \| ``"blockHeight"`` \| ``"transactionIndex"``\> + +#### Defined in + +[src/api/vote.ts:52](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/api/vote.ts#L52) ___ @@ -1101,7 +1532,7 @@ ___ #### Defined in -[types/client/account.ts:11](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/client/account.ts#L11) +[src/types/client/account.ts:12](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/client/account.ts#L12) ___ @@ -1113,11 +1544,11 @@ ___ | Name | Type | | :------ | :------ | -| `wallet` | `Wallet` \| `Signer` | +| `wallet` | `Wallet` \| `Signer` \| [`RemoteSigner`](classes/RemoteSigner) | #### Defined in -[types/client/account.ts:4](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/client/account.ts#L4) +[src/types/client/account.ts:5](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/client/account.ts#L5) ___ @@ -1139,7 +1570,7 @@ ___ #### Defined in -[services/anonymous.ts:23](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/anonymous.ts#L23) +[src/services/anonymous.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/services/anonymous.ts#L24) ## Variables @@ -1149,7 +1580,7 @@ ___ #### Defined in -[types/metadata/account.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/account.ts#L67) +[src/types/metadata/account.ts:67](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/account.ts#L67) ___ @@ -1159,4 +1590,4 @@ ___ #### Defined in -[types/metadata/election.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/metadata/election.ts#L140) +[src/types/metadata/election.ts:166](https://github.com/vocdoni/vocdoni-sdk/blob/f4514c39379db181cb8ecc039bbbb363994a78fa/src/types/metadata/election.ts#L166)